Table of Contents
Enumerations #
| Name | Values |
|---|---|
| AttachmentValues | Default |
| Fixed | |
| Local | |
| Scroll | |
| BlendModes | Default |
| Multiply | |
| Screen | |
| Overlay | |
| Darken | |
| Lighten | |
| Dodge | |
| Saturation | |
| Color | |
| Luminosity | |
| BoundaryValues | Default |
| PaddingBox | |
| BorderBox | |
| ContentBox | |
| PositionValues | Default |
| LeftTop | |
| LeftCenter | |
| LeftBottom | |
| RightTop | |
| RightCenter | |
| RightBottom | |
| CenterTop | |
| Center | |
| CenterBottom | |
| Raw | |
| RepeatValues | Default |
| Repeat | |
| RepeatX | |
| RepeatY | |
| NoRepeat | |
| SizeValues | Default |
| Cover | |
| Contain | |
| Raw |
Constants #
This class exposes no constants.
Events #
| Definition | Parameters | Description |
|---|---|---|
| MouseEnter | None | Raised when the user’s mouse enters the display area. |
| MouseExit | None | Raised when the user’s mouse exits the display area. |
| Pressed | None | Raised when the user left-clicks or touches the control. |
| PressedRight | None | Raised when the user right-clicks or long-presses the control. |
Methods #
| Definition | Parameters | Return Type | Description |
|---|---|---|---|
| SetBackgroundImage | p as Picture | None | Sets the background image of the rectangle to the specified Picture object. |
| SetBackgroundImage | p as WebFile | None | Sets the background image of the rectangle to the specified WebFile object. |
| SetBackgroundImage | p as WebPicture | None | Sets the background image of the rectangle to the specified WebPicture object. |
Properties #
| Name | Type | Default Value | Description |
|---|---|---|---|
| BorderBottom | Boolean | True | Determines whether the rectangle has a bottom border. |
| BorderBottomLeftRadius | Integer | 0 | Radius of the bottom left corner. |
| BorderBottomRightRadius | Integer | 0 | Radius of the bottom right corner. |
| BorderBottomRounded | Boolean | True | If True, corners at the bottom will be rounded. Also relies on each side having their Rounded property set to True. |
| BorderBottomSize | Integer | 1 | Size of the border along the bottom side. |
| BorderLeft | Boolean | True | Determines whether the rectangle has a left border. |
| BorderLeftRounded | Boolean | True | If True, corners on the left will be rounded. Also relies on top and/or bottom having their Rounded property set to True. |
| BorderLeftSize | Integer | 1 | Size of the border along the left side. |
| BorderRight | Boolean | True | Determines whether the rectangle has a right border. |
| BorderRightRounded | Boolean | True | If True, corners on the right will be rounded. Also relies on top and/or bottom having their Rounded property set to True. |
| BorderRightSize | Integer | 1 | Size of the border along the right side. |
| BorderTop | Boolean | True | Determines whether the rectangle has a top border. |
| BorderTopLeftRadius | Integer | 0 | Radius of the top left corner. |
| BorderTopRightRadius | Integer | 0 | Radius of the top right corner. |
| BorderTopRounded | Boolean | True | If True, corners at the top will be rounded. Also relies on each side having their Rounded property set to True. |
| BorderTopSize | Integer | 1 | Size of the border along the top side. |
| Border | Boolean | True | If True, corners at the top will be rounded. Also relies on each side having their Rounded property set to True. |
| ColorBackground | Color | &c000000 | Custom background color. |
| ColorBorder | Color | &c000000 | Custom border color. |
| CustomBackground | Boolean | False | When True, ColorBackground is applied to the rectangle. |
| CustomBorder | Boolean | False | When True, ColorBorder is applied to the rectangle. |
| ImageAttachment | AttachmentValues | Default | Sets whether a background image scrolls with the rest of the page, or is fixed. |
| ImageBackgroundURL | String | “” | URL to an image to set as the background. The SetBackgroundImage methods populate this property. |
| ImageBlendMode | BlendModes | Default | Sets how the background image should blend with each other and with the element’s background color. |
| ImageClip | BoundaryValues | Default | Sets whether an element’s background extends underneath its border box, padding box, or content box. |
| ImageOrigin | BoundaryValues | Default | Sets the background’s origin: from the border start, inside the border, or inside the padding. |
| ImagePosition | PositionValues | Default | Sets the initial position for each background image. The position is relative to the position layer set by ImageOrigin. |
| ImagePositionRaw | String | “” | Custom position value. See here for more information. |
| ImageRepeat | RepeatValues | Default | Sets whether the image will repeat along X, Y, both, or none axes. |
| ImageSize | SizeValues | Default | Sets the size of the element’s background image. The image can be left to its natural size, stretched, or constrained to fit the available space. |
| ImageSizeRaw | String | “” | Custom size values. See here for more information. |
| IndicatorBackground | WebUIControl.Indicators | Default | Bootstrap indicator to apply to the rectangle’s background. It is not recommended that you mix IndicatorBackground with ColorBackground. |
| IndicatorBorder | WebUIControl.Indicators | Default | Bootstrap indicator to apply to the rectangle’s border. It is not recommended that you mix IndicatorBorder with ColorBorder. |
| IsOval | Boolean | False | When set to True the control will draw as an oval and override the Border*Rounded properties. |
Examples #
This class currently has no examples.
Notes #
This class currently has no notes.