Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EntityProperty

An instance of this class is assigned to each of the properties of an entity that is being edited in RadDataForm. This instance can be used to change or adjust the editor that is used for this property.

Hierarchy

  • ViewBase

Index

Constructors

Properties

Methods

Constructors

constructor

  • Please note that should you be using the new Observable({}) constructor, it is obsolete since v3.0, and you have to migrate to the "data/observable" fromObject({}) or the fromObjectRecursive({}) functions.

    Returns EntityProperty

Properties

_context

_context: any

_cssState

_cssState: any

_domId

_domId: number

_isAddedToNativeVisualTree

_isAddedToNativeVisualTree: boolean

alignSelf

alignSelf: AlignSelf

android

android: any

Represents the native EntityProperty of RadDataForm from Progress Telerik UI for Android.

autoCompleteDisplayMode

autoCompleteDisplayMode: AutoCompleteDisplayMode

Gets or sets displayMode of the AutoCompleteTextView of the editor. This property affects only editors of type: AutoCompleteInline

bindingContext

bindingContext: any

className

className: string

Gets or sets the CSS class name for this view.

col

col: number

colSpan

colSpan: number

columnIndex

columnIndex: number

Gets or sets the columnIndex which is used to determine the order of the editors in their group.

converter

Gets or sets a PropertyConverter that will be used to convert between values stored in the model and values shows in an editor.

cssClasses

cssClasses: Set<string>

cssPseudoClasses

cssPseudoClasses: Set<string>

displayName

displayName: string

Gets or sets the name that is used for the label of the editor of this property.

dock

dock: "left" | "top" | "right" | "bottom"

domNode

domNode: DOMNode

editor

Gets or sets a PropertyEditor that is used to edit this property.

effectiveBorderBottomWidth

effectiveBorderBottomWidth: number

effectiveBorderLeftWidth

effectiveBorderLeftWidth: number

effectiveBorderRightWidth

effectiveBorderRightWidth: number

effectiveBorderTopWidth

effectiveBorderTopWidth: number

effectiveHeight

effectiveHeight: number

effectiveLeft

effectiveLeft: number

effectiveMarginBottom

effectiveMarginBottom: number

effectiveMarginLeft

effectiveMarginLeft: number

effectiveMarginRight

effectiveMarginRight: number

effectiveMarginTop

effectiveMarginTop: number

effectiveMinHeight

effectiveMinHeight: number

effectiveMinWidth

effectiveMinWidth: number

effectivePaddingBottom

effectivePaddingBottom: number

effectivePaddingLeft

effectivePaddingLeft: number

effectivePaddingRight

effectivePaddingRight: number

effectivePaddingTop

effectivePaddingTop: number

effectiveTop

effectiveTop: number

effectiveWidth

effectiveWidth: number

errorMessage

errorMessage: string

Gets or sets a message that will be displayed when the new value doesn't meet the validation criteria.

flexGrow

flexGrow: FlexGrow

flexShrink

flexShrink: FlexShrink

flexWrapBefore

flexWrapBefore: FlexWrapBefore

hidden

hidden: boolean

Gets or sets a value indicating whether this property is hidden or visible.

hintText

hintText: string

Gets or sets the text displayed in the editor while its value is null.

id

id: string

Gets or sets the id for this view.

imageResource

imageResource: any

Gets or sets the name of an image resource that will be used as the editor's label.

index

index: number

Gets or sets the index which is used to determine the order of the editors in their group.

ios

ios: any

Represents the native EntityProperty of RadDataForm from Progress Telerik UI for iOS.

isCollapsed

isCollapsed: boolean

Returns true if visibility is set to 'collapse'. Readonly property

isLoaded

isLoaded: boolean

isValid

isValid: boolean

Returns whether the property is valid.

left

left: Length

name

name: string

The name of this property. Please note that the name can be set only once.

nativeView

nativeView: any

nativeViewProtected

nativeViewProtected: any

read-only. If you want to set out-of-band the nativeView use the setNativeView method.

order

order: Order

page

page: Page

Gets owner page. This is a read-only property.

parent

parent: ViewBase

Gets the parent view. This property is read-only.

parentNode

parentNode: ViewBase

Gets the template parent or the native parent. Sets the template parent.

readOnly

readOnly: boolean

Gets or sets a value indicating whether this property can be edited or is read only.

required

required: boolean

Gets or sets a value indicating whether this property is required.

row

row: number

rowSpan

rowSpan: number

style

style: Style

Gets the style object associated to this view.

successMessage

successMessage: string

