XRPivotGridField Members
Represents a field within the XRPivotGrid control.Constructors
| Name | Description |
|---|---|
| XRPivotGridField() | Initializes a new instance of the XRPivotGridField class with the default settings. |
| XRPivotGridField(PivotGridData) | Initializes a new instance of the XRPivotGridField class. |
| XRPivotGridField(String, PivotArea) | Initializes a new instance of the XRPivotGridField class with the specified field name and location. |
Fields
| Name | Description |
|---|---|
| DefaultMinWidth static |
A default value of the PivotGridFieldBase.MinWidth property, which specifies the minimum allowed width of columns that correspond to the current field. Return value: 20 Inherited from PivotGridFieldBase. |
| DefaultWidth static |
A default value of the PivotGridFieldBase.Width property, which specifies the width of columns that correspond to the current field. Return value: 100 Inherited from PivotGridFieldBase. |
| MaximumColumnValueLineCount static |
Specifies the maximum height of column field values, in lines. Return value: 5 Inherited from PivotGridFieldBase. |
| MaximumRowValueLineCount static |
Specifies the maximum height of row field values, in lines. Return value: 5 Inherited from PivotGridFieldBase. |
| MinimumValueLineCount static |
Specifies the minimum height of column/row field values, in lines. Return value: 1 Inherited from PivotGridFieldBase. |
Properties
| Name | Description |
|---|---|
| ActualDataType | Gets the field’s actual data type. Inherited from PivotGridFieldBase. |
| ActualSortMode | This member supports the internal infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase. |
| AllowedAreas | Gets or sets the areas within which the field can be positioned. Inherited from PivotGridFieldBase. |
| AnnotationAttributes | Returns the object that contains current values for all existing Data Annotation Attributes. Inherited from PivotGridFieldBase. |
| Appearance | Provides access to the appearance settings used to paint the field’s header, values and value totals. |
| Area | Gets or sets the area in which the field is displayed. Inherited from PivotGridFieldBase. |
| AreaIndex | Gets or sets the field’s index from among the other fields displayed within the same area. Inherited from PivotGridFieldBase. |
| AutoPopulatedProperties | Get or set a collection of OLAP member properties. Inherited from PivotGridFieldBase. |
| CalculateHiddenSummaries | Allows you to calculate summary values for hidden data fields. Inherited from PivotGridFieldBase. |
| CanFilter | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase. |
| CanHide | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase. |
| CanRaiseEvents protected | Gets a value indicating whether the component can raise an event. Inherited from Component. |
| CanSort | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase. |
| CanSortBySummary | Gets whether the current field’s values can be sorted by values in other columns/rows. Inherited from PivotGridFieldBase. |
| Caption | Gets or sets the field’s display caption. Inherited from PivotGridFieldBase. |
| CellFormat | Provides access to the format settings applied to cells. Inherited from PivotGridFieldBase. |
| ColumnHandle | Obsolete. Gets the field’s unique identifier. Inherited from PivotGridFieldBase. |
| ColumnValueLineCount | If the current field is displayed in the Column Header Area, this property gets or sets the height of the field’s values, in text lines. Inherited from PivotGridFieldBase. |
| Container | Gets the IContainer that contains the Component. Inherited from Component. |
| CustomTotals | Gets the collection of custom totals for the current field. |
| DataBinding | |
| DataType | Gets the field’s data type. Inherited from PivotGridFieldBase. |
| DefaultDateFormat static | Provides access to global formatting settings for date/time values. Inherited from PivotGridFieldBase. |
| DefaultDecimalFormat static | Provides access to global formatting settings for decimal values. Inherited from PivotGridFieldBase. |
| DefaultPercentFormat static | Provides access to global formatting settings for percent values. Inherited from PivotGridFieldBase. |
| DefaultTotalFormat static | Provides access to global format settings for total values. Inherited from PivotGridFieldBase. |
| DesignMode protected | Gets a value that indicates whether the Component is currently in design mode. Inherited from Component. |
| DisplayFolder | Gets or sets the name of the folder containing the field. Inherited from PivotGridFieldBase. |
| DrillDownColumnName | For internal use. Inherited from PivotGridFieldBase. |
| EmptyCellText | Gets the text displayed by an empty cell. Inherited from PivotGridFieldBase. |
| EmptyValueText | Gets the text used for an empty field value header. Inherited from PivotGridFieldBase. |
| Events protected | Gets the list of event handlers that are attached to this Component. Inherited from Component. |
| ExpandedInFieldsGroup | Gets or sets the expansion status of the current field if it belongs to a field group. Inherited from PivotGridFieldBase. |
| ExpressionFieldName | Gets the field’s name in unbound expressions. Inherited from PivotGridFieldBase. |
| FieldName | Gets or sets the name of the database field that is assigned to the current Pivot Grid field. |
| FilterColumnName | Gets the column name mapped to the field in the filter control’s view model. For internal use. Inherited from PivotGridFieldBase. |
| FilterValues | Gets or sets filter values for the current field. Inherited from PivotGridFieldBase. |
| GrandTotalCellFormat | Provides access to the format settings applied to grand total values. Inherited from PivotGridFieldBase. |
| GrandTotalText | Gets or sets the text displayed within the Grand Total‘s header that corresponds to the current field. Inherited from PivotGridFieldBase. |
| Group | Gets the group which owns the current field. Inherited from PivotGridFieldBase. |
| GroupIndex | Gets the index of the field group which owns the current field. Inherited from PivotGridFieldBase. |
| GroupInterval | Gets or sets how the values of the current column or row field are combined into groups. Inherited from PivotGridFieldBase. |
| GroupIntervalNumericRange | Gets or sets the length of the intervals when values are grouped together. Inherited from PivotGridFieldBase. |
| HasNullValues | Gets whether the field has null values. Inherited from PivotGridFieldBase. |
| HeaderDisplayText | Returns the string displayed within the field’s header, taking into account the field’s PivotGridFieldBase.Caption and the PivotGridFieldBase.SummaryType. The field’s summary type is appended to the field’s Caption if the PivotGridFieldOptions.ShowSummaryTypeName property is enabled. Inherited from PivotGridFieldBase. |
| Hierarchy | Gets the hierarchy to which the dimension level represented by the current field belongs. Inherited from PivotGridFieldBase. |
| InnerGroupIndex | Gets the index of the field in a field group. Inherited from PivotGridFieldBase. |
| InvalidPropertyDisplayText static | For internal use. Inherited from PivotGridFieldBase. |
| IsColumn | Gets whether the field is displayed within the Column Header Area. Inherited from PivotGridFieldBase. |
| IsColumnOrRow | Gets whether the current field is displayed within the Column Header Area or Row Header Area. Inherited from PivotGridFieldBase. |
| IsDataField | This member supports the .NET Framework infrastructure and is not intended to be used directly from your code. Inherited from PivotGridFieldBase. |
| IsUnboundExpressionValid | Gets whether the PivotGridFieldBase.UnboundExpression property’s value specifies a valid expression. Inherited from PivotGridFieldBase. |
| KPIGraphic | Gets or sets a graphic set used to indicate KPI values. Inherited from PivotGridFieldBase. |
| KPIType | Gets the KPI type. Inherited from PivotGridFieldBase. |
| MinWidth | Gets or sets the minimum allowed width of columns that correspond to the current field. Inherited from PivotGridFieldBase. |
| Name | Gets or sets the field’s name. Inherited from PivotGridFieldBase. |
| NamePrefix static | Gets the prefix that is used to create field names at design time. Inherited from PivotGridFieldBase. |
| OLAPDimensionCaption | Specifies the OLAP dimension’s caption displayed in the Customization form’s field list. Inherited from PivotGridFieldBase. |
| OLAPDrillDownColumnName | In OLAP mode, gets the name of the corresponding column in the underlying data source, on an OLAP server. Inherited from PivotGridFieldBase. |
| OLAPExpression | Gets or sets an expression used to evaluate values for the current unbound field in OLAP. Inherited from PivotGridFieldBase. |
| Options | Contains the field’s options. |
| RowValueLineCount | If the current field is displayed in the Row Header Area, this property gets or sets the height of the field’s values, in text lines. Inherited from PivotGridFieldBase. |
| RunningTotal | Gets or sets whether Running totals are calculated for values in the Data Area that correspond to the current column or row field. Inherited from PivotGridFieldBase. |
| ShowActiveFilterButton | Gets whether the Filter Button is displayed as active. Inherited from PivotGridFieldBase. |
| ShowFilterButton | Gets whether the Filter Button is visible within the current field’s header. Inherited from PivotGridFieldBase. |
| ShowNewValues | Gets or sets whether field values that have appeared in the datasource after the field’s filtering was configured should be shown. Inherited from PivotGridFieldBase. |
| ShowSortButton | Gets whether the Sort Button is visible in the current field’s header. Inherited from PivotGridFieldBase. |
| Site | Gets or sets the ISite of the Component. Inherited from Component. |
| SortByAttribute | Gets or sets the OLAP member property name by which the pivot grid’s data is sorted. Inherited from PivotGridFieldBase. |
| SortBySummaryInfo | Contains the settings used to sort the values of the current column field or row field by summary values in rows/columns. Inherited from PivotGridFieldBase. |
| SortMode | Gets or sets how the field’s data is sorted. Inherited from PivotGridFieldBase. |
| SortOrder | Gets or sets the field’s sort order. Inherited from PivotGridFieldBase. |
| SummaryDisplayType | Gets or sets how a summary value calculated against the current data field is represented in a cell. Inherited from PivotGridFieldBase. |
| SummaryFilter | Gets summary filtering settings. Inherited from PivotGridFieldBase. |
| SummaryType | Gets or sets the type of the summary function which is calculated against the current data field. Inherited from PivotGridFieldBase. |
| Tag | Gets or sets the data associated with the field. Inherited from PivotGridFieldBase. |
| TopValueCount | Gets or sets the absolute or relative number of field values that should be displayed for the current column field or row field. Inherited from PivotGridFieldBase. |
| TopValueMode | Gets or sets whether top n values for a specified data field are calculated based on all data source records or in the parent category. Inherited from PivotGridFieldBase. |
| TopValueShowOthers | Gets or sets whether the “Others” item is displayed within the Pivot Grid when the Top X Value feature is enabled. Inherited from PivotGridFieldBase. |
| TopValueType | Gets or sets how the number of Top Values is determined. Inherited from PivotGridFieldBase. |
| TotalCellFormat | Provides access to the format settings applied to total cells. Inherited from PivotGridFieldBase. |
| TotalsVisibility | Gets or sets whether to display totals for the current field when it is in the Column Header Area or Row Header Area and if so, whether they are automatic or custom. Inherited from PivotGridFieldBase. |
| TotalValueFormat | Provides access to the format settings applied to the total header. Inherited from PivotGridFieldBase. |
| UnboundExpression | Gets or sets an expression used to evaluate the unbound field’s value. Inherited from PivotGridFieldBase. |
| UnboundExpressionMode | Gets or sets how the specified data field’s unbound expression is calculated. Inherited from PivotGridFieldBase. |
| UnboundFieldName | Gets or sets the name of a column in a summary data source that corresponds to the current unbound field. Inherited from PivotGridFieldBase. |
| UnboundType | Gets or sets the field’s data type and binding mode. Inherited from PivotGridFieldBase. |
| UseDecimalValuesForMaxMinSummary | For internal use. Inherited from PivotGridFieldBase. |
| UseNativeFormat | Gets or sets whether to use the current field’s data format when the Pivot Grid Control is exported in XLS/XLSX formats. Inherited from PivotGridFieldBase. |
| ValueFormat | Provides access to the format settings applied to field values. Inherited from PivotGridFieldBase. |
| Visible | Gets or sets whether the field is visible. Inherited from PivotGridFieldBase. |
| Width | Gets or sets the width of columns that correspond to the current field. Inherited from PivotGridFieldBase. |
Methods
| Name | Description |
|---|---|
| Assign(PivotGridFieldBase) | Copies settings from the specified object to the current object. Inherited from PivotGridFieldBase. |
| BestFit() | Resizes the columns that correspond to the current field to the minimum width required to completely display the column’s contents. |
| CanShowValueType(PivotGridValueType, Boolean) | For internal use. Inherited from PivotGridFieldBase. |
| ChangeSortOrder() | Toggles the sort order for the current field. Inherited from PivotGridFieldBase. |
| CollapseAll() | Collapses all rows/columns that correspond to the current column field or row field. Inherited from PivotGridFieldBase. |
| CollapseValue(Object) | Collapses the column/row that contains the specified value. Inherited from PivotGridFieldBase. |
| CreateObjRef(Type) | Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject. |
| Dispose() | Releases all resources used by the Component. Inherited from Component. |
| Equals(Object, Object) static | Determines whether the specified object instances are considered equal. Inherited from Object. |
| Equals(Object) | Determines whether the specified object is equal to the current object. Inherited from Object. |
| ExpandAll() | Expands all columns/rows that correspond to the current column field or row field. Inherited from PivotGridFieldBase. |
| ExpandValue(Object) | Expands the column/row that contains the specified value. Inherited from PivotGridFieldBase. |
| GetAvailableValues() | Returns a list of field values that are not excluded by filters applied to other fields and can be displayed. Inherited from PivotGridFieldBase. |
| GetAvailableValuesAsync() | Asynchronously returns a list of field values that are not excluded by filters applied to other fields and can be displayed. Inherited from PivotGridFieldBase. |
| GetDisplayText(Object) | Returns the display representation of the specified value, according to the settings used to format field values. Inherited from PivotGridFieldBase. |
| GetGrandTotalText() | Returns the actual text displayed within the Grand Total‘s header which corresponds to the current field. Inherited from PivotGridFieldBase. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetLifetimeService() | Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| GetOlapDefaultSortProperty() | Returns the name of an OLAP member property used to set the default member sorting. Inherited from PivotGridFieldBase. |
| GetOLAPMemberProperties() | Returns a list of OLAP member properties. Inherited from PivotGridFieldBase. |
| GetOLAPMembers() | Returns an array of the OLAP members for the current field. Inherited from PivotGridFieldBase. |
| GetOLAPMembersAsync() | Inherited from PivotGridFieldBase. |
| GetService(Type) protected | Returns an object that represents a service provided by the Component or by its Container. Inherited from Component. |
| GetSummaryInterval() | Returns information about the distribution of summary values that have been calculated against this field and belong to the lowest detail level. Inherited from PivotGridFieldBase. |
| GetSummaryInterval(PivotGridFieldBase, PivotGridFieldBase) | Returns information about the distribution of summary values that have been calculated against this field and belong to the specified detail level. Inherited from PivotGridFieldBase. |
| GetTotalOthersText() | Returns the text displayed within the total header which corresponds to the “Others” row/column. Inherited from PivotGridFieldBase. |
| GetTotalValueText(Object) | Returns a formatted text representation of the specified value according to the settings used to represent the headers of column or row totals. Inherited from PivotGridFieldBase. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| GetUniqueValues() | Returns an array of the unique values which are stored in the underlying data source in the current field. Inherited from PivotGridFieldBase. |
| GetUniqueValues(CriteriaOperator) | Returns an array of the unique values which are stored in the underlying data source in the current field. Inherited from PivotGridFieldBase. |
| GetValueText(IOLAPMember) | Returns a formatted text representation of the specified OLAP member according to the settings used to format field values. Inherited from PivotGridFieldBase. |
| GetValueText(Object) | Returns a formatted text representation of the specified value according to the settings used to format field values. Inherited from PivotGridFieldBase. |
| GetVisibleValues() | Returns the field values currently shown in the PivotGrid. Inherited from PivotGridFieldBase. |
| InitializeLifetimeService() | Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject. |
| IsAreaAllowed(PivotArea) | Returns whether the current field can be positioned within the specified area. Inherited from PivotGridFieldBase. |
| IsDefaultFormat(FormatInfo) static | Returns whether the specified formatting settings match the default ones. Inherited from PivotGridFieldBase. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| MemberwiseClone(Boolean) protected | Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject. |
| OnEndDeserializing(String) | This method supports the control’s internal infrastructure and is not intended to be called directly from your code. Inherited from PivotGridFieldBase. |
| OnEndSerializing() | This method supports the control’s internal infrastructure and is not intended to be called directly from your code. Inherited from PivotGridFieldBase. |
| OnStartDeserializing(LayoutAllowEventArgs) | This method supports the control’s internal infrastructure and is not intended to be called directly from your code. Inherited from PivotGridFieldBase. |
| OnStartSerializing() | This method supports the control’s internal infrastructure and is not intended to be called directly from your code. Inherited from PivotGridFieldBase. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| SetAreaPosition(PivotArea, Int32) | Positions the field in the specified area and at the specified location. Inherited from PivotGridFieldBase. |
| SetOLAPFilterByUniqueName(DefaultBoolean) | Inherited from PivotGridFieldBase. |
| SetSortBySummary(PivotGridFieldBase, List<PivotGridFieldSortCondition>, Nullable<PivotSummaryType>, Boolean) | Sorts field values by another column’s/row’s values. Inherited from PivotGridFieldBase. |
| ToString() | Returns the textual representation of XRPivotGridField‘s display text. |
Events
| Name | Description |
|---|---|
| Disposed | Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component. |
See Also