Class Form

Represents a form in Dynamics 365.

Hierarchy

Form

Index

Constructors

constructor

new Form(): Form
Returns Form
- Defined in src/XrmEx.ts:795

Properties

`Static` `Protected` _executionContext

_executionContext: Xrm.Events.EventContext

`Static` `Protected` _formContext

_formContext: FormContext

Accessors

`Static` IsCreate

get IsCreate(): boolean
Returns true if form is from type create

Returns boolean
- Defined in src/XrmEx.ts:841

`Static` IsNotCreate

get IsNotCreate(): boolean
Returns true if form is not from type create

Returns boolean
- Defined in src/XrmEx.ts:849

`Static` IsNotUpdate

get IsNotUpdate(): boolean
Returns true if form is not from type update

Returns boolean
- Defined in src/XrmEx.ts:853

`Static` IsUpdate

get IsUpdate(): boolean
Returns true if form is from type update

Returns boolean
- Defined in src/XrmEx.ts:845

`Static` entityReference

get entityReference(): Xrm.LookupValue
Gets a lookup value that references the record.

Returns Xrm.LookupValue
- Defined in src/XrmEx.ts:805

`Static` executionContext

get executionContext(): Xrm.Events.EventContext
Gets a reference to the current executio context

Returns Xrm.Events.EventContext
- Defined in src/XrmEx.ts:801
set executionContext(context): void
Sets a reference to the current execution context
Parameters
- context: FormContext | Xrm.Events.EventContext
Returns void
- Defined in src/XrmEx.ts:824

`Static` formContext

get formContext(): FormContext
Gets a reference to the current form context

Returns FormContext
- Defined in src/XrmEx.ts:797
set formContext(context): void
Sets a reference to the current form context
Parameters
- context: FormContext | Xrm.Events.EventContext
Returns void
- Defined in src/XrmEx.ts:809

Methods

`Static` addFormNotification

addFormNotification(message, level, uniqueId): boolean
Displays a form level notification. Any number of notifications can be displayed and will remain until removed using clearFormNotification. The height of the notification area is limited so each new message will be added to the top.
Parameters
- message: string
  
  The text of the notification message.
- level: Xrm.FormNotificationLevel
  
  The level of the notification which defines how the message will be displayed, such as the icon. ERROR: Notification will use the system error icon. WARNING: Notification will use the system warning icon. INFO: Notification will use the system info icon.
- uniqueId: string
  
  Unique identifier for the notification which is used with clearFormNotification to remove the notification.
Returns boolean
true if it succeeds, othenprwise false.
- Defined in src/XrmEx.ts:868

`Static` addOnChange

addOnChange(fields, handlers, execute?): void
Adds a handler to be called when the attribute's value is changed.
Parameters
- fields: Field[]
- handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]
- Optional execute: boolean
Returns void
- Defined in src/XrmEx.ts:972

`Static` addOnLoad

addOnLoad(handlers): void
Adds a function to be called when form data is loaded.
Parameters
- handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]
Returns void
- Defined in src/XrmEx.ts:948

`Static` addOnPostSave

addOnPostSave(handlers): void
Adds a function to be called after the OnSave is complete.
Parameters
- handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]
Returns void

Remarks
Added in 9.2

See
External Link: PostSave Event Documentation
- Defined in src/XrmEx.ts:924

`Static` addOnSave

addOnSave(handlers): void
Adds a handler to be called when the record is saved.
Parameters
- handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]
Returns void
- Defined in src/XrmEx.ts:898

`Static` removeFormNotification

removeFormNotification(uniqueId): boolean
Clears the form notification described by uniqueId.
Parameters
- uniqueId: string
  
  Unique identifier.
Returns boolean
True if it succeeds, otherwise false.
- Defined in src/XrmEx.ts:888

Class Form

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns Form

Properties

Static Protected _executionContext

Static Protected _formContext

Accessors

Static IsCreate

Returns boolean

Static IsNotCreate

Returns boolean

Static IsNotUpdate

Returns boolean

Static IsUpdate

Returns boolean

Static entityReference

Returns Xrm.LookupValue

Static executionContext

Returns Xrm.Events.EventContext

Parameters

context: FormContext | Xrm.Events.EventContext

Returns void

Static formContext

Returns FormContext

Parameters

context: FormContext | Xrm.Events.EventContext

Returns void

Methods

Static addFormNotification

Parameters

message: string

level: Xrm.FormNotificationLevel

uniqueId: string

Returns boolean

Static addOnChange

Parameters

fields: Field[]

handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]

Optional execute: boolean

Returns void

Static addOnLoad

Parameters

handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]

Returns void

Static addOnPostSave

Parameters

handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]

Returns void

Remarks

See

Static addOnSave

Parameters

handlers: Xrm.Events.ContextSensitiveHandler | Xrm.Events.ContextSensitiveHandler[]

Returns void

Static removeFormNotification

Parameters

uniqueId: string

Returns boolean

Settings

Member Visibility

Theme

On This Page

`Static` `Protected` _executionContext

`Static` `Protected` _formContext

`Static` IsCreate

`Static` IsNotCreate

`Static` IsNotUpdate

`Static` IsUpdate

`Static` entityReference

`Static` executionContext

`Static` formContext

`Static` addFormNotification

`Static` addOnChange

`Optional` execute: boolean

`Static` addOnLoad

`Static` addOnPostSave

`Static` addOnSave

`Static` removeFormNotification