Gets or sets a message that will be displayed when the new value meets the validation criteria.

top

top: Length

typeName

typeName: string

Gets the name of the constructor function for this instance. E.g. for a Button class this will return "Button".

validators

validators: Array<PropertyValidator>

Gets or sets an array of PropertyValidator that are used to validate the changes of this property.

value

value: any

Returns the committed value of the property.

valueCandidate

valueCandidate: any

Returns the current value of the editor of this property.

valuesProvider

valuesProvider: any

Gets or sets an array of values that are accepted as values for the editor associated with this property. This property affects only editors of type: Picker, List and SegmentedEditor.

viewController

viewController: any

returns the native UIViewController.

Static autoCompleteDisplayModeProperty

autoCompleteDisplayModeProperty: Property<EntityProperty, AutoCompleteDisplayMode>

Identifies the autoCompleteDisplayMode dependency property.

Static columnIndexProperty

columnIndexProperty: Property<EntityProperty, number>

Identifies the columnIndex dependency property.

Static converterProperty

converterProperty: Property<EntityProperty, PropertyConverter>

Identifies the converter dependency property.

Static displayNameProperty

displayNameProperty: Property<EntityProperty, string>

Identifies the displayName dependency property.

Static editorProperty

editorProperty: Property<EntityProperty, PropertyEditor>

Identifies the editor dependency property.

Static hiddenProperty

hiddenProperty: Property<EntityProperty, boolean>

Identifies the hidden dependency property.

Static hintTextProperty

hintTextProperty: Property<EntityProperty, string>

Identifies the hintText dependency property.

Static imageResourceProperty

imageResourceProperty: Property<EntityProperty, any>

Identifies the imageResource dependency property.

Static indexProperty

indexProperty: Property<EntityProperty, number>

Identifies the index dependency property.

Static loadedEvent

loadedEvent: string

String value used when hooking to loaded event.

Static nameProperty

nameProperty: Property<EntityProperty, string>

Identifies the name dependency property.

Static propertyChangeEvent

propertyChangeEvent: string

String value used when hooking to propertyChange event.

Static readOnlyProperty

readOnlyProperty: Property<EntityProperty, boolean>

Identifies the readOnly dependency property.

Static requiredProperty

requiredProperty: Property<EntityProperty, boolean>

Identifies the required dependency property.

Static unloadedEvent

unloadedEvent: string

String value used when hooking to unloaded event.

Static validatorsProperty

validatorsProperty: Property<EntityProperty, Array<PropertyValidator>>

Identifies the validators dependency property.

Static valuesProviderProperty

valuesProviderProperty: Property<EntityProperty, any>

Identifies the valuesProvider dependency property.

Methods

_addView

  • _addView(view: ViewBase, atIndex?: number): void
  • Parameters

    • view: ViewBase
    • Optional atIndex: number

    Returns void

_addViewCore

  • _addViewCore(view: ViewBase, atIndex?: number): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Parameters

    • view: ViewBase
    • Optional atIndex: number

    Returns void

_addViewToNativeVisualTree

  • _addViewToNativeVisualTree(view: ViewBase, atIndex?: number): boolean
  • Performs the core logic of adding a child view to the native visual tree. Returns true if the view's native representation has been successfully added, false otherwise.

    Parameters

    • view: ViewBase
    • Optional atIndex: number

    Returns boolean

_applyXmlAttribute

  • _applyXmlAttribute(attribute: any, value: any): boolean
  • This used to be the way to set attribute values in early {N} versions. Now attributes are expected to be set as plain properties on the view instances.

    deprecated

    Parameters

    • attribute: any
    • value: any

    Returns boolean

_childIndexToNativeChildIndex

  • _childIndexToNativeChildIndex(index?: number): number
  • Parameters

    • Optional index: number

    Returns number

_dialogClosed

  • _dialogClosed(): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Returns void

_goToVisualState

  • _goToVisualState(state: string): void
  • Parameters

    • state: string

    Returns void

Private _onCssStateChange

  • _onCssStateChange(): void
  • Returns void

_onRootViewReset

  • _onRootViewReset(): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Returns void

_parentChanged

  • _parentChanged(oldParent: ViewBase): void
  • Parameters

    • oldParent: ViewBase

    Returns void

_removeView

  • _removeView(view: ViewBase): void
  • Parameters

    • view: ViewBase

    Returns void

_removeViewCore

  • _removeViewCore(view: ViewBase): void
  • Method is intended to be overridden by inheritors and used as "protected"

    Parameters

    • view: ViewBase

    Returns void

