Interface SaveEventContext

Synchronous Form OnSave event context. In the API documentation, this is sometimes referred to as the executionContext. Asynchronous version see SaveEventContextAsync

See

Hierarchy

Xrm.Events.EventContext
- SaveEventContext

Index

Methods

getContext getDepth getEventArgs getEventSource getFormContext getSharedVariable setSharedVariable

Methods

getContext

getContext(): GlobalContext
Gets the Xrm context.

Returns GlobalContext
The Xrm context
Inherited from EventContext.getContext
- Defined in node_modules/@types/xrm/index.d.ts:778

getDepth

getDepth(): number
Gets the handler's depth, which is the order in which the handler is executed.

Returns number
The depth, a 0-based index.
Inherited from EventContext.getDepth
- Defined in node_modules/@types/xrm/index.d.ts:784

getEventArgs

getEventArgs(): Xrm.Events.SaveEventArguments
Gets save-event arguments.

Returns Xrm.Events.SaveEventArguments
- Defined in node_modules/@types/xrm/index.d.ts:900

getEventSource

getEventSource(): Xrm.Entity | Xrm.Attributes.Attribute<any> | Xrm.Controls.Control
Gets a reference to the object for which event occurred.

Returns Xrm.Entity | Xrm.Attributes.Attribute<any> | Xrm.Controls.Control
The event source.
Inherited from EventContext.getEventSource
- Defined in node_modules/@types/xrm/index.d.ts:790

getFormContext

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

Returns FormContext
The form context
Inherited from EventContext.getFormContext
- Defined in node_modules/@types/xrm/index.d.ts:796

getSharedVariable

getSharedVariable<T>(key): T
Type Parameters
- T
  
  Generic type parameter.
Parameters
- key: string
  
  The key.
Returns T
The shared variable.

Summary
Gets the shared variable with the specified key.

Description
Gets the shared variable with the specified key. Used to pass values between handlers of an event.
Inherited from EventContext.getSharedVariable
- Defined in node_modules/@types/xrm/index.d.ts:806

setSharedVariable

setSharedVariable<T>(key, value): void
Type Parameters
- T
  
  Generic type parameter.
Parameters
- key: string
  
  The key.
- value: T
  
  The value.
Returns void

Summary
Sets a shared variable.

Description
Sets the shared variable with the specified key. Used to pass values between handlers of an event.
Inherited from EventContext.setSharedVariable
- Defined in node_modules/@types/xrm/index.d.ts:816

Generated using TypeDoc