Interface IPluginFieldParameterBase<T>

Setting for custom fields

These allow a user to add parameters to custom field defined by the plugin each time it is added to a category

interface IPluginFieldParameterBase {
    adminVisibility?: boolean;
    copyfromdoc?: boolean;
    externalHelp?: string;
    hide_UI?: boolean;
    hide_document?: boolean;
    hide_publication?: boolean;
    hide_report?: boolean;
    inlineHelp?: string;
    invisible?: boolean;
    options: T;
    popupHelp?: string;
    readonly?: boolean;
    requiresContent?: boolean;
    unsafeHtml?: number;
    visibleOption?: string;
}

Type Parameters

Hierarchy

Properties

adminVisibility? copyfromdoc? externalHelp? hide_UI? hide_document? hide_publication? hide_report? inlineHelp? invisible? options popupHelp? readonly? requiresContent? unsafeHtml? visibleOption?

Properties

Optional adminVisibility

adminVisibility?: boolean

legacy options

Optional copyfromdoc

copyfromdoc?: boolean

this allows to copy fields from underlying DOC into the SIGN item. Note: Fields are copied only if this is set to true and the labels (names) of the field is the same in the DOC and the SIGN

Optional externalHelp

externalHelp?: string

this can be set to point to a an external website which is openend when user clicks on a link, e.g. "externalHelp":"matrix.com". Note this must be a website which is accesible through https://url

Optional hide_UI

hide_UI?: boolean

Optional hide_document

hide_document?: boolean

if set to true the field will not be shown in documents

Optional hide_publication

hide_publication?: boolean

if set to true the field will not be shown in published (QMS)

Optional hide_report

hide_report?: boolean

if set to true the field will not be shown in reports

Optional inlineHelp

inlineHelp?: string

this can be set to render a help line underneath the "heading":"enter a long description"

Optional invisible

invisible?: boolean

for SIGN category if set to true, the field is not visible (only makes sense with the above flag)

options

options: T

see below

Optional popupHelp

popupHelp?: string

this can be set to show help as a tooltip, e.g. "popupHelp":"enter a short description"

Optional readonly

readonly?: boolean

if set to true, the control will not be editable by the user

Optional requiresContent

requiresContent?: boolean

legacy options

Optional unsafeHtml

unsafeHtml?: number

set to 1 to not clean the field values

Optional visibleOption

visibleOption?: string

for folder category

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc