Class Border

A Component that defines a Frame's Border.

Methods

Border:Border (initialWidth[, initialStyle=BorderStyle.None], initialContent[, initialRadius=0], initialBorders) Border constructor.

Properties

self.Style.get () Returns the Border's BorderStyle.
self.Style.set (value) Sets the Border's BorderStyle.
self.Width.get () Returns the Border's width.
self.Width.set (value) Sets the Border's width.
self.Content.get () Returns the Border's content.
self.Content.set (Image) Sets the Border's content.
self.Top.get () Returns the Border's top BorderSide Component.
self.Top.set (value) Sets the Border's top BorderSide Component.
self.Right.get () Returns the Border's right BorderSide Component.
self.Right.set (value) Sets the Border's right BorderSide Component.
self.Bottom.get () Returns the Border's bottom BorderSide Component.
self.Bottom.set (value) Sets the Border's bottom BorderSide Component.
self.Left.get () Returns the Border's left BorderSide Component.
self.Left.set (value) Sets the Border's left BorderSide Component.
self.Stylesheet.get () Updates and returns the Border's stylesheet.


Methods

Border:Border (initialWidth[, initialStyle=BorderStyle.None], initialContent[, initialRadius=0], initialBorders)
Border constructor.

Parameters:

  • initialWidth number or table The Border Component's initial width. May be a number or a table of numbers.
  • initialStyle BorderStyle The Border Component's initial BorderStyle. (default BorderStyle.None)
  • initialContent Image, Brush or table The Border Component's initial content.
  • initialRadius number or table The Border Component's initial radius, for rounded corners. (default 0)
  • initialBorders table The Border Component's initial BorderSide Subcomponents. Must be a table containing one to four BorderSides.

Returns:

    Border

Properties

self.Style.get ()
Returns the Border's BorderStyle.

Returns:

    BorderStyle
self.Style.set (value)
Sets the Border's BorderStyle.

Parameters:

self.Width.get ()
Returns the Border's width.

Returns:

    number or table
self.Width.set (value)
Sets the Border's width.

Parameters:

self.Content.get ()
Returns the Border's content.

Returns:

    Image, Brush or table
self.Content.set (Image)
Sets the Border's content.

Parameters:

  • Image |Brush|table value
self.Top.get ()
Returns the Border's top BorderSide Component.

Returns:

    table
self.Top.set (value)
Sets the Border's top BorderSide Component.

Parameters:

self.Right.get ()
Returns the Border's right BorderSide Component.

Returns:

    table
self.Right.set (value)
Sets the Border's right BorderSide Component.

Parameters:

self.Bottom.get ()
Returns the Border's bottom BorderSide Component.

Returns:

    table
self.Bottom.set (value)
Sets the Border's bottom BorderSide Component.

Parameters:

self.Left.get ()
Returns the Border's left BorderSide Component.

Returns:

    table
self.Left.set (value)
Sets the Border's left BorderSide Component.

Parameters:

self.Stylesheet.get ()
Updates and returns the Border's stylesheet.

Returns:

    string
generated by LDoc 1.4.6 Last updated 2017-11-15 22:27:55