RadGrid for ASP.NET

RadGrid Send comments on this topic.
GridButtonColumn Class Members
See Also  Properties  Methods 
Telerik.WebControls Namespace : GridButtonColumn Class


The following tables list the members exposed by GridButtonColumn.

Public Constructors

 NameDescription
Public ConstructorGridButtonColumn ConstructorConstructs a new GridButtonColumn object.  
Top

Public Properties

 NameDescription
Public PropertyAutoPostBackOnFilter Gets or sets a value indicating whether the grid should automatically postback, when the value in the filter text-box changes, and the the focus moves to another element. (Inherited from GridColumn)
Public PropertyButtonType Gets or sets a value indicating the type of the button that will be rendered. The type should be one of the specified by the GridButtonColumnType enumeration.  
Public PropertyColumnType Gets the string representation of the type-name of this instance. The value is used by RadGrid to determine the type of the columns persisted into the ViewState, when recreating the grid after postback. The value is also used by the grid client-side object. This property is read only. (Inherited from GridColumn)
Public PropertyCommandArgument Gets or sets an optional parameter passed to the Command event along with the associated CommandName.  
Public PropertyCommandName Gets or sets a value defining the name of the command that will be fired when a button in this column is clicked.  
Public PropertyConfirmText Gets or sets the text that will be shown on the confirmation dialog when a button in this column is clicked. The prompt is automatically enabled when this property is set.  
Public PropertyCurrentFilterFunctionGets or sets the current function used for filtering. (Inherited from GridColumn)
Public PropertyCurrentFilterValueGets or sets a value of the currently applied filter. (Inherited from GridColumn)
Public PropertyDataTextField Gets or sets a value from the specified datasource field. This value will then be displayed in the GridBoundColumn.  
Public PropertyDataTextFormatString Gets or sets the string that specifies the display format for the caption in each button.  
Public PropertyDataTypeGets or sets (see the Remarks) the type of the data from the DataField as it was set in the DataSource. (Inherited from GridColumn)
Public PropertyDataTypeName Gets the string representation of the DataType property of the column, needed for the client-side grid instance. (Inherited from GridColumn)
Public PropertyDisplay Gets or sets a value indicating whether the cells corresponding to a column would be rendered with a 'display:none' style attribute (end-user-not-visible). To completely prevent cells from rendering, set the GridColumn.Visible property to false, instead of the Display property. (Inherited from GridColumn)
Public PropertyEditFormColumnIndexSpecifies the vertical collumn number where this column will appear when using EditForms editing mode and the form is autogenerated. See the remarks for details. (Inherited from GridColumn)
Public PropertyEditFormHeaderTextFormat String that formats the HeaderText when the column is displayed in an edit form (Inherited from GridColumn)
Public PropertyFilterImageToolTip (Inherited from GridColumn)
Public PropertyFilterImageUrl Gets or sets a string representing the URL to the image used in the filtering box. (Inherited from GridColumn)
Public PropertyFilterListOptions Gets or sets the value indincating which of the filter functions should be available for that column. For more information see GridFilterListOptions enumaration. (Inherited from GridColumn)
Public PropertyFooterStyle Style of the cell in the footer item of the grid, corresponding to the column. (Inherited from GridColumn)
Public PropertyFooterTextUse the FooterText property to specify your own or determine the current text for the footer section of the column. (Inherited from GridColumn)
Public PropertyGroupableOverridden.  Gets or sets a value indicating whether this column can be used for grouping. If set to false the column header cannot be dragged to the GroupPanel.  
Public PropertyGroupByExpressionThe group-expression that should be used when grid is grouping-by this column. If not set explicitly, RadGrid will generate a group expression based on the DataField of the column (if available), using the GridColumn.GetDefaultGroupByExpression method.

The grouping can be turned on/off for columns like GridBoundColumn using GridColumn.Groupable property.

For more information about the Group-By expressions and their syntax, see GridGroupByExpression class. (Inherited from GridColumn)

Public PropertyHeaderButtonTypeGets or sets the button type of the button rendered in the header item, used for sorting. The possible values that this property accepts are:

Telerik.WebControls.GridHeaderButtonType.LinkButton
Telerik.WebControls.GridHeaderButtonType.PushButton
Telerik.WebControls.GridHeaderButtonType.TextButton (Inherited from GridColumn)

