ig.excel.LimitedValueDataValidationRule

Base class for all data validations rules which prevent certain values form being applied to a cell.

Dependencies

jquery-1.4.4.js
infragistics.util.js
infragistics.ext_core.js
infragistics.ext_collections.js
infragistics.ext_collectionsExtended.js
infragistics.ext_io.js
infragistics.ext_text.js
infragistics.documents.core_core.js
infragistics.ext_ui.js
The current widget has no options.
The current widget has no events.
  • allowNull

    .allowNull( );
    Return Type:
    boolean
    Return Type Description:
    True if a null value can be set on the cell; False otherwise.

    Gets the value which indicates whether a null, or blank, value is allowed to be set on a cell.

  • allowNull

    .allowNull( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    True if a null value can be set on the cell; False otherwise.

    Sets the value which indicates whether a null, or blank, value is allowed to be set on a cell.

    • value
    • Type:boolean
  • clone
    Inherited

    .clone( );

    Creates a copy of this rule which can be applied to other worksheets.

  • errorMessageDescription
    Inherited

    .errorMessageDescription( );
    Return Type:
    string
    Return Type Description:
    The description to show the user or null to use a default error description.

    Gets the description which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 225 characters.

    Remarks

    This value is only used when DataValidationRule.showErrorMessageForInvalidValue is True.

    Note: the title cannot be more than 225 characters.

  • errorMessageDescription
    Inherited

    .errorMessageDescription( value:string );
    Return Type:
    string
    Return Type Description:
    The description to show the user or null to use a default error description.

    Sets the description which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 225 characters.

    Remarks

    This value is only used when DataValidationRule.showErrorMessageForInvalidValue is True.

    Note: the title cannot be more than 225 characters.

  • errorMessageTitle
    Inherited

    .errorMessageTitle( );
    Return Type:
    string
    Return Type Description:
    The title to show the user or null to use a default error dialog title.

    Gets the title which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 32 characters.

    Remarks

    This value is only used when DataValidationRule.showErrorMessageForInvalidValue is True.

    Note: the title cannot be more than 32 characters.

  • errorMessageTitle
    Inherited

    .errorMessageTitle( value:string );
    Return Type:
    string
    Return Type Description:
    The title to show the user or null to use a default error dialog title.

    Sets the title which appears in the dialog box when an invalid value is applied to a cell in Microsoft Excel.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 32 characters.

    Remarks

    This value is only used when DataValidationRule.showErrorMessageForInvalidValue is True.

    Note: the title cannot be more than 32 characters.

  • errorStyle
    Inherited

    .errorStyle( );
    Return Type:
    ig.excel.DataValidationErrorStyle
    Return Type Description:
    Returns a DataValidationErrorStyle.

    Gets the value which indicates whether the value is allowed when it is invalid and which options are given to the user in the error dialog shown by Microsoft Excel.

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException Occurs when the value is not a member of the DataValidationErrorStyle enumeration.

    Remarks

    This value is only used when DataValidationRule.showErrorMessageForInvalidValue is True.

  • errorStyle
    Inherited

    .errorStyle( value:ig.excel.DataValidationErrorStyle );
    Return Type:
    ig.excel.DataValidationErrorStyle
    Return Type Description:
    Returns a DataValidationErrorStyle.

    Sets the value which indicates whether the value is allowed when it is invalid and which options are given to the user in the error dialog shown by Microsoft Excel.

    • value
    • Type:ig.excel.DataValidationErrorStyle

    Exceptions

    Exception Description
    ig.excel.InvalidEnumArgumentException Occurs when the value is not a member of the DataValidationErrorStyle enumeration.

    Remarks

    This value is only used when DataValidationRule.showErrorMessageForInvalidValue is True.

  • inputMessageDescription
    Inherited

    .inputMessageDescription( );
    Return Type:
    string
    Return Type Description:
    The description to show the user in the tooltip.

    Gets the description in the tooltip which appears when the user selects the cell in Microsoft Excel.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 255 characters.

    Remarks

    This value is only used when DataValidationRule.showInputMessage is True.

    Note: the description cannot be more than 255 characters.

  • inputMessageDescription
    Inherited

    .inputMessageDescription( value:string );
    Return Type:
    string
    Return Type Description:
    The description to show the user in the tooltip.

    Sets the description in the tooltip which appears when the user selects the cell in Microsoft Excel.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 255 characters.

    Remarks

    This value is only used when DataValidationRule.showInputMessage is True.

    Note: the description cannot be more than 255 characters.

  • inputMessageTitle
    Inherited

    .inputMessageTitle( );
    Return Type:
    string
    Return Type Description:
    The title to show the user in the tooltip.

    Gets the title in the tooltip which appears when the user selects the cell in Microsoft Excel.

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 32 characters.

    Remarks

    This value is only used when DataValidationRule.showInputMessage is True.

    Note: the title cannot be more than 32 characters.

  • inputMessageTitle
    Inherited

    .inputMessageTitle( value:string );
    Return Type:
    string
    Return Type Description:
    The title to show the user in the tooltip.

    Sets the title in the tooltip which appears when the user selects the cell in Microsoft Excel.

    • value
    • Type:string

    Exceptions

    Exception Description
    ig.ArgumentException Occurs when the specified value is longer than 32 characters.

    Remarks

    This value is only used when DataValidationRule.showInputMessage is True.

    Note: the title cannot be more than 32 characters.

  • isEquivalentTo

    .isEquivalentTo( other:ig.excel.DataValidationRule );
    Return Type:
    boolean
    Return Type Description:
    Returns true if the specified other has the same settings as this rule.

    Indicates if this rule is structurally equivalent to another.

    • other
    • Type:ig.excel.DataValidationRule
    • The rule to compare against
  • showErrorMessageForInvalidValue
    Inherited

    .showErrorMessageForInvalidValue( );
    Return Type:
    boolean
    Return Type Description:
    True to show the error dialog for invalid cell data; False otherwise.

    Gets the value which indicates whether the error dialog should appear in Microsoft Excel when invalid data is entered in the cell.

    Remarks

    When the value is False, invalid data can be entered into cells, but when the user chooses to subsequently circle invalid values in Microsoft Excel, the cell will be circled.

  • showErrorMessageForInvalidValue
    Inherited

    .showErrorMessageForInvalidValue( value:boolean );
    Return Type:
    boolean
    Return Type Description:
    True to show the error dialog for invalid cell data; False otherwise.

    Sets the value which indicates whether the error dialog should appear in Microsoft Excel when invalid data is entered in the cell.

    • value
    • Type:boolean

    Remarks

    When the value is False, invalid data can be entered into cells, but when the user chooses to subsequently circle invalid values in Microsoft Excel, the cell will be circled.

  • showInputMessage
    Inherited

    .showInputMessage( );

    Gets the value which indicates whether to show the user an input prompt tooltip when the user selects the cell in Microsoft Excel.

    Remarks

    The input prompt will only be shown if this value is True and the DataValidationRule.inputMessageDescription is not null.

  • showInputMessage
    Inherited

    .showInputMessage( value:boolean );

    Sets the value which indicates whether to show the user an input prompt tooltip when the user selects the cell in Microsoft Excel.

    • value
    • Type:boolean

    Remarks

    The input prompt will only be shown if this value is True and the DataValidationRule.inputMessageDescription is not null.

Copyright © 1996 - 2019 Infragistics, Inc. All rights reserved.