_removeViewFromNativeVisualTree

  • _removeViewFromNativeVisualTree(view: ViewBase): void
  • Parameters

    • view: ViewBase

    Returns void

_setupUI

  • _setupUI(context: any, atIndex?: number): void
  • Setups the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

    Parameters

    • context: any
    • Optional atIndex: number

    Returns void

_tearDownUI

  • _tearDownUI(force?: boolean): void
  • Tears down the UI for ViewBase and all its children recursively. This method should not be overridden by derived views.

    Parameters

    • Optional force: boolean

    Returns void

addEventListener

  • addEventListener(eventNames: string, callback: function, thisArg?: any): any
  • Adds a listener for the specified event name.

    Parameters

    • eventNames: string

      Comma delimited names of the events to attach the listener to.

    • callback: function

      A function to be called when some of the specified event(s) is raised.

        • (data: EventData): void
        • Parameters

          • data: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which when set will be used as "this" in callback method call.

    Returns any

Protected addPseudoClass

  • addPseudoClass(name: string): void
  • unstable

    A widget can call this method to add a matching css pseudo class.

    Parameters

    • name: string

    Returns void

bind

  • bind(options: BindingOptions, source?: Object): void
  • Parameters

    • options: BindingOptions
    • Optional source: Object

    Returns void

closeModal

  • closeModal(context?: any): void
  • Closes the current modal view that this page is showing.

    Parameters

    • Optional context: any

      Any context you want to pass back to the host when closing the modal view.

    Returns void

createNativeView

  • createNativeView(): Object
  • Creates a native view. Returns either android.view.View or UIView.

    Returns Object

Protected deletePseudoClass

  • deletePseudoClass(name: string): void
  • unstable

    A widget can call this method to discard matching css pseudo class.

    Parameters

    • name: string

    Returns void

disposeNativeView

  • disposeNativeView(): void
  • Clean up references to the native view.

    Returns void

eachChild

  • eachChild(callback: function): void
  • Iterates over children of type ViewBase.

    Parameters

    • callback: function

      Called for each child of type ViewBase. Iteration stops if this method returns falsy value.

        • (child: ViewBase): boolean
        • Parameters

          • child: ViewBase

          Returns boolean

    Returns void

ensureDomNode

  • ensureDomNode(): any
  • unstable

    Ensures a dom-node for this view.

    Returns any

get

  • get(name: string): any
  • Gets the value of the specified property.

    Parameters

    • name: string

    Returns any

getViewById

  • getViewById<T>(id: string): T
  • Returns the child view with the specified id.

    Type parameters

    • T: ViewBase

    Parameters

    • id: string

    Returns T

hasListeners

  • hasListeners(eventName: string): boolean
  • Checks whether a listener is registered for the specified event name.

    Parameters

    • eventName: string

      The name of the event to check for.

    Returns boolean

initNativeView

  • initNativeView(): void
  • Initializes properties/listeners of the native view.

    Returns void

loadView

  • loadView(view: ViewBase): void
  • Load view.

    Parameters

    • view: ViewBase

      to load.

    Returns void

notify

  • notify<T>(data: T): void
  • Notifies all the registered listeners for the event provided in the data.eventName.

    Type parameters

    • T: EventData

    Parameters

    • data: T

      The data associated with the event.

    Returns void

notifyPropertyChange

  • notifyPropertyChange(propertyName: string, value: any, oldValue?: any): void
  • Notifies all the registered listeners for the property change event.

    Parameters

    • propertyName: string
    • value: any
    • Optional oldValue: any

    Returns void

off

  • off(eventNames: string, callback?: any, thisArg?: any): any
  • Shortcut alias to the removeEventListener method.

    Parameters

    • eventNames: string
    • Optional callback: any
    • Optional thisArg: any

    Returns any

on

  • on(eventNames: string, callback: function, thisArg?: any): any
  • on(event: "propertyChange", callback: function, thisArg?: any): any
  • A basic method signature to hook an event listener (shortcut alias to the addEventListener method).

    Parameters

    • eventNames: string

      String corresponding to events (e.g. "propertyChange"). Optionally could be used more events separated by , (e.g. "propertyChange", "change").

    • callback: function

      Callback function which will be executed when event is raised.

        • (data: EventData): void
        • Parameters

          • data: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which will be used as this context for callback execution.

    Returns any

  • Raised when a propertyChange occurs.

    Parameters

    • event: "propertyChange"
    • callback: function
        • (data: EventData): void
        • Parameters

          • data: EventData

          Returns void

    • Optional thisArg: any

    Returns any