Public PropertyHeaderImageUrl Gets or sets the URL of an image in the cell in the header item of the grid current column. You can use a relative or an absolute URL. (Inherited from GridColumn)
Public PropertyHeaderStyle Style of the cell in the header item of the grid, corresponding to the column. (Inherited from GridColumn)
Public PropertyHeaderText Use the HeaderText property to specify your own or determine the current text for the header section of the column. (Inherited from GridColumn)
Public PropertyImageUrl Gets or sets a value indicating the URL for the image that will be used in a Image button. ButtonType should be set to ImageButton.  
Public PropertyIsEditableOverridden. Gets the status of ShowInEditForm property.  
Public PropertyItemStyle Style of the cells, corresponding to the column. (Inherited from GridColumn)
Public PropertyOrderIndex Gets or sets the order index of column in the collection of GridTableView.RenderColumns. Use GridTableView.SwapColumns(String,String) method for reordering the columns. (Inherited from GridColumn)
Public PropertyOwner Gets the instance of the GridTableVeiw wich owns this column instance. (Inherited from GridColumn)
Public PropertyOwnerGridID Gets the value of the ClientID property of the RadGrid instance that owns this column. This property value is used by grid's client object (Inherited from GridColumn)
Public PropertyOwnerID Gets the value of the ClientID property of the GridTableView that owns this column. This property value is used by grid's client object (Inherited from GridColumn)
Public PropertyReorderable Gets or sets a value indicating whether the column can be reordered client-side. (Inherited from GridColumn)
Public PropertyResizable Gets or sets a value indicating whether the column can be resized client-side. You can use this property, by setting it to false, to disable resizing for a particular column, while preserving this functionality for all the other columns. (Inherited from GridColumn)
Public PropertyShowInEditForm If the corresponding GridTableView is in edit mode GridEditMode.InPlace specifies whether this column will render an Enabled=true button control, when the corresponding item is edit mode.  
Public PropertyShowSortIcon Get or Sets a value indicating whether a sort icon should appear next to the header button, when a column is sorted. (Inherited from GridColumn)
Public PropertySortAscImageUrl Gets or sets a string representing the URL to the image used for sorting in ascending mode. (Inherited from GridColumn)
Public PropertySortDescImageUrl Gets or sets a string representing the URL to the image used for sorting in descending mode. (Inherited from GridColumn)
Public PropertySortedBackColor (Inherited from GridColumn)
Public PropertySortExpression The string representing a filed-name from the DataSource that should be used when grid sorts by this column. For example: 'EmployeeName' (Inherited from GridColumn)
Public PropertyTextGets or sets a value indicating the text that will be shown for a button.  
Public PropertyUniqueName Each column in Telerik RadGrid has an UniqueName property (string). This property is assigned automatically by the designer (or the first time you want to access the columns if they are built dynamically). (Inherited from GridColumn)
Public PropertyVisible Gets or sets a value indicating if the column and all corresponding cells would be rendered. (Inherited from GridColumn)
Top

Public Methods

 NameDescription
Public MethodCloneOverridden. Returns a copy of the GridButtonColumn.  
Public MethodEvaluateFilterExpression Gets a string representing a filter expression, based on the settings of all columns that support filtering, with a syntax ready to be used by a DataView object (Inherited from GridColumn)
Public MethodGetCustomPropertyDataFieldsThis method should be used in case you develop your own column. It returns the full list of DataFields used by the column. GridTableView uses this to decide which DataFields from the specified DataSource will be inlcuded in case of GridTableView.RetrieveAllDataFields is set to false. (Inherited from GridColumn)
Public MethodGetDefaultGroupByExpression Calculate the default Group-by expression based on the settings of the DataField (if available) (Inherited from GridColumn)
Public MethodInitializeOverridden. The Initialize method is inherited by a derived GridButtonColumn class. Is is used to reset a column of the derived type.  
Public MethodInitializeCellOverridden. After a call to this method the column should add the corresponding button into the cell given, regarding the inItem type and column index.

Note: This method is called within RadGrid and is not intended to be used directly from your code.  

Public MethodIsBoundToFieldName This method returns true if the column is bound to the specified field name. (Inherited from GridColumn)
Public MethodPrepareCell Prepares the cell of the item given, when grid is rendered. (Inherited from GridColumn)
Public MethodRefreshCurrentFilterValueOverloaded.  Modifies the CurrentFilterFunction and CurrentFilterValue properties according to the function given and the corresponding filter text-box control in the filtering item. (Inherited from GridColumn)
Public MethodResetCurrentFilterValue Resets the values of the GridColumn.CurrentFilterFunction and GridColumn.CurrentFilterValue properties to their defaults. (Inherited from GridColumn)
Public MethodSupportsFiltering This method should be used in case you develop your own column. It returns true if the column supports filtering. (Inherited from GridColumn)
Top

See Also