C1.PivotEngine.PivotField
PivotField Class
Represents a property of the items in the data source.
Implements
Namespace: C1.PivotEngine
Assembly: C1.PivotEngine.dll
Syntax
public class PivotField : INotifyPropertyChangedRemarks
PivotField objects represent 'dimensions' in the output FlexPivot table.
Each row and column on the output table is uniquely identified by a PivotKey object. These objects contain a list of PivotField objects and specific values.
Properties
| Name | Description |
|---|---|
| Caption | Gets or sets a string to be displayed in the user interface. |
| Expression | Gets or sets the expression in case the field is a Calculated field. |
| Filter | Gets the filter used to select field values. |
| Format | Gets or sets the format to use when displaying field values. |
| IsActive | Gets or sets whether this field is active in the FlexPivot view. |
| Key | Gets a key that uniquely identifies the field in a collection. |
| Lookup | Gets or sets IDictionary that contains lookup values for this field. |
| Name | Gets the name of the field source column. |
| ParentList | Gets the PivotFieldList that contains this field. |
| PivotEngine | Gets the C1PivotEngine that owns this field. |
| Range | Provides the RangeInfo used to group values by a criteria. |
| ShowAs | Gets or sets how the field results should be formatted. |
| Style | Gets the PivotFieldStyle used to display the field values on the grid. |
| StyleHigh | Gets the PivotConditionalFieldStyle used to display high values. |
| StyleLow | Gets the PivotConditionalFieldStyle used to display low values. |
| Subtotal | Gets or sets the type of subtotal to use when combining field values. |
| Type | Gets the type of the field source column. |
| WeightField | Gets or sets the PivotField used as a weight for calculating subtotals on this field. |
| Width | Gets or sets the preferred width to be used for showing the field in the user interface. |
Methods
| Name | Description |
|---|---|
| GetUniqueValues() | Gets a list of unique values found in the data source for this field. |
| OnPropertyChanged(PropertyChangedEventArgs) | Raises the PropertyChanged event. |
| ReadXml(XmlReader) | Reads the field from an System.Xml.XmlReader. |
| ToString() | |
| WriteAttributes(XmlWriter) | Saves addition attributes of the field into an System.Xml.XmlWriter. |
| WriteXml(XmlWriter) | Saves the field into an System.Xml.XmlWriter. |
Events
| Name | Description |
|---|---|
| PropertyChanged | Fires when a property changes. |
Operators
| Name | Description |
|---|---|
| implicit operator C1FlexPivotField(PivotField) |