Interface BooleanAttribute

Interface for a Boolean attribute.

See

EnumAttribute

Hierarchy

Implemented by

Properties

controls

Methods

addOnChange fireOnChange getAttributeType getFormat getInitialValue getIsDirty getName getParent getRequiredLevel getSubmitMode getUserPrivilege getValue removeOnChange setIsValid setRequiredLevel setSubmitMode setValue

Properties

controls

controls: ItemCollection<BooleanControl>

A collection of all the controls on the form that interface with this attribute.

See

External Link: Collections (Client API reference)

Methods

addOnChange

  • Adds a handler to be called when the attribute's value is changed.

    Parameters

    Returns void

fireOnChange

  • Fire all "on change" event handlers.

    Returns void

getAttributeType

  • Gets the attribute format.

    Returns "boolean"

    the string "boolean"

getFormat

  • Gets the attribute format.

    Returns Xrm.Attributes.AttributeFormat

    The format of the attribute.

    Values returned are:

    • date (datetime)
    • datetime (datetime)
    • duration (integer)
    • email (string)
    • language (optionset)
    • none (integer)
    • phone (string)
    • text (string)
    • textarea (string)
    • tickersymbol (string)
    • timezone (optionset)
    • url (string)

    See

    getAttributeType

getInitialValue

getIsDirty

  • Gets a boolean value indicating whether this Attribute has unsaved changes.

    Returns boolean

    true if there are unsaved changes, otherwise false.

getName

  • Gets the logical name of the attribute.

    Returns string

    The logical name.

getParent

  • Gets a reference to the record context of this attribute.

    Returns Xrm.Entity

    The parent record context.

getRequiredLevel

getSubmitMode

  • Gets current submit mode for the attribute.

    Returns Xrm.SubmitMode

    The submit mode, as either "always", "never", or "dirty"

    Remarks

    The default value is "dirty"

getUserPrivilege

getValue

  • Gets the value.

    Returns boolean

    The value.

removeOnChange

  • Removes the handler from the "on change" event.

    Parameters

    Returns void

setIsValid

  • Sets a value for a column to determine whether it is valid or invalid with a message

    Parameters

    • isValid: boolean

      Specify false to set the column value to invalid and true to set the value to valid.

    • Optional message: string

      The message to display.

    Returns void

    See

    External Link: setIsValid (Client API reference)

setRequiredLevel

setSubmitMode

setValue

  • Sets the value.

    Parameters

    • value: boolean

      The value.

    Returns void

    Remarks

    Attributes on Quick Create Forms will not save values set with this method.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc