StiSimpleBorder Class
Namespace: Stimulsoft.Base.Drawing
Class describes a border.
Inheritance
Implements: ICloneable, IStiJsonReportObject
Constructors
| Constructor | Description |
|---|---|
| constructor(StiBorderSides side, Color color, any size, StiPenStyle style) | Creates a new instance of the StiBorder class. |
constructor(side: StiBorderSides, color: Color, size: any, style: StiPenStyle)
Creates a new instance of the StiBorder class.
Parameters
- side (StiBorderSides) — Border sides.
- color (Color) — Border color.
- size (any) — Border size.
- style (StiPenStyle) — Border style.
Properties
| Property | Type | Description |
|---|---|---|
| isAllBorderSidesPresent | boolean | Gets value which indicates that all sides of border is present. |
| isBottomBorderSidePresent | boolean | Gets value which indicates that bottom side of border is present. |
| isLeftBorderSidePresent | boolean | Gets value which indicates that left side of border is present. |
| isRightBorderSidePresent | boolean | Gets value which indicates that right side of border is present. |
| isTopBorderSidePresent | boolean | Gets value which indicates that top side of border is present. |
Methods
| Method | Returns | Description |
|---|---|---|
| clone | any | Creates a new object that is a copy of the current instance. |
| getBorder | StiBorder | |
| getSize | number | |
| getSizeIncludingSide | number | |
| getSizeOffset | number | |
| loadFromJsonObject | void | |
| loadFromXml | void | |
| saveToJsonObject | StiJson |
Method Details
clone
clone(): any
Creates a new object that is a copy of the current instance.
Returns any — A new object that is a copy of this instance.
getBorder
getBorder(): StiBorder
Returns StiBorder
getSize
getSize(): number
Returns number
getSizeIncludingSide
getSizeIncludingSide(): number
Returns number
getSizeOffset
getSizeOffset(): number
Returns number
loadFromJsonObject
loadFromJsonObject(jObject: StiJson): void
Parameters
- jObject (StiJson)
loadFromXml
loadFromXml(xmlNode: XmlNode): void
Parameters
- xmlNode (XmlNode)
saveToJsonObject
saveToJsonObject(mode: StiJsonSaveMode): StiJson
Parameters
- mode (StiJsonSaveMode)
Returns StiJson
Fields
| Field | Type | Description |
|---|---|---|
| color | any | Gets or sets a border color. |
| side | any | Gets or sets frame borders. |
| size | any | Gets or sets a border size. |
| style | any | Gets or sets a border style. |