Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RadDataForm

RadDataForm is a component that automatically generates UI for editing the properties of a supplied object. Each property of the object will have an assigned editor based on its type. This editor can be changed or customized. Editors can be shown in groups which can optionally be collapsible.

Hierarchy

  • any

Index

Properties

commitMode

commitMode: DataFormCommitMode

Gets or sets a value indicating when the changes in editors will be committed.

editedObject

editedObject: any

Gets the source object with all property modifications that are currently committed.

groups

groups: Array<PropertyGroup>

Gets or sets an array with groups. This array is used to define how the editors are laid out in groups through xml.

isReadOnly

isReadOnly: boolean

Gets or sets a value indicating whether the editors' values can be edited or are in read only mode.

metadata

metadata: any

Sets the metadata object that will be used to load proper editors in data form for the specified source.

properties

properties: Array<EntityProperty>

Gets or sets an array with properties. This array is used to change the default editors and/or their styles through xml.

source

source: any

Sets the source object that will be used to load the editors in data form.

validationMode

validationMode: DataFormValidationMode

Gets or sets a value indicating when the changes in editors will be validated.

Static commitModeProperty

commitModeProperty: Property<RadDataForm, DataFormCommitMode>

Identifies the commitMode dependency property.

Static editorDeselectedEvent

editorDeselectedEvent: string

An event fired when an editor loses focus /iOS only/. The event is fired with an instance of type DataFormEventData.

Static editorSelectedEvent

editorSelectedEvent: string

An event fired when an editor gets focussed /iOS only/. The event is fired with an instance of type DataFormEventData.

Static editorSetupEvent

editorSetupEvent: string

An event fired when an editor is created and allows for its customization /iOS only/. The event is fired with an instance of type DataFormEventData.

Static editorUpdateEvent

editorUpdateEvent: string

An event fired when an editor is updated and allows for its customization. The event is fired with an instance of type DataFormEventData.

Static groupCollapsedEvent

groupCollapsedEvent: string

An event fired when a group of editors is collapsed so the editors are not visible. The event is fired with an instance of type DataFormEventData.

Static groupExpandedEvent

groupExpandedEvent: string

An event fired when a group of editors is expanded so the editors are visible. The event is fired with an instance of type DataFormEventData.

Static groupUpdateEvent

groupUpdateEvent: string

An event fired when a group of editors is updated and allows for its customization. The event is fired with an instance of type DataFormEventData.

Static groupsProperty

groupsProperty: Property<RadDataForm, Array<PropertyGroup>>

Identifies the groups dependency property.

Static isReadOnlyProperty

isReadOnlyProperty: Property<RadDataForm, boolean>

Identifies the isReadOnly dependency property.

Static metadataProperty

metadataProperty: Property<RadDataForm, any>

Identifies the metadata dependency property.

Static propertiesProperty

propertiesProperty: Property<RadDataForm, Array<EntityProperty>>

Identifies the properties dependency property.

Static propertyCommitEvent

propertyCommitEvent: string

An event fired when the value of an editor is about to be committed. The event is fired with an instance of type DataFormEventData.

Static propertyCommittedEvent

propertyCommittedEvent: string

An event fired when the value of an editor has been committed. The event is fired with an instance of type DataFormEventData.

Static propertyEditedEvent

propertyEditedEvent: string

An event fired when the value of an editor changes /iOS only/. The event is fired with an instance of type DataFormEventData.

Static propertyValidateEvent

propertyValidateEvent: string

An event fired when the current value of an editor starts validation. The event is fired with an instance of type DataFormEventData.

Static propertyValidatedEvent

propertyValidatedEvent: string

An event fired when the current value of an editor is validated. The event is fired with an instance of type DataFormEventData.

Static sourceProperty

sourceProperty: Property<RadDataForm, any>

Identifies the source dependency property.

Static validationModeProperty

validationModeProperty: Property<RadDataForm, DataFormValidationMode>

Identifies the validationMode dependency property.

Methods

commitAll

  • commitAll(): void
  • Attmepts to commit all property changes. If the form is already has validation errors, the commit will be cancelled, but therer will be no further validation attempt.

    Returns void

getGroupByName

  • Gets the PropertyGroup object with the given name.

    Parameters

    • name: string

    Returns PropertyGroup

getPropertyByName

  • Gets the EntityProperty object for the property of the object with the given name.

    Parameters

    • name: string

    Returns EntityProperty

hasValidationErrors

  • hasValidationErrors(): boolean
  • Gets the 'validation' state of the RadDataForm.

    Returns boolean

notifyValidated

  • notifyValidated(propertyName: string, isValid: boolean): void
  • Used to manually update the validation state of a property.

    Parameters

    • propertyName: string
    • isValid: boolean

    Returns void

reload

  • reload(): void
  • Reloads the native data form objects.

    Returns void

validateAll

  • validateAll(): Promise<Boolean>
  • Validates all property changes and returns a Promise that will be resolved with the validation result.

    Returns Promise<Boolean>

validateAndCommitAll

  • validateAndCommitAll(): Promise<Boolean>
  • Attmepts to commit all property changes and returns a Promise that will be resolved with the result. If there are validation errors the commit will be cancelled and the promise result will be false.

    Returns Promise<Boolean>

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method