Class ContextManagerCustomScripting

This class supports the functionality for custom scripting on a context manager. You can access all the methods by using the namespace CSL.contextManager.

Hierarchy

  • CslBase
    • ContextManagerCustomScripting

Properties

componentId

Accessors

componentConfig htmlElement viewConfig viewFields

Methods

clear clearAll getContextValue getFullContext search setContextValue

Properties

componentId

componentId: string = ''

The component id of the current view instance.

Accessors

componentConfig

  • get componentConfig(): Component

  • The configuration of the component to render.

    Returns Component

htmlElement

  • get htmlElement(): any

  • The rendered HTML of the view.

    Returns any

viewConfig

  • get viewConfig(): UpdateView | MultiRecordView | SingleRecordView | CreateView

  • The configuration of the view to render.

    Returns UpdateView | MultiRecordView | SingleRecordView | CreateView

viewFields

  • get viewFields(): ViewField[]

  • The viewFields of the view.

    Returns ViewField[]

Methods

clear

  • Clear the current context manager.

    CSL.contextManager.clear();

    Parameters

    • Optional componentId: string

      The id of the context manager to clear.

    Returns void

clearAll

  • Clear all context managers.

    CSL.contextManager.clearAll();

    Returns void

getContextValue

  • Gets the context value for a specific field.

    CSL.contextManager.getContextValue('name');

    Parameters

    • fieldName: string

      The field of which you want to know the value for.

    Returns string

getFullContext

  • Get all context of the current page.

    Returns ValueObject<string>

search

  • Triggers the search of a context manager.

    CSL.contextManager.search();

    Parameters

    • Optional componentId: string

      The id of the context manager to search.

    Returns void

setContextValue

  • Sets the given context as context. Overrides if the key of a field was allready in use.

    CSL.contextManager.setContextValue({'name': 'John', 'age': 35});
    CSL.contextManager.setContextValue('name', 'John');

    Parameters

    • context: string | {
          [key: string]: any;
      }

      The context to set or the key of the context.

    • Optional contextValue: any

      The value for the key.

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc