GetConstraintFormula(String) Method

'Declaration
 
Public Overloads Function GetConstraintFormula( _
   ByVal address As System.String _
) As System.String

public System.string GetConstraintFormula( 
   System.string address
)

Parameters

address

The address of the cell or region that serves as the basis for relative references, or null to use the top-left cell of the worksheet.

Return Value

The way in which the cell value is compared to the constraint formula's value is determined by the ValidationOperator as well as the ValueConstraintDataValidationRule.ValidationCriteria.

Depending on the ValidationCriteria of the rule, either the cell value itself or the length of the cell value's text equivalent is compared to the constraint formula's value.

The address passed in is only needed if relative addresses are used in the the formula. For example, consider the formula applied is =B1, and the data validation rule is applied to the region A1:A5. If you get the formula for A1, the formula =B1 will be returned. If you get the formula for A2, =B2 will be returned. Similarly, for cell A5, =B5 will be returned. However, if the formula contains no references or all absolute references, the address is ignored. So in the previous example, if the original formula was =$B$1, the same formula will be returned regardless of the specified address.

address can be any valid cell or region reference on a worksheet. If a region address is specified, the top-left cell or the region is used. The cell or region specified does not need to have the data validation rule applied to it. Any reference is allowed.

The cell reference mode with which to parse address will be assumed to be A1, unless the data validation rule is applied to a worksheet which is in a workbook, in which case the Workbook.CellReferenceMode will be used.

Target Platforms: Windows 8.1, Windows 8.1, Windows 8, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

Reference

OneConstraintDataValidationRule Class
OneConstraintDataValidationRule Members
Overload List
TryGetConstraint(Double) Method
TryGetConstraint(DateTime) Method
TryGetConstraint(TimeSpan) Method
ValidationOperator Property
ValidationCriteria Property
GetConstraintFormula(String,WorkbookFormat,CellReferenceMode,CultureInfo) Method
SetConstraintFormula(String,String) Method
SetConstraintFormula(String,String,WorkbookFormat,CellReferenceMode,CultureInfo) Method