Interface LabelledControlProperties

Properties for SVICustomElement.LabelledControl.

Example: HTML Example:

<svi-labelled-control
  [childNode]="childNode"
  [pageModel]="pageModel"
>
  <!-- my control -->
</svi-labelled-control>

Example: Create the element via document.createElement:

const labelledControl = document.createElement(SVICustomElement.LabelledControl);
labelledControl.pageModel = this.pageModel;
labelledControl.childNode = this.childNode;
labelledControl.appendChild(myControlElement)
interface LabelledControlProperties {
    childNode: Control<TypeAttributes>;
    dataSource?: string;
    disableMaskToggle?: boolean;
    for?: string;
    hideMaskToggle?: boolean;
    isDisabled?: boolean;
    isRequired?: boolean;
    labelClass?: string;
    overrideLabel?: string;
    pageModel: PageModel;
}

Hierarchy (view full)

Properties

childNode dataSource? disableMaskToggle? for? hideMaskToggle? isDisabled? isRequired? labelClass? overrideLabel? pageModel

Properties

childNode

childNode: Control<TypeAttributes>

OptionaldataSource

dataSource?: string

Specify which dataSource the label's mask-toggle-button will toggle.

If no dataSource is specified, the mask-toggle-button will toggle the dataSource(s) defined in the childNode's typeAttributes.

OptionaldisableMaskToggle

disableMaskToggle?: boolean

Disable the label's mask toggle button.

Optionalfor

for?: string

Set the label's for attribute.

OptionalhideMaskToggle

hideMaskToggle?: boolean

Hide the label's mask toggle button.

OptionalisDisabled

isDisabled?: boolean

Set the label as disabled.

OptionalisRequired

isRequired?: boolean

Set the label as required.

OptionallabelClass

labelClass?: string

Add css classes to the label element.

OptionaloverrideLabel

overrideLabel?: string

Override the text displayed in the label.

pageModel

pageModel: PageModel

Settings

Member Visibility

On This Page

Properties