Interface ICaptioned

A control that shows text: a button's label, the text beside a check box, a group box's title.

interface ICaptioned {
    getCaption(): string | null;
    getFont(): Font | null;
    setCaption(
        caption: string | null,
        options?: ITransaction.OperationOptions,
    ): this;
}

Hierarchy (View Summary)

ICaptioned
- IButton
- ICheckBox
- IOptionButton
- IGroupBox
- ILabel

Index

Methods

getCaption getFont setCaption

Methods

getCaption

getCaption(): string | null

Returns the text written on the control, or null if it has none.

Returns string | null

getFont

getFont(): Font | null

Returns the font the caption is drawn in, or null when the control has not said.

Returns Font | null

setCaption

setCaption(
caption: string | null,
options?: ITransaction.OperationOptions,
): this
Sets the text written on the control.
Parameters
- caption: string | null
  The text, or null for none.
- Optionaloptions: ITransaction.OperationOptions
Returns this