GridColumnSummaryItem Members
A column’s total summary item.Constructors
| Name | Description |
|---|---|
| GridColumnSummaryItem() | Initializes a new GridColumnSummaryItem class instance. |
| GridColumnSummaryItem(SummaryItemType, SummaryMode, String, String, Object) | Initializes a new instance of the GridColumnSummaryItem class with specified settings. |
| GridColumnSummaryItem(SummaryItemType, SummaryMode, String, String) | Initializes a new instance of the GridColumnSummaryItem class with specified settings. |
| GridColumnSummaryItem(SummaryItemType, SummaryMode) | Initializes a new instance of the GridColumnSummaryItem class with specified settings. |
| GridColumnSummaryItem(SummaryItemType, String, String, Object) | Initializes a new GridColumnSummaryItem class instance with the specified summary type, field name, display format and tag. |
| GridColumnSummaryItem(SummaryItemType, String, String) | Initializes a new GridColumnSummaryItem class instance with the specified summary type, field name and display format. |
| GridColumnSummaryItem(SummaryItemType) | Initializes a new GridColumnSummaryItem class instance with the specified summary type. |
Properties
| Name | Description |
|---|---|
| Collection | Gets a collection to which the summary item belongs. Inherited from GridSummaryItem. |
| DisplayFormat | Gets or sets the display format rule for the GridSummaryItem value. An empty string to apply the default format rule. Inherited from GridSummaryItem. |
| FieldName | Gets or sets a name of the field for which a total summary should be calculated. |
| Format | Gets or sets the IFormatProvider object which specifies how values should be formatted. Inherited from GridSummaryItem. |
| HasValue | Returns whether the GridSummaryItem has a non-null value. Inherited from GridSummaryItem. |
| Index | Gets the summary item’s position within the owning collection. Inherited from GridSummaryItem. |
| Mode | Gets or sets whether to calculate the current summary against all rows or the selection. Use this property when you enable multiple row selection (see ColumnView.OptionsSelection.MultiSelect). This property is not supported in server mode. Inherited from GridSummaryItem. |
| SummaryType | Gets or sets the aggregation function type. Inherited from GridSummaryItem. |
| SummaryValue | Gets the current total summary item’s value. This value may differ from the actual View data if the GridOptionsBehavior.AutoUpdateTotalSummary setting is disabled. Call the GridView.UpdateTotalSummary method to forcibly recalculate summaries. Inherited from GridSummaryItem. |
| Tag | Gets or sets data associated with the summary item. Inherited from GridSummaryItem. |
Methods
| Name | Description |
|---|---|
| Assign(GridSummaryItem) | Copies settings from the summary item object specified as the parameter. Inherited from GridSummaryItem. |
| 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. |
| GetDefaultDisplayFormat() | Returns the default display format for a column’s summary item. |
| GetDisplayFormatByType(SummaryItemType, Boolean) | Returns the default format string for the specified summary type. Inherited from GridSummaryItem. |
| GetDisplayText(Object, Boolean) | Formats the specified value using the summary item’s format settings. Inherited from GridSummaryItem. |
| GetFormatDisplayText(String, Object) | Returns the value formatted according to the specified format string. Inherited from GridSummaryItem. |
| GetHashCode() | Serves as the default hash function. Inherited from Object. |
| GetType() | Gets the Type of the current instance. Inherited from Object. |
| IsEquals(GridSummaryItem) | Indicates whether the specified summary item has the same settings as the current one. Inherited from GridSummaryItem. |
| MemberwiseClone() protected | Creates a shallow copy of the current Object. Inherited from Object. |
| ReferenceEquals(Object, Object) static | Determines whether the specified Object instances are the same instance. Inherited from Object. |
| SetSummary(SummaryItemType, String, IFormatProvider, SummaryMode) | Specifies the type, display format, format provider, and summary mode of the summary item. Inherited from GridSummaryItem. |
| SetSummary(SummaryItemType, String) | Specifies the type and display format of the summary item. Inherited from GridSummaryItem. |
| ToString() | Gets the object’s text representation. Inherited from GridSummaryItem. |
See Also