Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Pages$SingleSearchField"
versionInfo: StructureVersionInfo = ...

Accessors

  • get attributePath(): string
  • set attributePath(newValue: string): void
  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Returns string

  • The value of this property is conceptually of type paths.LegacyAttributePath.

    In version 7.11.0: deleted

    Parameters

    • newValue: string

    Returns void

  • In version 7.11.0: introduced

    Returns null | AttributeRef

  • In version 7.11.0: introduced

    Parameters

    Returns void

  • get caption(): Text
  • set caption(newValue: Text): void
  • Returns Text

  • Parameters

    Returns void

  • get container(): TContainer
  • Returns TContainer

  • Returns ControlBar

  • Returns GridControlBar

  • get customDateFormat(): string
  • set customDateFormat(newValue: string): void
  • In version 7.21.0: introduced

    Returns string

  • In version 7.21.0: introduced

    Parameters

    • newValue: string

    Returns void

  • get defaultValue(): string
  • set defaultValue(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

    • if false, a load is required to access these properties.

    Returns boolean

  • get model(): TModel
  • Returns TModel

  • get name(): string
  • set name(newValue: string): void
  • Returns string

  • Parameters

    • newValue: string

    Returns void

  • get placeholder(): Text
  • set placeholder(newValue: Text): void
  • In version 7.21.0: introduced

    Returns Text

  • In version 7.21.0: introduced

    Parameters

    Returns void

Methods

  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Returns SingleSearchField

  • delete(): void
  • getContainerAs<T>(containerType: any): T
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Parameters

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<SingleSearchField>

  • toJSON(): IStructureJSON
  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

  • traverse(visit: (structure: IStructure) => void): void
  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T
  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

  • traversePublicParts(visit: (structure: IStructure) => void): void

Generated using TypeDoc