• Basics
  • Abyss
  • Web APIs
  • C# & Razor
  • .net API
  • JS & TS API

    Show / Hide Table of Contents

    Interface RunParamsWithContext

    Parameters for the Global $2sxc.cms.run(...) command in Addition to the RunParams. It provides context to the run-params such as a Sxc instance or a tag which it started on. New in 12.10

    Package: Api.Js.SxcJs

    Properties

    action

    The action to perform. Required.

    Declaration
    action?: CommandNames
    Property Value
    Type Description
    CommandNames

    context

    The context to run in, basically containing module id, etc. We always need the tag OR the context, but never both

    Declaration
    context?: Sxc | ContextIdentifier
    Property Value
    Type Description
    Sxc | ContextIdentifier

    event

    The event which triggered this command - sometimes useful internally further use. Optional in most cases, but in some cases it will improve the behavior of the code.

    Declaration
    event?: MouseEvent
    Property Value
    Type Description
    MouseEvent

    params

    The command params, like contentType, entityId etc. Optional for many actions.

    Declaration
    params?: CommandParams
    Property Value
    Type Description
    CommandParams

    tag

    The tag on which the run was triggered - it's used to give the command a context to start from We always need the tag OR the context, but never both

    Declaration
    tag?: HTMLElement
    Property Value
    Type Description
    HTMLElement

    workflows

    Workflows work the same way as with a toolbar, except that they are added here and not registered on init. Because of limitations in automatic documentation, the type here is set to unknown but it's actually WorkflowStep | WorkflowStep[]

    Declaration
    workflows?: unknown
    Property Value
    Type Description
    unknown
    Back to top Generated by DocFX