onLoaded

  • onLoaded(): void
  • Returns void

onResumeNativeUpdates

  • onResumeNativeUpdates(): void
  • Returns void

onUnloaded

  • onUnloaded(): void
  • Returns void

once

  • once(event: string, callback: function, thisArg?: any): any
  • Adds one-time listener function for the event named event.

    Parameters

    • event: string

      Name of the event to attach to.

    • callback: function

      A function to be called when the specified event is raised.

        • (data: EventData): void
        • Parameters

          • data: EventData

          Returns void

    • Optional thisArg: any

      An optional parameter which when set will be used as "this" in callback method call.

    Returns any

removeEventListener

  • removeEventListener(eventNames: string, callback?: any, thisArg?: any): any
  • Removes listener(s) for the specified event name.

    Parameters

    • eventNames: string

      Comma delimited names of the events the specified listener is associated with.

    • Optional callback: any

      An optional parameter pointing to a specific listener. If not defined, all listeners for the event names will be removed.

    • Optional thisArg: any

      An optional parameter which when set will be used to refine search of the correct callback which will be removed as event listener.

    Returns any

requestLayout

  • requestLayout(): void
  • Invalidates the layout of the view and triggers a new layout pass.

    Returns void

resetNativeView

  • resetNativeView(): void
  • Resets properties/listeners set to the native view.

    Returns void

set

  • set(name: string, value: any): void
  • Updates the specified property with the provided value.

    Parameters

    • name: string
    • value: any

    Returns void

setInlineStyle

  • setInlineStyle(style: string): void
  • Parameters

    • style: string

    Returns void

setNativeView

  • setNativeView(view: any): void
  • Set the nativeView field performing extra checks and updates to the native properties on the new view. Use in cases where the createNativeView is not suitable. As an example use in item controls where the native parent view will create the native views for child items.

    Parameters

    • view: any

    Returns void

showModal

  • showModal(moduleName: string, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): ViewBase
  • showModal(view: ViewBase, context: any, closeCallback: Function, fullscreen?: boolean, animated?: boolean, stretched?: boolean): ViewBase
  • showModal(moduleName: string, modalOptions: ShowModalOptions): ViewBase
  • showModal(view: ViewBase, modalOptions: ShowModalOptions): ViewBase
  • showModal(): ViewBase
  • deprecated

    Use showModal with ShowModalOptions instead. Shows the View contained in moduleName as a modal view.

    Parameters

    • moduleName: string

      The name of the module to load starting from the application root.

    • context: any

      Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.

    • closeCallback: Function

      A function that will be called when the view is closed. Any arguments provided when calling ShownModallyData.closeCallback will be available here.

    • Optional fullscreen: boolean

      An optional parameter specifying whether to show the modal view in full-screen mode.

    • Optional animated: boolean

      An optional parameter specifying whether to show the modal view with animation.

    • Optional stretched: boolean

      An optional parameter specifying whether to stretch the modal view when not in full-screen mode.

    Returns ViewBase

  • deprecated

    Use showModal with ShowModalOptions instead. Shows the view passed as parameter as a modal view.

    Parameters

    • view: ViewBase

      View instance to be shown modally.

    • context: any

      Any context you want to pass to the modally shown view. This same context will be available in the arguments of the shownModally event handler.

    • closeCallback: Function

      A function that will be called when the view is closed. Any arguments provided when calling ShownModallyData.closeCallback will be available here.

    • Optional fullscreen: boolean

      An optional parameter specifying whether to show the modal view in full-screen mode.

    • Optional animated: boolean

      An optional parameter specifying whether to show the modal view with animation.

    • Optional stretched: boolean

      An optional parameter specifying whether to stretch the modal view when not in full-screen mode.

    Returns ViewBase

  • Shows the View contained in moduleName as a modal view.

    Parameters

    • moduleName: string

      The name of the module to load starting from the application root.

    • modalOptions: ShowModalOptions

      A ShowModalOptions instance

    Returns ViewBase

  • Shows the view passed as parameter as a modal view.

    Parameters

    • view: ViewBase

      View instance to be shown modally.

    • modalOptions: ShowModalOptions

      A ShowModalOptions instance

    Returns ViewBase

  • Deprecated. Showing view as modal is deprecated. Use showModal method with arguments.

    Returns ViewBase

unbind

  • unbind(property: string): void
  • Parameters

    • property: string

    Returns void

unloadView

  • unloadView(view: ViewBase): void
  • Unload view.

    Parameters

    • view: ViewBase

      to unload.

    Returns void

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