Version

GetConstraintFormula(String,WorkbookFormat,CellReferenceMode,CultureInfo) Method

Gets the constraint formula used to validate the cell value.
Syntax
'Declaration
 
Public Overloads Function GetConstraintFormula( _
   ByVal address As String, _
   ByVal format As WorkbookFormat, _
   ByVal cellReferenceMode As CellReferenceMode, _
   ByVal culture As CultureInfo _
) As String
public string GetConstraintFormula( 
   string address,
   WorkbookFormat format,
   CellReferenceMode cellReferenceMode,
   CultureInfo culture
)

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.
format
The workbook format with which to parse address.
cellReferenceMode
The cell reference mode with which to parse address.
culture
The culture to use when generating the formula string.

Return Value

A formula used to validate the value applied to a cell.
Exceptions
ExceptionDescription
System.ArgumentExceptionOccurs when address is not a valid cell or regions address.
System.ComponentModel.InvalidEnumArgumentExceptionOccurs when format is not defined in the WorkbookFormat enumeration.
System.ComponentModel.InvalidEnumArgumentExceptionOccurs when cellReferenceMode is not defined in the CellReferenceMode enumeration.
Remarks

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.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, 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

See Also