Xceed Logo
Shop
Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.v4.3 Assembly / Xceed.Grid Namespace / SummaryCell Class / GetVariableText Method
The name of the variable to resolve. Does not include the % characters.


In This Topic
    GetVariableText Method (SummaryCell)
    In This Topic
    Retrieves the string equivalent of variableName used when dynamically resolving the variables specified in the TitleFormat property.
    Syntax
    'Declaration
 
Protected Overridable Function GetVariableText( _
   ByVal variableName As String _
) As String
    'Usage
 
Dim instance As SummaryCell
Dim variableName As String
Dim value As String
 
value = instance.GetVariableText(variableName)
    protected virtual string GetVariableText( 
   string variableName
)

    Parameters

    variableName
    The name of the variable to resolve. Does not include the % characters.

    Return Value

    The string equivalent of variableName.
    Remarks

    The following table provides a list of the supported variables and their definitions.

    Supported variables Descriptions
    %GROUPBYCOLUMNFIELDNAME% The Column.FieldName of the column as defined by the parent group's GroupBy property.
    %GROUPBYCOLUMNTITLE% The Column.Title of the column represented by the parent group's GroupBy property.
    %GROUPKEY% The Key of the parent group.
    %GROUPTITLE% The Title of the parent group.
    %DATAROWCOUNT% The number of datarows in the parent group.
    %STATCOLUMNFIELDNAME% The Column.FieldName of the column as defined by the StatFieldName property.
    %STATCOLUMNTITLE% The Column.Title of the column represented by the StatFieldName property.
    %COUNT: % The result of the Count statistical function.
    %MAX: (see below for usage)/% The result of the Maximum statistical function.
    %MIN: (see below for usage)/% The result of the Minimum statistical function.
    %SUM: (see below for usage)/% The result of the Sum statistical function.
    %AVG: (see below for usage)/% The result of the Average statistical function.
    %STDEV: (see below for usage)/% The result of the Standard Deviation statistical function.
    %STDEVP: (see below for usage)/% The result of the Standard Deviation Population statistical function.
    %VAR: (see below for usage)/% The result of the Variance statistical function.
    %VARP: (see below for usage)/% The result of the Variance Population statistical function.
    %MEDIAN: (see below for usage)/% The result of the Median statistical function.
    %MODE: (see below for usage)/% The result of the Mode statistical function.
    %GEOMEAN: (see below for usage)/% The result of the Geometric Mean statistical function.
    %HARMEAN: (see below for usage)/% The result of the Harmonic Mean statistical function.
    %RMS: (see below for usage)/% The result of the Root Mean Square statistical function.

    In the case of the variables that represent statistical functions (COUNT, MAX, MIN, SUM, AVG, STDEV, STDEVP, VAR, VARP, MEDIAN, MODE, GEOMEAN, HARMEAN, and RMS), additional parameters must be provided within the variable after the colon (:). These parameters are the fieldname of the column from which the data is retrieved, the (optional) format specifier with which the result of the statistical function is displayed, and the (optional) group level for which the statistical function is calculated.

    All items placed in square brackets [] are optional. If the stat_fieldname and/or format_specifier parameters contain spaces, quotes must be used. If a running_stat_group_level is not specified, -1 (current group) is assumed.

    When overriding GetVariableText in a derived class, base.GetVariableText( variableName ); must be called first. If a string is returned, then the variable was successfully resolved. If System.String.Empty is returned, then the override should be able to resolve the variable.

    Requirements

    Target Platforms: 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

    See Also

    Reference

    SummaryCell Class
    SummaryCell Members

    Send Feedback