GridSummaryItem Members
Represents a footer summary item.Constructors
| Name | Description |
|---|---|
| GridSummaryItem() | Creates a new GridSummaryItem object with default settings. |
| GridSummaryItem(SummaryItemType, String, String, Object, SummaryMode) | Initializes a new instance of the GridSummaryItem class with specified settings. |
| GridSummaryItem(SummaryItemType, String, String, Object) | Creates a new GridSummaryItem object with the predefined summary settings and tag. |
| GridSummaryItem(SummaryItemType, String, String) | Creates a new GridSummaryItem object with the predefined summary settings. |
Properties
| Name | Description |
|---|---|
| Collection | Gets a collection to which the summary item belongs. |
| DisplayFormat | Gets or sets the display format rule for the GridSummaryItem value. An empty string to apply the default format rule. |
| FieldName | Gets or sets the name of a dataset field whose values are used for summary calculation. |
| Format | Gets or sets the IFormatProvider object which specifies how values should be formatted. |
| HasValue | Returns whether the GridSummaryItem has a non-null value. |
| Index | Gets the summary item’s position within the owning collection. |
| 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. |
| SummaryType | Gets or sets the aggregation function type. |
| 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. |
| Tag | Gets or sets data associated with the summary item. |
Methods
| Name | Description |
|---|---|
| Assign(GridSummaryItem) | Copies settings from the summary item object specified as the parameter. |
| 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 the summary item. |
| GetDisplayFormatByType(SummaryItemType, Boolean) | Returns the default format string for the specified summary type. |
| GetDisplayText(Object, Boolean) | Formats the specified value using the summary item’s format settings. |
| GetFormatDisplayText(String, Object) | Returns the value formatted according to the specified format string. |
| 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. |
| 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. |
| SetSummary(SummaryItemType, String) | Specifies the type and display format of the summary item. |
| ToString() | Gets the object’s text representation. |
See Also