Interface ControlPageApiBase

Methods related to the page to which a control belongs.

interface ControlPageApiBase {
    field: ControlPageFieldApi;
    file: ControlFileApiBase;
    isExternalObject: boolean;
    isHomepage: boolean;
    objectId: string;
    objectName: string;
    getMode(): PageMode;
    onChange(handler: ((change: PageDataChange | PageModeChange) => void)): void;
}

Hierarchy (view full)

Properties

field file isExternalObject isHomepage objectId objectName

Methods

getMode onChange

Properties

Readonlyfield

field: ControlPageFieldApi

Methods that relate to object fields associated with the page.

Readonlyfile

file: ControlFileApiBase

Methods related to files associated with the page.

ReadonlyisExternalObject

isExternalObject: boolean

Checks if the object is external.

ReadonlyisHomepage

isHomepage: boolean

Checks if the page is a Home page.

ReadonlyobjectId

objectId: string

The object ID. Returns an empty string ("") if not applicable.

ReadonlyobjectName

objectName: string

The object name. Returns an empty string ("") if not applicable.

Methods

getMode

  • getMode(): PageMode

  • Returns the mode of the page on which the calling control resides.

    Returns PageMode

    The current PageMode.

    Method

onChange

  • onChange(handler): void

  • Registers a function to be invoked whenever a relevant change happens. The handler receives an object that gives information about the change event. There are two types of changes - PageDataChange when the data in the page model changes, and PageModeChange when the page mode changes.

    Parameters

    Returns void

    Method

Settings

Member Visibility

On This Page

Properties
Methods