RadGrid.Net2 This is a base class for all column editors for GridCheckBoxColumn. It defines the base properties for controls that can edit boolean values. Interface that describes the baseic column editor functionality, needed for a class that should be responsible for editing of a content of a cell in a Implement column editor to provide extended editing functionality in RadGrid. The column-editor inheritors should provide the methods for creating the column editor control inside the container (generally a grid TableCell). For example the default column editor for GridBoundColumn creates a TextBox control and adds it to the corresponding GridtableCell when the InstantiateInControl method is called. To inherit the base implementation of a column editor control in RadGrid you may consider deriving from instead implementing the IColumnEditor interface. Implement this member to add control int the given container. After the call to this method the ContainerControl property should return the instance of containerControl parameter passed to this function. The editor should recreate its state and imput controls from the Container. control (generally a TableCell) that contains the input controls, previously instantiated within the InitializeInControl method call Gets the instance of the Container control (generally a TableCell), after the last call of InstantiateInControl method Get value if the editor has been initialized after an InitializeInControl or InitializeFromControl method call Get a value indicating if the column/row the editor currently is instantiated is in edit mode. Create the input/edit controls belonging to the editor and prepare for AddControlsToContainer call. Implement this member to create the edit controls in the grid cell. This method is called from each column's InitializeCell method, when a initializes its cells. This method should recrteate the state of the column editor (edit controls, etc) from the container. This method is called when method is called, or when is called. This method is should prepare the column editor to extract values from the edit controls residign in a TableCell of the grid. Gets or sets the value for each cell in a GridCheckBoxColumn. Provides a reference to the control in the corresponding grid cell of the current GridCheckBoxColumn. Gets or sets the style defining the appearance of the corresponding check-box. Gets or sets the value for each cell in a GridCheckBoxColumn. Summary description for GridCreateColumnEditorEvent. Summary description for GridDropDownColumnEditor. Base class that intruduces the editor of GridBoundColumn. THis can be an editor that creates a simple TextBox control, ot RichTexst editors, that has a single string property Text. Class tha implements data editing of a GridBoundColumn with a single TextBox control. Gets The text box instance created of extracted from a cell after calls to AddControlsToContainer or LoadControlsFromContainer methods. Gets the instace of the Style that would be applied to the TextBox control, when initializing in a TableCell. A column type for the RadGrid control that is bound to a field in a data source. Grid column types The default data binding (when AutoGenerateColumns property is set to true) generates GridBoundColumn type of columns. It displays each item from the DataSource field as text. This column is editable (implements the IGridEditableColumn interface) and provides by default GridTextColumnEditor, used for editing the text in each item. GridBoundColumn has three similar and yet different properties controlling its visibility and rendering in a browser in regular and in edit mode: Display - concerns only the appearance of the column in browser mode, client-side. The column will be rendered in the browser but all the cells will be styled with display: none. The column editor will be visible in edit mode. Visible - will stop the column cells from rendering in browser mode. The column will be visible in edit mode. ReadOnly - the column will be displayed according to the settings of previous properties in browser mode but will not appear in the edit-form.
None of these properties can prevent you from accessing the column cells' content server-side using the UniqueName of the column. 
            <radG:GridBoundColumn FooterText="BoundColumn footer" UniqueName="CustomerID" SortExpression="CustomerID"
HeaderText="Bound<br/>Column" DataField="CustomerID">
</radG:GridBoundColumn>
Grid Column types Adding columns design-time Using columns All columns in RadGrid that have editing capabilities derive from GridEditableColumn. This class implements the base functionality for editing, using column editors etc. Provides IGridEditableColumn interface, which RadGrid uses to operate with the state of all the editable columns. A Column is the main logic unit that relates the content of the grid to properties of the objects in the DataSource. The GridColumn defines the properties and methods that are common to all column types in RadGrid. As it is an abstract class (MustInherit in VB.NET) GridColumn class can not be created directly. You should inherit it and use its children. GridColumn is the base abstract class that implements the functionality of a grid column. All inherited classes modify the base behavior corresponding to the specific data that should be displayed/edited in RadGrid. The columns that have editing capabilities derrive from class. Other instances display data, buttons, and so on in the cells of the grid regarding the type of the Item/row in which the cell resides. In you code you can create only instances of the derrived classes. In order to display a column in the grid you should add it in the corresponding collection. Since the column collection is fully persisted in the ViewSteate you should follow the rules that apply to creating asp.net server controls dynamically, when adding columns to grid tables programmatically. Using the FooterStyle property lets you enhance the appearance of the footer section of the column. You can set forecolor, backcolor, font and content alignment. Using the HeaderStyle property lets you enhance the appearance of the header section of the column. You can set forecolor, backcolor, font and content alignment. Use this property to enhance the appearance of the item cells of the column. You can provide a custom style for Common style attributes that can be adjusted such as: forecolor, backcolor, font, and content alignment within the cell. Creates and initializes a new column with its base properties. The Initialize method is inherited by a derived GridColumn class. Is is used to reset a column of the derived type. This method is mainly used to reset properties common for all column types derived from GridColumn class. The Initialize method is usually called during data-binding, prior to the first row being bound. After a call to this method the column should add the corresponding controls (text, labels, input controls) 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. This method should be used in case you develop your own column. It returns true if the column supports filtering. Modifies the CurrentFilterFunction and CurrentFilterValue properties according to the function given and the corresponding filter text-box control in the filtering item. Modifies the CurrentFilterValue property according to the corresponding selected item in the filter text-box control in the filtering item. Sets the value of the property CurrentFilterValue as a text on the TextBox control found in the cell Gets the value of the Text property of a textbox control found in the cell, used to set the value of the CurrentFilterValue property. 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 Instantiates the filter controls (text-box, image.) in the cell given Gets a list of filter functions based on the settings of the property. Prepares the cell of the item given, when grid is rendered. Resets the values of the and properties to their defaults. By default returns the SortExpression of the column. If the SortExpression is not set explicitly, it would be calculated, based on the DataField of the column. Calculate the default Group-by expression based on the settings of the DataField (if available) For example, if a column's DataField is ProductType the default group-by expression will be: 'ProductType Group By ProductType' Note: When implementing/overriding this method be sure to call the base member or call CopyBaseProperties to be sure that all base properties will be copied accordingly Creates a copy of the current column. This method returns true if the column is bound to the specified field name. The name of the DataField, which will be checked. This 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. Gets or sets a value of the currently applied filter. This property returns a string, representing the current value, for which the columns is filtered (the value, which the user has entered in the filtering text box). Gets or sets the current function used for filtering. This property returns a value of type Telerik.WebControls.GridKnownFunction. The possible values are: GridKnownFunction.Between
GridKnownFunction.Contains
GridKnownFunction.Custom
GridKnownFunction.DoesNotContain
GridKnownFunction.EndsWith
GridKnownFunction.EqualTo
GridKnownFunction.GreaterThan
GridKnownFunction.GridKnownFunction
GridKnownFunction.GreaterThanOrEqualTo
GridKnownFunction.IsEmpty
GridKnownFunction.IsNull
GridKnownFunction.LessThan
GridKnownFunction.LessThanOrEqualTo
GridKnownFunction.NoFilter
GridKnownFunction.NotBetween
GridKnownFunction.NotEqualTo
GridKnownFunction.NotIsEmpty
GridKnownFunction.NotIsNull
GridKnownFunction.StartsWith Gets or sets the value indincating which of the filter functions should be available for that column. For more information see enumaration. This property returns a value of type Telerik.WebControls.GridFilterListOptions. The possible values are: Telerik.WebControls.GridFilterListOptions.AllowAllFilters
Telerik.WebControls.GridFilterListOptions.VaryByDataType
Telerik.WebControls.GridFilterListOptions.VaryByDataTypeAllowCustom 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. This property returns a Boolean value, indicating whether the grid will postback, once the focus moves to another element, and the text of the filtering textbox has changed. Gets or sets a string representing the URL to the image used in the filtering box. A string, representing the URL to the image used in the filtering box. Gets or sets a string representing the URL to the image used for sorting in ascending mode. A string, representing the URL to the image used for sorting in ascending mode Gets or sets a string representing the URL to the image used for sorting in descending mode. A string, representing the URL to the image used for sorting in descending mode Gets the string representation of the DataType property of the column, needed for the client-side grid instance. Style of the cell in the footer item of the grid, corresponding to the column. Use the FooterText property to specify your own or determine the current text for the footer section of the column. 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. Style of the cell in the header item of the grid, corresponding to the column. Use the HeaderText property to specify your own or determine the current text for the header section of the column. Style of the cells, corresponding to the column. Gets the instance of the GridTableVeiw wich owns this column instance. The string representing a filed-name from the DataSource that should be used when grid sorts by this column. For example: 'EmployeeName' The 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 method. The grouping can be turned on/off for columns like GridBoundColumn using property. For more information about the Group-By expressions and their syntax, see class. Get or Sets a value indicating whether a sort icon should appear next to the header button, when a column is sorted. This property returns a Boolean value, indicating whether a sort icon should appear next to the header button, when a column is sorted. Gets or sets a value indicating if the column and all corresponding cells would be rendered. This property returns a Boolean value, indicating whether the cells corresponding to the column, would be visible on the client, and whether they would be rendered on the client. 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 property to false, instead of the Display property. This property returns a Boolean value, indicating whether the cells corresponding to the column would be rendered with a 'display:none' style attribute (end-user-not-visible). Gets the value of the ClientID property of the GridTableView that owns this column. This property value is used by grid's client object The return value of this property is a string, representing the clientID of the GridTableView, which contains the column. This is the ClientID of the grid instance, followed by "_" and another string, representing the place of the container in the control hierarchy. For the MasterTableView, the default OwnerID for a column will look like: "RadGrid1_ctl01". 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 This property returns a string, which represents a the ClientID for the control. 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. The property returns a boolean value, indicating whether the column can be resized on the client. Gets or sets a value indicating whether the column can be reordered client-side. This property returns a boolean value, indicating whether the column is reorderable. The default value is true, meaning that the column can be reordered, using the SwapColumns client side method. Gets or sets a value indicating whether you will be able to group Telerik RadGrid by that column. By default this property is true. A boolean value of either true, when you are able to group by that column, or false. See Telerik RadGrid manual for details about using grouping. If Groupable is false the column header cannot be dragged to the GroupPanel. Using this property, you can easily turn off grouping for one or more columns, while still allowing this functionality for all other columns in the control. This is demonstrated in the code sample below: 
            <radG:GridBoundColumn
   DataField="ContactName"
   HeaderText="ContactName"
   SortExpression="ContactName"
   UniqueName="ContactName"
   Groupable="false">
</radG:GridBoundColumn>
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. Gets 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 The return value for this property is of type Telerik.WebControls.GridHeaderButtonType Gets or sets the order index of column in the collection of . Use method for reordering the columns. We recommend using this property only for getting the order index for a specific column instead of setting it. Use method for reordering columns. Note that changing the column order index will change the order of the cells in the grid items, after the grid is rebound. The value of the property would not affect the order of the column in the collection. integer representing the current column index. You should have in mind that GridExpandColumn and RowIndicatorColumn are always in front of data columns so that's why you columns will start from index 2. protected void RadGrid1_PreRender(object sender, EventArgs e) { foreach (GridBoundColumn column in RadGrid1.MasterTableView.Columns) { Response.Write(column.UniqueName + column.OrderIndex + "<br>"); } RadGrid1.MasterTableView.SwapColumns(2, 4); foreach (GridBoundColumn column in RadGrid1.MasterTableView.Columns) { Response.Write(column.UniqueName + column.OrderIndex + "<br>"); } } Protected Sub RadGrid1_PreRender(sender As Object, e As EventArgs) Dim column As GridBoundColumn For Each column In RadGrid1.MasterTableView.Columns Response.Write((column.UniqueName + column.OrderIndex + "<br>")) Next column RadGrid1.MasterTableView.SwapColumns(2, 4) Dim column As GridBoundColumn For Each column In RadGrid1.MasterTableView.Columns Response.Write((column.UniqueName + column.OrderIndex + "<br>")) Next column End Sub 'RadGrid1_PreRender This property is supposed for developers of new grid columns. It gets whether a column is currently ReadOnly. The ReadOnly property determines whether a column will be editable in edit mode. A column for which the ReadOnly property is true will not be present in the automatically generated edit form. A boolean value, indicating whether a specific column is editable. Specifies the vertical collumn number where this column will appear when using EditForms editing mode and the form is autogenerated. See the remarks for details. A practicle example of using this property is to deterimine the number of columns rendered in the edit form. If there will be only one column in the rendered edit form, when we retrieve the value of this property for a column, as shown in the code below:
protected void RadGrid1_PreRender(object sender, EventArgs e)
{
int columnIndex = RadGrid1.MasterTableView.Columns[3].EditFormColumnIndex;
}
it will be equal to 0, meaning the the column belongs to the first group of columns in the edit form. 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). You can also set it explicitly, if you prefer. However, the automatic generation handles most of the cases. For example a GridBoundColumn with DataField 'ContactName' would generate an UniqueName of 'ContactName'. Additionally, there may be occasions when you will want to set the UniqueName explicitly. You can do so simply by specifying the custom name that you want to choose:
<radG:GridTemplateColumn
UniqueName="ColumnUniqueName">
</radG:GridTemplateColumn>
When you want to access a cell within a grid item, you should use the following code to obtain the right cell: TableCell cell = gridDataItem["ColumnUniqueName"]; or gridDataItem["ColumnUniqueName"].Text = to access the Text property Using this property you can index objects of type %GridDataItem:GridDataItem% or %GridEditFormItem:GridEditFormItem% (or all descendants of %GridEditableItem:GridEditableItem% class) In events related to creating, binding or for commands in items, the event argument has a property Item to access the item that event is fired for. To get an instance of type GridDataItem, you should use the following: //presume e is the event argument object
if (e.Item is GridDataItem)
{
GridDataItem gridDataItem = e.Item as GridDataItem; String that formats the HeaderText when the column is displayed in an edit form The following code demonstrates one possible use of this property:
In this way, once a record enters edit mode, the name of the column will be followed by the custom text entered in the example above. [ASPX/ASCX] <radG:GridBoundColumn DataField="CustomerID"
HeaderText="CustomerID"
SortExpression="CustomerID"
UniqueName="CustomerID"
EditFormHeaderTextFormat="{0} is currently in edit mode" >
</radG:GridBoundColumn> Gets or sets (see the Remarks) the type of the data from the DataField as it was set in the DataSource. The DataType property supports the following base .NET Framework data types: Boolean Byte Char DateTime Decimal Double Int16 Int32 Int64 SByte Single String TimeSpan UInt16 UInt32 UInt64 Interface that RadGrid uses to determine the editable columns, their current state etc. protected void RadGrid1_UpdateCommand(object source, Telerik.WebControls.GridCommandEventArgs e) { GridEditableItem editedItem = e.Item as GridEditableItem; GridEditManager editMan = editedItem.EditManager; foreach( GridColumn column in e.Item.OwnerTableView.RenderColumns ) { if ( column is IGridEditableColumn ) { IGridEditableColumn editableCol = (column as IGridEditableColumn); if ( editableCol.IsEditable ) { IGridColumnEditor editor = editMan.GetColumnEditor( editableCol ); string editorType = editor.ToString(); string editorText = "unknown"; object editorValue = null; if ( editor is GridTextColumnEditor ) { editorText = (editor as GridTextColumnEditor).Text; editorValue = (editor as GridTextColumnEditor).Text; } if ( editor is GridBoolColumnEditor ) { editorText = (editor as GridBoolColumnEditor).Value.ToString(); editorValue = (editor as GridBoolColumnEditor).Value; } if ( editor is GridDropDownColumnEditor ) { editorText = (editor as GridDropDownColumnEditor).SelectedText + "; " + (editor as GridDropDownColumnEditor).SelectedValue; editorValue = (editor as GridDropDownColumnEditor).SelectedValue; } try { DataRow[] changedRows = this.EmployeesData.Tables["Employees"].Select( "EmployeeID = " + editedItem.OwnerTableView.DataKeyValues[editedItem.ItemIndex]["EmployeeID"] ); changedRows[0][column.UniqueName] = editorValue; this.EmployeesData.Tables["Employees"].AcceptChanges(); } catch(Exception ex) { RadGrid1.Controls.Add(new LiteralControl ("<strong>Unable to set value of column '" + column.UniqueName + "'</strong> - " + ex.Message)); e.Canceled = true; break; } } } } } Private Sub RadGrid1_UpdateCommand(ByVal source As System.Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Handles RadGrid1.UpdateCommand Dim editedItem As GridEditableItem = CType(e.Item, GridEditableItem) Dim editMan As GridEditManager = editedItem.EditManager Dim column As GridColumn For Each column In e.Item.OwnerTableView.Columns If Typeof column Is IGridEditableColumn Then Dim editableCol As IGridEditableColumn = CType(column, IGridEditableColumn) If (editableCol.IsEditable) Then Dim editor As IGridColumnEditor = editMan.GetColumnEditor(editableCol) Dim editorType As String = CType(editor, Object).ToString() Dim editorText As String = "unknown" Dim editorValue As Object = Nothing If (Typeof editor Is GridTextColumnEditor) Then editorText = CType(editor, GridTextColumnEditor).Text editorValue = CType(editor, GridTextColumnEditor).Text End If If (Typeof editor Is GridBoolColumnEditor) Then editorText = CType(editor, GridBoolColumnEditor).Value.ToString() editorValue = CType(editor, GridBoolColumnEditor).Value End If If (Typeof editor Is GridDropDownColumnEditor) Then editorText = CType(editor, GridDropDownColumnEditor).SelectedText & "; " & CType(editor, GridDropDownColumnEditor).SelectedValue editorValue = CType(editor, GridDropDownColumnEditor).SelectedValue End If Try Dim changedRows As DataRow() = Me.EmployeesData.Tables("Employees").Select("EmployeeID = " & editedItem.OwnerTableView.DataKeyValues(editedItem.ItemIndex)("EmployeeID")) changedRows(0)(column.UniqueName) = editorValue Me.EmployeesData.Tables("Employees").AcceptChanges() Catch ex As Exception RadGrid1.Controls.Add(New LiteralControl("<strong>Unable to set value of column '" & column.UniqueName & "'</strong> - " + ex.Message)) e.Canceled = True End Try End If End If Next End Sub Using column editors Get value based on the current IsEditable state, item edited state and ForceExtractValue setting. item to check to extract values from Extracts the values from the editedItem and fills the names/values pairs for each data-field edited by the column in the newValues dictionary. dictionary to fill. This param should not be null (Nothing in VB.NET) the GridEditableItem to extract values from Get whether a column is currently read-only Gets the column editor instance for this column Gets the GridColumn instance implementing this interface Force RadGrid to extract values from EditableColumns that are ReadOnly (or IsEditable is false). Extracts the values from the editedItem and fills the names/values pairs for each data-field edited by the column in the newValues dictionary. dictionary to fill. This param should not be null (Nothing in VB.NET) the GridEditableItem to extract values from Get value based on the current IsEditable state, item edited state and ForceExtractValue setting. item to check to extract values from Get the current colum editor. If the column editor is not assigned at the moment the column will search for the ColumnEditorID on the page or should create its default column editor Convert the emty string to null when extracting values for inserting, updating, deleting Force RadGrid to extract values from EditableColumns that are ReadOnly (or IsEditable is false). Resets the GridBoundColumn to its initial state. Resets the specified cell in the GridBoundColumn to its initial state. Gets or sets the field name from the specified data source to bind to the GridBoundColumn. A string, specifying the data field from the data source, from which to bind the column. Gets or Sets an integer, specifying the maximum number of characters, which will be accepted in the edit textbox for the field, when in edit mode. An integer, specifying the maximum number of characters, which the item will accept when in edit mode.
Use the DataFormatString property to provide a custom format for the items in the column. The data format string consists of two parts, separated by a colon, in the form { A : Bxx }.
For example, the formatting string {0:C2} displays a currency formatted number with two decimal places. Note: The entire string must be enclosed in braces to indicate that it is a format string and not a literal string. Any text outside the braces is displayed as literal text. The value before the colon (A in the general example) specifies the parameter index in a zero-based list of parameters.
Note: This value can only be set to 0 because there is only one value in each cell.
The value before the colon (A in the general example) specifies the parameter index in a zero-based list of parameters. The character after the colon (B in the general example) specifies the format to display the value in. The following table lists the common formats.
Format character Description C Displays numeric values in currency format. D Displays numeric values in decimal format. E Displays numeric values in scientific (exponential) format. F Displays numeric values in fixed format. G Displays numeric values in general format. N Displays numeric values in number format. X Displays numeric values in hexadecimal format.
Note: The format character is not case-sensitive, except for X, which displays the hexadecimal characters in the case specified.
The value after the format character (xx in the general example) specifies the number of significant digits or decimal places to display.
For more information on formatting strings, see Formatting Overview (external link to MSDN library).
 Gets or sets the string that specifies the display format for items in the column. A string that specifies the display format for items in the column Gets or sets the readonly status of the column. The column will be displayed in browser mode (unless its Visible property is false) but will not appear in the edit-form. A boolean value, indicating whether a column is ReadOnly. Gets or sets whether the column data can be filtered. A boolean value, indicating whether the column data can be filtered. Gets or sets a whether the column data can be sorted. A boolean value, indicating whether the column data can be sorted. Gets a boolean value, indicating whether the column is editable. A ReadOnly column will return a false value for this property. The property is readOnly. A boolean value, indicating whether the column is editable Defines what button will be rendered in a GridButtonColumn Renders a standard hyperlink button. Renders a standard button. Renders an image that acts like a button. It displays a button for each item in the column. Grid column types This column renderes a button of the specified ButtonType in each corresponding cell of the items of type and . You can use this buttons to fire command events that can be handeled in event handler. This, in combination with the event bubbling mechanism in Telerik RadGrid, allows you to create a column of custom button controls, such as Add, Remove, Select or Edit buttons. The available buttons types are: PushButton,LinkButton and ImageButton. Telerik RadGrid comes with two types of button columns: Select - when a button in this column is pressed, it will select the whole row. The Select column below uses a PushButton. Remove selection - when a button in this column is pressed, it will delete the row. The Remove selection column below uses a LinkButton. 
                <radG:GridButtonColumn FooterText="PushButtonColumn<br/>footer" DataTextFormatString="Select {0}"
        ButtonType="PushButton" UniqueName="column" HeaderText="PushButton<br/>Column"   
        CommandName="Select" DataTextField="CustomerID">
    </radG:GridButtonColumn>
Grid Column types Adding columns design-time Using columns Constructs a new GridButtonColumn object. The Initialize method is inherited by a derived GridButtonColumn class. Is is used to reset a column of the derived type. 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. Returns a copy of the GridButtonColumn. 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 enumeration. LinkButton Renders a standard hyperlink button. PushButton Renders a standard button. ImageButton Renders an image that acts like a button. Gets or sets a value defining the name of the command that will be fired when a button in this column is clicked.
Fired By controls within DataItems - showing and editing data
CancelCommandName Represents the Cancel command name. Fires RadGrid.CancelCommand event and sets Item.Edit to false for the parent Item.
DeleteCommandName Represents the Delete command name. Fires RadGrid.DeleteCommand event. Under .Net 2.0 performs automatic delete operation and then sets Item.Edit to false.
UpdateCommandName Represents the Update command name. Fires RadGrid.UpdateCommand event. Under .Net 2.0 performs automatic update operation and then sets Item.Edit to false.
EditCommandName Represents the Edit command name. Sets Item.Edit to true.
SelectCommandName Represents the Select command name. Sets Item.Selected to true.
DeselectCommandName Represents the Deselect command name. Sets Item.Selected to false.
Can be fired by controls within any Item
InitInsertCommandName By default grid renders an image button in the CommandItem. Opens the insert item.
PerformInsertCommandName Fires RadGrid.InsertCommand event. Under .Net 2.0 Perfoms automatic insert operation and closes the insert item.
RebindGridCommandName By default grid renders an image button in the CommandItem. Forces RadGrid.Rebind
SortCommandName Represents the Sort command name. By default it is fired by image buttons in the header item when Sorting is enabled. The argument for the SortCommand must be the DataField name for the DataField to be sorted.
 Gets or sets an optional parameter passed to the Command event along with the associated CommandName. Use the DataTextField property to specify the field name from the data source to bind to the Text property of the buttons in the GridButtonColumn object. Binding the column to a field instead of directly setting the Text property allows you to display different captions for the buttons in the GridButtonColumn by using the values in the specified field. Tip: This property is most often used in combination with DataTextFormatString Property. Gets or sets a value from the specified datasource field. This value will then be displayed in the GridBoundColumn.
[ASPX/ASCX]<br/><br/><radg:RadGrid id=<font class="string">"RadGrid1"</font> runat=<font class="string">"server"</font>><br/> <MasterTableView AutoGenerateColumns=<font class="string">"False"</font>><br/> <Columns><br/> <radg:GridButtonColumn HeaderText=<font class="string">"Customer ID"</font><font color="red">DataTextField=<font class="string">"CustomerID"</font></font><br/><font color="red">DataTextFormatString=<font class="string">"Edit Customer {0}"</font></font> ButtonType=<font class="string">"LinkButton"</font> UniqueName=<font class="string">"ButtonColumn"</font>><br/> </radg:GridButtonColumn> Use the DataTextFormatString property to provide a custom display format for the caption of the buttons in the GridButtonColumn. Note: The entire string must be enclosed in braces to indicate that it is a format string and not a literal string. Any text outside the braces is displayed as literal text.
[ASPX/ASCX]<br/><br/><radg:RadGrid id=<font color="black"><font class="string">"RadGrid1"</font> runat=<font class="string">"server"</font>><br/> <MasterTableView AutoGenerateColumns=<font class="string">"False"</font>><br/> <Columns><br/> <radg:GridButtonColumn HeaderText=<font class="string">"Customer ID"</font></font><font color="red">DataTextField=<font class="string">"CustomerID"</font><br/>DataTextFormatString=<font class="string">"Edit Customer {0}"</font></font> ButtonType=<font class="string" color="black">"LinkButton"</font> UniqueName=<font color="black"><font class="string">"ButtonColumn"</font>><br/> </radg:GridButtonColumn></font> Gets or sets the string that specifies the display format for the caption in each button. Gets or sets a value indicating the text that will be shown for a button. Gets or sets a value indicating the URL for the image that will be used in a Image button. should be set to ImageButton. 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. 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 . Gets the status of property. If the corresponding is in edit mode specifies whether this column will render an Enabled=true button control, when the corresponding item is edit mode. Displays a CheckBox control for each item in the column. This allows you to edit for example Boolean field(s) from data table(s). Grid column types This column is editable (implements the IGridEditableColumn interface) and provides by default GridBoolColumnEditor, used for editing the text in each item. You can persist the checked state of a checkbox, if you use it within GridTemplateColumn ( see here). 
                <radG:GridCheckBoxColumn FooterText="CheckBoxColumn footer" UniqueName="Bool" HeaderText="CheckBox<br/>Column"
        DataField="Bool">
    </radG:GridCheckBoxColumn>
Grid Column types Adding columns design-time Using columns Similarities/Differences between GridCheckBoxColumn and GridTemplateColumn with checkbox Gets or sets the field name from the specified data source to bind to the column. A string, specifying the data field from the data source, from which to bind the column. Gets or sets the readonly status of the column. If set to true, the column will be displayed in browser mode (unless its Visible property is false) but will not appear in the edit-form. A boolean value, indicating whether a column is ReadOnly. Gets or sets a whether the column data can be sorted. A boolean value, indicating whether the column data can be sorted. Gets or sets whether the column data can be filtered. A boolean value, indicating whether the column data can be filtered. Gets a boolean value, indicating whether the column is editable. A ReadOnly column will return a false value for this property. The property is readOnly. A boolean value, indicating whether the column is editable. A special type of GridButtonColumn, including a delete buttons in each row. It provides the functionality of erasing records client-side, without making a round trip to the server. This optimizes the performance and the source data is automatically refreshed on the subsequent post to the server. The user experience is improved because the delete action is done client-side and the table presentation is updated immediately. Its ConfirmText property can be assigned like with the default GridButtonColumn showing a dialog which allows the user to cancel the action. 
            <radG:GridClientDeleteColumn ConfirmText="Are you sure you want to delete the selected row?" HeaderStyle-Width="35px" ButtonType="ImageButton" ImageUrl="~/RadControls/Grid/Skins/WebBlue/Delete.gif" />
Client-side delete feature Grid column types Client-side delete Web Grid Displays a Checkbox control for each item in the column. This allows you to select grid rows client-side automatically when you change the status of the checkbox to checked. Column types Client selection If you choose AllowMultiRowSelection = true for the grid, a checkbox will be displayed in the column header to toggle the checked/selected stated of the rows simultaneously (according to the state of that checkbox in the header).

To enable this feature you need to turn on the client selection of the grid (ClientSettings -> Selecting -> AllowRowSelect = true). 
            <radG:GridClientSelectColumn UniqueName="CheckboxSelectColumn" HeaderText="CheckboxSelect column <br />" />
Grid Column types Adding columns design-time Using columns The collection of columns of RadGrid or its tables. Accessible through Columns property of RadGrid and GridTableView (MasterTableView) classes. Its items are of the available Grid column types. GridBoundColumn boundColumn; boundColumn = new GridBoundColumn(); boundColumn.DataField = "CustomerID"; boundColumn.HeaderText = "CustomerID"; RadGrid1.MasterTableView.Columns.Add(boundColumn); boundColumn = new GridBoundColumn(); boundColumn.DataField = "ContactName"; boundColumn.HeaderText = "Contact Name"; RadGrid1.MasterTableView.Columns.Add(boundColumn); RadGrid1.MasterTableView.Columns.Add( new GridExpandColumn() ); Dim boundColumn As GridBoundColumn boundColumn = New GridBoundColumn() boundColumn.DataField = "CustomerID" boundColumn.HeaderText = "CustomerID" RadGrid1.MasterTableView.Columns.Add(boundColumn) boundColumn = New GridBoundColumn() boundColumn.DataField = "ContactName" boundColumn.HeaderText = "Contact Name" RadGrid1.MasterTableView.Columns.Add(boundColumn) RadGrid1.MasterTableView.Columns.Add(New GridExpandColumn()) Adds a column object to the GridColumnCollection. The GridColumn object to add to the collection. Determines whether the CridColumnCollection contains the value specified by the given GridColumn object. true if the GridColumn is found in the GridColumnCollection; otherwise, false. GridColumn object to locate in the GridColumnCollection. Determines the index of a specific column in the GridColumnCollection. The index of value if found in the collection; otherwise, -1. The object to locate in the GridColumnCollection. Inserts a column to the GridColumnCollectino at the specified index. The zero-based index at which column should be inserted. The to insert into the collection. Removes the first occurrence of an object from the GridColumnCollection. The object to remove from the collection. Determines the index of a specific column in the GridColumnCollection. The index of value if found in the collection; otherwise, -1. The to locate in the GridColumnCollection. Removes the first occurrence of a column from the GridColumnCollection. The column to remove from the collection. Removes the GridColumnCollection item at the specified index. The zero-based index of the item(column) to remove. Gets the first column with UniqueName found. Throws GridException if no column is found. Gets the first column with UniqueName found. Returns null if no column is found. Gets the first column found bound to the DataField. Throws GridException if no column is bound to this DataField Gets the first column found bound to the DataField. Returns null is no column is bound to this DataField Gets all columns found bound to the DataField specified. Returns null is no column is bound to this DataField Gets the number of columns added programmatically or declaratively. Note that this is not the actual number of column in a . See also RenderColumns Property (Telerik.WebControls.GridTableView) If the column/detail table structure is created after the control has been initialized (indicated by RadGrid.Init event ) the state of the columns/detail tables may have been lost. This happens when properties have been set to GridColumn/GridTableView instance before it has been added to the corresponding collection of Columns/DetailTables. Then a GridException is thrown with message: "Failed accessing GridCollumn by index. Please very that you have specified the structure of RadGrid correctly." Here is the mechanism which Telerik RadGrid uses to present values for GridDropDownColumn. Consider the snippet below: <radg:GridDropDownColumn
UniqueName="LevelID"
ListDataMember="Level"
ListTextField="Description"
ListValueField="LevelID"
HeaderText="LevelID"
DataField="LevelID"
/>
As you can see, a requirement for the proper functioning of GridDropDownColumn is that all column values referenced by the DataField attribute match the column values referenced by the ListValueField attribute.
If there are values in the LevelID column of the LevelID table which do not have corresponding equal values in the LevelID column of the Level table, then the grid will display the default first value from the Description column as it will not "know" what is the correct field. Displays a DropDown control for each item in the column. This allows you to edit for example lookup field(s) from data table(s). Grid column types Grid Column types Adding columns design-time Using columns The ListDataMember property points to the data table (part of the dataset used for grid data-source) which is the source for the GridDropDownColumn generation. A string, specifying the ID of the datasource control, which will be used to populate the dropdown with data. A string, specifying the ID of the datasource control, which will be used to populate the dropdown with data. The ListTextField points to the column in the data table from which the grid will extract the values for the dropdown. The ListValueField points to the column in the data table which will be used as a pointer to retrieve the items for the dropdown in the GridDropDownColumn. The DataField property points to the column in the grid data-source containing values which will be compared at a later stage with the values available in the column, referenced by the %ListValueField:ListValueField% property. Gets or sets a value indicating if this column's items will be visible/available for edit in edit forms. A Boolean value, indicating whether the dropdown column will be bound to a default value/text when there is no data source specified, from which to fetch the data. A Boolean value, specifying whether the dropdown column accepts EmptyListItemText and EmptyListItemValue strings. A string, specifying the text to be displayed in normal mode, when there is no Data Source specified for the column. In edit mode, this value is rendered as a dropdown list item. When in edit mode, and there is a valid DataSource specified for the control, this value is appended as the first item of the dropdown box. A string, specifying the text to be displayed in normal/edit mode, when there is no Data Source specified for the column. A string value, representing the value, associated with the . A string value, representing the value, associated with the . A Boolean value, indicating whether a dropdown column is editable. If it is editable, it will be represented as an active dropdown box in edit mode. A Boolean value, indicating whether a dropdown column is editable. Gets or sets a whether the column data can be sorted. A boolean value, indicating whether the column data can be sorted. A Boolean property, which specifies whether filtering will be enabled for the column. A Bollean value, indicating whether a particular dropdown column can be filtered. Force RadGrid to extract values from EditableColumns that are ReadOnly. See also the method. No values would be extracted from ReadOnly column Values will be extracted only when an item is NOT in edit mode Values will be extracted only when an item is in edit mode Values will be extracted in all cases. Initially only the [Edit] button is shown. When it is pressed, the [Update] and [Cancel] appear at its place and the cells on this row become editable. Grid column types Web Grid 
            <radg:GridEditCommandColumn ButtonType="ImageButton" UpdateImageUrl="..\Img\Update.gif"
    EditImageUrl="..\Img\Edit.gif" InsertImageUrl="..\Img\Insert.gif"
    CancelImageUrl="..\Img\Cancel.gif" UniqueName="EditCommandColumn">
</radg:GridEditCommandColumn>
Grid Column types Adding columns design-time Using columns Gets or sets a value indicating what type of buttons will be used in the GridEditCommandColumn items. Gets or sets a string representing the text that will be used for the Cancel button, in the Edit/Insert form. string, representing the text that will be used for the Cancel button. string, representing the text that will be used for the Edit button. Gets or sets a string, representing the text of the edit linkbutton, which is located in the GridEditCommandColumn, and which will replace the default "Edit" text. A string, representing the text that will be used for the Update button. Gets or sets a string, representing the text that will be used for the Update button. A string, representing the text that will be used for the Insert button. Gets or sets a string, representing a text, which will be displayed instead of the default "Insert" text for the GridEditFormInsertItem item. Gets or sets the URL for the image that will be used to fire the Insert command. This property should be used in conjunction with ButtonType set to ImageButton. string, representing the URL of the image that is used. Gets or sets the URL for the image that will be used to fire the Update command. This property should be used in conjunction with set to ImageButton. string, representing the URL of the image that is used. A string, representing the URL of the image that is used. Gets or sets the URL for the image that will be used to fire the Edit command. This property should be used in conjunction with ButtonType set to ImageButton. A string, representing the url path to the image that will be used instead of the default cancel linkbutton, in the EditForm. A string, representing the url path to the image that will be used instead of the default cancel linkbutton, in the EditForm. Gets or sets a unique name for this column. The unique name can be used to reference particular columns, or cells within grid rows. A string, representing the Unique name of the column. This column appears when the grid has a hierarchical structure, to facilitate the expand/collapse functionality. The expand column is always placed in front of all other grid content columns and can not be moved. Column Types How to hide images of ExpandCollapse column when no records Gets or sets a string, specifying the URL to the image, which will be used instead of the default Expand image for the GridGroupSplitterColumn (the plus sign). A string, specifying the URL to the image, which will be used instead of the default Expand image for the GridGroupSplitterColumn Gets or sets a string, specifying the URL to the image, which will be used instead of the default Collapse image for the GridGroupSplitterColumn (the minus sign). A string, specifying the URL to the image, which will be used instead of the default Collapse image for the GridGroupSplitterColumn Gets a Telerik.WebControls.GridExpandColumnType value, indicating the type of the button. The button of the GridExpandColumn is always of type ImageButton. A Telerik.WebControls.GridExpandColumnType value, indicating the type of the button. Gets or sets a string, specifying the Unique name of the column. The default value is "ExpandColumn". function GridCreated() { } A string, specifying the Unique name of the column. Gets a Boolean value indicating whether the GridGroupSplitterColumn is groupable. This value is always false. Gets a Boolean value indicating whether the GridGroupSplitterColumn is groupable. Gets a Boolean value, indicating whether the GridExpandColumn is reorderable. This value is always false, due to the specificity of the column, which should always be positioned first. A Boolean value, indicating whether the GridExpandColumn is reorderable. Gets or sets a string, representing the CommandName of the GridExpandColumn. The command name's default value is "ExpandCollapse". It can be used to determine the type of command in the ItemCommand event handler. function GridCreated() { } A string, representing the CommandName of the GridExpandColumn. This column appears when grouping is enabled, to facilitate the expand/collapse functionality. The group splitter column is always placed first and can not be moved. Grid Column types Grouping demo with GridGroupSplitterColumn Gets or sets a string, specifying the URL to the image, which will be used instead of the default Expand image for the GridGroupSplitterColumn (the plus sign). A string, specifying the URL to the image, which will be used instead of the default Expand image for the GridGroupSplitterColumn Gets or sets a string, specifying the URL to the image, which will be used instead of the default Collapse image for the GridGroupSplitterColumn (the minus sign). A string, specifying the URL to the image, which will be used instead of the default Collapse image for the GridGroupSplitterColumn Gets a Boolean value indicating whether the GridGroupSplitterColumn is groupable. This value is always false. Gets a Boolean value indicating whether the GridGroupSplitterColumn is groupable. This property is for internal usage. An enumeration, used to get/set the button type of the headers of the columns. The default value is LinkButton. The possible values are: LinkButton PushButton TextButton If set to a value other than LinkButton, the property is only honored when sorting is enabled. Each row in a Hyperlink column will contain a predefined hyperlink. This link is not the same for the whole column and can be defined for each row individually. Grid column types The content of the column can be bound to a field in a data source or to a static text. You can customize the look of the links by using CSS classes. You can set multiple fields to a GridHyperlinkColumn through its DataNavigateUrlFields property. These fields can later be used when setting the DataNavigateUrlFormatString property and be part of a query string: 
            							
            <radG:GridHyperLinkColumn
     DataNavigateUrlFields= "ProductID,OrderID"
     DataNavigateUrlFormatString= "~/Details.aspx?ProductID={0}&OrderID={1}">
</radG:GridHyperLinkColumn>
Grid Column types Adding columns design-time Using columns Gets or sets a string, specifying the DataField from the data source, which will supply the text for the url, which will be the target of the current window/frame. A string, specifying the DataField from the data source, which will supply the text for the url, which will be the target of the current window/frame. Gets or sets a string, representing a comma-separated enumeration of DataFields from the data source, which will form the url of the windwow/frame that the hyperlink will target. A string, representing a comma-separated enumeration of DataFields from the data source, which will form the url of the windwow/frame that the hyperlink will target. Gets or sets a string, specifying the FormatString of the DataNavigateURL. Essentially, the DataNavigateUrlFormatString property sets the formatting for the url string of the target window or frame. A string, specifying the FormatString of the DataNavigateURL. Gets or sets a string, representing the DataField name from the data source, which will be used to supply the text for the hyperlink in the column. This text can further be customized, by using the DataTextFormatString property. A string, representing the DataField name from the data source, which will be used to supply the text for the hyperlink in the column. Gets or sets a string, specifying the format string, which will be used to format the text of the hyperlink, rendered in the cells of the column. A string, specifying the format string, which will be used to format the text of the hyperlink, rendered in the cells of the column. Gets or sets a string, specifying the url, to which to navigate, when a hyperlink within a column is pressed. This property will be honored only if the DataNavigateUrlField and DataNavigateUrlFields are not set. If either DataNavigateUrlField or DataNavigateUrlFields are set, they will override the NavigateUrl property. A a string, specifying the url, to which to navigate, when a hyperlink within a column is pressed. Sets or gets a string, specifying the window or frame at which to target content. The possible values are: _blank - the target URL will open in a new window
_self - the target URL will open in the same frame as it was clicked
_parent - the target URL will open in the parent frameset
_top - the target URL will open in the full body of the window A string, specifying the window or frame at which to target content. Gets or sets a string, specifying the text to be displayed by the hyperlinks in the column, when there is no DataTextField specified. A string, specifying the text to be displayed by the hyperlinks in the column, when there is no DataTextField specified. Gets or sets whether the column data can be filtered. The default value is true. A Boolean value, indicating whether the column can be filtered. Displays each item in the column in accordance with a specified templates (item, edit item, header and footer templates). This allows you to provide custom controls in the column. Grid column types 
            <radG:GridTemplateColumn UniqueName="TemplateColumn" SortExpression="CompanyName">
    <FooterTemplate>
<img src="Img/image.gif" alt="" style="vertical-align: middle" />
        Template footer
   
            </FooterTemplate>
    <HeaderTemplate>
        
            <table id="Table1" cellspacing="0" cellpadding="0" width="300" border="1">
            <tr>
<td colspan="2" align="center">
                    <b>Contact details</b></td>
</tr>
            <tr>
                <td style="width: 50%" align="center">
 
            <asp:LinkButton CssClass="Button" Width="140" ID="btnContName" Text="Contact name"
 
            ToolTip="Sort by ContactName" CommandName='Sort' CommandArgument='ContactName'
                       
            runat="server" /></td>
                <td style="width: 50%" align="center">
 
            <asp:LinkButton CssClass="Button" Width="140" ID="btnContTitle" Text="Contact title"
      
            ToolTip="Sort by ContactTitle" CommandName='Sort' CommandArgument='ContactTitle'
      
            runat="server" /></td>
            </tr>
        </table>
   
            </HeaderTemplate>
    <ItemTemplate>
      
            <table cellpadding="1" cellspacing="1" class="customTable">
         
            <tr>
                <td style="width: 50%">
     
            </%# Eval("ContactName") /%>
                </td>
 
            <td style="width: 50%">
          
            </%# Eval("ContactTitle") /%>
            
            </td>
            </tr>
            <tr>
     
            <td colspan="2" align="center">
                   
            <a href='</%# "http://www.google.com/search?hl=en&q=" + DataBinder.Eval(Container.DataItem, "ContactName") + "&btnG=Google+Search"/%>'>
   
            <em>Search Google for
                            </%# Eval("ContactName") /%>
 
            </em></a>
                </td>
            </tr>
            <tr>
<td colspan="2" align="center">
                    <img src="Img/image.gif" alt="" />
 
            </td>
            </tr>
        </table>
    
            </ItemTemplate>
</radG:GridTemplateColumn>
Grid Column types Adding columns design-time Using columns Customizing with GridTemplateColumn Persisting CheckBox control state in GridTemplateColumn on Rebind You can view and set templates using the Edit Templates command in grid's Smart Tag. You can also create the template columns programmatically and bind the controls in the code-behind (see Programmatic creation of Telerik RadGrid). Note: Unlike other grid columns, GridTemplateColumn cannot be set as read-only. Programmatic creation Gets or sets a string, specifying which DataField from the data source the control will use to handle the automatic filtering. A string, specifying which DataField from the data source the control will use to handle the automatic filtering. Gets or sets whether the column data can be filtered. The default value is true. A Boolean value, indicating whether the column can be filtered. Template that will generate controls in the corresponding cell if the item is in edit mode. Gets or sets the Controls, which will be rendered in the footer of the template column. A value of type System.Web.UI.CompiledTemplateBuilder. Gets or sets the Controls, which will be rendered in the header of the template column. A value of type System.Web.UI.CompiledBindableTemplateBuilder. Gets or sets the ItemTemplate, which is rendered in the control in normal (non-Edit) mode. A value of type System.Web.UI.CompiledBindableTemplateBuilder Gets a Boolean value, indicating whether the column is editable. If a template column is editable, it will render the contents of the EditItemTemplate in the edit form. If there are no contents in the EditItemTemplate, the column will not be editable. A Boolean value, indicating whether the column is editable. Set to false if templates should overwrite other controls in header cell (sort image, etc) Summary description for ControlBuilderForm. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for GridBordersPageControl. Summary description for GridPropertyPageControl. Checks if it is the first time a property page control has been activated Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for GridColumnsPageControl. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for GridFormatPageControl. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for GridGeneralPageControl. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for GridPagingPageControl. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Summary description for GridGeneralPageControl. Required designer variable. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Type of the edit forms in RadGrid Form is autogenerated, based on the column that each GridTableView exposes. The edit form is a WebUserControl specified by The template specified by is used as an edit form. Settings for the edit forms generated by a for each item that is in edit mode and the is set to . Set the type of the EditForm using . If the type is then the form will be autogenerated based on the columns of the corresponding table view. Note that only the columns that are editable wil be included. Those are the standatrd columns that have editing capabilities - such that has set to false. All the style properties apply only to the autogenerated edit form. See for more details on the types of the edit forms. Set properties of the update-cancel buttons column that appears in an edit form Number of vertical columns to split all edit fields on the form when it is autogenerated. Each GridColumn has a to choose the column where the editor would appear. Data field to incude in form's caption Caption format string - {0} parameter must be included and would be repaced with DataField value Style of the forms's area (rendered as a DIV elemet) Style of the forms' table element Style of the forms' main table element Style of the table row that shows the caption of the form Style of the normal rows in the edit-form's table Style of the alternating rows in the edit-form's table Style of the footer row of the table, where the update-cancel buttons appear Specifies the type of the edit form. See about details for the possible values and their meanings. EditForm template - if EditFormType if is of type . Summary description for GridEditManager. Summary description for GridColumnsEditorForm. Summary description for GridEditorForm. Clean up any resources being used. Required method for Designer support - do not modify the contents of this method with the code editor. Disable visual designer Summary description for GridColumnsEditorForm. This implementation allows grid property-page-control to work properly on both grid editor forms - GridEditorForm and GridComponentEditor PropertyPage control that is empty - used as default property page of GridEditorForm Checks if it is the first time a property page control has been activated Item that is displayed on top or at the bottom of the each GridTableView base on the settings of property. Generally this item displays by default "Add new record" and "Refresh" button, but it can be customized using the . The commands bubbled through this item will be fired by RadGrid.ItemCommand event. Class that represents the rows of each GridTableView with RadGrid. All Items in RadGrid inherit from this class. RadGrid creates the items runtime, when it binds to data. Initializes the base properties of an item. Use this method to simulate item command event that bubbles to RadGrid and can be handeled automatically or in a custom manner, handling RadGrid.ItemCommand event. command to bubble, for example 'Page' command argument, for example 'Next' This method is not intended to be used directly from your code. This method is not intended to be used directly from your code This method is not intended to be used directly from your code Override this method to change the default logic for rendering the item Used after postback before ViewState becomes available - for example in ItemCreated and ItemDataBound events //get MasterTableView's second (index 1) nested view item GridNestedViewItem firstLevelNestedViewItem = (GridNestedViewItem)RadGrid1.MasterTableView.GetItems(GridItemType.NestedView)[1]; //get second nested view item at level 2 of the hierarchy GridNestedViewItem secondLevelNestedViewItem = (GridNestedViewItem)firstLevelNestedViewItem.NestedTableViews[0].GetItems(GridItemType.NestedView)[1]; //get the first item to be expanded GridItem itemToExpand = secondLevelNestedViewItem.NestedTableViews[0].GetItems(GridItemType.Item)[0]; itemToExpand.ExpandHierarchyToTop(); 'get MasterTableView's second (index 1) nested view item Dim firstLevelNestedViewItem As GridNestedViewItem = CType(RadGrid1.MasterTableView.GetItems(GridItemType.NestedView)(1), GridNestedViewItem) 'get second nested view item at level 2 of the hierarchy Dim secondLevelNestedViewItem As GridNestedViewItem = CType(firstLevelNestedViewItem.NestedTableViews(0).GetItems(GridItemType.NestedView)(1), GridNestedViewItem) 'get the first item to be expanded Dim itemToExpand As GridItem = secondLevelNestedViewItem.NestedTableViews(0).GetItems(GridItemType.Item)(0) itemToExpand.ExpandHierarchyToTop() Expands the hierarchy starting from the last level to the top Calculate column-span value for a cell using column list, when the cell indicated with FromCellIndex should be spanned to ToCellIndex columns - visible property is taken in count cell inbdex of spanned cell cell index of next not-spanned cell or -1 for the last cell index ColSpan number Gets a reference to the GridTableView that owns this GridItem. You can use the OwnerTableView property to get an instance of the GridTableView that holds the item modified. For example in the SelectedIndexChanged event handler you can get the GridTableView object like this: protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e) { GridTableView tableview = RadGrid1.SelectedItems[0].OwnerTableView; } Protected Sub RadGrid1_SelectedIndexChanged(sender As Object, e As EventArgs) Dim tableview As GridTableView = RadGrid1.SelectedItems(0).OwnerTableView End Sub Gets the ClientID of the GridTableView that owns this instance. The OwnerID property will get the ClientID of the GridTableView that owns the referenced instance. For example the code below will return RadGrid1_ctl01 which is the ClientID of the MasterTableView for basic RadGrid: protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e) { Label1.Text = RadGrid1.SelectedItems[0].OwnerID; } Protected Sub RadGrid1_SelectedIndexChanged(sender As Object, e As EventArgs) Label1.Text = RadGrid1.SelectedItems(0).OwnerID End Sub Gets the ClientID of the RadGrid instance that owns the item. The OwnerGridID property will get the ClientID of the Grid instance that owns the referenced item. For example the code below will return RadGrid1 which is the ClientID of the owner Grid instance. protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e) { if (e.Item is GridEditableItem && e.Item.IsInEditMode) { Response.Write(e.Item.OwnerGridID); } } Protected Sub RadGrid1_ItemCreated(sender As Object, e As GridItemEventArgs) If Typeof e.Item Is GridEditableItem And e.Item.IsInEditMode Then Response.Write(e.Item.OwnerGridID) End If End Sub This would be useful if several controls use the same eventhandler and you need to diferentiate the Grid instances in the handler. Gets a value indicating whether this item has child items - or items somehow related to this. For example the GridDataItem has child NestedViewItem that holds the hierarchy tables when grid is rendering hierarchy.
GroupHeaderItems has the items with a group for children, and so on. protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e) { if (e.Item is GridItem && (e.Item as GridItem).HasChildItems == true) { Label1.Text = "has items"; } } Gets a value indicating whether the item can be "expanded" to show its child items Shows whether an item can be "expanded" to show its child items protected void RadGrid1_ItemCreated(object sender, GridItemEventArgs e) { if (e.Item is GridItem && (e.Item as GridItem).CanExpand == true) { Label1.Text = "Item was expanded"; } } The original DataItem from the DataSource. See examples section below. For example if you bind the grid to a DataView object the DataItem will represent the DataRowView object extracted from the DataView for this GridItem. Note that the DataItem object is available only when grid binds to data. Gets the index of the GridDataItem in the underlying DataTable/specified table from a DataSet. Integer This property has a meaning only when the Telerik RadGrid source is DataTable. Gets the index of the grid item among the collection. This index also can be used to get the DataKeyValues corresponding to this item from a GridTableView. Gets a value representing the index of this item among the collection. This index also can be used to get the DataKeyValues corresponding to this item from a GridTableView. Gets the index of the row as in the html table object rendered on the client Gets the index of the item in the rows collection of the underlying Table server control Get the unique item index among all the item in the hierarchy. This index is used when setting item to selected, edited, etc If we have three level hierarchy with two items each and select the first item in the third level then the ItemIndexHierarchical will be 1:0_1:0_0 protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e) { Response.Write(RadGrid1.SelectedItems[0].ItemIndexHierarchical); } Protected Sub RadGrid1_SelectedIndexChanged(sender As Object, e As EventArgs) Response.Write(RadGrid1.SelectedItems(0).ItemIndexHierarchical) End Sub 'RadGrid1_SelectedIndexChanged Gets the respective GridItemType of the grid item. Gets the respective GridItemType of the grid item. foreach (GridItem dataItem in rgdStateRules.MasterTableView.Items) { if (dataItem.ItemType == GridItemType.Item || dataItem.ItemType == GridItemType.AlternatingItem) { string reqName = dataItem["SomeColumnUniqueName"]. Text; .... } } Dim dataItem As GridItem For Each dataItem In rgdStateRules.MasterTableView.Items If dataItem.ItemType = GridItemType.Item Or dataItem.ItemType = GridItemType.AlternatingItem Then Dim reqName As String = dataItem("SomeColumnUniqueName").Text End If Next dataItem Gets or sets a value indicating whether the grid item is expanded or collapsed. The example below sets all expanded items to collapsed for(int i = 0; i < RadGrid.Items.Count - 1;i++) if(RadGrid.Items[i].Expanded) { RadGrid.Items[i].Expanded = false; } Dim i As Integer For i = 0 To (RadGrid.Items.Count - 1) Step -1 If RadGrid.Items(i).Expanded Then RadGrid.Items(i).Expanded = False End If Next i The example below will hide the GridCommandItem. if (e.Item is GridCommandItem) { e.Item.Display = false; } If Typeof e.Item Is GridCommandItem Then e.Item.Display = False End If Sets whether the GridItem will be visible or with style="display:none;" Gets or set a value indicating whether the grid item is selected You can check whether a certain item is selected using the Selected property: protected void RadGrid1_PreRender(object sender, EventArgs e) { foreach (GridDataItem dataitem in RadGrid1.MasterTableView.Items) { if (dataitem.Selected == true) { //do your thing } } } Protected Sub RadGrid1_PreRender(sender As Object, e As EventArgs) Dim dataitem As GridDataItem For Each dataitem In RadGrid1.MasterTableView.Items If dataitem.Selected = True Then 'do your thing End If Next dataitem End Sub 'RadGrid1_PreRender Sets the Item in edit mode. Requires Telerik RadGrid to rebind. If is set to InPlace, the grid column editors will be displayed inline of this item. If is set to InForms, a new GridItem will be created, which will be child of this item. The new item will hold the edit form. We suggest using IsInEditMode instead of Edit to check whether an Item is in edit more or not. Gets the index of the Item in the group. This works only when grouping. This example expands all items that meet the condition: if (e.Item.GroupIndex == EditItemGroupIndex | EditItemGroupIndex.StartsWith(e.Item.GroupIndex + "_")) { e.Item.Expanded = true; } If e.Item.GroupIndex = EditItemGroupIndex Or EditItemGroupIndex.StartsWith(e.Item.GroupIndex & "_") Then e.Item.Expanded = True End If Returns a string formed: X_Y_Z, where:
- X is a zero-based value representing the group index (the first group of results will have index = 0) - Y is a zero-based value representing the group level. If you group the grid using 2 criteria, the inner groups will have index = 1. - Z is a zero-based value representing the GridItem index in the group (the first item will have index = 0) Note that if you use more criteria, you will have more indexes returned: X_Y_Z_W, where the last one is always the item index in the group. Gets a value indicating whether the grid item is bound to a data source. Default value is true when the grid is databound. Gets a value indicating whether the grid item is in edit mode at the moment. Will locate the TextBox for Item in Edit mode: if (e.Item is GridEditableItem && e.Item.IsInEditMode) { TextBox txt = (e.Item as GridEditableItem)["SomeColumnName"].Controls[0] as TextBox; } If Typeof e.Item Is GridEditableItem And e.Item.IsInEditMode Then ... End If Represents the base class for any items that display and edit data in a GridTableView of RadGrid. Inheritors has the capabilities to: Locate a table cell based on the column unique names Extract values from the cells of column editors Has a dictionary of saved-old-values that are necessary for optimistic concurency editing oprations Edit/browse mode EditManager instance, which is capable of locating the column editors Extracts values for each column, using This dictionary to fill, this parameter should not be null Get the DataKeyValues from the owner GridTableView with the corresponding item ItemIndex and keyName. The keyName should be one of the specified in the array data key name data key value Allows you to access the column editors GridEditManager editMan = editedItem.EditManager; IGridEditableColumn editableCol = (column as IGridEditableColumn); IGridColumnEditor editor = editMan.GetColumnEditor( editableCol ); Dim editMan As GridEditManager = editedItem.EditManager Dim editableCol As IGridEditableColumn = CType(column, IGridEditableColumn) Dim editor As IGridColumnEditor = editMan.GetColumnEditor(editableCol) Gets the old value of the edited item foreach (DictionaryEntry entry in newValues) { Label1.Text += "\n<br />Key: " + entry.Key + "<br />New value: " + entry.Value + "<br /> Old value: " + editedItem.SavedOldValues[entry.Key] + "<br />"; } For Each entry As DictionaryEntry In newValues Label1.Text += "" & Microsoft.VisualBasic.Chr(10) & "<br />Key: " + entry.Key + "<br />New value: " + entry.Value + "<br /> Old value: " + editedItem.SavedOldValues(entry.Key) + "<br />" Next string keyValues = ((GridEditableItem)e.Item).KeyValues; if (keyValues.Contains("CustomerID")) Session["CustomerID"] = keyValues.Substring(13, keyValues.Length - 1); else Session["OrderID"] = keyValues.Substring(10, keyValues.Length - 1); Dim keyValues As String = CType(e.Item, GridEditableItem).KeyValues If keyValues.Contains("CustomerID") Then Session("CustomerID") = keyValues.Substring(13, keyValues.Length - 1) Else Session("OrderID") = keyValues.Substring(10, keyValues.Length - 1) End If Summary description for GridDataItem. Sets the visibility of the children items. This method is for Telerik RadGrid internal usage. This method is for Telerik RadGrid internal usage. Item that loads an EditForm during binding if is . When in this mode RadGrid loads an EditFormItem for each normal data-bound item. EditForm is generated only for the items that are in = true mode. The table cell where the edit form will be instantiated, during data-binding. FormColumns are only available when EditFormType is GridEditFormType.AutoGenerated. These are the container controls for each edit-form-column. You cna find the edit controls in these containers. You should not remove any controls from this containers. The corresponding DataItem that the edit form is generated for. It's an item, displaying input controls, which allows user to enter a filter values for each visible column in a GridTableView. By default the columns render a textbox and a button, displaying the filtering menu on click. This item is visible based on the settings of property. The items is displayed right under the header row of a GridTabelView. Setting filter textbox dimensions/changing default filter image Protected Sub RadGrid1_ItemCreated(sender As Object, e As GridItemEventArgs) Handles RadGrid1.ItemCreated If Typeof e.Item Is GridFilteringItem Then Dim filteringItem As GridFilteringItem = CType(e.Item, GridFilteringItem) 'set dimensions for the filter textbox Dim box As TextBox = CType(filteringItem("ContactName").Controls(0), TextBox) box.Width = Unit.Pixel(30) 'set ImageUrl which points to your custom image Dim image As Image = CType(filteringItem("ContactName").Controls(1), Image) image.ImageUrl = "<my_image_url>" End If End Sub 'RadGrid1_ItemCreated Protected void RadGrid1_ItemCreated(Object sender, GridItemEventArgs e) { If (e.Item Is GridFilteringItem) { GridFilteringItem filteringItem = e.Item As GridFilteringItem; //Set dimensions For the filter textbox TextBox box = filteringItem["ContactName"].Controls[0] As TextBox; box.Width = Unit.Pixel(30); //Set ImageUrl which points To your custom image Image image = filteringItem["ContactName"].Controls[1] As Image; image.ImageUrl = "<my_image_url>"; } } Displays the footer row of a GridTableView with cells for each column in the grid similar to GridHeaderItem. The item which splits the groups (when utilizing the grouping feature of RadGrid) and provides expand/collapse functionality for them. Here is how you can get reference to the GridGroupHeaderItem on ItemDataBound: Private Sub RadGrid1_ItemDataBound(sender As Object, e As Telerik.WebControls.GridItemEventArgs) If Typeof e.Item Is GridGroupHeaderItem Then Dim item As GridGroupHeaderItem = CType(e.Item, GridGroupHeaderItem) 'do something here End If End Sub 'RadGrid1_ItemDataBound private void RadGrid1_ItemDataBound(object sender, Telerik.WebControls.GridItemEventArgs e) { if ( e.Item is GridGroupHeaderItem ) { GridGroupHeaderItem item = (GridGroupHeaderItem)e.Item; //do something here } } } Created and meaningful only with grouping enabled. should be applied to have such type of item(s). Customize GridGroupHeaderItem Performing calculations in group header Marked for internal usage only Inherited from Control, for internal usage only Inherited from Control, for internal usage only Inherited from Control, for internal usage only Method which returns the data items under the group. An array of GridItem instances The code below can be used to loop through the data items in a group on button click handler (for example): Dim groupHeader As GridGroupHeaderItem = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)(0) Dim groupItems As GridItem() = groupHeader.GetChildItems() 'traverse the items and operate with them further GridGroupHeaderItem groupHeader= RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)[0] as GridGroupHeaderItem; GridItem [] groupItems = groupHeader.GetChildItems(); //traverse the items and operate with them further Meaningful only with grouping enabled. should be applied to have available. Method which shows/hides the items in the group designated by the N/A The code below will hide the items under the first group in the grid: Dim groupHeader As GridGroupHeaderItem = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)(0) groupHeader.SetVisibleChildren(False) GridGroupHeaderItem groupHeader = RadGrid1.MasterTableView.GetItems(GridItemType.GroupHeader)[0] as GridGroupHeaderItem; groupHeader.SetVisibleChildren(false); Meaningful only with grouping enabled. should be applied to have available. boolean, determines whether the items in the group will be displayed or hidden The cell holding the content of the N/A Below is a sample code presenting how to customize the DataCell content dynamically on ItemDataBound: Private Sub RadGrid1_ItemDataBound(sender As Object, e As Telerik.WebControls.GridItemEventArgs) If Typeof e.Item Is GridGroupHeaderItem Then Dim item As GridGroupHeaderItem = CType(e.Item, GridGroupHeaderItem) Dim groupDataRow As DataRowView = CType(e.Item.DataItem, DataRowView) 'Clear the present text of the cell item.DataCell.Text = "" Dim column As DataColumn For Each column In groupDataRow.DataView.Table.Columns 'Check the condition and add only the field you need If column.ColumnName = "Country" Then item.DataCell.Text += "Customized display - Country is " + groupDataRow("Country").ToString() End If Next column End If End Sub 'RadGrid1_ItemDataBound Private void RadGrid1_ItemDataBound(Object sender, Telerik.WebControls.GridItemEventArgs e) { If ( e.Item Is GridGroupHeaderItem ) { GridGroupHeaderItem item = (GridGroupHeaderItem)e.Item; DataRowView groupDataRow = (DataRowView)e.Item.DataItem; //Clear the present text of the cell item.DataCell.Text = ""; foreach( DataColumn column In groupDataRow.DataView.Table.Columns) //Check the condition And add only the field you need If ( column.ColumnName == "Country" ) { item.DataCell.Text += "Customized display - Country is " + groupDataRow ["Country"].ToString(); } } } Created and meaningful only with grouping enabled. should be applied to have with DataCell. Customize GridGroupHeaderItem Performing calculations in group header Boolean property indicating whether the relevant has child items inside the group it forms. boolean Dim groupHeader As GridGroupHeaderItem = grid.MasterTableView.GetItems(GridItemType.GroupHeader)(0) If (groupHeader.HasChildItems) Then 'operate with the items Else 'do something else End If GridGroupHeaderItem groupHeader = grid.MasterTableView.GetItems(GridItemType.GroupHeader)[0] as GridGroupHeaderItem; if (groupHeader.HasChildItems) { //operate with the items } else { //do something else } Meaningful only with grouping enabled. should be applied to have with this boolean property. Marked for internal usage Summary description for GridHeaderItem. Summary description for GridMultiRowItem. Item that contains the nested instances of GridTableView class, that appear as a child item of the corresponding GridDataItem The child tables will be created when grid is databinding and will be added as controls of the Then these tables can also be accessed using the array. Creates an instance of GridNestedViewItem For internal usage only. An instance of GridTableView Class, which will contain the created item The value for ItemIndex Property (Telerik.WebControls.GridItem) property The value for DataSetIndex Property (Telerik.WebControls.GridItem) property Defines the default logic for rendering the item. For internal usage only. This method is not intended to be used directly from your code This method is not intended to be used directly from your code Gets the cell that contains the . System.Web.UI.WebControls.TableCell foreach (GridNestedViewItem nestedViewItem in radgrid1.MasterTableView.GetItems(GridItemType.NestedView)) { TableCell cell = nestedViewItem.NestedViewCell; cell.BorderColor = System.Drawing.Color.Red; } Dim nestedViewItem As GridNestedViewItem For Each nestedViewItem In RadGrid1.MasterTableView.GetItems(GridItemType.NestedView) Dim cell As TableCell = nestedViewItem.NestedViewCell cell.BorderColor = System.Drawing.Color.Red Next nestedViewItem Gets an array of GridTableView objects residing in the . GridTableView nestedTable = RadGrid1.MasterTableView.Items[0].ChildItem.NestedTableViews[0]; Dim nestedTable As GridTableView = RadGrid1.MasterTableView.Items(0).ChildItem.NestedTableViews(0) GridNoRecordsItem is used to display no records template, in the corresponding table view has is set to true (the default) Summary description for GridPagerItem. Gets the position of the pager in the RadGrid. Default value is false. if (((GridPagerItem)this.Item).IsTopPager) { Item.Visible = false; return; } If CType(Me.Item, GridPagerItem).IsTopPager Then Item.Visible = False Return End If The Cell where the PagerItems are located if (e.Item is GridPagerItem) { GridPagerItem pagerItem = (e.Item as GridPagerItem); pagerItem.PagerContentCell.Controls.Clear(); //custom paging } If Typeof e.Item Is GridPagerItem Then Dim pagerItem As GridPagerItem = CType(e.Item, GridPagerItem) pagerItem.PagerContentCell.Controls.Clear 'custom paging End If GridStatusBarItem is used to display information messages for Telerik RadGrid status. Meaningful only when Telerik RadGrid is in AJAX mode. GridGroupPanel appears on the top of Telerik RadGrid when ShowGroupPanel of RadGrid is set to true and if is set to true, you can drag column to the panel to group data by that column. Basic Grouping Traversing items in group panel protected void RadGrid1_PreRender(object sender, System.EventArgs e) { TableCell cell; foreach (cell in RadGrid1.GroupPanel.GroupPanelItems) { Control ctrl; foreach (ctrl in cell.Controls) { if (ctrl is ImageButton) { ImageButton button = ctrl as ImageButton; button.ImageUrl = "<my_img_url>"; button.CausesValidation = false; } } } } Protected Sub RadGrid1_PreRender(ByVal sender As Object, ByVal e As System.EventArgs) Handles RadGrid1.PreRender Dim cell As TableCell For Each cell In RadGrid1.GroupPanel.GroupPanelItems Dim ctrl As Control For Each ctrl In cell.Controls If (Typeof ctrl Is ImageButton) Then Dim button As ImageButton = CType(ctrl, ImageButton) button.ImageUrl = "<my_img_url>" button.CausesValidation = False End If Next ctrl Next cell End Sub Group by fields (displayed in the GroupPanel) are defined through the GridGroupByExpressions. For internal usage only. Gets a collection of items displayed in the group panel. These items represent the GroupByFields used for Telerik RadGrid grouping. protected void RadGrid1_PreRender(object sender, System.EventArgs e) { TableCell cell; foreach (cell in RadGrid1.GroupPanel.GroupPanelItems) { Control ctrl; foreach (ctrl in cell.Controls) { if (ctrl is ImageButton) { ImageButton button = ctrl as ImageButton; button.ImageUrl = "<my_img_url>"; button.CausesValidation = false; } } } } Protected Sub RadGrid1_PreRender(ByVal sender As Object, ByVal e As System.EventArgs) Handles RadGrid1.PreRender Dim cell As TableCell For Each cell In RadGrid1.GroupPanel.GroupPanelItems Dim ctrl As Control For Each ctrl In cell.Controls If (Typeof ctrl Is ImageButton) Then Dim button As ImageButton = CType(ctrl, ImageButton) button.ImageUrl = "<my_img_url>" button.CausesValidation = False End If Next ctrl Next cell End Sub Traversing items in group panel Gets or sets the text displayed in the group panel to urge the user dragging a column to group by. 
            <GroupPanel Text="Drag here the column you need to group by."></GroupPanel>
Note that the GroupPanel Text has a default value, so you don't need to set it generally. Gets the style that will be used for the group panel. 
                <GroupPanel Text="Drag a column here.">
        <PanelStyle BackColor="Aqua" BorderStyle="Dotted" />
    </GroupPanel>
Gets the style that will be used for the group panel items. 
                <GroupPanel Text="Drag a column here.">
        <PanelStyle BackColor="Aqua" BorderStyle="Dotted" />
        <PanelItemsStyle BackColor="Black" Font-Italic="true"/>
    </GroupPanel>
Gets or sets a value indicating whether the group panel will be displayed. true, if group panel is visible, otherwise false (the default value). Summary description for GridGroupPanelStyle. This class represents a generic menu that could be used in RadGrid. Currently it is used for the filtering menu (). Gets a reference to the parent RadGrid object. This property is for RadGrid internal usage. Gets or sets if this menu would be visible true, if the menu would be visible, otherwise false. Gets a collection of all menu items. returns a of all menu items. You cannot use this property to modify the Items for this menu. For this purpose use the objet that this property returns. Gets or sets the URL to the image that will be displayed when an item in this menu is selected. Gets or sets the URL to the image that will be displayed for all items in this menu that are not selected. Gets or sets the of the stripe that appears on the left side of the menu and hold the selector image. the of the stripe that holds the selector image Gets or sets the of the text in the menu. the of the text in the menu. Gets or sets the that will be applied to the background when this item is hovered. The color that is used for the item's background. Gets or sets the that will be applied to the border lines of the menu item. The that is used for the borders of the menu item. Gets or sets the name of the CSS class that will be used for customizing the menu. The name of the CSS class used for customizing the menu as . Gets a ControlCollection object that represents the child controls for this menu in the UI hierarchy. with the child controls for this menu. The Controls property allows you programmatic access to the instance of the ControlCollection class for any server control. You can add controls to the collection, remove controls from the collection, or iterate through the server controls in the collection. Represents the filtering menu for Telerik RadGrid. Constructs a new GridFilterMenu object. the RadGrid object that will hold this menu This class represents a single item in the menu. Gets a reference to the that holds this item. This event fires when an item in this menu is clicked. The following example demonstrates how to handle the OnClick event and set custom filter function. First you set the and properties for this menu item, then in the event handler, you fire the "Filter" event and pass the menu item as an ergument in pair. override protected void OnInit(EventArgs e) { private void InitializeComponent() { this.Init += new EventHandler(WebForm1_Init); this.Load += new System.EventHandler(this.Page_Load); RadGrid1.NeedDataSource += new Telerik.WebControls.GridNeedDataSourceEventHandler(RadGrid1_NeedDataSource); } private void RadGrid1_NeedDataSource(object source, Telerik.WebControls.GridNeedDataSourceEventArgs e) { RadGrid1.DataSource = DataSourceHelperCS.GetDataTable("SELECT * FROM Customers"); } private void WebForm1_Init(object sender, EventArgs e) { RadGrid1.FilterMenu.Items.Clear(); GridMenuItem menuItem = new GridMenuItem(); RadGrid1.FilterMenu.Items.Add(menuItem); menuItem.Text = "Custom-Text (Contains)"; menuItem.Value = "Contains"; menuItem.OnClick += new GridMenuItemClickEventHandler(menuItem_OnClick); } private void menuItem_OnClick(GridMenuItem sender, GridMenuItemClickEventArgs e) { GridFilteringItem filterItem = RadGrid1.MasterTableView.GetItems(GridItemType.FilteringItem)[0] as GridFilteringItem; GridMenuItem menuItem = sender as GridMenuItem; filterItem.FireCommandEvent( "Filter", new Pair(menuItem.Value, e.ColumnName)); } Protected Overrides Sub OnInit(ByVal e As EventArgs) Dim InitializeComponent As System.Void AddHandler Init, AddressOf Me.WebForm1_Init AddHandler Load, AddressOf Me.Page_Load AddHandler RadGrid1.NeedDataSource, AddressOf Me.RadGrid1_NeedDataSource End Sub Private Sub RadGrid1_NeedDataSource(ByVal source As Object, ByVal e As Telerik.WebControls.GridNeedDataSourceEventArgs) RadGrid1.DataSource = DataSourceHelperCS.GetDataTable("SELECT * FROM Customers") End Sub Private Sub WebForm1_Init(ByVal sender As Object, ByVal e As EventArgs) RadGrid1.FilterMenu.Items.Clear Dim menuItem As GridMenuItem = New GridMenuItem RadGrid1.FilterMenu.Items.Add(menuItem) menuItem.Text = "Custom-Text (Contains)" menuItem.Value = "Contains" AddHandler menuItem.OnClick, AddressOf Me.menuItem_OnClick End Sub Private Sub menuItem_OnClick(ByVal sender As GridMenuItem, ByVal e As GridMenuItemClickEventArgs) Dim filterItem As GridFilteringItem = CType(RadGrid1.MasterTableView.GetItems(GridItemType.FilteringItem)(0),GridFilteringItem) Dim menuItem As GridMenuItem = CType(sender,GridMenuItem) filterItem.FireCommandEvent("Filter", New Pair(menuItem.Value, e.ColumnName)) End Sub Gets or sets a value indicating if this specific item is selected. true, if item is selected, otherwise false. You can customize the selected item, using the property. Gets or sets the Text for the specific item. You can use this property in conjunction with the property to create you own custom menu Items. The following example demonstrates how to handle the OnClick event and set custom filter function. First you set the and properties for this menu item, then in the event handler, you fire the "Filter" event and pass the menu item as an ergument in pair. override protected void OnInit(EventArgs e) { private void InitializeComponent() { this.Init += new EventHandler(WebForm1_Init); this.Load += new System.EventHandler(this.Page_Load); RadGrid1.NeedDataSource += new Telerik.WebControls.GridNeedDataSourceEventHandler(RadGrid1_NeedDataSource); } private void RadGrid1_NeedDataSource(object source, Telerik.WebControls.GridNeedDataSourceEventArgs e) { RadGrid1.DataSource = DataSourceHelperCS.GetDataTable("SELECT * FROM Customers"); } private void WebForm1_Init(object sender, EventArgs e) { RadGrid1.FilterMenu.Items.Clear(); GridMenuItem menuItem = new GridMenuItem(); RadGrid1.FilterMenu.Items.Add(menuItem); menuItem.Text = "Custom-Text (Contains)"; menuItem.Value = "Contains"; menuItem.OnClick += new GridMenuItemClickEventHandler(menuItem_OnClick); } private void menuItem_OnClick(GridMenuItem sender, GridMenuItemClickEventArgs e) { GridFilteringItem filterItem = RadGrid1.MasterTableView.GetItems(GridItemType.FilteringItem)[0] as GridFilteringItem; GridMenuItem menuItem = sender as GridMenuItem; filterItem.FireCommandEvent( "Filter", new Pair(menuItem.Value, e.ColumnName)); } Protected Overrides Sub OnInit(ByVal e As EventArgs) Dim InitializeComponent As System.Void AddHandler Init, AddressOf Me.WebForm1_Init AddHandler Load, AddressOf Me.Page_Load AddHandler RadGrid1.NeedDataSource, AddressOf Me.RadGrid1_NeedDataSource End Sub Private Sub RadGrid1_NeedDataSource(ByVal source As Object, ByVal e As Telerik.WebControls.GridNeedDataSourceEventArgs) RadGrid1.DataSource = DataSourceHelperCS.GetDataTable("SELECT * FROM Customers") End Sub Private Sub WebForm1_Init(ByVal sender As Object, ByVal e As EventArgs) RadGrid1.FilterMenu.Items.Clear Dim menuItem As GridMenuItem = New GridMenuItem RadGrid1.FilterMenu.Items.Add(menuItem) menuItem.Text = "Custom-Text (Contains)" menuItem.Value = "Contains" AddHandler menuItem.OnClick, AddressOf Me.menuItem_OnClick End Sub Private Sub menuItem_OnClick(ByVal sender As GridMenuItem, ByVal e As GridMenuItemClickEventArgs) Dim filterItem As GridFilteringItem = CType(RadGrid1.MasterTableView.GetItems(GridItemType.FilteringItem)(0),GridFilteringItem) Dim menuItem As GridMenuItem = CType(sender,GridMenuItem) filterItem.FireCommandEvent("Filter", New Pair(menuItem.Value, e.ColumnName)) End Sub Gets or sets the value for this Item as one of the members of Enumeration. You can use this property in conjunction with the property to create you own custom menu Items. The following example demonstrates how to handle the OnClick event and set custom filter function. First you set the and properties for this menu item, then in the event handler, you fire the "Filter" event and pass the menu item as an ergument in pair. Protected Overrides Sub OnInit(ByVal e As EventArgs) Dim InitializeComponent As System.Void AddHandler Init, AddressOf Me.WebForm1_Init AddHandler Load, AddressOf Me.Page_Load AddHandler RadGrid1.NeedDataSource, AddressOf Me.RadGrid1_NeedDataSource End Sub Private Sub RadGrid1_NeedDataSource(ByVal source As Object, ByVal e As Telerik.WebControls.GridNeedDataSourceEventArgs) RadGrid1.DataSource = DataSourceHelperCS.GetDataTable("SELECT * FROM Customers") End Sub Private Sub WebForm1_Init(ByVal sender As Object, ByVal e As EventArgs) RadGrid1.FilterMenu.Items.Clear Dim menuItem As GridMenuItem = New GridMenuItem RadGrid1.FilterMenu.Items.Add(menuItem) menuItem.Text = "Custom-Text (Contains)" menuItem.Value = "Contains" AddHandler menuItem.OnClick, AddressOf Me.menuItem_OnClick End Sub Private Sub menuItem_OnClick(ByVal sender As GridMenuItem, ByVal e As GridMenuItemClickEventArgs) Dim filterItem As GridFilteringItem = CType(RadGrid1.MasterTableView.GetItems(GridItemType.FilteringItem)(0),GridFilteringItem) Dim menuItem As GridMenuItem = CType(sender,GridMenuItem) filterItem.FireCommandEvent("Filter", New Pair(menuItem.Value, e.ColumnName)) End Sub override Protected void OnInit(EventArgs e) { Private void InitializeComponent() { this.Init += New EventHandler(WebForm1_Init); this.Load += New System.EventHandler(this.Page_Load); RadGrid1.NeedDataSource += New Telerik.WebControls.GridNeedDataSourceEventHandler(RadGrid1_NeedDataSource); } Private void RadGrid1_NeedDataSource(Object source, Telerik.WebControls.GridNeedDataSourceEventArgs e) { RadGrid1.DataSource = DataSourceHelperCS.GetDataTable("SELECT * FROM Customers"); } Private void WebForm1_Init(Object sender, EventArgs e) { RadGrid1.FilterMenu.Items.Clear(); GridMenuItem menuItem = New GridMenuItem(); RadGrid1.FilterMenu.Items.Add(menuItem); menuItem.Text = "Custom-Text (Contains)"; menuItem.Value = "Contains"; menuItem.OnClick += New GridMenuItemClickEventHandler(menuItem_OnClick); } Private void menuItem_OnClick(GridMenuItem sender, GridMenuItemClickEventArgs e) { GridFilteringItem filterItem = RadGrid1.MasterTableView.GetItems(GridItemType.FilteringItem)[0] As GridFilteringItem; GridMenuItem menuItem = sender As GridMenuItem; filterItem.FireCommandEvent( "Filter", New Pair(menuItem.Value, e.ColumnName)); } This property is for internal RadGrid usage. This property is for internal RadGrid usage. Gets or sets the visibility of an item. true if the item is visible, otherwise false. For RadGrid internal usage. Contains data related to the event. The of the GridTableView that will be filtered. The of the column that will be filtered. The of the GridTableView that will be filtered. The of the column that will be filtered. A collection that stores objects. You can access this collection through Items Property of GridMenu/GridFilterMenu. Copies the current collection to a collection starting at the specified index of the target collection (). the target array where the current collection will be copied. the starting index of the target array where the current collection will be copied to. Returns an enumerator that iterates through a collection. An object that can be used to iterate through the collection. Adds an object to the end of Items collection. The that will be added to the end of the collection. Determines if the Items collection contains the specified Item. true if the item is present in this collection, otherwise false. The Item to locate in the collection. Removes all items from the collection. You can use the Clear method to remove the entire collection of item from a parent control. To remove an individual item from the collection, use the or methods. To add new Item objects to the collection, use the method. Returns the index within the collection of the specified item. The zero-based index where the item is located within the collection; otherwise, negative one (-1). An object representing the item to locate in the collection. Inserts an Item in the collection at the specified index. the zero-based index where the Item will be inserted. the Item that will be inserted Removes an Item from the collection the Item that will be removed. Removes an Item at the specidied position from the collection. the position of the Item that will be removed. Gets the number of items in this collection. the number of items in this collection as Integer. Gets an object that can be used to synchronize access to this collection. Gets a value indicating whether access to this collection is synchronized (thread safe). true if the access to the collection is thread safe; otherwise false. Gets a value indicating whether the collection is with restricted access (read-only). Gets a value indicating whether the collection has a fixed size. true if the collection has a fixed size; otherwise, false. The default is false. This control is intended for internal usage by other telerik controls. Gets the component's current version. Gets or sets a value indicating whether to use the embedded JavaScript files or not. True if embedded JavaScript files are to be used; otherwise false. The default value is true. Use this property for debugging purposes or to apply any modifications to the JavaScript files. This method is intended only for internal usage. Gets or sets a string collection of JavaScripts that will be executed on client-side when the response returns. The following example demonstrates a sample usage of the ResponseScripts property: 
            [C#]  
                
            <form id="Form1" method="post" runat="server">
<script language="C#" runat="server">
private void Button1_Click(object sender, System.EventArgs e)
{
RadAjaxManager1.ResponseScripts.Add("alert('This can be any script!');");
}
</script>
<radA:RadAjaxManager id="RadAjaxManager1" runat="server" >
 <AjaxSettings>
  <radA:AjaxSetting AjaxControlID="Button1">
  <radA:AjaxSetting>
 </AjaxSettings>
</radA:RadAjaxManager>
</form>
<form id="Form1" method="post" runat="server"> <script language="VB" runat="server"> Private Sub Button1_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles Button1.Click RadAjaxManager.ResponseScripts.Add("alert('This can be any script!');") End Sub 'RadAjaxManager1_AjaxRequest </script> <radA:RadAjaxManager id="RadAjaxManager1" runat="server" > <AjaxSettings> <radA:AjaxSetting AjaxControlID="Button1"> <radA:AjaxSetting> </AjaxSettings> </radA:RadAjaxManager> </form> July 11, 2006 Gets or sets a value indicating whether the control will work in AJAX or Postback mode. Set to false to force using postbacks instead of AJAX requests. Returns true by default. Gets or sets a value indicating if the outside scripts for the AJAX-enabled controls will be evaluated. The default value is false. Outside scripts are scripts rendered from the code-behind and are usually not executed if they are rendered outside of the currently updated control(s). Using this property you can provide your own error handler for AJAX requests in RadAjax, RadGrid, RadCalendar if you wish to block or handle those errors in a specific way. You can either supply the name of a javascript function or executable code like "alert(e.message)" The javascript handler function should have the following signature: AjaxRequestErrorHandler(e, clientID) {...} It must also be defined ABOVE the code clock which contains your AJAX enabled control. Gets a value indicating whether the current request is an AJAX request initiated by the current control. Gets a value indicating whether the current request is an AJAX request initiated by the current control. Gets or sets a value containing the URL that will be used for AJAX request. Returns a String containing the URL that will be used for AJAX request. The default value is the URL of the current page. AJAX Panel and AJAX Manager automatically resolve the current page URL when forming the request. However if you want to achieve different scenario such as AJAX requests between two pages you can set the desired URL for the request using this property. Gets or sets a value the URL that the control will use for AJAX requests. Utility class for Design - Time VisualStudio.NET project management. Defines the common property categories' names Summary description for ClientObjectBuilder. Number of items in the group Number of items displayed on the page if true Group is countinued from the previous page or it continues on the next page if value of false Summary description for DataSetHelper. Summary description for DefaultValueChecker. Serves as the abstract base class for data tables. This class provides the methods and properties common to all tables in Telerik RadGrid. Occurs when a different item is selected in a table between posts to the server. Gets or sets the tab index of the Web server control. Gets or sets the amount of space between the contents of a cell and the cell's border. Gets or sets the amount of space between cells. Gets or sets a value that specifies whether the border between the cells of a data table is displayed. Gets or sets the horizontal alignment of a data table within its container. ObjectWithState This event is fired when asynchronous request is started. Handle RadGrid.OnRequestStart to execute code that should perform any operations before the AJAX request has started. Those can be - cleanup operations, check if the request can be performed at this moment to prevent any loss of user data, etc. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnRequestStart="RequestStart" ... JavaScript <script> function RequestStart() { return confirm("Request started!"); } </script> This client-side event is fired when asynchronous request is started. This client-side event is fired when asynchronous request is finished. RadGrid.OnRequestEnd can be used to recreate any javascript objects related to RadGrid, execute scripts related to the initial load state of the control. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnRequestEnd="RequestEnd" ... JavaScript <script> function RequestEnd() { alert("Request end!"); } </script> This client-side event is fired when asynchronous request is finished. This client-side event is fired when the server returns status different from '200 OK'. RadGrid.OnRequestError can be used for various purposes such redirects, permissions checks, etc. Fired by RadGrid Arguments Error object Can be canceled Yes, return false to cancel Examples ascx/aspx <ClientEvents OnRequestError="RequestError" ... JavaScript <script> function RequestError(sender, e) { alert("Status code: " + e.Status); alert("ResponseText: " + e.ResponseText); alert("ResponseHeaders: " + e.ResponseHeaders); } </script> This client-side event is fired when asynchronous request is finished. This event is fired before grid creation. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnGridCreating="GridCreating" ... JavaScript <script>
function GridCreating() { alert("Creting grid with ClientID: " + this.ClientID); }
</script> This client-side event is fired before grid creation. This event is fired after the grid is created. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnGridCreated="GridCreated" ... JavaScript <script> function GridCreated() { alert("Grid with ClientID: " + this.ClientID + " was created"); } </script> This client-side event is fired after the grid is created. This event is fired when RadGrid object is destroyed, i.e. on each window.onunload Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnGridCreating="GridDestroying" ... JavaScript <script> function GridDestroying() { alert("Destroying grid with ClientID: " + this.ClientID); } </script> This client-side event is fired when RadGrid object is destroyed, i.e. on each window.onunload This event is fired before the MasterTableView is created. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnMasterTableViewCreating="MasterTableViewCreating" ... JavaScript <script> function MasterTableViewCreating() { alert("Creating MasterTableView"); } </script> This client-side event is fired before the MasterTableView is created. This event is fired after the MasterTableView is created. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnMasterTableViewCreated="MasterTableViewCreated" ... JavaScript <script> function MasterTableViewCreated() { alert("MasterTableView was created"); } </script> This client-side event is fired after the MasterTableView is created. You can hook this event to have your code executed when an error occurs in RadGrid. Fired by RadGrid Arguments Error object Can be canceled Yes, return false to cancel Examples ascx/aspx <ClientEvents OnError="Error" ... JavaScript <script> function Error() { return false; // cancel error event } </script> You can hook this client-side event to have your code executed when an error occurs in RadGrid. This event is fired before table creation. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnTableCreating="TableCreating" ... JavaScript <script> function TableCreating() { alert("Creating DetailTable"); } </script> This client-side event is fired before table creation. This event is fired after the table is created. Fired by RadGrid Arguments RadGridTable Object Can be canceled No Examples ascx/aspx <ClientEvents OnTableCreated="TableCreated" ... JavaScript <script> function TableCreated(tableObject) { alert("DetailTable with ClientID: " + tableObject.ClientID + " was created"); } </script> This client-side event is fired after the table is created. This event is fired when table object is destroyed. Fired by RadGrid Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnTableDestroying="TableDestroying" ... JavaScript <script> function TableDestroying() { alert("Destroing DetailTable with ClientID: " + this.ClientID); } </script> This client-side event is fired when table object is destroyed. This event is fired before column available at client-side creation. Fired by RadGridTable Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnColumnCreating="ColumnCreating" ... JavaScript <script> function ColumnCreating() { alert("Creating column); } </script> This client-side event is fired before column available at client-side creation. This event is fired after a column available at client-side is created. Fired by RadGridTable Arguments RadGridTableColumn object Can be canceled No Examples ascx/aspx <ClientEvents OnColumnCreated="ColumnCreated" ... JavaScript <script> function ColumnCreated(columnObject) { alert("Column with Index: " + columnObject.Index + " was created"); } </script> This client-side event is fired after a column available at client-side is created. This event is fired when a column object is destroyed. Fired by RadGridTable Arguments N/A Can be canceled No Examples ascx/aspx <ClientEvents OnColumnDestroying="ColumnDestroying" ... JavaScript <script> function ColumnDestroying() { alert("Destroing column with Index: " + this.Index); } </script> This client-side event is fired when a column object is destroyed. This event is fired before a column is resized. Fired by RadGridTable Arguments columnIndex, columnWidth Can be canceled Yes, return false to cancel Examples ascx/aspx <ClientEvents OnColumnResizing="ColumnResizing" ... JavaScript <script> function ColumnResizing(columnIndex, columnWidth) { alert("Resizng column with Index: " + columnIndex + ", width: " + columnWidth); } OR function ColumnResizing(columnIndex, columnWidth) { return false; //cancel ColumnResizing event } </script> This client-side event is fired before a column is resized. FOR FUTURE VERSIONS The client-side script for RadGrid.ClientSettings.ClientEvents.OnRowContextMenu kills any exceptions that occur in the event handler. This can make bugs hard to track down because it appears that nothing happens when actually the exception was killed before it becomes visible. You can avoid this problem by putting a try/catch block around the event handler that sends an alert if an exception was thrown: 
            RadGrid1.ClientSettings.ClientEvents.OnRowContextMenu = " try { ... my event handling code ... } catch (exp) { alert(exp.message); }";
Contains properties related to messages appearing as tooltips for various grid actions. You can use this class for localizing the grid messages. Gets or sets a string that will be displayed as a tooltip when you start dragging a column header trying to reorder columns. string, the tooltip that will be displayed when you try to reorder columns. By default it states "Drop here to reorder". Gets or sets a string that will be displayed as a tooltip when you hover a column that can be dragged. string, the tooltip that will be displayed hover a draggable column. By default it states "Drag to group or reorder". string, the tooltip that will be displayed when you hover the resizing handle of a column. By default it states "Drag to resize". Gets or sets a string that will be displayed as a tooltip when you hover the resizing handle of a column. The format string used for the tooltip when using Ajax scroll paging or the Slider pager This method is for Telerik RadGrid internal usage. Checks if a client settings property value was changed and differs from its default. Gets a reference to class providing properties related to client-side selection features. Gets a reference to class. Gets a reference to class, holding properties that can be used for localizing Telerik RadGrid. Gets a reference to , which holds various properties for setting the Telerik RadGrid scrolling features. Gets a reference to , which holds properties related to Telerik RadGrid resizing features. Gets or sets a value indicating whether the keyboard navigation will be enabled in Telerik RadGrid. true, if keyboard navigation is enabled, otherwise false (the default value).
  • Arrowkey Navigation - allows end-users to navigate around the menu structure using the arrow keys.
  • select grid items pressing the [SPACE] key
  • edit rows hitting the [ENTER] key
 Gets or sets a value indicating whether the CSS styles will be set when the control is rendered on the server or when the control is rendered on the client (using JavaScript). Applying the styles on the client will reduce the output sent from the server to the client. It will also share the grid rendering load between the server and the client, thus reducing the server CPU load. true, if the styles will be applied client-side, otherwise false (the default value). Gets or sets a value indicating whether you will be able to drag column headers to and let the grid automatically form and group its data. true, if you are able to drag group header to the group panel, otherwise false (the default value) Gets or sets a value indicating whether you will be able to reorder columns by using drag&drop. By default it is false. ReorderColumnsOnClient Property true if reorder via drag&drop is enabled, otherwise false (the default value). Gets or sets a value indicating whether columns will be reordered on the client. This property is meaningful when used in conjunction with set to true. False by default, which means that each time you try to reorder columns a postback will be performed. Note that in case this property is true the order changes will be persisted on the server only after postback. true if columns are reordered on the client, otherwise false (the default value. Gets or sets a value indicating whether the expand/collapse functionality for hierarchical structures in grid will be enabled. This property should be set to true, when working in HierarchyLoadMode.Client. true if expand/collapse is enabled, otherwise false (the default value). Gets or sets a value indicating whether the expand/collapse functionality for grouped data in grid will be enabled. true, if expand/collapse is enabled, otherwise false (the default value). Gets or sets a value indicating whether you will be able to retrieve the field values client-side through the KeyValues array. Interface that provides the basic functionality needed for a class to be used to send information to Command event handler. Override to fire the corresponding command. Gets or sets a value, defining whether the command should be canceled. For internal usage only. For internal usage only. Represents the method that will handle grid's Command events including CancelCommand, DeleteCommand, EditCommand, InsertCommand, ItemCommand, SortCommand and UpdateCommand. The source of the event. A object that contains the event data. Provides data for Command events including CancelCommand, DeleteCommand, EditCommand, InsertCommand, ItemCommand, SortCommand and UpdateCommand. Fires the command stored in property Gets the source of the command // Get a reference to the control that triggered expand/collapse command protected void RadGrid1_ItemCommand(object source, GridCommandEventArgs e) { if (e.CommandName == RadGrid.ExpandCollapseCommandName) { Control c = e.CommandSource as Control; } } ' Get a reference to the control that triggered expand/collapse command Protected Sub RadGrid1_ItemCommand([source] As Object, e As GridCommandEventArgs) If e.CommandName = RadGrid.ExpandCollapseCommandName Then Dim c As Control = e.CommandSource End If End Sub 'RadGrid1_ItemCommand Gets the item containing the command source protected void RadGrid1_UpdateCommand(object source, GridCommandEventArgs e) { if (e.Item is GridEditFormItem && e.Item.IsInEditMode) { GridEditFormItem item = e.Item as GridEditFormItem; Hashtable newValues = new Hashtable(); item.OwnerTableView.ExtractValuesFromItem(newValues, item); if (newValues["Name"].ToString() == "DefaultName") { e.Canceled = true; } } } Protected Sub RadGrid1_UpdateCommand([source] As Object, e As GridCommandEventArgs) If Typeof e.Item Is GridEditFormItem AndAlso e.Item.IsInEditMode Then Dim item As GridEditFormItem = e.Item Dim newValues As New Hashtable() item.OwnerTableView.ExtractValuesFromItem(newValues, item) If newValues("Name").ToString() = "DefaultName" Then e.Canceled = True End If End If End Sub Gets or sets a value, defining whether the command should be canceled. protected void RadGrid1_UpdateCommand(object source, GridCommandEventArgs e) { if (e.Item is GridEditFormItem && e.Item.IsInEditMode) { GridEditFormItem item = e.Item as GridEditFormItem; Hashtable newValues = new Hashtable(); item.OwnerTableView.ExtractValuesFromItem(newValues, item); if (newValues["Name"].ToString() == "DefaultName") { e.Canceled = true; } } } Protected Sub RadGrid1_UpdateCommand([source] As Object, e As GridCommandEventArgs) If Typeof e.Item Is GridEditFormItem AndAlso e.Item.IsInEditMode Then Dim item As GridEditFormItem = e.Item Dim newValues As New Hashtable() item.OwnerTableView.ExtractValuesFromItem(newValues, item) If newValues("Name").ToString() = "DefaultName" Then e.Canceled = True End If End If End Sub For internal usage only. Fires RadGrid.SelectedIndexChanged event. For internal usage only Fires RadGrid.SelectedIndexChanged event. Represents a method that will handle grid's DetailTableDataBind event. Provides data for DetailTableDataBind event. protected void RadGrid1_DetailTableDataBind(object source, Telerik.WebControls.GridDetailTableDataBindEventArgs e) { GridDataItem parentItem = e.DetailTableView.ParentItem as GridDataItem; if (e.DetailTableView.DataSourceID == "AccessDataSource2") { Session["CustomerID"] = parentItem["CustomerID"].Text; } } Protected Sub RadGrid1_DetailTableDataBind(ByVal source As Object, ByVal e As GridDetailTableDataBindEventArgs) Handles RadGrid1.DetailTableDataBind Dim parentItem As GridDataItem = CType(e.DetailTableView.ParentItem, GridDataItem) If (e.DetailTableView.DataSourceID = "AccessDataSource2") Then Session("CustomerID") = parentItem("CustomerID").Text End If End Sub Fires RadGrid.DetailTableDataBind event Gets a reference to the detail table being bound. protected void RadGrid1_DetailTableDataBind(object source, Telerik.WebControls.GridDetailTableDataBindEventArgs e) { GridDataItem parentItem = e.DetailTableView.ParentItem as GridDataItem; if (e.DetailTableView.DataSourceID == "AccessDataSource2") { Session["CustomerID"] = parentItem["CustomerID"].Text; } } Protected Sub RadGrid1_DetailTableDataBind(ByVal source As Object, ByVal e As GridDetailTableDataBindEventArgs) Handles RadGrid1.DetailTableDataBind Dim parentItem As GridDataItem = CType(e.DetailTableView.ParentItem, GridDataItem) If (e.DetailTableView.DataSourceID = "AccessDataSource2") Then Session("CustomerID") = parentItem("CustomerID").Text End If End Sub Gets or sets a value, defining whether the command should be canceled. For internal usage only. Expands/Collapses the containing the For internal usage only. Calculates and sets the to the corresponding and rebinds the grid. A collection that stores objects. You can access this collection through property of a parent . Initializes a new instance of . that would aggregate this instance Initializes a new instance of based on another . A from which the contents are copied Initializes a new instance of containing any array of objects. An array of objects with which to intialize the collection Adds a with the specified value to the . The to add. The index at which the new element was inserted. Copies the elements of an array to the end of the . An array of type containing the objects to add to the collection. None. Adds the contents of another to the end of the collection. A containing the objects to add to the collection. None. Gets a value indicating whether the contains the specified . The to locate. if the is contained in the collection; otherwise, . Copies the values to a one-dimensional instance at the specified index. The one-dimensional that is the destination of the values copied from . The index in where copying begins. None. is multidimensional. -or- The number of elements in the is greater than the available space between and the end of . is . is less than "s lowbound. Returns the index of a in the . The to locate. The index of the of in the , if found; otherwise, -1. Inserts a into the at the specified index. The zero-based index where should be inserted. The to insert. None. Returns an enumerator that can iterate through the . None. Removes a specific from the . The to remove from the . None. is not found in the Collection. Get the instance of that owns this instance Represents the entry at the specified index of the . The zero-based index of the entry to locate in the collection. The entry at the specified index of the collection. is outside the valid range of indexes for the collection. Add DataColumns for grid columns with composite DataFields (sub properties) Summary description for IGridEnumerable. Container of misc. grouping settings of RadGrid control A string specifying the name (without the extension) of the file that will be created. The file extension is automatically added based on the method that is used. Export Grid to Microsoft Excel, Microsoft Word Determines whether only data will be exported. Export Grid to Microsoft Excel, Microsoft Word Specifies whether all records will be exported or merely those on the current page. Export Grid to Microsoft Excel, Microsoft Word Opens the exported grid in a new instead of the same page. Export Grid to Microsoft Excel, Microsoft Word Predefined filter expression enumeration. Used by class. Basic Filtering Some functions are applicable (and are not displayed on filterting) to all the data types: String type supports all the functions. Integer: NoFilter, EqualTo, NotEqualTo, GreaterThan, LessThan, GreaterThanOrEqualTo, LessThanOrEqualTo, Between, NotBetween, IsNull and NotIsNull are supported. Contains, DoesNotContain, StartsWith, EndsWith, IsEmpty and NotIsEmpty are not supported. Date: same as Integer. Basic Filtering How-To: Localizing filtering menu options How-To: Reducing filtering menu options No filter would be applied, filter controls would be cleared Same as: dataField LIKE '/%value/%' Same as: dataField NOT LIKE '/%value/%' Same as: dataField LIKE 'value/%' Same as: dataField LIKE '/%value' Same as: dataField = value Same as: dataField != value Same as: dataField > value Same as: dataField < value Same as: dataField >= value Same as: dataField <= value Same as: value1 <= dataField <= value2.
Note that value1 and value2 should be separated by [space] when entered as filter. Same as: dataField <= value1 && dataField >= value2.
Note that value1 and value2 should be separated by [space] when entered as filter. Same as: dataField = '' Same as: dataField != '' Only null values Only those records that does not contain null values within the corresponding column Custom function will be applied. The filter value should contain a valid filter expression, including DataField, operators and value Choose which filter function will be enabled for a column Basic Filtering Custom option for filtering (FilterListOptions -> VaryByDataTypeAllowCustom) Depending of data type of the column, RadGrid will automatically choose which filters to be displayed in the list As VaryByDataType with custom filtering enabled All filters will be displayed. Note that some data types are not applicatble to some filter functions. For example you cannot apply the 'like' function for integer data type. In such cases you should handle the filtering in a custom manner, handling for 'Filter' command or Used when column-based filtering feature of RadGrid is enabled. Defines properties and methods for formatting the predefined filter expressions Enumeration representing the aggregate functions which can be applied to a GridGroupByField (part of collection) Meaningful only when GridGroupByField is part of collection Programmatic GridGroupByField syntax GridGroupByField gridGroupByField; gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "Freight"; gridGroupByField.HeaderText = "Total shipping cost is "; gridGroupByField.Aggregate = GridAggregateFunction.Sum; expression.SelectFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "Freight" gridGroupByField.HeaderText = "Total shipping cost is " gridGroupByField.Aggregate = GridAggregateFunction.Sum expression.SelectFields.Add(gridGroupByField) Field which is part of each and collection Dim groupExpression As GridGroupByExpression = New GridGroupByExpression() Dim groupByField As GridGroupByField = New GridGroupByField() groupByField = New GridGroupByField() groupByField.FieldName = "Received" groupExpression.SelectFields.Add(groupByField) groupByField = New GridGroupByField() groupByField.FieldName = "Received" groupExpression.GroupByFields.Add(groupByField) RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression) GridGroupByExpression groupExpression = new GridGroupByExpression(); GridGroupByField groupByField = new GridGroupByField(); groupByField = new GridGroupByField(); groupByField.FieldName = "Received"; groupExpression.SelectFields.Add(groupByField); groupByField = new GridGroupByField(); groupByField.FieldName = "Received"; groupExpression.GroupByFields.Add(groupByField); RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression); Some of the GridGroupByField properties are meaningful only when present under specific collection - or Declarative GridGroupByField syntax Programmatic GridGroupByField syntax Method setting the aggregate function applied for a GridGroupByField which is part of the collection. N/A Dim groupExpression As GridGroupByExpression = New GridGroupByExpression() Dim groupByField As GridGroupByField = New GridGroupByField() groupByField.FieldName = "Size" groupByField.SetAggregate(GridAggregateFunction.Sum) groupExpression.SelectFields.Add(groupByField) groupByField = New GridGroupByField() groupByField.FieldName = "Received" groupExpression.SelectFields.Add(groupByField) groupByField = New GridGroupByField() groupByField.FieldName = "Received" groupExpression.GroupByFields.Add(groupByField) RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression) GridGroupByExpression groupExpression = new GridGroupByExpression(); GridGroupByField groupByField = new GridGroupByField(); groupByField.FieldName = "Size"; groupByField.SetAggregate(GridAggregateFunction.Sum); groupExpression.SelectFields.Add(groupByField); groupByField = new GridGroupByField(); groupByField.FieldName = "Received"; groupExpression.SelectFields.Add(groupByField); groupByField = new GridGroupByField(); groupByField.FieldName = "Received"; groupExpression.GroupByFields.Add(groupByField); RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression); Meaningful only for GridGroupByFields from the collection Method setting the sort order applied for a GridGroupByField which is part of the collection. N/A Meaningful only for GridGroupByFields from the collection GridGroupByExpression groupExpression = new GridGroupByExpression(); groupByField = new GridGroupByField(); groupByField.FieldName = "Received"; groupExpression.SelectFields.Add(groupByField); groupByField = new GridGroupByField(); groupByField.FieldName = "Received"; groupByField.SetSortOrder(GridSortOrder.Ascending); groupExpression.GroupByFields.Add(groupByField); RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression); Dim groupExpression As GridGroupByExpression = New GridGroupByExpression() Dim groupByField As GridGroupByField = New GridGroupByField() groupByField = New GridGroupByField() groupByField.FieldName = "Received" groupExpression.SelectFields.Add(groupByField) groupByField = New GridGroupByField() groupByField.FieldName = "Received" groupByField.SetSortOrder(GridSortOrder.Descending) groupExpression.GroupByFields.Add(groupByField) RadGrid1.MasterTableView.GroupByExpressions.Add(groupExpression) Method which gets the HeaderText value from GridGroupByField part of the collection String containing the HeaderText value Meaningful only for GridGroupByFields from the collection Dim groupExpression As GridGroupByExpression = RadGrid1.MasterTableView.GroupByExpressions(0) Dim headerText as String = groupExpression.SelectFields(0).GetHeaderText() GridGroupByExpression groupExpression = RadGrid1.MasterTableView.GroupByExpressions[0] as GridGroupByExpression; String headerText = groupExpression.SelectFields[0].GetHeaderText() Method which gets the FormatString value from GridGroupByField part of the collection String containing the FormatString value Meaningful only for GridGroupByFields from the collection Dim groupExpression As GridGroupByExpression = RadGrid1.MasterTableView.GroupByExpressions(0) Dim formatString As String = groupExpression.SelectFields(0).GetFormatString() GridGroupByExpression groupExpression = RadGrid1.MasterTableView.GroupByExpressions[0] As GridGroupByExpression; String formatString = groupExpression.SelectFields[0].GetFormatString() Inherited but not used Method that retrieves a System.String that indicates the current object The string format of the object. Object.ToString() Inherited but not used Gets or sets a string that represents the DataField column property that will be used to form the GroupByExpression. Unless you have specified a FieldAlias, the value of this property will be used when Telerik RadGrid constructs the text for GridGroupHeaderItem. FieldName has a meaning both for SelectFields and GroupByFields of GroupByExpression. String representing the DataField for the corresponding grouped column GridGroupByField gridGroupByField; //Add select fields (before the "Group By" clause) gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; gridGroupByField.HeaderText = "Employee"; expression.SelectFields.Add( gridGroupByField ); //Add a field for group-by (after the "Group By" clause) gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; expression.GroupByFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField 'Add select field (before the "Group By" clause) gridGroupByField = New GridGroupByField() gridGroupByField.FieldName = "EmployeeID" gridGroupByField.HeaderText = "Employee" expression.SelectFields.Add(gridGroupByField) 'Add a field for group-by (after the "Group By" clause) gridGroupByField = New GridGroupByField() gridGroupByField.FieldName = "EmployeeID" expression.GroupByFields.Add(gridGroupByField) Declarative GridGroupByField syntax Programmatic GridGroupByField syntax Gets or sets a value representing a friendly name for the field used for forming the group by expression. This name will be displayed in each group header when grouping by the respective field. Use this property for setting the field text that will be displayed in the GridGroupHeaderItem. If this property is not set, the value of property will be used. Note that this property has a meaning only for GridGroupByField part of the SelectFields of GridGroupByExpression. This property is useful in cases when: you want to change the value displayed in group header (different than the default DataField column value)
or group by a template column and Telerik RadGrid cannot get the header text for that column. GridGroupByField gridGroupByField; //Add select fields (before the "Group By" clause) gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; gridGroupByField.FieldAlias = "EmployeeIdentificator"; expression.SelectFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField 'Add select fields (before the "Group By" clause) gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "EmployeeID" gridGroupByField.FieldAlias = "EmployeeIdentificator" expression.SelectFields.Add(gridGroupByField) String representing the friendly name shown Declarative GridGroupByField syntax Programmatic GridGroupByField syntax Meaningful only for fields in the collection. Gets or sets aggregate function (from enumeration values) that will be applied on the grouped data. Returns the result from currently used aggregate function. This property defaults to GridAggregateFunction.None GridGroupByField gridGroupByField; gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "Freight"; gridGroupByField.HeaderText = "Total shipping cost is "; gridGroupByField.Aggregate = GridAggregateFunction.Sum; expression.SelectFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "Freight" gridGroupByField.HeaderText = "Total shipping cost is " gridGroupByField.Aggregate = GridAggregateFunction.Sum expression.SelectFields.Add(gridGroupByField) Programmatic GridGroupByField syntax Meaningful only for fields in the collection. 'None' value is not supported because it can not determine uniquely the order in which the groups will be displayed. Gets or sets the value representing how the data will be sorted. Acceptable values are the values of enumeration except for None (Ascending, Descending). Returns the sorting mode applied to the grouped data. By default it is Ascending. GridGroupByField gridGroupByField; gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; gridGroupByField.SortOrder = GridSortOrder.Descending; expression.GroupByFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "EmployeeID" gridGroupByField.SortOrder = GridSortOrder.Descending expression.GroupByFields.Add(gridGroupByField) Programmatic GridGroupByField syntax Meaningful only for fields in the collection. When rendering RadGrid is using this expression to format field's value. It is mandatory that {0} parameter is specified in the string - it will be replaced with field's runtime value. Gets or sets the string that will be used to format the GridGroupByField part of the collection. String, formated by the GridGroupByField's FormatString property. It defaults to: "{0}". GridGroupByField gridGroupByField; gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; gridGroupByField.FormatString = "<strong>{0}</strong>"; expression.SelectFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "EmployeeID" gridGroupByField.FormatString = "<strong>{0}</strong>" expression.SelectFields.Add(gridGroupByField) Declarative GridGroupByField syntax Programmatic GridGroupByField syntax Meaningful only for fields in the collection. When rendering RadGrid will override the FieldAlias value with the HeaderText specified. string, copied from the column's HeaderText if this group expression is based on a column. It defaults to the FieldAlias value (if specified). Gets or sets the expression that will be displayed in the . GridGroupByField gridGroupByField; gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; gridGroupByField.HeaderText = "EmployeeNo"; expression.SelectFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "EmployeeID" gridGroupByField.HeaderText = "EmployeeNo" expression.SelectFields.Add(gridGroupByField) Programmatic GridGroupByField syntax Gets or sets the string that separates header text from value text as the field is rendered in the GroupHeaderItems. string, represents the separator between the header text and value text. This field value defaults to ": ". GridGroupByField gridGroupByField; gridGroupByField = new GridGroupByField(); gridGroupByField.FieldName = "EmployeeID"; gridGroupByField.HeaderValueSeparator = " for current group: "; expression.SelectFields.Add( gridGroupByField ); Dim gridGroupByField As GridGroupByField gridGroupByField = New GridGroupByField gridGroupByField.FieldName = "EmployeeID" gridGroupByField.HeaderValueSeparator = " for current group: " expression.SelectFields.Add(gridGroupByField) Meaningful only for fields in the collection. Programmatic GridGroupByField syntax Declarative GridGroupByField syntax Container of miscellaneous grouping settings of RadGrid control For internal usage only The group header message, indicating that the group continues on the next page. Localizing the grid messages Localizing the grid messages topic lists all the tooltips and text messages which can be modified. 
            <GroupingSettings GroupContinuesFormatString="The group continues on the next page." />
The group header message indicating that this group continues from the previous page. Localizing the grid messages Localizing the grid messages topic lists all the tooltips and text messages which can be modified. 
            <GroupingSettings GroupContinuedFormatString="This group continues from the previous page." />
A part of the string that formats the information label that appears on each group header of a group that is split onto several pages parameter {0} will be replaced with the number of actual items displayed on the page parameter {1} will be replaced with the number of all items in the group Gets or sets the format string that will be used when group is split, containing the GroupSplitDisplayFormat or GroupContinuedFormatString and GroupContinuesFormatString or the three together. This property defaults to "({0})" String that separates each group-by field when displayed in GridGroupHeaderItems. This property default to ";" Gets or sets a value indicating whether the grouping operations will be case sensitive or not. true if grouping is case sensitive, otherwise false. The default value is true. Gets or sets a string that will be displayed when the group expand image is hovered. Localizing the grid messages Localizing the grid messages topic lists all the tooltips and text messages which can be modified. 
              <GroupingSettings ExpandTooltip="Click here to expand the group!" />
Gets or sets a string that will be displayed when the group collapse image is hovered. Localizing the grid messages Localizing the grid messages topic lists all the tooltips and text messages which can be modified. 
              <GroupingSettings ExpandTooltip="Click here to collapse the group!" />
Gets or sets a string that will be displayed when a group panel item is hovered. Localizing the grid messages Localizing the grid messages topic lists all the tooltips and text messages which can be modified. 
                <radG:RadGrid>
        ..
        <GroupingSettings UnGroupTooltip="Wanna ungroup? Drag me back!" />
    </radG:RadGrid>
Holds properties specific for grouping mechanism such as performed action and reference to GridTableView where the action was performed. Gets a reference to enumeration, which holds information about what action did fire the event. protected void RadGrid1_GroupsChanging(object source, Telerik.WebControls.GridGroupsChangingEventArgs e)
{
if (e.Action == GridGroupsChangingAction.Group) { ... } Gets a reference to the GridTableView object where the grouping is performed. a reference to GridTableView object. Gets or sets the that will be used for grouping Telerik RadGrid. protected void RadGrid1_GroupsChanging(object source, Telerik.WebControls.GridGroupsChangingEventArgs e) { if (e.Action == GridGroupsChangingAction.Group) { GridGroupByField countryGroupField = new GridGroupByField(); countryGroupField.FieldName = "Country"; GridGroupByField cityGroupField = new GridGroupByField(); cityGroupField.FieldName = "City"; e.Expression.SelectFields.Clear(); e.Expression.SelectFields.Add(countryGroupField); e.Expression.SelectFields.Add(cityGroupField); e.Expression.GroupByFields.Clear(); e.Expression.GroupByFields.Add(countryGroupField); e.Expression.GroupByFields.Add(cityGroupField); ... } } Protected Sub RadGrid1_GroupsChanging(ByVal source As Object, ByVal e As Telerik.WebControls.GridGroupsChangingEventArgs) 'Expression is added (by drag/grop on group panel) If (e.Action = GridGroupsChangingAction.Group) Then Dim countryGroupField As GridGroupByField = New GridGroupByField countryGroupField.FieldName = "Country" Dim cityGroupField As GridGroupByField = New GridGroupByField cityGroupField.FieldName = "City" e.Expression.SelectFields.Clear e.Expression.SelectFields.Add(countryGroupField) e.Expression.SelectFields.Add(cityGroupField) e.Expression.GroupByFields.Clear e.Expression.GroupByFields.Add(countryGroupField) e.Expression.GroupByFields.Add(cityGroupField) End If End Sub Gets a reference to the currently used . Gets or sets a value indicating whether event will be canceled. true, if the event is canceled, otherwise false. Container of misc. grouping settings of RadGrid control Gets or sets a string that represents the tooltip that will be shown when the expand image is hovered. Gets or sets a string that represents the tooltip that will be shown when the collapse image is hovered. Gets or sets a string that represents the tooltip that will be shown when the self-hierarchy expand image is hovered. Gets or sets a string that represents the tooltip that will be shown when the self-hierarchy collapse image is hovered. This is a collection of item indexes - each item index is unique within the collection Constructs and add item hierarchical index to the collection of indexes. The hierarchical-index is based on sequential numbers of indxes of items and detail tables. For example index Add(1) will construct the hierarchicalindex for Item 1 in MasterTableView. Add(1, 0, 2) references to the item with index 2 that belongs to a child table 0 of the item 1 in MastertableView. Summary description for GridItemDecorator. Event info object. Cast to derrived classes to obtain the appropriate instance Set to true to cancel the default event execution, if available. The ItemCreated and ItemDataBound events cannot be cancelled. The mode of the pager defines what buttons will be displayed and how the pager will navigate through the pages. The grid Pager will display only the Previous and Next link buttons. The grid Pager will display only the page numbers as link buttons. The grid Pager will display the Previous button, then the page numbers and then the Next button. The grid Pager will display the Previous button, then the page numbers and then the Next button. On the next Pager row, the Pager will display text boxes for navigating to a specific page and setting the Page size (number of items per page). The grid Pager will display text boxes for navigating to a specific page and setting the Page size (number of items per page). The grid Pager will display a slider for very fast and AJAX-based navigation through grid pages. This enumeration defines the possible positions of the pager item The Pager item will be displayed on the bottom of the grid. (Default value) The Pager item will be displayed on the top of the grid. The Pager item will be displayed both on the bottom and on the top of the grid. RadGrid and GridTableView use instance of this class to set style of thir PagerItem-s when rendering Summary description for GridTableItemStyle. Returns 'True' if none of the properties have been set Returns true if none of the properties have been set. Gets a value indicating whether the default pager will be used, i.e. no customizations have been made. Gets a value indicating whether the pager is displayed on the bottom of the grid. Returns true if the pager will be displayed on the bottom of the grid. Otherwise false. Gets a value indicating whether the pager is displayed on the top of the grid. Returns true if the pager will be displayed on the top of the grid. Otherwise false. Gets or sets the mode of Telerik RadGrid Pager. The mode defines what the pager will contain. This property accepts as values only members of the GridPagerMode Enumeration. Returns the pager mode as one of the values of the GridPagerMode Enumeration. You should have Paging enabled by setting the property. Text that would appear if Mode is PrevNext for 'next' page button ToolTip that would appear if Mode is PrevNext for 'next' page button ToolTip that would appear if Mode is PrevNext for 'prev' page button ToolTip that would appear if Mode is PrevNext for 'next' page button ToolTip that would appear if Mode is PrevNext for 'prev' page button Gets or sets the number of buttons that would be rendered if pager Mode is returns the number of button that will be displayed. The default value is 10 buttons. By default 10 buttons will be displayed. If the number of grid pages is greater than 10, ellipsis will be displayed. Gets or sets the Position of pager item(s).Accepts only values, members of the GridPagerPosition Enumeration. Returns the Pager position as a value, member of the GridPagerPosition Enumeration. Text that would appear if Mode is PrevNext for 'previous' page button Gets or sets the visibility of the pager item In order to display the grid pager regardless of the number of records returned and the page size, you should set this property of the corresponding GridTableView to true. Its default value is false. Gets or set a value indicating whether the Pager will be visible regardless of the number of items. (See the remarks) true, if pager will be displayed, regardless of the number of grid items, othewise false. By fefault it is false. Get or set a value indicating whether the SEO (Search Engine Optimized) paging enabled December 15, 2006 Gets or sets the horizontal align of the pager. Accepts as values members of the enumeration. the horizontal align of the pager as a value from the enumeration. Gets or sets a value indicating whether the pager text or only the pager buttons will be displayed. true if both pager text and buttons will be displayed, otherwise false. By default it is true. The string used to format the description text that appears in a pager item. See the remarks. The parameters {0) - {4} are mandatory.

Parameter {0} is used to display current page number.
Parameter {1} is total number of pages.
Parameter {2} will be replaced with the number of the first item in the current page.
Parameter {3} will be set to the number of the last item in the current page.
Parameter {4} indicates where pager buttons would appear.
Parameter {5} corresponds to number of all items in the datasource. The default value is:
Change page: {4} | Displaying page {0} of {1}, items {2} to {3} of {5} Summary description for GridPagingManager. Number of items in the data-source Number of items in the current page Represents the paper size used when exporting to PDF. Container of misc. grouping settings of RadGrid control Gets or sets the physical paper size that RadGrid will use when exporting to PDF. It will be overriden by setting PageWidth and PageHeight explicitly. Gets or sets the page width that RadGrid will use when exporting to PDF. This setting will override any predefined value that comes from the PaperSize property. Gets or sets the page height that RadGrid will use when exporting to PDF. This setting will override any predefined value that comes from the PaperSize property. GridPropertyEvaluator A DataBinder.Eval() workalike that is a bit more forgiving and does not throw exceptions when it can't find a property. Summary description for GridResizing. Contains properties related to customizing the settings for scrolling operation in Telerik RadGrid. Gets or sets a value indicating whether scrolling will be enabled in Telerik RadGrid. true, if scrolling is enabled, otherwise false (the default value). Gets or sets a value specifying the grid height in pixels (px) beyond which the scrolling will be enabled. the default value is 300px Gets or sets a value indicating whether grid column headers will scroll as the rest of the grid items or will remain static (MS Excel ® style). true if headers remain static on scroll, otherwise false (the default value). This property is meaningful only when used in conjunction with set to true. Gets or sets a value indicating whether Telerik RadGrid will keep the scroll position during postbacks. This property is meaningful only when used in conjunction with set to true. true (the default value), if Telerik RadGrid keeps the scroll position on postback, otherwise false . This property is particularly useful when working with huge datasets. Using the grid scrollbar, you can change the grid pages just like in Microsoft Word®. When scrolling with the virtual scrollbar, Telerik RadGrid uses AJAX requests to change the pages, i.e. no Postbacks are performed. The overall behavior is smooth and with no flicker. Note that you should have AJAX enabled for Telerik RadGrid by setting the EnableAJAX="True". Gets or sets a value indicating whether Telerik RadGrid will change the pages when you scroll using the grid scroller. This in terms of Telerik RadGrid is called Virtual Scrolling. true, if virtual scrolling is enabled, otherwise false (the default value). Provides properties related to setting the client-side selection in Telerik RadGrid. You can get a reference to this class using property. not currently available not currently available Gets or sets a value indicating whether you will be able to select a grid row on the client by clicking on it with the mouse. true, if you will be able to select a row on the client, otherwise false (the default value). not currently available not currently available Gets or sets a value indicating whether you will be able to select multiple rows by dragging a rectangle around them with the mouse. true, if you can select rows by dragging a rectangle with the mouse, otherwise false (the default value) Holds the column names presenting the self-referencing relations in the source table. <MasterTableView HierarchyDefaultExpanded="true" HierarchyLoadMode="Client" EnableNoRecordsTemplate="false"
DataKeyNames= "ID,ParentID" Width="100%">
<SelfHierarchySettings ParentKeyName="ParentID" KeyName="ID" />
</MasterTableView> Meaningful in cases of self-referenced grid. This method is for Telerik RadGrid internal usage. Checks if a self-hierarchy settings property value was changed and differs from its default. Gets or sets a value representing the parent ID field when building the self-referencing hierarchy. The value property must be included in the DataKeyNames array for the MasterTableView. string, representing the parent ID of the current table level. 
            <radG:RadGrid ID="RadGrid1" EnableAJAX="True" ShowHeader="true" runat="server" Skin="None"
                        Width= "97%" GridLines="None" OnColumnCreated="RadGrid1_ColumnCreated"
                        OnItemCreated="RadGrid1_ItemCreated"
                        OnNeedDataSource= "RadGrid1_NeedDataSource">
                        <MasterTableView HierarchyDefaultExpanded="true" HierarchyLoadMode="Client" EnableNoRecordsTemplate="false"

            					DataKeyNames= "ID,ParentID" Width="100%">
                            <SelfHierarchySettings ParentKeyName="ParentID" KeyName="ID" />
                        </MasterTableView>
                        <ClientSettings AllowExpandCollapse="true" />
            </radG:RadGrid>
Gets or sets a value, representing the ID of the current table level in self-referencing hierarchy structure. string, representing the current table level. The value property must be included in the DataKeyNames array for the MasterTableView. 
            <radG:RadGrid ID="RadGrid1" EnableAJAX="True" ShowHeader="true" runat="server" Skin="None"
                        Width= "97%" GridLines="None" OnColumnCreated="RadGrid1_ColumnCreated"
                        OnItemCreated="RadGrid1_ItemCreated"
                        OnNeedDataSource= "RadGrid1_NeedDataSource">
                        <MasterTableView HierarchyDefaultExpanded="true" HierarchyLoadMode="Client" EnableNoRecordsTemplate="false"

            					DataKeyNames= "ID,ParentID" Width="100%">
                            <SelfHierarchySettings ParentKeyName="ParentID" KeyName="ID" />
                        </MasterTableView>
                        <ClientSettings AllowExpandCollapse="true" />
            
            </radG:RadGrid>
This property can be set only once when the grid is initialized and can not be modified. Gets or sets a value indicating the level-depth limit of the nested tables. integer, representing the depth limit in levels of nesting. By default the limit is 10 levels. Enumeration representing the order of sorting data in RadGrid sorts grid data in ascending order sorts grid data in descending order do not sort the grid data Class that is used to define sort field and sort order for RadGrid This method gives the string representation of the sorting order. It can be either "ASC" or "DESC" Returns a GridSortOrder enumeration based on the string input. Takes either "ASC" or "DESC" This method gives the string representation of the sorting order. It can be either "ASC" or "DESC" Sets the sort order. The SortOrder paremeter should be either "Ascending", "Descending" or "None". Parses a string representation of the sort order and returns GirdSortExpression. Gets or sets the name of the field to which sorting is applied. Sets or gets the current sorting order. A collection of objects. Depending on the value of it holds single or multiple sort expressions. Returns an enumerator that iterates through the GridSortExpressionCollection. Adds a to the collection. Clears the GridSortExpressionCollection of all items. Find a SortExpression in the collection if it contains any with sort field = expression sort field If is true adds the sortExpression in the collection. Else any other expression previously stored in the collection wioll be removed If is true adds the sortExpression in the collection. Else any other expression previously stored in the collection wioll be removed String containing sort field and optionaly sort order (ASC or DESC) Adds a to the collection at the specified index. As a convenience feature, adding at an index greater than zero will set the to true. Removes the specified from the collection. Returns true or false depending on whether the specified sorting expression exists in the collection. Takes a parameter. Returns true or false depending on whether the specified sorting expression exists in the collection. Takes a string parameter. Adds the sort field (expression parameter) if the collection does not alreqady contain the field. Else the sort order of the field will be inverted. The default change order is Asc -> Desc -> No Sort. The No-Sort state can be controlled using property Get a comma separated list of sort fields and sort-order, in the same format used by DataView.Sort string expression. Returns null (Nothing) if there are no sort expressions in the collection Comma separated list of sort fields and optionaly sort-order, null if there are no sort expressions in the collection Searches for the specified GridSortExpression and returns the zero-based index of the first occurrence within the entire GridSortExpressionCollection. If false, the collection can contain only one sort expression at a time. Trying to add a new one in this case will delete the existing expression or will change the sort order if its FiledName is the same. Returns the number of items in the GridSortExpressionCollection. Gets a value indicating whether access to the GridSortExpressionCollection is synchronized (thread safe). This is the default indexer of the collection - takes an integer value.
Gets an object that can be used to synchronize access to the GirdSortExpressionCollection.
Allow the no-sort state when changing sort order. Holds miscellaneous properties related to sorting like the localization properties. Gets or sets the tooltip that will be displayed when you hover the sorting button and there is no sorting applied. Gets or sets the tooltip that will be displayed when you hover the sorting button and the column is sorted ascending. Gets or sets the tooltip that will be displayed when you hover the sorting button and the column is sorted descending. State managemenet helper. This class is intended to be used only internally in RadGrid. This class holds settings related to the StatusBar item. <StatusBarSettingsReadyText="Stand by"/> November 26, 2006 Gets the ID of the Label that will display the status message. Gets or sets the text that will be displayed in GridStatusBarItem when Telerik RadGrid does not perform any operations. the default value is "Ready" Gets or sets the text that will be displayed in GridStatusBarItem when Telerik RadGrid is performing an AJAX request. the default value is "Loading..." A String Tokenizer that accepts Strings as source and delimiter. Only 1 delimiter is supported (either String or char[]). Constructor for StringTokenizer Class. The Source String. The Delimiter String. If a 0 length delimiter is given, " " (space) is used by default. Constructor for StringTokenizer Class. The Source String. The Delimiter String as a char[]. Note that this is converted into a single String and expects Unicode encoded chars. Constructor for StringTokenizer Class. The default delimiter of " " (space) is used. The Source String. Empty Constructor. Will create an empty StringTokenizer with no source, no delimiter, and no tokens. If you want to use this StringTokenizer you will have to call the NewSource(string s) method. You may optionally call the NewDelim(string d) or NewDelim(char[] d) methods if you don't with to use the default delimiter of " " (space). Method to add or change this Instance's Source string. The delimiter will remain the same (either default of " " (space) or whatever you constructed this StringTokenizer with or added with NewDelim(string d) or NewDelim(char[] d) ). The new Source String. Method to add or change this Instance's Delimiter string. The source string will remain the same (either empty if you used Empty Constructor, or the previous value of source from the call to a parameterized constructor or NewSource(string s)). The new Delimiter String. Method to add or change this Instance's Delimiter string. The source string will remain the same (either empty if you used Empty Constructor, or the previous value of source from the call to a parameterized constructor or NewSource(string s)). The new Delimiter as a char[]. Note that this is converted into a single String and expects Unicode encoded chars. Method to get the number of tokens in this StringTokenizer. The number of Tokens in the internal ArrayList. Method to probe for more tokens. true if there are more tokens; false otherwise. Method to get the next (string)token of this StringTokenizer. A string representing the next token; null if no tokens or no more tokens. Gets the Source string of this Stringtokenizer. A string representing the current Source. Gets the Delimiter string of this StringTokenizer. A string representing the current Delimiter. The frame attribute for a table specifies which sides of the frame surrounding the table will be visible. No sides. The top side only. The bottom side only. The top and bottom sides only. The left-hand side only. The right-hand side only. The right and left sides only. All four sides. All four sides Specifies the two possible text directions. Related to Telerik RadGrid support for right-to-left languages. Left-To-Right direction Right-To-Left direction Defines the possible modes for loading the child items when RadGrid displays hierarchy. All child GridTableViews will be bound immediately when DataBind occurs for a parent GridTableView or RadGrid. DataBind of a child GridTableView would only take place when an item is Expanded . This is the default value of This mode is similar to ServerBind, but items are expanded client-side, using JavaScript manipulations, instead of postback to the server. In order to use client-side hierarchy expand, you will need to set also to true. Specifies where the grouping will be handled. There are two options: Server-side - GridTableView.GroupLoadMode.Server Client-side - GridTableView.GroupLoadMode.Client This is the default behavior. Groups are expanded after postback to the server for example:
<MasterTableView GroupLoadMode="Server">
Groups will be expanded client-side and no postback will be performed.
<MasterTableView GroupLoadMode="Client">
and set the client setting AllowGroupExpandCollapse to true:
<ClientSettings AllowGroupExpandCollapse="True">
To display the grid column editors inline when switching grid item in edit mode (see the screenshot below), you simply need to change the EditMode property to InPlace. 
            							
            <radg:RadGrid id="RadGrid1" runat="server">
<MasterTableView AutoGenerateColumns="True" EditMode="InPlace" />
</radg:RadGrid>
A row in edit mode To display the grid column editors in auto-generated form when switching grid item in edit mode (see the screenshot below), you simply need to change the MasterTableView EditMode property to EditForms. 
            							
            <radg:RadGrid id="RadGrid1" runat="server">
<MasterTableView AutoGenerateColumns="True" EditMode="EditForms" />
</radg:RadGrid>
Edit in forms mode Telerik RadGrid will display the column editors inline when switching grid item in edit mode Telerik RadGrid will display the grid column editors in auto-generated form when switching grid item in edit mode Indicate where RadGrid would store its data DataSource (or generated html tables) data will not be stored. RadGrid will fire NeedDataSource event and will bind after each postback Default - RadGrid stores data in the view-state bag. Discribe how RadGrid whould respond if the is invalid when data-binding. See CurrentPageIndex would be set to 0 CurrentPageIndex would be set to current page count - 1 RadGrid would repord an InvalidOperationException. Specifies the position of the in Telerik RadGrid. There will be no command item. The command item will be above the Telerik RadGrid The command item will be on the bottom of Telerik RadGrid The command item will be both on the top and bottom of Telerik RadGrid. Represents one table of data. In case of flat grid structure, i.e. no hierarchy levels, this object is the MasterTableView itself. In case of hierarchical structure, the topmost GridTableView is the MasterTableView. All inner (child) tables are refered as DetailTables. Each table that has children tables has a collection called where you can access these tables. Gets the rendering style of a FilterItem. Gets the rendering style of a CommandItem. Constructs a new GridTableView and sets as its owner the RadGrid object. GridTableView Method GridTableView Method Constructs a new GridTableView and sets as its owner the RadGrid object. Sets the IsTrackingViewState property to the corresponding value of the boolean parameter. GridTableView Method GridTableView Method The owner RadGrid object Indicates whether RadGrid is saving changes to its view state. Default contructor for GridTableView - generally used by Page serializer only. GridTableView Method GridTableView Method Swaps columns appearance position using the unique names of the two columns. SwapColumns Method first column unique name second column unique name Swaps columns appearance position using order indexes of the two columns. You should have in mind that GridExpandColumn and RowIndicatorColumn are always in front of data columns so that's why you columns will start from index 2. SwapColumns Method first column order index second column order index Removes all selected items that belong to this GridTableView instance. GridSelecting Class ClearEditItems Method Removes all edit items that belong to the GridTableView instance. GridEditFormItem Class ClearSelectedItems Method Forces the Owner RadGrid to fire event then calls . GridNeedDataSourceEventHandler Delegate DataBind Method The Rebind method should be called every time a change to the RadGrid columns/items has been made. Binds the data source to the RadGrid instance. Call this member to bind partially RadGrid. Before calling this method the property should be assigned or you can use method instead. Use or member to bind all GridTableViews in RadGrid. DataSource Property Rebind Method For internal usage. For internal usage. For internal usage. For Internal Usage Returns a based on its . The GridColumn object related to the columnUniqueName. GridColumn Class UniqueName Property (Telerik.WebControls.GridColumn) The following code snippet demonstrates how you to access a column at PreRender RadGrid event and make set it as invisible: [ASPX/ASCX] <radg:radgrid id="RadGrid1" DataSourceID="AccessDataSource1" runat="server" OnPreRender="RadGrid1_PreRender">
</radg:radgrid>
<asp:AccessDataSource ID="AccessDataSource1" DataFile="~/Grid/Data/Access/Nwind.mdb"
SelectCommand="SELECT CustomerID, CompanyName, ContactName FROM Customers"
runat="server">
</asp:AccessDataSource> protected void RadGrid1_PreRender(object sender, System.EventArgs e) { RadGrid1.MasterTableView.GetColumn( "CustomerID" ).Visible = false; } GetItems Method The for the requested column. Returns a based on its . The for the requested column. Returns a collection of objects based on their . A s collection of objects based on their . GetColumn Method The , which will be used as a criteria for the collection. Applies all view changes to control hierarchy before rendering This method is used by RadGrid internally. Please do not use. For internal structure usage. Recreates all GridItems and chld controls, using the DataSource or the ViewState 'True' means that DataBind() is executing. 'False' means that Viewtate has been just loaded after postback. Exports the grid data in CSV format using the properties set in the ExportSettings. ExportToWord Method ExportToExcel Method MS Excel and MS Word online example Exports the grid data in PDF format using the properties set in the ExportSettings. Exporting online example Exports the grid data in Microsoft Excel ® format using the properties set in the ExportSettings. ExportToWord Method ExportToExcel Method MS Excel and MS Word online example Exports the grid data in Microsoft Excel ® format file with a given name. Only export to Excel 2003 and above is currently supported. GridExportSettings Class ExportToWord Method ExportToExcel2007 Method ExportToWord2007 Method MS Excel and MS Word online example A string specifying the name of the file for the exported data. The file extension should not be included. Exports the grid data in Microsoft Excel ® format file with a given name and options to ignore formatting and paging. Only export to Excel 2003 and above is currently supported. ExportToWord Method ExportToExcel2007 Method ExportToWord2007 Method GridExportSettings Class MS Excel and MS Word online example A string specifying the name of the file for the exported data. The file extension should not be included. If set to true, only the data will be exported, ignoring the formatting options. If set to true, the whole grid data will be exported ignoring the defined paging options. Otherwise (set to false) only the current page data will be exported. Exports the grid data in Microsoft Excel 2007 ® format using the properties set in the ExportSettings. ExportToExcel Method ExportToWord Method ExportToWord2007 Method Exports the grid data in Microsoft Excel 2007 ® format file with a given name. ExportToExcel Method ExportToWord Method ExportToWord2007 Method A string specifying the name of the file for the exported data. The file extension should not be included. Exports the grid data in Microsoft Excel 2007 ® format with options to ignore formatting and paging. ExportToExcel Method ExportToWord Method ExportToWord2007 Method A string specifying the name of the file for the exported data. The file extension should not be included. If set to true, only the data will be exported, ignoring the formatting options. If set to true, the whole grid data will be exported ignoring the defined paging options. Otherwise (set to false) only the current page data will be exported. Exports the grid data in Microsoft Word ® format based on the selected ExportSettings. GridExportSettings Class ExportToExcel Method ExportToExcel2007 Method ExportToWord2007 Method Exports the grid data in Microsoft Word ® format. Only export to Word 2003 and above is currently supported. GridExportSettings Class ExportToExcel Method ExportToExcel2007 Method ExportToWord2007 Method The name of the file that will be used for the exported data. Do not include the file extension. Exports the grid data in Microsoft Word ® format with options to ignore formatting and paging. Only export to Excel 2003 and above is currently supported. GridExportSettings Class ExportToExcel Method ExportToExcel2007 Method ExportToWord2007 Method The name of the file that will be used for the exported data. Do not include the file extension. If set to true, only the data will be exported, ignoring the formatting options. If set to true, the whole grid data will be exported ignoring the defined paging options. Otherwise (set to false) only the current page data will be exported. Exports the grid data in Microsoft Word 2007 ® format based on the selected ExportSettings. GridExportSettings Class ExportToExcel Method ExportToWord Method ExportToExcel2007 Method Exports the grid data in Microsoft Word 2007 ® format file with the given name. GridExportSettings Class ExportToExcel Method ExportToWord Method ExportToExcel2007 Method The name of the file that will be used for the exported data. Do not include the file extension. Exports the grid data in Microsoft Word 2007 ® format with options to ignore formatting and paging. GridExportSettings Class ExportToExcel Method ExportToWord Method ExportToExcel2007 Method The name of the file that will be used for the exported data. Do not include the file extension. If set to true, only the data will be exported, ignoring the formatting options. If set to true, the whole grid data will be exported ignoring the defined paging options. Otherwise (set to false) only the current page data will be exported. For internal usage. For internal usage. The passed IDictionary object (like Hashtable for example) will be filled with the names/values of the corresponding column data-fields and their values. Only instances of type support extracting values. Using grid server-side API for extraction the dictionary that will be filled the item to extract values from Perform asynchronous update operation, using the DataSource control API and the Rebind method. Please, make sure you have specified the correct DataKeyNames for the . When the asynchronous operation calls back, RadGrid will fire event. The following online example uses PerformUpdate method: Edit on double-click DataKeyNames Property PerformInsert Method PerformDelete Method Perform asynchronous update operation, using the DataSource control API. Please make sure you have specified the correct DataKeyNames for the GridTableView. When the asynchronous operation calls back, RadGrid will fire event. The boolean property defines if RadGrid will after the update. PerformInsert Method PerformDelete Method the item that is in edit mode and should be updated set to true to prevent grid from binding after the update operation completes Perform asynchronous insert of the new item, diplayed by RadGrid when in edit mode, using the DataSourceControl API, then . When the asynchronous operation calls back, RadGrid will fire event. PerformUpdate Method PerformDelete Method Get the item that appears when grid is in Insert Mode. PerformInsert Method A reference to the newly inserted item for the respective GridTableView. There is scenarios in which you need to make some changes with/depending on the inserted item. If you want to predifine some controls values on item insertion, you should use the ItemCommand server-side event to access it: 
            [C#]
private void RadGrid1_ItemCommand(object source, Telerik.WebControls.GridCommandEventArgs e)
{
  if (e.CommandName == RadGrid.InitInsertCommandName)

              {
    e.Canceled = true;

                e.Item.OwnerTableView.InsertItem();
    GridEditableItem insertedItem = e.Item.OwnerTableView.GetInsertItem();

                GridEditFormItem editFormItem = insertedItem as GridEditFormItem; 

    TextBox box = editFormItem.FindControl("txtEmployeeID") as TextBox;
    box.Text = "11";
  }
}
                
            		
[VB.NET]
                
            Private Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Handles RadGrid1.ItemCommand
         If (e.CommandName = RadGrid.InitInsertCommandName) Then

                        e.Canceled = True
            e.Item.OwnerTableView.InsertItem()
             Dim insertedItem As GridEditableItem = e.Item.OwnerTableView.GetInsertItem()

                         Dim editFormItem As GridEditFormItem = CType(insertedItem, GridEditFormItem)

             Dim box As TextBox = CType(MyUserControl.FindControl("insertedItem"), TextBox)
            box.Text = "11"
         End If
 End Sub
If you want to get access to the newly added row and its values to update in a custom data source, you can use the InsertCommand event: [C#] 
            		protected void RadGrid1_InsertCommand(object source, GridCommandEventArgs e)  
 {  
     GridDataInsertItem gridDataInsertItem =  
         (GridDataInsertItem)(RadGrid1.MasterTableView.GetInsertItem());

                Hashtable ht = new Hashtable();  
     gridDataInsertItem.ExtractValues(ht);  
     //Loop through each "DictionaryEntry" in hash table and insert using key value 
     foreach (DictionaryEntry ent in ht)  

                 {  
         //get the key values and insert to custom datasource. 
     } 
            		
}
[Visual Basic] 
            Protected Sub RadGrid1_InsertCommand(ByVal source As Object, ByVal e As GridCommandEventArgs)
    Dim gridDataInsertItem As GridDataInsertItem = CType(RadGrid1.MasterTableView.GetInsertItem,GridDataInsertItem)

                Dim ht As Hashtable = New Hashtable
    gridDataInsertItem.ExtractValues(ht)
    'Loop through each "DictionaryEntry" in hash table and insert using key value 
    For Each ent As DictionaryEntry In ht

                    'get the key values and insert to custom datasource. 
    Next
End Sub
Performs asynchronous insert operation, using the DataSourceControl API, then Rebinds. When the asynchronous operation calls back, RadGrid will fire event. PerformUpdate Method PerformDelete Method item to be inserted Perform asynchronous insert operation, using the DataSource control API. When the asynchronous operation calls back, RadGrid will fire event. PerformUpdate Method PerformDelete Method the item to be inserted True to prevent from binding after the insert operartion completes. Perform asynchronous delete operation, using the DataSourceControl API the Rebinds the grid. Please make sure you have specified the correct DataKeyNames for the GridTableView. When the asynchronous operation calls back, RadGrid will fire event. DataKeyNames Property PerformUpdate Method PerformInsert Method The item that should be deleted Perform delete operation, using the DataSourceControl API. Please make sure you have specified the correct DataKeyNames for the GridTableView. DataKeyNames Property PerformUpdate Method PerformInsert Method The item that should be deleted Set to true to stop error from binding Places the GridTableView in insert mode, allowing user to insert a new data-item values. The will be set to display the last page. You can use also the to place the GridTableView in insert mode. Places the GridTableView in insert mode, allowing the user to insert a new data-item values. The GridInsertItem created will be bound to values of the newDataItem object. The will be set to display the last page. You can use also the property to place the GridTableView in insert mode. Places the GridTableView in insert mode, allowing the user to insert a new data-item values. The GridInsertItem created will be bound to values found in newValues dictionary; The will be set to display the last page. You can use also the to place the GridTableView in insert mode. Gets the owner RadGrid object. The owner RadGrid object. OwnerID Property Gets the ClientID of the RadGrid object that contains this instance. The string representation of the ClientID object that contains the instance. OwnerGrid Property Gets or sets the collection of detail table views for this GridTableView. A collection of detail table views for this GridTableView. DataKeyValues Property DataKeyNames Property Adding or removing objects to the DetailTables collection changes the hierarchical structure. Use after modifying the collection programmatically. This collection can also be altered unsing the environment designer. Gets or sets a value that describes how RadGrid would respond if the is invalid when data-binding. This property is not persisted in the ViewState. By deafult the value is . GridResetPageIndexAction Enumeration A member of the GridResetPageIndexAction enumeration which describes how RadGrid would respond if the CurrentPageIndex is invalid when data-binding. By default its value is Gets or sets a value indicating whether the border lines for grid cells will be displayed. One of the GridLines values. The default is . Use the GridLines property to specify the gridline style for a GridTableView control. The following table lists the available styles. Style Description GridLines.None No gridlines are displayed. GridLines.Horizontal Displays the horizontal gridlines only. GridLines.Vertical Displays the vertical gridlines only. GridLines.Both Displays both the horizontal and vertical gridlines. CellPadding Property (Telerik.WebControls.GridTableViewBase) CellSpacing Property (Telerik.WebControls.GridTableViewBase) The following code snippet demonstrates how to use the GridLines property to hide the gridlines in a GridTableView control. [ASPX/ASCX] <radG:RadGrid ID="RadGrid1" runat="server" GridLines="None">
</radGrid:RadGrid> RadGrid1.GridLines = GridLines.None RadGrid1.GridLines = GridLines.None; HorizontalAlign Property Gets or sets a value indicating the horizontal alignment of the grid table. One of the HorizontalAlign values. The default is . Use the HorizontalAlign property to specify the horizontal alignment of a GridTableView control within the page. The following table lists the different horizontal alignment styles. Alignment value Description HorizontalAlign.NotSet The horizontal alignment of the GridTableView control has not been set. HorizontalAlign.Left The GridTableView control is left-aligned on the page. HorizontalAlign.Center The GridTableView control is centered on the page. HorizontalAlign.Right The GridTableView control is right-aligned on the page. HorizontalAlign.Justify The GridTableView control is aligned with both the left and right margins of the page. GridLines Property The following code snippet demonstrates how to use the HorizontalAlign property to align a GridTableView control on the right side of a page. [ASPX/ASCX] <radG:RadGrid ID="RadGrid1" runat="server" HorizontalAlign="Right">
</radG:RadGrid> RadGrid1.HorizontalAlign = HorizontalAlign.Right RadGrid1.HorizontalAlign = HorizontalAlign.Right; Gets a collection of DataKeyValue objects that represent the data key value of the corresponding item (specified with its ) and the DataKeyName (case-sensitive!). The DataKeyName should be one of the specified in the array. protected void RadGrid1_ItemUpdated(object source, Telerik.WebControls.GridUpdatedEventArgs e) { if (e.Exception != null) { e.KeepInEditMode = true; e.ExceptionHandled = true; Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues[e.Item.ItemIndex]["EmployeeID"] + " cannot be updated. Reason: " + e.Exception.Message); } else { Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues[e.Item.ItemIndex]["EmployeeID"] + " updated"); } } int eID = (int)tableView.DataKeyValues[editedItem.ItemIndex]["EmployeeID"]; Dim eID as Integer = (CInt)tableView.DataKeyValues(editedItem.ItemIndex)("EmployeeID") Protected Sub RadGrid1_ItemUpdated(ByVal source As Object, ByVal e As Telerik.WebControls.GridUpdatedEventArgs) Handles RadGrid1.ItemUpdated If Not e.Exception Is Nothing Then e.KeepInEditMode = True e.ExceptionHandled = True Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues(e.Item.ItemIndex)("EmployeeID").ToString() + " cannot be updated. Reason: " + e.Exception.Message) Else Response.Write("Employee " + e.Item.OwnerTableView.DataKeyValues(e.Item.ItemIndex)("EmployeeID").ToString() + " updated") End If End Sub data key name/value pair A GridDataKeyArray that contains the data key of each item in a GridTableView control. When the DataKeyNames property is set, the GridTableView control automatically creates a DataKeyValue object for each item in the control. The DataKeyValue object contains the values of the field or fields specified in the DataKeyNames property. The DataKeyValue objects are then added to the control's DataKeysValue collection. Use the DataKeysValue property to retrieve the DataKeyValue object for a specific data item in the GridTableView control. Gets or sets an array of data-field names that will be used to populate the collection, when the GridTableView control is databinding. Use the DataKeyNames property to specify the field or fields that represent the primary key of the data source. Note: Values set to this property are case-sensitive! The field names should be coma-separated. The data key names/values are stored in the ViewState so they are available at any moment after grid have been data-bound, after postbacks, etc. This collection is used when editing data, and for automatic relations when binding an hiararchical grid (see ). If the Visible property of a column field is set to false, the column is not displayed in the GridTableView control and the data for the column does not make a round trip to the client. If you want the data for a column that is not visible to make a round trip, add the field name to the DataKeyNames property. An array that contains the names of the primary key fields for the items displayed in a GridTableView control. Gets or sets values indicating DataFieldNames that should be sorted, grouped, etc and are not included as columns, in case the property is false. DataKeyValues Property DataKeyNames Property An array of DataFieldNames values that should be sorted, grouped, etc and are not included as columns. RetrieveAllDataFields Property Gets or sets a value indicating whether RadGrid will show instead of the corresponding if there is no items to display. true if usage is enabled; otherwise, false. The default value is true. NoRecordsTemplate Property NoMasterRecordsText Property NoDetailRecordsText Property Gets or sets the template that will be displayed if a GridTableView control is bound to a data source that does not contain any records. You can set the text that will appear in the NoRecordsTemplate through NoMasterRecordsText and NoDetailRecordsText properties. By default if Items.Count equals 0, GridTableView will render no records message. If NoRecordsTemplate and NoMasterRecordsText/NoDetailRecordsText are set, the NoRecordsTemplate property has priority. A System.Web.UI.ITemplate that contains the custom content for the empty data row. The default value is a null reference (Nothing in Visual Basic), which indicates that this property is not set. The following example demonstrates how NoRecordsTemplate can be implemented declaratively: [ASPX/ASCX] <radG:RadGrid ID="RadGrid1" runat="server">
<MasterTableView>
<NoRecordsTemplate>
<div style="text-align: center; height: 300px">
<asp:Label ForeColor="RoyalBlue" runat="server" ID="Label1">Currently there are no items in this folder.</asp:Label>
<br />
</div>
</NoRecordsTemplate>
</MasterTableView>
</radG:RadGrid> The following code snippet demonstrates how the NoRecordsTemplate can be implemented dynamically: RadGrid1.MasterTableView.NoRecordsTemplate = New NoRecordsTemplate() Public Class NoRecordsTemplate Implements ITemplate Public Sub New() End Sub Public Sub InstantiateIn(ByVal container As System.Web.UI.Control) Implements System.Web.UI.ITemplate.InstantiateIn Dim lbl As Label = New Label() lbl.ID = "Label1" lbl.Text = "Currently there are no items in this folder." lbl.ForeColor = System.Drawing.Color.RoyalBlue container.Controls.Add(lbl) End Sub End Class RadGrid1.MasterTableView.NoRecordsTemplate = new NoRecordsTemplate(); class NoRecordsTemplate: ITemplate { public NoRecordsTemplate() { } public void InstantiateIn(Control container) { Label lbl = new Label(); lbl.ID = "Label1"; lbl.Text = "Currently there are no items in this folder."; lbl.ForeColor = System.Drawing.Color.RoyalBlue; container.Controls.Add(lbl); } } The EnableNoRecordsTemplate Property should be set to true (its default value) in order to be displayed the NoRecordsTemplate. EnableNoRecordsTemplate Property NoMasterRecordsText Property NoDetailRecordsText Property Gets or sets the text that will be displayed in there is no defined and no records in the MasterTableView. EnableNoRecordsTemplate Property NoRecordsTemplate Property NoDetailRecordsText Property The text to display in the empty data item. The default is an empty string ("") which indicates that this property is not set. The empty data row is displayed in a GridTableView control when the data source that is bound to the control does not contain any records. Use the NoMasterRecordsText and NoDetailRecordsText property to specify the text to display in the empty data item. Alternatively, you can define your own custom user interface (UI) for the empty data item by setting the NoRecordsTemplate property instead of this property. Gets or sets the text that will be displayed in there is no defined and no records in the Detail tables. The text to display in the empty data item. The default is an empty string (""), which indicates that this property is not set. The empty data row is displayed in a GridTableView control when the data source that is bound to the control does not contain any records. Use the NoMasterRecordsText and NoDetailRecordsText property to specify the text to display in the empty data item. Alternatively, you can define your own custom user interface (UI) for the empty data item by setting the NoRecordsTemplate property instead of this property. EnableNoRecordsTemplate Property NoRecordsTemplate Property NoMasterRecordsText Property Gets or sets a value indicating whether the GridTableView will extract all bindable properties from the DataSource when binding, to perform operations like sorting, grouping, etc on DataFields that are not included in the column declarations. You can also use the array to indicate RadGrid DataFieldNames that should be sorted, grouped, ect and are not included as columns. true, if the GridTableView will extract all bindable properties from the DataSource when binding; otherwise, false. The default value is true. AdditionalDataFieldNames Property Gets or sets a value indicating whether null values in the database will be retrieved as dbnull values. true if the null values in the database will be retrieved as dbnull values; otherwise, false. The default is false. Gets or sets the collection of data-field pairs that describe the relations in a hierarchical grid. If you have specified the relations RadGrid will automatically filter the child data-source when when binding detail-tables. The specified in each in this collection should be a Key that is specified in the parent table's array. Each DetailKeyField specfied should also be included in this GridTableView's DataKeyNames array. MasterTableView does not need any ParentTableRelations. A GridTableViewRelation collection of data-field pairs that describe the relations in a hierarchical grid. GridTableViewRelation Class DataKeyValues Property DataKeyNames Property Hierarchy online example Gets a set the options for GridTableView's self-hierarchy behavior. GridSelfHierarchySettings Class Options for GridTableView's self-hierarchy behavior. Self-referencing hierarchy online example Gets a set the options for GridTableView's command item. The options for GridTableView's command item. GridCommandItemSettings Class CommandItemDisplay Property Gets or sets the object from which the data-bound control retrieves its list of data items. Generally the DataSource object references . Assign this property only if you need to change the default behavior or . RadGrid modifies this property when is assigned. On postback the DataSource property settings are not persisted due to performance reasons. Note, however, that you can save the grid DataSource in a Session/Application/Cache variable and then retrieve it from there after postback invocation. Respectively, you can get the changes made in the data source in a dataset object and then operate with them. This property cannot be set by themes or style sheet themes. An object that represents the data source from which the GridTableView control retrieves its data. The default is a null reference (Nothing in Visual Basic). DataSourceID Property Simple data-binding online example Various data sources online example GridNeedDataSourceEventHandler Delegate Gets or sets the ID of the DataSource control used for population of this GridTableView data items. [ASPX/ASCX]
<radG:RadGrid ID="RadGrid1" runat="server" DataSourceID="SessionDataSource1">
............
</radG:RadGrid> The ID of a control that represents the data source from which the data-bound control retrieves its data. The default is String.Empty (""). This property cannot be set by themes or style sheet themes. DataSource Property GridNeedDataSourceEventHandler Delegate Gets a reference to a GridItem that is a parent of this GridTableView, when this GridTableView represents a child table in a hierarchical structure. A reference to the server control's parent control. Whenever a page is requested, a hierarchy of server controls on that page is built. This property allows you to determine the parent control of the current server control in that hierarchy, and to program against it. Whenever a page is requested, a hierarchy of server controls on that page is built. This property allows you to determine the parent control of the current server control in that hierarchy, and to program against it. GridItem Class Gets or sets the filtering options for grid columns. In the most common case, Telerik RadGrid checks all filtering options for each column, then prepares a filter expression and sets this property internally. Note: You should be careful when setting this property as it may break the whole filtering functionality for your grid. More info on the way, the expressions are created you can find here (external link to MSDN library). If (Not Page.IsPostBack) Then RadGrid1.MasterTableView.FilterExpression = "([Country] LIKE '<see cref="Germany"/>') " Dim column As GridColumn = RadGrid1.MasterTableView.GetColumnSafe("Country") column.CurrentFilterFunction = GridKnownFunction.Contains column.CurrentFilterValue = "Germany" End If if (!Page.IsPostBack) { RadGrid1.MasterTableView.FilterExpression = "([Country] LIKE \'<see cref="Germany"/>\') "; GridColumn column = RadGrid1.MasterTableView.GetColumnSafe("Country"); column.CurrentFilterFunction = GridKnownFunction.Contains; column.CurrentFilterValue = "Germany"; } Applying default filter on initial load Gets or sets a value indicating whether the groups will be expanded on grid load (true by default). true, if the groups will be expanded on grid load; otherwise, false. The default value is true. GroupLoadMode Property GroupByExpressions Property Gets or sets a value indicating whether the hierarchy will be expanded by default. Gets a reference to the object, allowing you to customize its settings. The property setter does nothing and should not be used. It works around a bug in the VS.NET designer. Gets a reference to the object, allowing you to customize its settings. The property setter does nothing and should not be used. It works around a bug in the VS.NET designer. Gets or sets a value indicating when the DataBind of the child GridTableView will occur when working in hierarchy mode. Accepts values from enumeration. See the remars for details. Changing this propery value impacts the performance the following way: In ServerBind mode - Roundtrip to the database only when grid is bound. ViewState holds all detail tables data. Only detail table-views of the expanded items are rendered. Postback to the server to expand an item In ServerOnDemand mode - Roundtrip to the database when grid is bound and when item is expanded. ViewState holds data for only visible Items (smallest possible). Only detail table-views of the expanded items are rendered. Postback to the server to expand an item. In Client mode - Roundtrip to the database only when grid is bound. ViewState holds all detail tables data. All items are rendered - even is not visible (not expanded). NO postback to the server to expand an item - expand/collapse of hierarchy items is managed client-side.
Note: In order to use client-side hierarchy expand, you will need to set also to true. The default value is ServerOnDemand. Specifies where the grouping will be handled. There are two options: Server-side - GridTableView.GroupLoadMode.Server Client-side - GridTableView.GroupLoadMode.Client GridTableView.GroupLoadMode.Server This is the default behavior. Groups are expanded after postback to the server for example: 
            							
            <MasterTableView GroupLoadMode="Server">
GridTableView.GroupLoadMode.Client
Groups will be expanded client-side and no postback will be performed.
            								
            <MasterTableView GroupLoadMode="Client">
and set the client setting AllowGroupExpandCollapse to true:
            								
            <ClientSettings AllowGroupExpandCollapse="True">
There are two possible values defined by the GridEditMode enumeration: InPlace EditForms To display the grid column editors inline when switching grid item in edit mode (see the screenshot below), you simply need to change the EditMode property to InPlace. 
            							
            <radg:RadGrid id="RadGrid1" runat="server">
<MasterTableView AutoGenerateColumns="True" EditMode="InPlace" />
</radg:RadGrid>
A row in edit mode To display the grid column editors in auto-generated form when switching grid item in edit mode (see the screenshot below), you simply need to change the MasterTableView EditMode property to EditForms. 
            							
            <radg:RadGrid id="RadGrid1" runat="server">
<MasterTableView AutoGenerateColumns="True" EditMode="EditForms" />
</radg:RadGrid>
Edit in forms mode FormsGets or sets a value indicating how a GridItem will look in edit mode. A value indicating how a GridItem will look in edit mode. The default is EditForms. GridEditMode Enumeration Gets or sets the value indicating wheather more than one column can be sorted in a single GridTableView. The order is the same as the sequence of expressions in . true, if more than one column can be sorted in a single GridTableView; otherwise, false. The default value is false. AllowSorting Property SortExpressions Property Gets or sets the value indicated whether the no-sort state when changing sort order will be allowed. true, if the no-sort state when changing sort order will be allowed; otherwise, false. The default value is true. SortExpressions Property AllowSorting Property Gets or sets a value indicating whether the sorting feature is enabled. true if the sorting feature is enabled; otherwise, false. The default is . SortExpressions Property AllowCustomSorting Property AllowMultiColumnSorting Property When a data source control that supports sorting is bound to the GridTableView control, the GridTableView control can take advantage of the data source control's capabilities and provide automatic sorting functionality. To enable sorting, set the AllowSorting property to true. When sorting is enabled, the heading text for each column field with its SortExpressions property set is displayed as a link button. Clicking the link button for a column causes the items in the GridTableView control to be sorted based on the sort expression. Typically, the sort expression is simply the name of the field displayed in the column, which causes the GridTableView control to sort with respect to that column. To sort by multiple fields, use a sort expression that contains a comma-separated list of field names. You can determine the sort expression that the GridTableView control is applying by using the SortExpressions property. Clicking a column's link button repeatedly toggles the sort direction between ascending and descending order. Note that if you want to sort the grid by a column different than a GridBoundColumn, you should set also its SortExpression property to the desired data field name you want the column to be sorted by. Different data sources have different requirements for enabling their sorting capabilities. To determine the requirements, see the documentation for the specific data source. The SortExpression property for an automatically generated columns field is automatically populated. If you define your own columns through the Columns collection, you must set the SortExpression property for each column; otherwise, the column will not display the link button in the header. AllowNaturalSort Property SortExpressions Property Gets or sets a value indicating whether the filtering by column feature is enabled. true if the filtering by column feature is enabled; otherwise, false. Default value is the value of . When the value is true, GridTableView will display the filtering item, under the table's header item. The filtering can be controlled based on a column through column properties: , , . The column method is used to determine if a column can be used with filtering. Generally, this function returns the value set to AllowFiltering for a specific column. For example will return the values of property. GridFilteringItem Class Basic filtering online example Gets or sets a value indicating whether Telerik RadGrid will automatically generate columns at runtime based on its DataSource. A value indicating whether Telerik RadGrid will automatically generate columns at runtime based on its DataSource. The default value is the value of RadGrid's property . AutoGeneratedColumns Property For internal usage. Gets all items among the hierarchy of GridTableView items that are selected. The selected items in a GridTableView are cleared when collapses and the ParentItem becomes selected. A GridItemCollection of items among the hierarchy of GridTableView items that are selected. GridItemCollection Class Gets all items among the hierarchy of GridTableView items that are in edit mode. The edit items in a GridTableView are cleared when collapses. A GridItemCollection of items that are in edit mode. GridItemCollection Class EditMode Property EditFormSettings Property Gets or sets a value indicating whether all columns settings will be persisted in the ViewState or not. true if columns are kept in the view state; otherwise false. The default value is true. Set this property to false if you need to change dynamically the structure of the RadGrid. Gets or sets if the custom sorting feature is enabled. With custom sorting turned on, RadGrid will display as Sorting Icons, will maintain the SortExpressions collection and so on, but it will not actually sort the Data. You should perform the custom sorting in the SortCommand event handler. You can also use the method, which will return the sort expressions string in the same format as it wold be used by a DataView component. true, if custom sorting feature is enabled; otherwise, false. The default value is false. AllowSorting Property SortExpressions Property GridSortCommandEventHandler Delegate Gets or sets if the custom paging feature is enabled. true, if the custom paging feature is enabled; otherwise, false. Default value is the value of . AllowPaging Property Custom paging online example There are cases in which you may want to fetch only a fixed number of records and perform operations over this specified set of data. Telerik RadGrid allows such data manipulation through the custom paging mechanism integrated in the control. The main steps you need to undertake are: Set AllowPaging = true and AllowCustomPaging = true for your grid instance Implement code logic which to extract merely a fixed number of records from the grid source and present them in the grid structure The total number of records in the grid source should be defined through the VirtualItemCount property of the MasterTableView/GridTableView instance. Thus the grid "understands" that the data source contains the specified number of records and it should fetch merely part of them at a time to execute requested operation. Another available option for custom paging support is through the ObjectDataSource control custom paging feature:
Custom paging with ObjectDataSource grid content generator Gets or sets a value indicating whether the paging feature is enabled. true if the paging feature is enabled; otherwise, false. The default is . PageCount Property PageSize Property PagingManager Property PagerStyle Property RenderPagerStyle Property PagerTemplate Property CurrentPageIndex Property CurrentResetPageIndexAction Property Instead of displaying all the records in the data source at the same time, the GridTableView control can automatically break the records up into pages. If the data source supports the paging capability, the GridTableView control can take advantage of that and provide built-in paging functionality. The paging feature can be used with any data source object that supports the System.Collections.ICollection interface or a data source that supports paging capability. To enable the paging feature, set the AllowPaging property to true. By default, the GridTableView control displays 10 records on a page at a time. You can change the number of records displayed on a page by setting the PageSize property. To determine the total number of pages required to display the data source contents, use the PageCount property. You can determine the index of the currently displayed page by using the CurrentPageIndex property. When paging is enabled, an additional row called the pager item is automatically displayed in the GridTableView control. The pager row contains controls that allow the user to navigate to the other pages. You can control the settings of the pager row (such as the pager display mode, the number of page links to display at a time, and the pager control's text labels) by using the PagerStyle properties. The pager row can be displayed at the top, bottom, or both the top and bottom of the control by setting the Position property. You can also select from one of six built-in pager display modes by setting the Mode property. The GridTableView control also allows you to define a custom template for the pager row. For more information on creating a custom pager row template, see PagerTemplate. The GridTableView control provides an event that you can use to perform a custom action when paging occurs. Event Description Occurs when one of the pager buttons is clicked, but after the GridTableView control handles the paging operation. This event is commonly used when you need to perform a task after the user navigates to a different page in the control. Specify the maximum number of items that would appear in a page, when paging is enabled by or property. Default value is the value of . The number of records to display on a single page. The default is 10. The PageSize property is set to a value less than 1. When the paging feature is enabled (by setting the AllowPaging property to true), use the PageSize property to specify the number of records to display on a single page. The number of records to display on a single page. The default is 10. Gets or sets a value indicating whether Telerik RadGrid will perform automatic updates, i.e. using the DataSource controls functionality. true, if Telerik RadGrid will perform automatic updates; otherwise, false. The default value is false. Automatic operations online example Gets or sets a value indicating whether Telerik RadGrid will perform automatic inserts, i.e. using the DataSource controls functionality. true, if the Telerik RadGrid will perform automatic inserts; otherwise, false. The default value is false. Automatic operations online example Gets or sets a value indicating whether Telerik RadGrid will perform automatic deletes, i.e. using the DataSource controls functionality. true, if Telerik RadGrid will perform automatic deletes; otherwise, false. The default value is false. Automatic operations online example Gets a collection of GridColumn objects that represent the column fields in a GridTableView control. A GridColumnCollection that contains all the column fields in the GridTableView control. A column field represents a column in a GridTableView control. The Columns property (collection) is used to store all the explicitly declared column fields that get rendered in the GridTableView control. You can also use the Columns collection to programmatically manage the collection of column fields. The column fields are displayed in the GridTableView control in the order that the column fields appear in the Columns collection. To get a list of all columns rendered in the current instance use Although you can programmatically add column fields to the Columns collection, it is easier to list the column fields declaratively in the GridTableView control and then use the Visible property of each column field to show or hide each column field. If the Visible property of a column field is set to false, the column is not displayed in the GridTableView control and the data for the column does not make a round trip to the client. If you want the data for a column that is not visible to make a round trip, add the field name to the DataKeyNames property. This property can be managed programmatically or by Property Builder (IDE designer). Explicitly declared column fields can be used in combination with automatically generated column fields. When both are used, explicitly declared column fields are rendered first, followed by the automatically generated column fields. Automatically generated column fields are not added to the Columns collection. GridColumnCollection Class GridColumn Class Column types online example Gets the number of pages required to display the records of the data source in a GridTableView control. The number of pages in a GridTableView control. When the paging feature is enabled (by setting the AllowPaging Property to true), use the PageCount property to determine the total number of pages required to display the records in the data source. This value is calculated by dividing the total number of records in the data source by the number of records displayed in a page (as specified by the PageSize property) and rounding up. AllowPaging Property AllowCustomPaging Property PageSize Property PagingManager Property PagerStyle Property PagerTemplate Property Gets the number of pages if paging is enabled. The number of pages if paging is enabled. AllowPaging Property AllowCustomPaging Property Gets a DataView object that represents the data sent to the to be displayed. A result DataView object of all grid operations. ResolvedDataSourceView is available only in event handler i.e. when the grid is bound. Gets a Paging object that is the result of paging settings and runtime paging state of the grid. A GridPagingManager object that corresponds to the Paging object. Note that changes made to this object would not have effect on the structure of the grid. AllowPaging Property PageSize Property PageCount Property Gets a collection of sort expressions for this table view instance, associated with the column or columns being sorted. Modifying the SortExpressions collection will result in change of the order of appearance of items in the table view. If is set to false this collection can only contain one item. Adding other in the collection in this case will cause existing expression to be deleted or if GridSortExpression with the same same exist its will be changed. This property's value is preserved in the ViewState. GridSortExpressionCollection Class AllowSorting Property AllowCustomSorting Property AllowMultiColumnSorting Property The collection of sort expressions associated with the column or columns being sorted. Advanced sorting online example Adding to this collection will cause the current table-view to display items sorted and devided in groups separated by s, that display common group and aggregate field values. See on details of expressions syntax. Note that the correctness of the expressions in the collection is checked when DataBind occures. Then if an expression in not correct or a combination of expressions is erroneous a would be thrown on . This property's value is preserved in the ViewState. A GroupByExpressionCollection of values that will cause the current table-view to display items sorted and devided in groups separated by GridGroupHeaderItems, that display common group and aggregate field values. Group-By expressions online example Get an array of automatically generated columns. This array is available when is set to true. Autogenerated columns appear always after when rendering. An array of automatically generated columns. Gets a value defining the setting that will be applied when an Item is in edit mode and the property is set to EditForms. [ASPX/ASCX] <MasterTableView>
<EditFormSettings CaptionFormatString='<img src="img/editRowBg.gif" alt="" />'>
<FormMainTableStyle GridLines="None" CellSpacing="0" CellPadding="3" Width="100%" CssClass="none"/>
<FormTableStyle CssClass="EditRow" CellSpacing="0" BorderColor="#c4c0b5" CellPadding="2" Width="100%"/>
<FormStyle Width="100%" BackColor="#ffffe1"></FormStyle>
</EditFormSettings> GridEditFormSettings Class Use this property to determine how DataSource of the GridTableView will be persisted on PostBack. Some operations in Telerik RadGrid, like groupings or hierarchical views expand/collapse, require that the DataSourcePersistenceMode is set to . If no data is persisted for items in Telerik RadGrid (NoPersistence mode) then the state of items is lost on postback. Generally, datasource persistence optimization should be used if the small size/speed of a page, showing Telerik RadGrid, is crucial to the application.
If the value of this property is , RadGrid will call NeedDataSource and will bind after each post back, to restore its items. RadGrid manages the state of the following features with NoPersistence mode: indexes of selected items indexes of edited items group-by expressions sort expressions style properties (but not if any style is applied on a single cell or row in ItemDataBound event) column order other column properties hierarchy structure RadGrid does NOT manage the state in NoPersistence mode for the following: custom edit forms (user control or form template) filtering Returns ViewState if Telerik RadGrid will persist the DataSource in its ViewState, otherwise NoPersistence. The default value is ViewState. GridDataSourcePersistenceMode Enumeration Gets or sets a string that specifies a brief description of a GridTableView. Related to Telerik RadGrid accessibility compliance. A string that represents the text to render in an HTML caption element in a GridTableView control. The default value is an empty string (""). Use the Caption property to specify the text to render in an HTML caption element in a GridTableView control. The text that you specify provides assistive technology devices with a description of the table that can be used to make the control more accessible. Summary Property 
            The following example demonstrates how to style the Caption of a MasterTableView and detail GridTableView.
            
            <head runat="server">
    <title>Untitled Page</title>
    <style type="text/css">

            		.MasterTable_Default caption
            {
             color: red;
            }   
                
            		.DetailTable_Default caption
            {
             color: blue;
            }

            		
    </style>
</head>
<body>
<form id="form1" runat="server">
<div>
<radG:RadGrid runat="server" ID="RadGrid1" DataSourceID="SqlDataSource1" AllowPaging="true"
AllowMultiRowEdit="true" OnItemCommand="RadGrid1_ItemCommand" >
<MasterTableView EditMode="EditForms" DataKeyNames="CustomerID" Caption="Master Caption" CommandItemDisplay="Top">
 
            <Columns>
<radG:GridEditCommandColumn>
</radG:GridEditCommandColumn>
</Columns>
<DetailTables>
<radG:GridTableView DataKeyNames="OrderID" DataSourceID="SqlDataSource2" Caption="Detail Caption" CssClass="DetailTable_Default">
<ParentTableRelation>
<radG:GridRelationFields DetailKeyField="CustomerID" MasterKeyField="CustomerID" />
</ParentTableRelation>
</radG:GridTableView>
</DetailTables>
</MasterTableView>
</radG:RadGrid>
<asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="</%$ ConnectionStrings:NorthwindConnectionString2/%>"
SelectCommand="SELECT [CustomerID], [CompanyName], [ContactName], [ContactTitle] FROM [Customers]">
</asp:SqlDataSource>
<asp:SqlDataSource ID="SqlDataSource2" runat="server" ConnectionString="</%$ ConnectionStrings:NorthwindConnectionString2/%>"
SelectCommand="SELECT [OrderID], [CustomerID], [ShipCountry] FROM [Orders] WHERE ([CustomerID] = @CustomerID)">
<SelectParameters>
<asp:Parameter Name="CustomerID" Type="String" />
</SelectParameters>
</asp:SqlDataSource>
</div>
</form>
</body>
Gets or sets the 'summary' attribute for the respective table. This attribute provides a summary of the table's purpose and structure for user agents rendering to non-visual media such as speech and Braille. This property is a part of Telerik RadGrid accessibility features. A string representation of the 'summary' attribute for the respective table. Caption Property Gets or sets the text direction. This property is related to Telerik RadGrid support for Right-To-Left lanugages. It has two possible vales defined by enumeration: LTR - left-to-right text RTL - right-to-left text The frame attribute for a table specifies which sides of the frame surrounding the table will be visible. Possible values: void: No sides. This is the default value. above: The top side only. below: The bottom side only. hsides: The top and bottom sides only. vsides: The right and left sides only. lhs: The left-hand side only. rhs: The right-hand side only. box: All four sides. border: All four sides Gets or sets a value specifying the frame table attribute. A GridTableFrame value, specifying the frame table attribute. GridTableFrame Enumeration GridTableLayout Enumeration A GridTableLayout value, indicating the table layout type. The default value is . Gets or sets a string that indicates whether the table layout is fixed. The value of the TableLayout property is a string that specifies or receives one of the following GridTableLayout enumeration values: Auto Column width is set by the widest unbreakable content in the column cells. Fixed Default. Table and column widths are set either by the sum of the widths on the objects or, if these are not specified, by the width of the first row of cells. If no width is specified for the table, it renders by default with width=100%. Gets a reference to the GridTableItemStyle object that allows you to set the appearance of items in a GridTableView control. A reference to the GridTableItemStyle that represents the style of data items in a GridTableView control. If style is not altered (is default) is used. AlternatingItemStyle Property CommandItemStyle Property FooterStyle Property HeaderStyle Property SelectedItemStyle Property Gets the rendering style of an Item. A reference to the GridTableItemStyle that represents the rendering style of the item. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Manage visual style of the group header items. A reference to the GridTableItemStyle that represents the style of the group header items. If style is not altered (is default) is used. GridTableItemStyle Class Gets the rendering style of the group header items. A reference to the GridTableItemStyle that represents the rendering style of the group header items. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Gets a reference to the GridTableItemStyle object that allows you to set the appearance of alternating items in a GridTableView control. A reference to the GridTableItemStyle that represents the style of alternating data items in a GridTableView control. If style is not altered (is default) is used. Use the AlternatingItemStyle property to control the appearance of alternating items in a GridTableView control. When this property is set, the items are displayed alternating between the ItemStyle settings and the AlternatingItemStyle settings. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the GridTableView control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, AlternatingItemStyle-ForeColor). Nest an <AlternatingItemStyle> element between the opening and closing tags of the GridTableView control. The properties can also be set programmatically in the form Property.Subproperty (for example, AlternatingItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. GridTableItemStyle Class Gets the rendering style of the AlternatingItem. GridTableItemStyle Class A reference to the GridTableItemStyle that represents the rendering style of the AlternatingItem. If is not specified the return value is OwnerGrid.. Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the item selected for editing in a GridTableView control. A reference to the GridTableItemStyle that represents the style of the row being edited in a GridTableView control. If style is not altered (is default) is used. Use the EditItemStyle property to control the appearance of the item in edit mode. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the GridTableView control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, EditItemStyle-ForeColor). Nest an <EditItemStyle> element between the opening and closing tags of the GridTableView control. The properties can also be set programmatically in the form Property.Subproperty (for example, EditItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. ItemStyle Property GroupHeaderItemStyle Property AlternatingItemStyle Property PagerStyle Property HeaderStyle Property FilterItemStyle Property CommandItemStyle Property FooterStyle Property SelectedItemStyle Property GridTableItemStyle Class Gets the rendering style of an edit Item. A reference to the GridTableItemStyle that represents the rendering style of an edit item. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Gets a reference to the GridPagerStyle object that allows you to set the appearance of the pager item in a GridTableView control. A reference to the GridPagerStyle that represents the style of the pager item in a GridTableView control. If style is not altered (is default) is used. Use the PagerStyle property to control the appearance of the pager item in a GridTableView control. The pager item is displayed when the paging feature is enabled (by setting the AllowPaging property to true) and contains the controls that allow the user to navigate to the different pages in the control. This property is read-only; however, you can set the properties of the GridPagerStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the GridTableView control in the form Property-Subproperty, where Subproperty is a property of the GridPagerStyle object (for example, PagerStyle-ForeColor). Nest a <PagerStyle> element between the opening and closing tags of the GridTableView control. The properties can also be set programmatically in the form Property.Subproperty (for example, PagerStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. ItemStyle Property AlternatingItemStyle Property HeaderStyle Property FooterStyle Property SelectedItemStyle Property GridTableItemStyle Class Styling Header, Footer and Pager items online example Gets the rendering style of the Pager item. A reference to the GridTableItemStyle that represents the rendering style of the pager item. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the header item in a GridTableView control. A reference to the GridTableItemStyle that represents the style of the header row in a GridTableView control. If style is not altered (is default) is used. Use the HeaderStyle property to control the appearance of the header item in a GridTableView control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the GridTableView control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, HeaderStyle-ForeColor). Nest a <HeaderStyle> element between the opening and closing tags of the GridTableView control. The properties can also be set programmatically in the form Property.Subproperty (for example, HeaderStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. ItemStyle Property AlternatingItemStyle Property EditItemStyle Property FooterStyle Property SelectedItemStyle Property GridTableItemStyle Class Styling Header, Footer and Pager items online example Gets the rendering style of a GridHeaderItem. A reference to the GridTableItemStyle that represents the rendering style of the GridHeaderItem. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the filter item in a GridTableView control. A reference to the GridTableItemStyle that represents the style of the filter item. GridTableItemStyle Class Gets the rendering style of a FilterItem. A reference to the GridTableItemStyle that represents the rendering style of a FilterItem. If is not specified the return value is OwnerGrid. GridTableItemStyle Class Gets a referenct to the GridTableItemStyle object that allows you to set the appearance of the command item in a GridTableView control. A reference to the GridTableItemStyle that represents the style of the command item. GridTableItemStyle Class Gets the rendering style of a CommandItem. A reference to the GridTableItemStyle that represents the rendering style of a CommandItem. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Gets the rendering style of an ActiveItem. A reference to the GridTableItemStyle that represents the rendering style of an ActiveItem. GridTableItemStyle Class Manage visual style of the footer item. A reference to the GridTableItemStyle that represents the style of the footer item. If style is not altered (is default) is used. GridTableItemStyle Class Styling Header, Footer and Pager items online example Gets the rendering style of an FooterItem. A reference to the GridTableItemStyle that represents the rendering style of an FooterItem. If is not specified the return value is OwnerGrid.. GridTableItemStyle Class Gets a reference to the Style object that allows you to set the appearance of the selected item in a GridTableView control. A reference to the Style object that represents the style of the selected item in a GridTableView control. If style is not altered (is default) is used. Use the SelectedItemStyle property to control the appearance of the selected item in a GridTableView control. This property is read-only; however, you can set the properties of the Style object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the GridTableView control in the form Property-Subproperty, where Subproperty is a property of the Style object (for example, SelectedItemStyle-ForeColor). Nest a <SelectedRowStyle> element between the opening and closing tags of the GridTableView control. The properties can also be set programmatically in the form Property.Subproperty (for example, SelectedItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the selected item in a GridTableView control. [ASPX/ASCX] <radG:RadGrid ID="RadGrid1" runat="server">
..........
<SelectedItemStyle BackColor="#FFE0C0" />
</radG:RadGrid> RadGrid1.SelectedItemStyle.BackColor = System.Drawing.Color.Azure RadGrid1.SelectedItemStyle.BackColor = System.Drawing.Color.Azure; ItemStyle Property AlternatingItemStyle Property Gets or sets the name of the GridTableView. The string representation of the Name of the GridTableView it is assigned to. The default is String.Empty (""). The Name property can be used distinguish different GridTableView instances. Often used to set different settings for different views conditionally. The following example demonstrates different action on [ASPX/ASCX]<script type="text/javascript" >
function OnRowDblClick(index)
{
if(this.Name == "MasterTableView")
{
alert("Cliecked row with index " + index + " of the MasterTableView");
}
if(this.Name == "DetailTableView1")
{
alert("Clicked row with index " + index + " of the first detail table");
}
if(this.Name == "DetailTableView2")
{
alert("Clicked row with index " + index + " of the second detail table");
}
}
</script>

<radG:RadGrid ID="RadGrid1" runat="server" >
<MasterTableView Name="MasterTableView">
<DetailTables>
<radG:GridTableView Name="DetailTableView1" >
</radG:GridTableView>
<radG:GridTableView Name="DetailTableView2">
</radG:GridTableView>
</DetailTables>
</MasterTableView>
<ClientSettings>
<ClientEvents OnRowDblClick="OnRowDblClick"></ClientEvents>
</ClientSettings>
</radG:RadGrid> Gets or sets a value indicating if the will be shown in the current GridTableView. true, if the GridHeaderItem will be shown in the current GridTableView; otherwise, false. The default value is true. ShowFooter Property Gets or sets a value indicating if the will be shown in the current GridTableView. true, if the GridFooterItem will be shown in the current GridTableView; otherwise, false. The default value is false. ShowHeader Property Gets an array of all columns that are used when rendering the grid instance. An array of all columns that are used when rendering the grid instance. Modifying the array would not affect rendering as it is regenerated before each data-bind. To modify the list of columns available use property. Columns Property Gets a collection of all data items of a grid table view and items that belong to child tables of the GridTableView if the hierarchy is expanded. The items are collected depth-first. The property actually referres to ItemsHierarchy of
. This property can be used to traverse all
DataItems items in the hiearchy of a GridTableView. A GridDataItemCollection of all data items of a grid table view and items that belong to child tables of the GridTableView if the hierarchy is expanded. GridDataItem Class Gets a collection of GridDataItem objects that represent the data items in a GridDataItem control. The Items property (collection) is used to store the data items in a GridTableView control. The GridTableView control automatically populates the Items collection by creating a GridDataItem object for each record in the data source and then adding each object to the collection. This property is commonly used to access a specific item in the control or to iterate though the entire collection of items. A GridDataItemCollection that contains all the data items in a GridTableView control GridDataItem Class AllowCustomPaging Property Gets or sets a value indicating the index of the currently active page in case paging is enabled ( is true). The index of the currently active page in case paging is enabled. AllowCustomPaging Property AllowPaging Property If set to true (the default) GridNoRecordsItem is used to display no records template. This item is the only one displayed in the GridTableView in this case. NoRecordsTemplate Property Gets a value indicating if the GridTableView instance has children (Detail) tables. true, if the GridTableView instance has children (Detail) tables; otherwise, false. DetailTables Property Gets or sets the programmatic identifier assigned to the current GridTableView. This property is set automatically by RadGrid object that owns this instance. The programmatic identifier assigned to the control. Only combinations of alphanumeric characters and the underscore character ( _ ) are valid values for this property. Including spaces or other invalid characters will cause an ASP.NET page parser error. OwnerID Property Gets or sets a value indicating whether RadGrid will be built on PreRender unless it was built before that. This property is supposed for Telerik RadGrid internal usage, yet you can set it with care. true, if the RadGrid will be built on PreRender; otherwise, false. The unique hierarchy index of the current table view, generated when it is binding. The hierarchy index of the current table view. Indicates whether the items have been created, generally by data-binding. true, if the items have beed created; otherwise, false. This property is used internally by RadGrid and it is not intended to be used directly from your code. Gets or sets the custom content for the pager item in a GridTableView control. A System.Web.UI.ITemplate that contains the custom content for the pager item. The default value is null, which indicates that this property is not set. If this template is set, RadGrid will not create the default pager controls. AllowPaging Property PagingManager Property Gets or sets the template that will be instantiated in the CommandItem. If this template is set, RadGrid will not create the default CommandItem controls. A System.Web.UI.ITemplate object that contains the custom content for the pager item. The default value is null, which indicates that this property is not set. GridCommandItem Class CommandItemSettings Property Gets or sets a value indicating if the GridTableView is currently in insert mode. true, if the GridTableView is currently in insert mode; otherwise, false. The ItemInserted property indicates if the GridTableView is currently in insert mode. After setting it you should call the method. You can also use the method, that will also reposition the grid to show the last page, where the newly inserted item is generally displayed. Gets or sets the default position of the GridCommandItem as defined by the . The possible values are: None - this is the default value - the command item will not be rendered Top - the command item will be rendered on the top of the grid Bottom - the command item will be rendered on the bottom of the grid TopAndBottom - the command item will be rendered both on top and bottom of the grid. A GridCommandItemDisplay proprty which define the default position of the GridCommandItem. GridCommandItemDisplay Enumeration corresponding fields from a master-detail relation A collection that stores objects. Initializes a new instance of . Initializes a new instance of based on another . A from which the contents are copied Initializes a new instance of containing any array of objects. A array of objects with which to intialize the collection Adds a with the specified value to the . The to add. The index at which the new element was inserted. Copies the elements of an array to the end of the . An array of type containing the objects to add to the collection. None. Adds the contents of another to the end of the collection. A containing the objects to add to the collection. None. Gets a value indicating whether the contains the specified . The to locate. if the is contained in the collection; otherwise, . Copies the values to a one-dimensional instance at the specified index. The one-dimensional that is the destination of the values copied from . The index in where copying begins. None. is multidimensional. -or- The number of elements in the is greater than the available space between and the end of . is . is less than 's lowbound. Returns the index of a in the . The to locate. The index of the of in the , if found; otherwise, -1. Inserts a into the at the specified index. The zero-based index where should be inserted. The to insert. None. Returns an enumerator that can iterate through the . None. Removes a specific from the . The to remove from the . None. is not found in the Collection. Represents the entry at the specified index of the . The zero-based index of the entry to locate in the collection. The entry at the specified index of the collection. is outside the valid range of indexes for the collection. Container of misc. grouping settings of RadGrid control Expression similar to SQL's "Select Group By" clause that is used by GridTableView to group items (. Expressions can be defined by assigning Expression property and/or managing the items in or collections. If you use property to assign group by expression as string then the expression is parsed and and are created. If the expression syntax is incorrect a would be thrown. You can use 's properties to set expression's fields appearance format strings, etc. See property for details about the expression syntax. Constructs a new GroupByExpression from a grid GridColumn. If the column does not have a valud string assigned this constructor will throw . Column should be The following properties will be copied from the corresponding column's properties: Column's data-format-string depending on the type of the column. For example will be copied to . Column's will be copied to the column (and its DataField respectively) that will be used for grouping Telerik RadGrid Calls GridGroupByExpression(expression) The same as the property the string representation of the expression. Compares the current expression against the expression set as parameter and check if both expressions contain field with the same name. true if both expressions contain field with the same name, otherwise false. expression to check against this expression Checks if the given expression contains same Group-By field as this one. true if the expression already contains this GroupByField, otherwise false. Use this function to determine if two expressions seem to produce the same set of results Expression to check Gets a collection of SelectField objects (field names, aggregates etc.) that form the "Select" clause. Standing on the left side of the "Group By" clause. Gets a collection of objects that form the grouping clause. Standing on the right side of the "Group By" clause String representation of the GroupBy expression. Expression syntax: fieldname[ alias]|aggregate(fieldname)[ alias][, ...] Group By fieldname[ sort][, ...] fieldname: the name of any field from the alias: alas string. This cannot contain blanks or other reserved symbols like ',', '.' etc. aggregate: any of - min, max, sum, count, last, first etc (the same as in enumeration ) sort: asc or desc - the sort order of the grouped items Country, City, count(Country) Items, ContactName Group By Country, City desc Country, City, count(Country) Items, ContactName Group By Country, City desc Gets the index of the expression if added in a integer, representing the index of the collection ni . Collection that stores group by expressions Initializes a new instance of . Initializes a new instance of based on another . A from which the contents are copied Initializes a new instance of containing any array of objects. An array of objects with which to intialize the collection Adds a with the specified value to the . The to add. The index at which the new element was inserted. Parses value and adds a to the . The string representation to add. The index at which the new element was inserted. Copies the elements of an array to the end of the . An array of type containing the objects to add to the collection. None. Adds the contents of another to the end of the collection. A containing the objects to add to the collection. None. Gets a value indicating whether the contains the specified . The to locate. if the is contained in the collection; otherwise, . Copies the values to a one-dimensional instance at the specified index. The one-dimensional that is the destination of the values copied from . The index in where copying begins. None. is multidimensional. -or- The number of elements in the is greater than the available space between and the end of . is . is less than "s lowbound. Returns the index of a in the . The to locate. The index of the of in the , if found; otherwise, -1. Inserts a into the at the specified index. The zero-based index where should be inserted. The to insert. None. Returns an enumerator that can iterate through the . None. Removes a specific from the . The to remove from the . None. is not found in the Collection. Represents the entry at the specified index of the . The zero-based index of the entry to locate in the collection. The entry at the specified index of the collection. is outside the valid range of indexes for the collection. Summary description for NeedDataSourceEvent. RadGrid control class. Set properties of RadGrid as default for the corresponding properties of grid's table views . The best approach to bind RadGrid is to handle its event and set the DataSource property there. This way RadGrid will handle automatically operations like paging, sorting, grouping, etc. The main table-view can be accessed through property. The group panel and its items can be accessed using GroupPanel property. Note that the group items can be modified only through the properties of each GridTableView. Hierarchical grid structure can be implemented adding GridTableView objects to and handling event, where you should set the DataSource of each bound detail table filtered according to the property key values. The of RadGrid property is a reference to the columns of the MasterTableView and is present in RadGrid for compatibility with the DataGrid server control. Represents the Cancel command name. This field is read-only. Use the CancelCommandName field to represent the "Cancel" command name. This command cancels the edit operation and RadGrid returns to normal mode. The example below demonstrates how to use the Cancel command within an EditItemTemplate. 
            <radG:GridTemplateColumn UniqueName="TemplateColumn">
            
                <EditItemTemplate>
            
                    <asp:LinkButton runat="server" ID="Cancel" Text="Cancel Edit" CommandName="Cancel">
            
                    </asp:LinkButton>
            
                </EditItemTemplate>
            
            </radG:GridTemplateColumn>
Represents the "Delete" command name. This field is read-only. Use the DeleteCommandName field to represent the "Delete" command name. The example below demonstrates how to use the Delete command within an ItemTemplate. 
            <radG:GridTemplateColumn UniqueName="TemplateColumn">
            
                <ItemTemplate>
            
                    <asp:LinkButton runat="server" ID="Delete" Text="Delete" CommandName="Delete">
            
                    </asp:LinkButton>
            
                </ItemTemplate>
            
            </radG:GridTemplateColumn>
Represents the "Edit" command name. This field is read-only. Use the EditCommandName field to represent the "Edit" command name. This command enters RadGrid in edit mode. The example below demonstrates how to use the "Edit" command within an ItemTemplate. 
            <radG:GridTemplateColumn UniqueName="TemplateColumn">
            
                <ItemTemplate>
            
                    <asp:LinkButton runat="server" ID="Edit" Text="Edit" CommandName="Edit">
                
                    </asp:LinkButton>
            
                </ItemTemplate>
            
            </radG:GridTemplateColumn>
Represents the "InitInsert" command name. This field is read-only. The example below demonstrates how to use the InitInsert command within an CommandItemTemplate. 
                <CommandItemTemplate>
            
                    <asp:LinkButton runat="server" ID="AddNew" Text="Add new record" CommandName="InitInsert">
            
                    </asp:LinkButton>
            
                </CommandItemTemplate>
Use the InitInsertCommandName field to represent the "InitInsert" command name. This command enters RadGrid in edit mode and lets the user enter the data for a new record. Represents the "PerformInsert" command name. This field is read-only. Use the PerformInsertCommandName field to represent the "PerformInsert" command name. This command enters the new record into the database. Represents the "RebindGrid" command name. This field is read-only. Forces RadGrid.Rebind Use the RebindGridCommandName field to force rebinding the grid. The example below demonstrates how to use the Update command within an EditItemTemplate. 
            <radG:GridTemplateColumn UniqueName="TemplateColumn">
                
                <EditItemTemplate>
                
                    <asp:LinkButton runat="server" ID="Update" Text="Update" CommandName="Update">
                
                    </asp:LinkButton>
                
                </EditItemTemplate>
                
            </radG:GridTemplateColumn>
Represents the "Update" command name. This field is read-only. Use the UpdateCommandName field to represent the "Update" command name. Represents the "UpdateEdited" command name. Updates all items that are in edit mode. This field is read-only. The example below demonstrates how to use the UpdateEdited command within an CommandItemTemplate. 
                <CommandItemTemplate>
            
                    <asp:LinkButton runat="server" ID="UpdateEdited" Text="Update Edited" CommandName="UpdateEdited">
            
                    </asp:LinkButton>
            
                </CommandItemTemplate>
Use the UpdateCommandName field to represent the "Update" command name. Represents the "DeleteSelected" command name. This field is read-only. Use the DeleteSelectedCommandName field to represent the "DeleteSelected" command name. The example below demonstrates how to use the DeleteSelected command within an CommandItemTemplate. 
                <CommandItemTemplate>
            
                    <asp:LinkButton runat="server" ID="DeleteSelected" Text="Delete Selected" CommandName="DeleteSelected">
                
                    </asp:LinkButton>
            
                </CommandItemTemplate>
Constructs a new instance of RadGrid Data-bind %MasterTableView% and its detail %GridTableView%s. Prior to calling DataBind, the %DataSource% property should be assigned. Simple Data-binding You should have in mind, that in case you are using simple data binding (i.e. when you are not using NeedDataSource event) the correct approach is to call the DataBind() method on the first page load when !Page.IsPostBack and after handling some event (sort event for example). You will need to assign DataSource and rebind the grid after each operation (paging, sorting, editing, etc.) - this copies exactly MS DataGrid behavior. We recommend using the method instead and handling the event. This method is used by RadGrid internally. Please do not use. Forces RadGrid to fire NeedDataSource event then calls DataBind Performs a redirection to another page defined with a relative path using an AJAX request. RadGrid1.AsyncRedirect("~/Default.aspx") RadGrid1.AsyncRedirect("~/Default.aspx"); The URL where you want to redirect to. This URL should be a relative path. For absolute paths consider using AsyncRedirect(string, bool) Method instead. Performs a redirection to another page using an AJAX request. The boolean parameter defines if the path is absolute or relative. RadGrid1.AsyncRedirect("http://localhost/MySite/Default.aspx", true) RadGrid1.AsyncRedirect("http://localhost/MySite/Default.aspx", true); The URL where you want to redirect to. This URL should be a relative path. For absolute paths consider using AsyncRedirect(string, bool) Method instead. Defines if the specified path is absolute or relative (true for absolute and false for relative). Returns the path of the used skin, relative to the application root. Returns the path of the used skin, relative to the application root. The name of the skin is set using the property. All skins reside in a folder named as the name of the skin.
The method returns the path to the skin in this form (Default is the name of the skin as defined by the Skin property): ~/RadControls/Grid/Skins/Default Occurs when the Cancel button is clicked for an item in the Telerik RadGrid control. The CancelCommand event is raised when the Cancel button is clicked for an item in the Telerik RadGrid control.
The following code example demonstrates how to specify and code a handler for the CancelCommand event to cancel edits made to an item in the Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_CancelCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Response.Write("Cancel") End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnCancelCommand="RadGrid1_CancelCommand" > <MasterTableView> <Columns> <radG:GridEditCommandColumn> </radG:GridEditCommandColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Fires when each editable column creates its column editor, prior to initializing its controls in the cells of the grid Fires when the grid is about to be bound and the data source must be assigned (is null/Nothing). Using this event eliminates the need for calling when the grid content should be refreshed, due to a structural change.
For example if Edit command bubbles, grid will automatically rebind and display the item in edit mode, with no additional code. Note that when you use NeedDataSource you need to assign manually the DataSource property only once in the event handler! Important: You should never call Rebind() method in NeedDataSource event handler or DataBind() for the grid at any stage of the page lifecycle! For more information related to Advanced Data Binding (i.e. with NeedDataSource) see the following Data binding article. Fires when various item events occur - for example, before Pager item is initialized, before EditForm is initialized, etc. Fires when a detail-table in the hierarchy is about to be bound. You should only assign the DataSource property of the detail table to a data-source properly filtered to display ony child records related to the parent item. You can find the instance of the detail table in the event argument (e). You can find the parent item using e.DetailTable.ParentItem property. For more information see Hierarchical Binding Occurs when the Delete button is clicked for an item in the Telerik RadGrid control. The DeleteCommand event is raised when the Delete button is clicked for an item in the Telerik RadGrid control. A typical handler for the DeleteCommand event removes the selected item from the data source. The following code example demonstrates how to specify and code a handler for the CancelCommand event to cancel a Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_DeleteCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Response.Write("Delete") End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnDeleteCommand="RadGrid1_DeleteCommand" > <MasterTableView> <Columns> <radG:GridButtonColumn Text="Delete" CommandName="Delete" UniqueName="Delete"></radG:GridButtonColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Occurs when the Edit button is clicked for an item in the Telerik RadGrid control. The EditCommand event is raised when the Edit button is clicked for an item in the Telerik RadGrid control. A typical handler for the EditCommand event edites the selected item from the data source. The following code example demonstrates how to specify and code a handler for the EditCommand event to edit a Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_EditCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Response.Write("Edit") End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnEditCommand="RadGrid1_EditCommand" > <MasterTableView> <Columns> <radG:GridEditCommandColumn> </radG:GridEditCommandColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Occurs when a button is clicked in a Telerik RadGrid control. The ItemCommand event is raised when a button is clicked in the Telerik RadGrid control. This allows you to provide an event-handling method that performs a custom routine whenever this event occurs. Buttons within a Telerik RadGrid control can also invoke some of the built-in functionality of the control. Fires if any control inside Telerik RadGrid rises a bubble event. This can be a command button (like Edit, Update button, Expand/Collapse of an items) The command arguemtn carries a reference to the item which rised the event, the command name and argument object. A GridCommandEventArgs object is passed to the event-handling method, which allows you to determine the command name and command argument of the button clicked. The following code example demonstrates how to use the ItemCommand event to add the name of a customer from a Telerik RadGrid control to a ListBox control when a item's Add button is clicked. <%@ Page Language="VB" <see cref="> <"/>@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.WebControls.GridItemEventArgs) If e.Item.ItemType = GridItemType.AlternatingItem Or e.Item.ItemType = GridItemType.Item Then Dim item As Telerik.WebControls.GridDataItem item = e.Item Dim LinkButton1 As LinkButton LinkButton1 = item("LinkColumn").FindControl("LinkButton1") LinkButton1.CommandArgument = e.Item.ItemIndex.ToString() End If End Sub Protected Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) ' If multiple buttons are used in a Telerik RadGrid control, use the ' CommandName property to determine which button was clicked. If e.CommandName = "Add" Then ' Convert the row index stored in the CommandArgument ' property to an Integer. Dim index As Integer = Convert.ToInt32(e.CommandArgument) ' Retrieve the item that contains the button clicked ' by the user from the Items collection. Dim item As Telerik.WebControls.GridDataItem = RadGrid1.Items(index) ' Create a new ListItem object for the customer in the item. Dim nitem As New ListItem() nitem.Text = Server.HtmlDecode(item("CustomerID").Text) ' If the customer is not already in the ListBox, add the ListItem ' object to the Items collection of the ListBox control. If Not CustomersListBox.Items.Contains(nitem) Then CustomersListBox.Items.Add(nitem) End If End If End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnItemCreated="RadGrid1_ItemCreated" OnItemCommand="RadGrid1_ItemCommand"> <MasterTableView> <Columns> <radG:GridTemplateColumn UniqueName="LinkColumn" HeaderText="LinkColumn"> <ItemTemplate> <asp:LinkButton CommandName="Add" Text="click" ID="LinkButton1" runat="server">LinkButton</asp:LinkButton> </ItemTemplate> </radG:GridTemplateColumn> </Columns> </MasterTableView> </radG:RadGrid> <asp:listbox id="CustomersListBox" runat="server"/> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Occurs when a item is created in a Telerik RadGrid control. Before the Telerik RadGrid control can be rendered, a GridItem object must be created for each row in the control. The ItemCreated event is raised when each row in the Telerik RadGrid control is created. This allows you to provide an event-handling method that performs a custom routine, such as adding custom content to a item, whenever this event occurs. A GridItemEventArgs object is passed to the event-handling method, which allows you to access the properties of the row being created. You can determine which item type (header item, data pager item, and so on) is being bound by using the Item.ItemType property. Note that the changes made to the item control and its children at this stage does not persist into the ViewState. The following code example demonstrates how to use the ItemCreated event to store the index of the item being created in the CommandArgument property of a LinkButton control contained in the item. This allows you to determine the index of the item that contains the LinkButton control when the user clicked the button. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_ItemCreated(ByVal sender As Object, ByVal e As Telerik.WebControls.GridItemEventArgs) If e.Item.ItemType = GridItemType.AlternatingItem Or e.Item.ItemType = GridItemType.Item Then Dim item As Telerik.WebControls.GridDataItem item = e.Item Dim LinkButton1 As LinkButton LinkButton1 = item("LinkColumn").FindControl("LinkButton1") LinkButton1.CommandArgument = e.Item.ItemIndex.ToString() End If End Sub Protected Sub RadGrid1_ItemCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) ' If multiple buttons are used in a Telerik RadGrid control, use the ' CommandName property to determine which button was clicked. If e.CommandName = "Add" Then ' Convert the row index stored in the CommandArgument ' property to an Integer. Dim index As Integer = Convert.ToInt32(e.CommandArgument) ' Retrieve the item that contains the button clicked ' by the user from the Items collection. Dim item As Telerik.WebControls.GridDataItem = RadGrid1.Items(index) ' Create a new ListItem object for the customer in the item. Dim nitem As New ListItem() nitem.Text = Server.HtmlDecode(item("CustomerID").Text) ' If the customer is not already in the ListBox, add the ListItem ' object to the Items collection of the ListBox control. If Not CustomersListBox.Items.Contains(nitem) Then CustomersListBox.Items.Add(nitem) End If End If End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnItemCreated="RadGrid1_ItemCreated" OnItemCommand="RadGrid1_ItemCommand"> <MasterTableView> <Columns> <radG:GridTemplateColumn UniqueName="LinkColumn" HeaderText="LinkColumn"> <ItemTemplate> <asp:LinkButton CommandName="Add" Text="click" ID="LinkButton1" runat="server">LinkButton</asp:LinkButton> </ItemTemplate> </radG:GridTemplateColumn> </Columns> </MasterTableView> </radG:RadGrid> <asp:listbox id="CustomersListBox" runat="server"/> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Fires before a custom column is created. You can handle the event to replace or modify the instance of the column that should be created and added into the collection of column in the corresponding GridTableView. The ColumnCreating event of Telerik RadGrid is fired only for custom grid columns. It is not designed to be used to cancel the creation of auto-generated columns. Its purpose is to have place where to define your custom columns (extending the default grid columns) programmatically and add them to the grid Columns collection. See the manual part of Telerik RadGrid documentation for details about Telerik RadGrid inheritance. The ColumnCreated event of Telerik RadGrid is designated to customize auto-generated columns at runtime (for example DataFormatString, ReadOnly or other properties of these auto-generated columns). This event is fired after the creation of auto-generated columns. Occurs when a data iten is bound to data in a Telerik RadGrid control. Before the Telerik RadGrid control can be rendered, each item in the control must be bound to a record in the data source. The ItemDataBound event is raised when a data item (represented by a GridItem object) is bound to data in the Telerik RadGrid control. This allows you to provide an event-handling method that performs a custom routine, such as modifying the values of the data bound to the item, whenever this event occurs. A GridItemEventArgs object is passed to the event-handling method, which allows you to access the properties of the item being bound. You can determine which item type (header item, data pager item, and so on) is being bound by using the Item.ItemType property. Note that the changes made to the item control and its children does persist into the ViewState. This event is fired as a result of a data-binding of Telerik RadGrid contorl. This event is fired for items of type: GridDataItem GridEditFormItem GridHeaderItem GridPagerItem GridFooterItem The following code example demonstrates how to use the ItemDataBound event to modify the value of a field in the data source before it is displayed in a Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_ItemDataBound(ByVal sender As Object, ByVal e As Telerik.WebControls.GridItemEventArgs) If e.Item.ItemType = GridItemType.AlternatingItem Or e.Item.ItemType = GridItemType.Item Then Dim item As Telerik.WebControls.GridDataItem item = e.Item item("CustomerID").Text = "Telerik" End If End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnItemDataBound="RadGrid1_ItemDataBound"> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </form> </body> </html> Fires when a paging action has been performed. Fires when PageSize property value has been changed. The PageSizeChanged event is rised when the value of the property PageSize is changed. You can cancel the event if the new PageSize value is invalid and it will not be saved. For example: 
            protected void RadGrid1_PageSizeChanged(object source, GridPageSizeChangedEventArgs e)
{
    if(e.NewPageSize < 1)

            		e.Canceled = true;
}
Occurs when a column is sorted. The SortCommand event is raised when a column is sorted. A typical handler for the SortCommand event sorts the list. The following code example demonstrates how to specify and code a handler for the SortCommand event to sort a Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_SortCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridSortCommandEventArgs) Response.Write("Sort") End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" AllowSorting="true" runat="server" OnSortCommand="RadGrid1_SortCommand" > </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Occurs when the Update button is clicked for an item in the Telerik RadGrid control. The UpdateCommand event is raised when the Update button is clicked for an item in the Telerik RadGrid control. A typical handler for the UpdateCommand event updates the selected item from the data source. The following code example demonstrates how to specify and code a handler for the UpdateCommand event to update a Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_UpdateCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Response.Write("Update") End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnUpdateCommand="RadGrid1_UpdateCommand" > <MasterTableView> <Columns> <radG:GridEditCommandColumn> </radG:GridEditCommandColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Occurs when the Insert button is clicked for an item in the Telerik RadGrid control. The InsertCommand event is raised when the Insert button is clicked for an item in the Telerik RadGrid control. A typical handler for the InsertCommand event insert the item into the data source. The following code example demonstrates how to specify and code a handler for the InsertCommand event to insert a Telerik RadGrid control. <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_InsertCommand(ByVal source As Object, ByVal e As Telerik.WebControls.GridCommandEventArgs) Response.Write("Insert") End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" OnInsertCommand="RadGrid1_InsertCommand" > <MasterTableView CommandItemDisplay="TopAndBottom"> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Fires when a grouping action has been performed. For example when a column header was dragged in the GroupPanel. You can use this event to set your own GridGroupByExpression when the user tries to group the grid. protected void RadGrid1_GroupsChanging(object source, Telerik.WebControls.GridGroupsChangingEventArgs e) { //Expression is added (by drag/grop on group panel) if (e.Action == GridGroupsChangingAction.Group) { if (e.Expression.GroupByFields[0].FieldName != "CustomerID") { GridGroupByField countryGroupField = new GridGroupByField(); countryGroupField.FieldName = "Country"; GridGroupByField cityGroupField = new GridGroupByField(); cityGroupField.FieldName = "City"; e.Expression.SelectFields.Clear(); e.Expression.SelectFields.Add(countryGroupField); e.Expression.SelectFields.Add(cityGroupField); e.Expression.GroupByFields.Clear(); e.Expression.GroupByFields.Add(countryGroupField); e.Expression.GroupByFields.Add(cityGroupField); } } } Protected Sub RadGrid1_GroupsChanging(ByVal source As Object, ByVal e As Telerik.WebControls.GridGroupsChangingEventArgs) 'Expression is added (by drag/grop on group panel) If (e.Action = GridGroupsChangingAction.Group) Then If (e.Expression.GroupByFields(0).FieldName <> "CustomerID") Then Dim countryGroupField As GridGroupByField = New GridGroupByField countryGroupField.FieldName = "Country" Dim cityGroupField As GridGroupByField = New GridGroupByField cityGroupField.FieldName = "City" e.Expression.SelectFields.Clear e.Expression.SelectFields.Add(countryGroupField) e.Expression.SelectFields.Add(cityGroupField) e.Expression.GroupByFields.Clear e.Expression.GroupByFields.Add(countryGroupField) e.Expression.GroupByFields.Add(cityGroupField) End If End If End Sub Fires when a grid item has been updated. Fires when a grid item has been inserted. Fires when a grid item has been deleted. Gets or sets the object from which the Telerik RadGrid control retrieves its list of data items. You should have in mind, that in case you are using simple data binding (i.e. when you are not using NeedDataSource event) the correct approach is to call the DataBind() method on the first page load when !Page.IsPostBack and after handling some event (sort event for example). You will need to assign DataSource and rebind the grid after each operation (paging, sorting, editing, etc.) - this copies exactly MS DataGrid behavior. An object that represents the data source from which the Telerik RadGrid control retrieves its data. The default is a null reference (Nothing in Visual Basic). The following code example demonstrates how the DataSource property of a Telerik RadGrid control is used. In this example, the Telerik RadGrid control is bound to a DataSet object. After the DataSource property is set, the DataBind method is called explicitly. Gets or sets the name of the list of data that the Telerik RadGrid control binds to, in cases where the data source contains more than one distinct list of data items. The name of the specific list of data that the Telerik RadGrid control binds to, if more than one list is supplied by a data source control. The default value is String.Empty. Use the DataMember property to specify a member from a multimember data source to bind to the list control. For example, if you have a data source with more than one table specified in the DataSource property, use the DataMember property to specify which table to bind to a data listing control. The value of the DataMember property is stored in view state. This property cannot be set by themes or style sheet themes. For more information, see ThemeableAttribute and Themes and Skins Overview in MSDN. Gets a reference to the object that allows you to set the properties of the grouping operation in a Telerik RadGrid control. The following code example demonstrates how to set the GroupingSettings property declaratively. It sets the tooltips of the group expand control of the Telerik RadGrid. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server"> <GroupingSettings ExpandTooltip="ExpandTooltip" /> <MasterTableView> <GroupByExpressions> <radG:GridGroupByExpression> <SelectFields> <radG:GridGroupByField FieldAlias="CompanyName" FieldName="CompanyName" ></radG:GridGroupByField> </SelectFields> <GroupByFields> <radG:GridGroupByField FieldName="CompanyName" SortOrder="Descending"></radG:GridGroupByField> </GroupByFields> </radG:GridGroupByExpression> </GroupByExpressions> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> A reference to the that allows you to set the properties of the grouping operation in a Telerik RadGrid control. Use the GroupingSettings property to control the settings of the grouping operations in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridGroupingSettings object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridGroupingSettings object (for example, GroupingSettings-ExpandTooltip). Nest a <GroupingSettings> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, GroupingSettings.ExpandTooltip). Common settings usually include the tool tips for the sorting controls. Gets a reference to the object that allows you to set the properties of the sorting operation in a Telerik RadGrid control. A reference to the that allows you to set the properties of the sorting operation in a Telerik RadGrid control. Use the SortingSettings property to control the settings of the sorting operations in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridSortingSettings object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridSortingSettings object (for example, SortingSettings-SortedAscToolTip). Nest a <SortingSettings> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, SortingSettings.SortedAscToolTip). Common settings usually include the tool tips for the sorting controls. The following code example demonstrates how to set the SortingSettings property declaratively. It sets the tooltips of the sorting control of the Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" AllowSorting="true"> <SortingSettings SortToolTip="SortToolTip" SortedAscToolTip="SortedAscToolTip" SortedDescToolTip="SortedDescToolTip" /> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Gets a reference to the object that allows you to set the properties of the hierarchical Telerik RadGrid control. A reference to the GridHierarchySettings that allows you to set the properties of the hierarchical Telerik RadGrid control. Use the HierarchySettings property to control the settings of the hierarchical Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridHierarchySettings object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridHierarchySettings object (for example, HierarchySettings-CollapseTooltip). Nest a <HierarchySettings> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, HierarchySettings.CollapseTooltip). Common settings usually include the tool tips for the hierarchical Telerik RadGrid control. Gets a reference to the object that allows you to set the properties of the grouping operation in a Telerik RadGrid control. A reference to the GridExportSettings that allows you to set the properties of the grouping operation in a Telerik RadGrid control. Use the ExportSettings property to control the settings of the grouping operations in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridGroupingSettings object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridExportSettings object (for example, GroupingSettings-ExpandTooltip). Nest a <GroupingSettings> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, GroupingSettings.ExpandTooltip). Common settings usually include the tool tips for the sorting controls. Gets a reference to the object that allows you to set the properties of the validate operation in a Telerik RadGrid control. A reference to the that allows you to set the properties of the validate operation in a Telerik RadGrid control. The following code example demonstrates how to set the ValidationSettings property declaratively. It sets the validation for the PerformInsert command event of the TextBox1 control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" AutoGenerateColumns="false" runat="server"> <ValidationSettings EnableValidation="true" CommandsToValidate="PefrormInsert" /> <MasterTableView CommandItemDisplay="TopAndBottom"> <Columns> <radG:GridEditCommandColumn> </radG:GridEditCommandColumn> <radG:GridTemplateColumn HeaderText="ContactName" UniqueName="ContactName" DataField="ContactName"> <ItemTemplate> <%# Eval("ContactName") <see cref="TextBox Text='<">> </ItemTemplate> <EditItemTemplate> <asp</see># Bind("ContactName") %>' ID="TextBox1" runat="server"></asp:TextBox> <asp:RequiredFieldValidator ControlToValidate="TextBox1" ID="RequiredFieldValidator1" runat="server" ErrorMessage="RequiredFieldValidator"></asp:RequiredFieldValidator> </EditItemTemplate> </radG:GridTemplateColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT TOP 3 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Use the ValidationSettings property to control the settings of the validate operations in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridValidationSettings object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridValidationSettings object (for example, ValidationSettings-EnableValidation). Nest a <ValidationSettings> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, ValidationSettings.EnableValidation). Common settings usually include the propeties for the validation logic in Telerik RadGrid control. Gets or sets a value indicating whether Telerik RadGrid will work in AJAX mode, i.e. will perform asynchronous requests instead of traditional postbacks. true if the ajax feature is enabled; otherwise, false. The default is false To enable sorting, set the EnableAjax property to true. When ajax is enabled, the ra.a.d.grid perform asynchronous requests instead of traditional postbacks on every command Gets or sets a value indicating if the outside scripts for the AJAX-enabled controls will be evaluated. The default value is false. Outside scripts are scripts rendered from the code-behind and are usually not executed if they are rendered outside of the currently updated control(s). Gets or sets a value indicating whether custom paging should be performed instead of the integrated automatic paging. This online example demonstrates an approach to implementing custom paging with Telerik RadGrid. The simulated "DataLayer" wraps the logic of extracting records for only the specified page and deleting records. Telerik RadGrid maintains the pager buttons, changing of pager and other presentation specific features. Another available option for custom paging support is represented in the how-to section. Note: There is no universal mechanism for grouping when custom paging is allowed. The reason for this is that with the custom paging mechanism you fetch only part of the whole information from the grid datasource. Thus, when you trigger the grouping event the grid is restricted from operating with the whole available source data and is not able to group the items accurately. Furthermore, the aggregate functions as Count, Sum, etc. (covering operations with the whole set of grid items) will return incorrect results. A workaround solution for you could be to use hierarchy in the grid instead of grouping to single out the grid items logically and visually according to custom criteria. Thus you will be able to use custom paging without further limitations. Another approach is to build your own complex SQL statements which to get the whole available data from the grid datasource and then group the items in the grid with custom code logic.

Finally, you can use standard paging instead of custom paging to ensure the consistency of the data on grouping. true, if custom paging is allowed; otherwise false. The default is false. Gets or sets a value indicating whether the automatic paging feature is enabled. true if the paging feature is enabled; otherwise, false. The default is false Instead of displaying all the records in the data source at the same time, the Telerik RadGrid control can automatically break the records up into pages. If the data source supports the paging capability, the Telerik RadGrid control can take advantage of that and provide built-in paging functionality. The paging feature can be used with any data source object that supports the System.Collections.ICollection interface or a data source that supports paging capability. To enable the paging feature, set the AllowPaging property to true. By default, the Telerik RadGrid control displays 10 records on a page at a time. You can change the number of records displayed on a page by setting the PageSize property. To determine the total number of pages required to display the data source contents, use the PageCount property. You can determine the index of the currently displayed page by using the CurrentPageIndex property. When paging is enabled, an additional item called the pager item is automatically displayed in the Telerik RadGrid control. The pager item contains controls that allow the user to navigate to the other pages. You can control the settings of the pager item by using the PagerItemStyle property. The pager item can be displayed at the top, bottom, or both the top and bottom of the control by setting the Position property. You can also select from one of four built-in pager display modes by setting the Mode property. The Telerik RadGrid control also allows you to define a custom template for the pager item. The following code example demonstrates how to use the AllowPaging property to declaratively enable the paging feature in the Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" AllowPaging="true" > </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework AllowCustomPaging Property Basic Paging Pager Item Gets or sets a value indicating whether the sorting feature is enabled. true if the sorting feature is enabled; otherwise, false. The default is false. When a data source control that supports sorting is bound to the Telerik RadGrid control, the Telerik RadGrid control can take advantage of the data source control's capabilities and provide automatic sorting functionality. To enable sorting, set the AllowSorting property to true. When sorting is enabled, the heading text for each column field with its SortExpression property set is displayed as a link button. Clicking the link button for a column causes the items in the Telerik RadGrid control to be sorted based on the sort expression. Typically, the sort expression is simply the name of the field displayed in the column, which causes the Telerik RadGrid control to sort with respect to that column. To sort by multiple fields, use a sort expression that contains a comma-separated list of field names. You can determine the sort expression that the Telerik RadGrid control is applying by using the SortExpression property. Clicking a column's link button repeatedly toggles the sort direction between ascending and descending order. Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework The following code example demonstrates how to use the AllowSorting property to enable sorting in a Telerik RadGrid control when automatically generated columns are used. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" AllowSorting="true"> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Sorting Expressions Gets a reference to the object that allows you to set the properties of the client-side behavior and appearance in a Telerik RadGrid control. A reference to the that allows you to set the properties of the the client-side behavior and appearance in a Telerik RadGrid control. Use the ClientSettings property to control the settings of the client-side behavior and appearance in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridClientSettings object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridClientSettings object (for example, ClientSettings-AllowDragToGroup). Nest a <ClientSettings> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, SortingSettings.AllowDragToGroup). Common settings usually include the behavior and appearance on the client-side. Gets a reference to the GridTableItemStyle object that allows you to set the appearance of alternating data items in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of alternating data items in a Telerik RadGrid control. Use the AlternatingItemStyle property to control the appearance of alternating data items in a Telerik RadGrid control. When this property is set, the data items are displayed alternating between the ItemStyle settings and the AlternatingItemStyle settings. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, AlternatingItemStyle-ForeColor). Nest an <AlternatingItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, AlternatingItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the AlternatingItemStyle property to declaratively define the style for alternating data items in a Telerik RadGrid control. <%@ Page language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html > <head id="Head1" runat="server"> <title>GridView ItemStyle and AlternatingItemStyle Example</title> </head> <body> <form id="form1" runat="server"> <h3>GridView ItemStyle and AlternatingItemStyle Example</h3> <radG:RadGrid id="CustomersGridView" datasourceid="CustomersSource" autogeneratecolumns="true" Skin="None" runat="server"> <itemstyle backcolor="LightCyan" forecolor="DarkBlue" font-italic="true"/> <alternatingitemstyle backcolor="PaleTurquoise" forecolor="DarkBlue" font-italic="true"/> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:sqldatasource id="CustomersSource" selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]" connectionstring="<<see cref="NorthWindConnectionString">$ ConnectionStrings</see>>" runat="server"/> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the group-header item in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the group-header item in a Telerik RadGrid control. Use the GroupHeaderItemStyle property to control the appearance of the group-header item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, GroupHeaderItemStyle-ForeColor). Nest a <GroupHeaderItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, GroupHeaderItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the group-header item in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None" > <GroupHeaderItemStyle BackColor="red" /> <MasterTableView> <GroupByExpressions> <radG:GridGroupByExpression> <SelectFields> <radG:GridGroupByField FieldAlias="CompanyName" FieldName="CompanyName" ></radG:GridGroupByField> </SelectFields> <GroupByFields> <radG:GridGroupByField FieldName="CompanyName" SortOrder="Descending"></radG:GridGroupByField> </GroupByFields> </radG:GridGroupByExpression> </GroupByExpressions> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets or sets a value indicating whether bound fields are automatically created for each field in the data source. When the AutoGenerateColumns property is set to true, an GridBoundColumn object is automatically created for each field in the data source. Each field is then displayed as a column in the Telerik RadGrid control in the order that the fields appear in the data source. This option provides a convenient way to display every field in the data source; however, you have limited control of how an automatically generated column field is displayed or behaves. This set of columns can be accessed using the AutoGeneratedColumns collection.
Runtime auto-generated columns will always appear after the user-specified columns, unless the columns are ordered programmatically.
Instead of letting the Telerik RadGrid control automatically generate the column fields, you can manually define the column fields by setting the AutoGenerateColumns property to false and then creating a custom Columns collection. In addition to bound column fields, you can also display a button column, a check box column, a button column, a hyperlink column, an image column, or a column based on your own custom-defined template etc. true to automatically create bound fields for each field in the data source; otherwise, false. The default is true. The following code example demonstrates how to use the AutoGenerateColumns property to automatically create bound columns in a Telerik RadGrid control for each field in the data source. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" AutoGenerateColumns="true" AllowSorting="true"> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets or sets the URL to an image to display in the background of a Telerik RadGrid control. The URL of an image to display in the background of the Telerik RadGrid control. The default is an empty string (""), which indicates that this property is not set. Use the BackImageUrl property to specify the URL to an image to display in the background of a Telerik RadGrid control. If the specified image is smaller than the Telerik RadGrid control, the image is tiled to fill in the background. If the image is larger than the control, the image is cropped. Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets group panel control instance - visible only if grouping is enabled in grid (). Each 's Group-By-Expression is visualized in this panel. If grouping is enabled grid allows grouping by column(s) by drag-and-drop of columns from it's detail tables in this panel For this purpose set AllowDragToGroup property to true. You can modify panel's appearance using and . Gets or sets a value indicating whether the would be shown in Telerik RadGrid. true, when Telerik RadGrid will display the panel; otherwise false. The default is false. GroupPanel Gets or sets a value indicating whether the grouping is enabled. Most often this property is used in conjunction with property set to true. The easiest way to turn the grouping on is by using the grid's SmartTag option for enabling the grouping. Basic Grouping true, when the automatic grouping is enabled; otherwise false. The default is false. Gets or sets a value indicating whether Telerik RadGrid will perform automatic updates to the data source. true, when the automatic updates are allowed; otherwise false. The default is false. See Automatic Data Source Operations for details. Gets or sets a value indicating whether Telerik RadGrid will perform automatic insert of records to the data source. See Automatic Data Source Operations for details. true, when automatic insert into the database would be performed; otherwise false. The default is false. Gets or sets a value indicating whether Telerik RadGrid will automatically delete records from the specified data source. See Automatic Data Source Operations for details. true, when automatic delete from the database would be performed; otherwise false. The default is false. The instance of that represents the main grid-table view in RadGrid. Telerik RadGrid introduces a new approach to hierarchical data structures. The innovative in Telerik RadGrid is having a so called MasterTableView. This is the topmost table of the hierarchical structure. It is a with . The collection holds the so called DetailTables - tables related to the fields of the MasterTable. Each DetailTable can have its own GridTableViewCollection with other Detail Tables, thus forming the hierarchical structure.
Note: There is only one Master Table for a single Telerik RadGrid. This is the topmost table. All inner tables are referred as a Detail Tables regardless of whether they have related (inner) tables or not.
A reference to the topmost , i.e the MasterTableView. RadGrid and MasterTableView difference 
            <radg:radgrid id="RadGrid1" runat="server"

            CssClass= "RadGrid" Width="100%" AutoGenerateColumns="False" PageSize="3" AllowSorting="True"
  
            AllowMultiRowSelection= "False" AllowPaging="True" GridLines="None" AllowFilteringByColumn="true">
 
            <PagerStyle Mode="NumericPages" CssClass="Pager"></PagerStyle>
  
            <HeaderStyle CssClass="Header"></HeaderStyle>
  
            <ItemStyle CssClass="Row"></ItemStyle>

            <AlternatingItemStyle CssClass="AltRow"></AlternatingItemStyle>
  
            <MasterTableView DataKeyNames="CustomerID" AllowMultiColumnSorting="True">
 
            <DetailTables>
     
            <radG:GridTableView DataKeyNames="OrderID" DataMember="Orders">
  
            <ParentTableRelation>
   
            <radG:GridRelationFields DetailKeyField="CustomerID" MasterKeyField="CustomerID" />
  
            </ParentTableRelation>
                        <DetailTables>
    
            <radG:GridTableView DataKeyNames="OrderID" DataMember="OrderDetails">
    
            <ParentTableRelation>
        
            <radG:GridRelationFields DetailKeyField="OrderID" MasterKeyField="OrderID" />
    
            </ParentTableRelation>
              
            <Columns>
                   
            <radG:GridBoundColumn SortExpression="UnitPrice" HeaderText="Unit Price" HeaderButtonType="TextButton"
 
            DataField= "UnitPrice">
    
            </radG:GridBoundColumn>
          
            <radG:GridBoundColumn SortExpression="Quantity" HeaderText="Quantity" HeaderButtonType="TextButton"
     
            DataField= "Quantity">
                                    </radG:GridBoundColumn>
    
            <radG:GridBoundColumn SortExpression="Discount" HeaderText="Discount" HeaderButtonType="TextButton"
     
            DataField= "Discount">
                                    </radG:GridBoundColumn>
          
            </Columns>
                                <SortExpressions>
                           
            <radG:GridSortExpression FieldName="Quantity" SortOrder="Descending"></radG:GridSortExpression>
    
            </SortExpressions>
                                <ItemStyle BackColor="#A7B986"></ItemStyle>
  
            <HeaderStyle CssClass="Header1"></HeaderStyle>
     
            <AlternatingItemStyle BackColor="#D9E8C4"></AlternatingItemStyle>
    
            </radG:GridTableView>
              
            </DetailTables>
      
            <Columns>
               
            <radG:GridBoundColumn SortExpression="OrderID" HeaderText="OrderID" HeaderButtonType="TextButton"
   
            DataField= "OrderID">
                            </radG:GridBoundColumn>
        
            <radG:GridBoundColumn SortExpression="OrderDate" HeaderText="Date Ordered" HeaderButtonType="TextButton"
    
            DataField= "OrderDate">
                            </radG:GridBoundColumn>
       
            <radG:GridBoundColumn SortExpression="EmployeeID" HeaderText="EmployeeID" HeaderButtonType="TextButton"
  
            DataField= "EmployeeID">
                            </radG:GridBoundColumn>
     
            </Columns>
                        <SortExpressions>
          
            <radG:GridSortExpression FieldName="OrderDate"></radG:GridSortExpression>
        
            </SortExpressions>
                        <ItemStyle Height="19px" BackColor="#FCEDB0"></ItemStyle>
 
            <HeaderStyle CssClass="Header2" ForeColor="#ffffff"></HeaderStyle>
       
            <AlternatingItemStyle Height="19px" BackColor="#D5B96A"></AlternatingItemStyle>
  
            </radG:GridTableView>
                </DetailTables>
      
            <Columns>
        
            <radG:GridBoundColumn SortExpression="CustomerID" HeaderText="CustomerID" HeaderButtonType="TextButton"
  
            DataField= "CustomerID">
        
            </radG:GridBoundColumn>
    
            <radG:GridBoundColumn SortExpression="ContactName" HeaderText="Contact Name" HeaderButtonType="TextButton"
    
            DataField= "ContactName">
   
            </radG:GridBoundColumn>
       
            <radG:GridBoundColumn SortExpression="CompanyName" HeaderText="Company" HeaderButtonType="TextButton"
  
            DataField= "CompanyName">
       
            </radG:GridBoundColumn>
                </Columns>
      
            <SortExpressions>
          
            <radG:GridSortExpression FieldName="CompanyName"></radG:GridSortExpression>
    
            </SortExpressions>
            </MasterTableView>
   
            <SelectedItemStyle ForeColor="White" BackColor="DarkBlue" CssClass=""></SelectedItemStyle>

            </radg:radgrid>
Gets or sets an integer value representing the current page index. Note that the Paging must be enabled ( must be true) in order to use this property. zero-based int representing the index of the current page. Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the item selected for editing in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the item being edited in a Telerik RadGrid control. Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Use the EditItemStyle property to control the appearance of the item being edited in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, EditItemStyle-ForeColor). Nest a <EditItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, EditItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the EditItemStyle property to define a custom style for the item being edited in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None" > <EditItemStyle BackColor="red" /> <MasterTableView> <Columns> <radG:GridEditCommandColumn> </radG:GridEditCommandColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the footer item in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the footer item in a Telerik RadGrid control. Use the FooterItemStyle property to control the appearance of the footer item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, FooterItemStyle-ForeColor). Nest a <FooterItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, FooterItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the footer item in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None" ShowFooter="true" > <FooterStyle BackColor="red" /> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets the style properties of the heading section in the RadGrid control. A reference to the that represents the style of the header item in a Telerik RadGrid control. Use the HeaderItemStyle property to control the appearance of the header item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, HeaderItemStyle-ForeColor). Nest a <HeaderItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, HeaderItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The ShowHeader property must be set to true for this property to be visible. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the header item in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None" > <HeaderStyle BackColor="red" /> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the filter item in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the filter item in a Telerik RadGrid control. Use the FilterItemStyle property to control the appearance of the filter item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, FilterItemStyle-ForeColor). Nest a <FilterItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, FilterItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the filter item in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None" AllowFilteringByColumn="true"> <FilterItemStyle BackColor="red" /> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the command item in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the command item in a Telerik RadGrid control. Use the CommandItemStyle property to control the appearance of the command item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, CommandItemStyle-ForeColor). Nest a <CommandItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, CommandItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the command item in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None"> <CommandItemStyle BackColor="red" /> <MasterTableView CommandItemDisplay="TopAndBottom"> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the active item in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the actibe item in a Telerik RadGrid control. Use the ActiveItemStyle property to control the appearance of the active item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, ActiveItemStyle-ForeColor). Nest a <ActiveItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, ActiveItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the active item in a Telerik RadGrid control. Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets a collection of all GridDataItems. The RadGrid control automatically populates the Items collection by creating a GridDataItem object for each record in the data source and then adding each object to the collection. This property is commonly used to access a specific item in the control or to iterate though the entire collection of items. You cannot use this collection to get special Items like Header, Pager, Footer, etc. Handle event and use the event arguments to get a reference to such items. all grid data items as Gets a reference to the GridTableItemStyle object that allows you to set the appearance of the data items in a RadGrid control. A reference to the GridTableItemStyle that represents the style of the data items in a Telerik RadGrid control. Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework <%@ Page language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html > <head id="Head1" runat="server"> <title>GridView ItemStyle And AlternatingItemStyle Example</title> </head> <body> <form id="form1" runat="server"> <h3>GridView ItemStyle And AlternatingItemStyle Example</h3> <radG:RadGrid id="CustomersGridView" datasourceid="CustomersSource" autogeneratecolumns="true" Skin="None" runat="server"> <itemstyle backcolor="LightCyan" forecolor="DarkBlue" font-italic="true"/> <alternatingitemstyle backcolor="PaleTurquoise" forecolor="DarkBlue" font-italic="true"/> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:sqldatasource id="CustomersSource" selectcommand="Select [CustomerID], [CompanyName], [Address], [City], [PostalCode], [Country] From [Customers]" connectionstring="<<see cref="NorthWindConnectionString">$ ConnectionStrings</see>>" runat="server"/> </form> </body> </html> Use the ItemStyle property to control the appearance of the data items in a Telerik RadGrid control. When the AlternatingItemStyle property is also set, the data items are displayed alternating between the ItemStyle settings and the AlternatingItemStyle settings. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. Gets the number of pages required to display the records of the data source in a Telerik RadGrid control. When the paging feature is enabled (by setting the AllowPaging property to true), use the PageCount property to determine the total number of pages required to display the records in the data source. This value is calculated by dividing the total number of records in the data source by the number of records displayed in a page (as specified by the PageSize property) and rounding up. The number of pages in a Telerik RadGrid control. The following code example demonstrates how to use the PageCount property to determine the total number of pages displayed in the Telerik RadGrid control. <%@ Page Language="C#" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> protected void RadGrid1_PreRender(object sender, EventArgs e) { Label1.Text = RadGrid1.PageCount.ToString(); } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" AllowPaging="true" runat="server" OnPreRender="RadGrid1_PreRender"> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label></div> </form> </body> </html> <%@ Page Language="VB" @ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Protected Sub RadGrid1_PreRender(ByVal sender As Object, ByVal e As System.EventArgs) Label1.Text = RadGrid1.PageCount.ToString() End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" AllowPaging="true" runat="server" OnPreRender="RadGrid1_PreRender" > </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label></div> </form> </body> </html> Gets a reference to the GridPagerStyle object that allows you to set the appearance of the page item in a Telerik RadGrid control. A GridPagerStyle object that contains the style properties of the paging section of the RadGrid control. The default value is an empty GridPagerStyle object. Use this property to provide a custom style for the paging section of the RadGrid control. Common style attributes that can be adjusted include forecolor, backcolor, font, and content alignment within the cell. Providing a different style enhances the appearance of the RadGrid control. To specify a custom style for the paging section, place the <PagerStyle> tags between the opening and closing tags of the RadGrid control. You can then list the style attributes within the opening <PagerStyle> tag. The following code example demonstrates how to use the PagerStyle property to specify a custom style for the page selection elements of the RadGrid control. <%@ Page Language="VB" %> <%@ Import Namespace="System.Data" <see cref="> <"/>@ Register TagPrefix="radG" Namespace="Telerik.WebControls" Assembly="RadGrid.Net2" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <script runat="server"> Function CreateDataSource() As ICollection Dim dt As New DataTable() Dim dr As DataRow dt.Columns.Add(New DataColumn("IntegerValue", GetType(Int32))) dt.Columns.Add(New DataColumn("StringValue", GetType(String))) dt.Columns.Add(New DataColumn("DateTimeValue", GetType(String))) dt.Columns.Add(New DataColumn("BoolValue", GetType(Boolean))) Dim i As Integer For i = 0 To 99 dr = dt.NewRow() dr(0) = i dr(1) = "Item " & i.ToString() dr(2) = DateTime.Now.ToShortDateString() If i Mod 2 <> 0 Then dr(3) = True Else dr(3) = False End If dt.Rows.Add(dr) Next i Dim dv As New DataView(dt) Return dv End Function 'CreateDataSource Sub ShowStats() lblEnabled.Text = "AllowPaging is " & RadGrid1.AllowPaging lblCurrentIndex.Text = "CurrentPageIndex is " & RadGrid1.CurrentPageIndex lblPageCount.Text = "PageCount is " & RadGrid1.PageCount lblPageSize.Text = "PageSize is " & RadGrid1.PageSize End Sub 'ShowStats Protected Sub RadGrid1_NeedDataSource(ByVal source As Object, ByVal e As Telerik.WebControls.GridNeedDataSourceEventArgs) Handles RadGrid1.NeedDataSource RadGrid1.DataSource = CreateDataSource() ShowStats() End Sub Protected Sub CheckBox1_CheckedChanged(ByVal sender As Object, ByVal e As System.EventArgs) Handles CheckBox1.CheckedChanged If CheckBox1.Checked Then RadGrid1.PagerStyle.Mode = GridPagerMode.NumericPages Else RadGrid1.PagerStyle.Mode = GridPagerMode.NextPrev End If RadGrid1.Rebind() End Sub </script> <head id="Head1" runat="server"> <title>RadGrid Paging Example</title> </head> <body> <h3> RadGrid Paging Example</h3> <form id="form1" runat="server"> <radG:RadGrid ID="RadGrid1" runat="server" AllowPaging="True"> <PagerStyle Mode="NumericPages" HorizontalAlign="Right"></PagerStyle> <HeaderStyle BackColor="#aaaadd"></HeaderStyle> <AlternatingItemStyle BackColor="#eeeeee"></AlternatingItemStyle> </radG:RadGrid> <br /> <asp:CheckBox ID="CheckBox1" runat="server" Text="Show numeric page navigation buttons" AutoPostBack="true" /> <br /> <table style="background-color: #eeeeee; padding: 6"> <tr> <td style="display: inline"> <asp:Label ID="lblEnabled" runat="server" /><br /> <asp:Label ID="lblCurrentIndex" runat="server" /><br /> <asp:Label ID="lblPageCount" runat="server" /><br /> <asp:Label ID="lblPageSize" runat="server" /><br /> </td> </tr> </table> </form> </body> </html> <%@ Page Language="C#" %> <%@ Import Namespace="System.Data" <see cref="> <"/>@ Register TagPrefix="radG" Namespace="Telerik.WebControls" Assembly="RadGrid.Net2" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <script runat="server"> ICollection CreateDataSource() { DataTable dt = new DataTable(); DataRow dr; dt.Columns.Add(new DataColumn("IntegerValue", typeof(Int32))); dt.Columns.Add(new DataColumn("StringValue", typeof(string))); dt.Columns.Add(new DataColumn("DateTimeValue", typeof(string))); dt.Columns.Add(new DataColumn("BoolValue", typeof(bool))); int i; for (i = 0; (i <= 99); i++) { dr = dt.NewRow(); dr[0] = i; dr[1] = ("Item " + i.ToString()); dr[2] = DateTime.Now.ToShortDateString(); if (((i % 2) != 0)) { dr[3] = true; } else { dr[3] = false; } dt.Rows.Add(dr); } DataView dv = new DataView(dt); return dv; } // CreateDataSource void ShowStats() { lblEnabled.Text = ("AllowPaging is " + RadGrid1.AllowPaging); lblCurrentIndex.Text = ("CurrentPageIndex is " + RadGrid1.CurrentPageIndex); lblPageCount.Text = ("PageCount is " + RadGrid1.PageCount); lblPageSize.Text = ("PageSize is " + RadGrid1.PageSize); } // ShowStats protected void RadGrid1_NeedDataSource(object source, Telerik.WebControls.GridNeedDataSourceEventArgs e) { RadGrid1.DataSource = CreateDataSource(); ShowStats(); } protected void CheckBox1_CheckedChanged(object sender, System.EventArgs e) { if (CheckBox1.Checked) { RadGrid1.PagerStyle.Mode = GridPagerMode.NumericPages; } else { RadGrid1.PagerStyle.Mode = GridPagerMode.NextPrev; } RadGrid1.Rebind(); } </script> <head id="Head1" runat="server"> <title>RadGrid Paging Example</title> </head> <body> <h3> RadGrid Paging Example</h3> <form id="form1" runat="server"> <radG:RadGrid ID="RadGrid1" runat="server" AllowPaging="True" OnNeedDataSource="RadGrid1_NeedDataSource"> <PagerStyle Mode="NumericPages" HorizontalAlign="Right"></PagerStyle> <HeaderStyle BackColor="#aaaadd"></HeaderStyle> <AlternatingItemStyle BackColor="#eeeeee"></AlternatingItemStyle> </radG:RadGrid> <br /> <asp:CheckBox ID="CheckBox1" runat="server" Text="Show numeric page navigation buttons" AutoPostBack="true" OnCheckedChanged="CheckBox1_CheckedChanged" /> <br /> <table style="background-color: #eeeeee; padding: 6"> <tr> <td style="display: inline"> <asp:Label ID="lblEnabled" runat="server" /><br /> <asp:Label ID="lblCurrentIndex" runat="server" /><br /> <asp:Label ID="lblPageCount" runat="server" /><br /> <asp:Label ID="lblPageSize" runat="server" /><br /> </td> </tr> </table> </form> </body> </html> Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework Gets or sets an integer value indicating the number of Items that a single page in Telerik RadGrid will contain. Note that the Paging must be enabled ( must be true) in order to use this property. integer, indicating the number of the Items that a single grid page would contain. Gets or sets a value indicating whether you will be able to select multiple rows in Telerik RadGrid. By default this property is set to false. true if you can have multiple rows selected at once. Otherwise, false. The default is false. Note: You will not be able to select the Header, Footer or Pager rows. Gets or sets a value indicating whether Telerik RadGrid will allow you to have multiple rows in edit mode. The default value is false. true if you can have more than one row in edit mode. Otherwise, false. The default value is false. You can see an example usage of this property in the following online example: http://www.telerik.com/r.a.d.controls/Grid/Examples/Hierarchy/ThreeLevel/DefaultCS.aspx private void Page_Load(object sender, EventArgs e) { if (!IsPostBack) { RadGrid1.SelectedIndexes.Add(1, 0, 1, 0, 1); //Index of 1, 0, 1, 0, 1 means: //1 - item with index 1 in the MasterTabelView //0 - detail table with index 0 //1 - item with index 1 (the second item) in the first detail table //0 - 0 the third-level detail table //1 - the item with index 1 in the third-level table } } Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs) Handles Me.Load If Not IsPostBack Then RadGrid1.SelectedIndexes.Add(1, 0, 1, 0, 1) 'Index of 1, 0, 1, 0, 1 means: '1 - item With index 1 In the MasterTabelView '0 - detail table With index 0 '1 - item With index 1 (the second item) In the first detail table '0 - 0 the third-level detail table '1 - the item With index 1 In the third-level table End If End Sub Gets a collection of indexes of the selected items. returns of the indexes of all selected Items. Gets a collection of the indexes of the Items that are in edit mode. The following example demonstrates how to hide "Add New" button in the CommandItemTemplate when Telerik RadGrid is in edit/insert mode. The easiest way to check if Telerik RadGrid is in edit mode is to check whether the (EditIndexes gives a reference to this) is empty. 
            <CommandItemTemplate>
                
                <asp:LinkButton ID="LinkButton1" Visible="<%# (!(RadGrid1.MasterTableView.IsItemInserted || RadGrid1.EditIndexes.Count >0 )) %>"
                
            runat="server" CommandName="InitInsert">Add New</asp:LinkButton>
                
            </CommandItemTemplate>
returns of all data items that are in edit mode. Gets a collection of the currently selected GridDataItems Returns a of all selected data items. Gets the data key value of the selected row in a RadGrid control. The data key value of the selected row in a RadGrid control. The following code example demonstrates how to use the SelectedValue property to determine the data key value of the selected row in a RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> Sub RadGrid1_SelectedIndexChanged(ByVal sender As Object, ByVal e As EventArgs) ' Display the primary key value of the selected row. Label1.Text = "The primary key value of the selected row is " & _ RadGrid1.SelectedValue.ToString() & "." End Sub </script> <html xmlns="http://www.w3.org/1999/xhtml"> <head runat="server"> <title>RadGrid SelectedValue Example</title> </head> <body> <form id="form1" runat="server"> <h3> RadGrid SelectedValue Example</h3> <asp:Label ID="Label1" ForeColor="Red" runat="server" /> <radG:RadGrid ID="RadGrid1" DataSourceID="SqlDataSource1" OnSelectedIndexChanged="RadGrid1_SelectedIndexChanged" runat="server"> <MasterTableView DataKeyNames="CustomerID"> <Columns> <radG:GridButtonColumn CommandName="Select" Text="Select" /> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" SelectCommand="SELECT * FROM [Customers]" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" /> </form> </body> </html> <%@ Page Language="C#" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html Public "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <script runat="server"> protected void RadGrid1_SelectedIndexChanged(object sender, EventArgs e) { // Display the primary key value of the selected row. Label1.Text = "The primary key value of the selected row is " + RadGrid1.SelectedValue.ToString() + "."; } </script> <html xmlns="http://www.w3.org/1999/xhtml"> <head runat="server"> <title>RadGrid SelectedValue Example</title> </head> <body> <form id="form1" runat="server"> <h3> RadGrid SelectedValue Example</h3> <asp:Label ID="Label1" ForeColor="Red" runat="server" /> <radG:RadGrid ID="RadGrid1" DataSourceID="SqlDataSource1" OnSelectedIndexChanged="RadGrid1_SelectedIndexChanged" runat="server"> <MasterTableView DataKeyNames="CustomerID"> <Columns> <radG:GridButtonColumn CommandName="Select" Text="Select" /> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server And connects --> <!-- To the Northwind sample database. Use an ASP.NET --> <!-- expression To retrieve the connection String value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" SelectCommand="SELECT * FROM [Customers]" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" /> </form> </body> </html> The EditItems collection contains InPlace edit mode items. When you switch the edit type to EditForms, the EditItems collection holds the currently edited items but not their EditFormItems (which in this case hold the new values). See this help article for more details. You should not use this property to check whether there are items in edit mode. The better approach is to use property instead. Gets a collection of all GridItems in edit mode. See the Remarks for more info. of all items that are in edit mode. Gets a reference to the object that allows you to set the appearance of the selected item in a Telerik RadGrid control. A reference to the GridTableItemStyle that represents the style of the selected item in a Telerik RadGrid control. Supported in: 3.0, 2.0, 1.1, 1.0 .NET Framework The following code example demonstrates how to use the SelectedItemStyle property to define a custom style for the selected item in a Telerik RadGrid control. <%@ Page Language="VB" %> <%@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server" Skin="None"> <SelectedItemStyle BackColor="red" /> <MasterTableView> <Columns> <radG:GridButtonColumn Text="Select" UniqueName="Select" CommandName="Select"> </radG:GridButtonColumn> </Columns> </MasterTableView> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<$ ConnectionStrings>" SelectCommand="SELECT TOP 5 [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> </div> </form> </body> </html> Use the SelectedItemStyle property to control the appearance of the selected item in a Telerik RadGrid control. This property is read-only; however, you can set the properties of the GridTableItemStyle object it returns. The properties can be set declaratively using one of the following methods: Place an attribute in the opening tag of the Telerik RadGrid control in the form Property-Subproperty, where Subproperty is a property of the GridTableItemStyle object (for example, SelectedItemStyle-ForeColor). Nest a <SelectedItemStyle> element between the opening and closing tags of the Telerik RadGrid control. The properties can also be set programmatically in the form Property.Subproperty (for example, SelectedItemStyle.ForeColor). Common settings usually include a custom background color, foreground color, and font properties. Gets or set a value indicating whether the footer item of the grid will be shown. Setting this property will affect all grid tables, unless they specify otherwise explicitly. The default value of this property is false. Gets or set a value indicating whether the statusbar item of the grid will be shown. This property is meaningful when the grid is in AJAX mode, i.e. when is set to true. See this help topic for more details. true if the status bar item would be shown, otherwise false. The default value of this property is false. Status bar item Gets a object that contains variable settings related to the status bar. 
            <radG:RadGrid ID="RadGrid1" runat="server" DataSourceID="SqlDataSource1" ShowStatusBar="true" EnableAjax="true">
      <StatusBarSettings LoadingText="Loading... Please wait!" ReadyText="Online" />              
 </radG:RadGrid>
returns a reference to object. Gets or set a value indicating whether the header item of the grid will be shown. This default value for this property is true. Setting this property will affect all grid tables, unless they specify otherwise explicitly. Gets or sets a value, indicating the total number of items in the data source when custom paging is used. Thus the grid "understands" that the data source contains the specified number of records and it should fetch merely part of them at a time to execute requested operation. int, representing the total number of items in the datasource. The default value is 0. If you set a value that is greater than the actual number of items, RadGrid will show all available items plus empty pages (or whatever other content you set) for the items that exceed the actual number. For example you have a data source with 9'000 items and you set VirtualItemCount to 10'000. If your page size is 1000, the grid will render 10 pages and the last page will be empty (or with NoRecordsTemplate if you're using such). Gets a reference to object. The filtering menu appears when the filter button on the is clicked. returns a reference to object. This property is meaningful only when you have filtering enabled (by setting AllowFilteringByColumn="true"). The following example demonstrates how to customize the filtering menu: [ASPX/ASCX]
<head runat="server">
<title>Filter menu change</title>
<style type="text/css">
.FilterMenuClass1 td
{
background-color: white;
color: green;
font-size: 10px;
}
.FilterMenuClass2 td
{
background-color: blue;
color: white;
font-size: 15px;
}
</style>
</head>
<body>
<form id="form1" runat="server">
<div>
<script type="text/javascript">
function GridCreated()
{
window.setTimeout(SetFilterMenuClass(this), 500);
}
function SetFilterMenuClass(gridObject)
{
gridObject.FilterMenu.SelectColumnBackColor = "";
gridObject.FilterMenu.TextColumnBackColor = "";

}
</script>
<radG:RadGrid ID="RadGrid1" AllowFilteringByColumn="true" DataSourceID= "AccessDataSource1"
AllowSorting= "True" runat="server">
<FilterMenu CssClass="FilterMenuClass1"></FilterMenu>
<ClientSettings>
<ClientEvents OnGridCreated="GridCreated" />
</ClientSettings>
</radG:RadGrid>
<br />
<asp:AccessDataSource ID="AccessDataSource1" DataFile="~/Grid/Data/Access/Nwind.mdb"
SelectCommand= "SELECT TOP 10 CustomerID, CompanyName, ContactName, ContactTitle, Address, PostalCode FROM Customers"
runat= "server"></asp:AccessDataSource>
<radG:RadGrid ID="RadGrid2" DataSourceID="AccessDataSource1" AllowSorting="True"
AllowFilteringByColumn= "true" Skin="Windows" runat="server">
<ClientSettings>
<ClientEvents OnGridCreated="GridCreated" />
</ClientSettings>
<FilterMenu CssClass="FilterMenuClass2"></FilterMenu>
</radG:RadGrid>
</div>
</form>
</body>
</html> Gets or sets transparency in percentage. Default value is 0 percents. int, showing the current transparency for the Loading Template. Setting this property to 0% would mean an opaque loading template. Setting the property to 100% would mean a fully transparent template. See this topic for more details regarding the Loading Template. If set to true and if there is AJAX request, RadGrid will show The template that will be displayed as a progress indicator during AJAX request. Loading Template By default if you have't set own template, Telerik RadGrid will use the loading.gif image of the selected skin. <radg:radgrid id="RadGrid1" Width="100%" EnableAJAXLoadingTemplate="True" cssclass="RadGrid"
EnableAJAX="True" allowsorting="True"
pagesize="5" allowpaging="True" Height="200px" runat="server">
<headerstyle cssclass="GridHeader" Height="20px"/>
<pagerstyle mode="NumericPages" cssclass="GridPager" Height="20px" />
<itemstyle cssclass="GridRow" />
<alternatingitemstyle cssclass="GridRow" />
<MasterTableView CssClass="MasterTable" Height="100%" ></MasterTableView>
</radg:radgrid> Gets a collection () of all columns in Telerik RadGrid. This is one of the three columns collections in Telerik RadGrid. The other two are AutoGeneratedColumns and RenderColumns. returns a of all grid columns. The example below demonstrates how to use the columns collection to define columns declaratively (in the ASPX) 
            		<
            		radG:RadGrid ID="RadGrid1" DataSourceID="AccessDataSource1" AllowPaging="True" ShowFooter="True"
runat="server" AutoGenerateColumns="False" AllowSorting="True" PageSize="3" Width="925px"
GridLines="None" CellPadding="0" Skin="Default" AllowMultiRowSelection="true">
<MasterTableView ShowFooter="True">
<RowIndicatorColumn Visible="False" UniqueName="RowIndicator">
<HeaderStyle Width="20px"></
            		HeaderStyle>
</RowIndicatorColumn
            		>
<Columns
            		>
<radG:GridEditCommandColumn FooterText="EditCommand footer" UniqueName="EditCommandColumn"
HeaderText="Edit&#160;Command Column">
</radG:GridEditCommandColumn
            		>
<radG:GridClientSelectColumn UniqueName="CheckboxSelectColumn" HeaderText="CheckboxSelect column <br
            		/>" />
<radG:GridBoundColumn FooterText="BoundColumn footer" UniqueName="CustomerID" SortExpression="CustomerID"
HeaderText="Bound<br/
            		>Column" DataField="CustomerID">
</radG:GridBoundColumn
            		>
<radG:GridCheckBoxColumn FooterText="CheckBoxColumn footer" UniqueName="Bool" HeaderText="CheckBox<
            		br/>Column"
DataField="Bool">
</radG:GridCheckBoxColumn
            		>
<radG:GridDropDownColumn FooterText="DropDownColumn footer" UniqueName="DropDownListColumn"
ListTextField="ContactName" ListValueField="CustomerID" DataSourceID="AccessDataSource2"
HeaderText="DropDown<
            		br/>Column" DataField="CustomerID">
</radG:GridDropDownColumn
            		>
<radG:GridButtonColumn FooterText="PushButtonColumn<
            		br/>footer" DataTextFormatString="Select {0}"
ButtonType="PushButton" UniqueName="column" HeaderText="PushButton<
            		br/>Column"
CommandName="Select" DataTextField="CustomerID">
</radG:GridButtonColumn
            		>
<radG:GridButtonColumn FooterText="LinkButtonColumn footer" DataTextFormatString="Remove selection"
UniqueName="column1" HeaderText="LinkButton<
            		br/>Column" CommandName="Deselect"
DataTextField="CustomerID">
</radG:GridButtonColumn
            		>
<radG:GridHyperLinkColumn FooterText="HyperLinkColumn footer" DataTextFormatString="Search Google for '{0}'"
DataNavigateUrlField="CompanyName" UniqueName="CompanyName" DataNavigateUrlFormatString="http://www.google.com/search?hl=en&amp;q={0}&amp;btnG=Google+Search"
HeaderText="HyperLink<
            		br/>Column" DataTextField="CompanyName">
</radG:GridHyperLinkColumn
            		>
<radG:GridTemplateColumn UniqueName="TemplateColumn" SortExpression="CompanyName">
<FooterTemplate
            		>
<img src="Img/image.gif" alt="" style="vertical-align: middle" />
Template footer
</FooterTemplate
            		>
<HeaderTemplate
            		>
<table id="Table1" cellspacing="0" cellpadding="0" width="300" border="1">
<tr
            		>
<td colspan="2" align="center">
<b
            		>Contact details</b
            		></td
            		>
</tr
            		>
<tr
            		>
<td style="width: 50%" align="center">
<asp:LinkButton CssClass="Button" Width="140" ID="btnContName" Text="Contact name"
Tooltip="Sort by ContactName" CommandName='Sort' CommandArgument='ContactName' runat="server" /></td>
<td style="width: 50%" align="center">
<asp:LinkButton CssClass="Button" Width="140" ID="btnContTitle" Text="Contact title"
Tooltip="Sort by ContactTitle" CommandName='Sort' CommandArgument='ContactTitle'
runat="server" /></td>
</tr
            		>
</table
            		>
</HeaderTemplate
            		>
<ItemTemplate
            		>
<table cellpadding="1" cellspacing="1" class="customTable">
<tr
            		>
<td style="width: 50%">
<%#Eval("ContactName") %>
</td
            		>
<td style="width: 50%">
<%#Eval("ContactTitle") %>
</td
            		>
</tr
            		>
<tr
            		>
<td colspan="2" align="center">
<a href='<%#"http://www.google.com/search?hl=en&amp;q=" + DataBinder.Eval(Container.DataItem, "ContactName") + "&amp;btnG=Google+Search"%>' >
<em
            		>Search Google for
<%#Eval("ContactName") %>
</em
            		></a
            		>
</td
            		>
</tr
            		>
<tr
            		>
<td colspan="2" align="center">
<img src="Img/image.gif" alt="" />
</td
            		>
</tr
            		>
</table
            		>
</ItemTemplate
            		>
</radG:GridTemplateColumn
            		>
</Columns
            		>
</MasterTableView
            		>
<ClientSettings
            		>
<Selecting AllowRowSelect="true" />
</ClientSettings
            		>
</radG:RadGrid
            		>
this.RadGrid1 = new RadGrid(); this.RadGrid1.NeedDataSource += new GridNeedDataSourceEventHandler(this.RadGrid1_NeedDataSource); this.RadGrid1.AutoGenerateColumns = false; this.RadGrid1.MasterTableView.DataMember = "Customers"; GridBoundColumn boundColumn; boundColumn = new GridBoundColumn(); boundColumn.DataField = "CustomerID"; boundColumn.HeaderText = "CustomerID"; this.RadGrid1.MasterTableView.Columns.Add(boundColumn); .... //Add to page controls collection this.PlaceHolder1.Controls.Add( RadGrid1 ); Me.RadGrid1 = New RadGrid AddHandler RadGrid1.NeedDataSource, AddressOf Me.RadGrid1_NeedDataSource AddHandler RadGrid1.DetailTableDataBind, AddressOf Me.RadGrid1_DetailTableDataBind Me.RadGrid1.AutoGenerateColumns = False Me.RadGrid1.MasterTableView.DataMember = "Customers" Dim boundColumn As GridBoundColumn boundColumn = New GridBoundColumn boundColumn.DataField = "CustomerID" boundColumn.HeaderText = "CustomerID" Me.RadGrid1.MasterTableView.Columns.Add(boundColumn) ....'Add to page controls collection Me.PlaceHolder1.Controls.Add(RadGrid1) Gets a value indicating whether a detail table is currently binding. Gets or sets the ID of the control from which the Telerik RadGrid control retrieves its list of data items. The ID of a control that represents the data source from which the Telerik RadGrid control retrieves its data. The default is String.Empty. If the Telerik RadGrid control has already been initialized when you set the DataSourceID property. This property cannot be set by themes or style sheet themes. The following code example demonstrates how the DataSourceID property of a Telerik RadGrid control is used. The Telerik RadGrid control is associated to the SqlDataSource control by setting its DataSourceID property to "SqlDataSource1", the ID of the SqlDataSource control. When the DataSourceID property is set (instead of the DataSource property), the Telerik RadGrid control automatically binds to the data source control at run time. <%@ Page Language="VB" <see cref="> <"/>@ Register Assembly="RadGrid.Net2" Namespace="Telerik.WebControls" TagPrefix="radG" %> <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>Untitled Page</title> </head> <body> <form id="form1" runat="server"> <div> <radG:RadGrid DataSourceID="SqlDataSource1" ID="RadGrid1" runat="server"> </radG:RadGrid> <!-- This example uses Microsoft SQL Server and connects --> <!-- to the Northwind sample database. Use an ASP.NET --> <!-- expression to retrieve the connection string value --> <!-- from the Web.config file. --> <asp:SqlDataSource ID="SqlDataSource1" runat="server" ConnectionString="<<see cref="NorthwindConnectionString">$ ConnectionStrings</see>>" SelectCommand="SELECT [CustomerID], [ContactName], [CompanyName] FROM [Customers]"> </asp:SqlDataSource> <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label></div> </form> </body> </html> Gets or sets the folder where the skins for Telerik RadGrid reside. By default this is ~/RadControls/Grid/Skins folder. The relative path to the skins folder as String. The default value is ~/RadControls/Grid/Skins. Gets or sets the name of the Skin that Telerik RadGrid will use. The name of the skin is actually the name of the subfolder of ~/RadControls/Grid/Skins, where the stylesheet and images for this skin reside. The folder that holds the skins can be changed using the SkinsPath Property. There are three possible scenarios for using this property: Leave this property unset or set it to "Default" - the default skin, common for the Telerik RadControls for ASP.NET suite will be used Set the name of the grid skin - the skin will be applied Set this property to "none" - no skin will be applied. Only the default grid images (for Expand/Collapse, Sort, Edit, etc) will be used. Use this option if you have own appearance customizations for prevous Telerik RadGrid versions. The name of the skin as String. Gets or sets a value indicating whether the filtering of all tables in the hierarchy will be enabled, unless specified other by GridTableView.AllowFilteringByColumn. true, enables filtering for the whole grid. Otherwise, false. Default is false. A length quantity in XSL which is specified as "auto". a colour quantity in XSL the red component the green component the blue component the alpha component set the colour given a particular String specifying either a colour name or #RGB or #RRGGBB a space quantity in XSL (space-before, space-after) a length quantity in XSL Set the length given a number of relative units and the current font size in base units. Set the length given a number of units and a unit name. set the length as a number of base units Convert the given length to a dimensionless integer representing a whole number of base units (milli-points). Constructor for IDNode @param idValue The value of the id for this node Sets the page number for this node @param number page number of node Returns the page number of this node @return page number of this node creates a new GoTo object for an internal link @param objectNumber the number to be assigned to the new object sets the page reference for the internal link's GoTo. The GoTo will jump to this page reference. @param pageReference the page reference to which the internal link GoTo should jump ex. 23 0 R Returns the reference to the Internal Link's GoTo object @return GoTo object reference Returns the id value of this node @return this node's id value Returns the PDFGoTo object associated with the internal link @return PDFGoTo object Determines whether there is an internal link GoTo for this node @return true if internal link GoTo for this node is set, false otherwise Sets the position of this node @param x the x position @param y the y position Constructor for IDReferences Creates and configures the specified id. @param id The id to initialize @param area The area where this id was encountered @exception ApocException Creates id entry @param id The id to create @param area The area where this id was encountered @exception ApocException Creates id entry that hasn't been validated @param id The id to create @exception ApocException Adds created id list of unvalidated ids that have already been created. This should be used if it is unsure whether the id is valid but it must be anyhow. @param id The id to create Removes id from list of unvalidated ids. This should be used if the id has been determined to be valid. @param id The id to remove Determines whether specified id already exists in idUnvalidated @param id The id to search for @return true if ID was found, false otherwise Configures this id @param id The id to configure @param area The area where the id was encountered Adds id to validation list to be validated . This should be used if it is unsure whether the id is valid @param id id to be added Removes id from validation list. This should be used if the id has been determined to be valid @param id the id to remove Removes id from IDReferences @param id The id to remove @exception ApocException Determines whether all id's are valid @return true if all id's are valid, false otherwise Returns all invalid id's still remaining in the validation list @return invalid ids from validation list Determines whether specified id already exists in IDReferences @param id the id to search for @return true if ID was found, false otherwise Determines whether the GoTo reference for the specified id is defined @param id the id to search for @return true if GoTo reference is defined, false otherwise Returns the reference to the GoTo object used for the internal link @param id the id whose reference to use @return reference to GoTo object Creates an PdfGoto object that will 'goto' the passed Id. The ID of the link's target. The PDF object id to use for the GoTo object. This method is a bit 'wrong'. Passing in an objectId seems a bit dirty and I don't see why an IDNode should be responsible for keeping track of the GoTo object that points to it. These decisions only seem to pollute this class with PDF specific code. Adds an id to IDReferences @param id the id to add Returns the PDFGoTo object for the specified id @param id the id for which the PDFGoTo to be retrieved is associated @return the PdfGoTo object associated with the specified id sets the page reference for the internal link's GoTo. The GoTo will jump to this page reference. @param pageReference the page reference to which the internal link GoTo should jump ex. 23 0 R Sets the page number for the specified id @param id The id whose page number is being set @param pageNumber The page number of the specified id Returns the page number where the specified id is found @param id The id whose page number to return @return the page number of the id, or null if the id does not exist Sets the x and y position of specified id @param id the id whose position is to be set @param x x position of id @param y y position of id XSL FO Keep Property datatype (keep-together, etc) What to do here? There isn't really a meaningful single value. Keep Value Stores the different types of keeps in a single convenient format. FO parent of the FO for which this property is to be calculated. PropertyList for the FO where this property is calculated. One of the defined types of LengthBase Accessor for parentFO object from subclasses which define custom kinds of LengthBase calculations. Accessor for propertyList object from subclasses which define custom kinds of LengthBase calculations. This datatype hold a pair of lengths, specifiying the dimensions in both inline and block-progression-directions. It is currently only used to specify border-separation in tables. a "progression-dimension" quantity ex. block-progression-dimension, inline-progression-dimension corresponds to the triplet min-height, height, max-height (or width) Set minimum value to min. @param min A Length value specifying the minimum value for this LengthRange. @param bIsDefault If true, this is set as a "default" value and not a user-specified explicit value. Set maximum value to max if it is >= optimum or optimum isn't set. @param max A Length value specifying the maximum value for this @param bIsDefault If true, this is set as a "default" value and not a user-specified explicit value. Set the optimum value. @param opt A Length value specifying the optimum value for this @param bIsDefault If true, this is set as a "default" value and not a user-specified explicit value. Return the computed value in millipoints. A length quantity in XSL which is specified with a mixture of absolute and relative and/or percent components. The actual value may not be computable before layout is done. a percent specified length quantity in XSL construct an object based on a factor (the percent, as a a factor) and an object which has a method to return the Length which provides the "base" for this calculation. Return the computed value in millipoints. This assumes that the base length has been resolved to an absolute length value. A space quantity in XSL (space-before, space-after) A table-column width specification, possibly including some number of proportional "column-units". The absolute size of a column-unit depends on the fixed and proportional sizes of all columns in the table, and on the overall size of the table. It can't be calculated until all columns have been specified and until the actual width of the table is known. Since this can be specified as a percent of its parent containing width, the calculation is done during layout. NOTE: this is only supposed to be allowed if table-layout=fixed. Number of table-column proportional units Construct an object with tcolUnits of proportional measure. Override the method in Length to return the number of specified proportional table-column units. Calculate the number of millipoints and set it. The original specified value for properties which inherit specified values. Accessor functions for all possible Property datatypes Gets or setd the original value specified for the property attribute. Construct an instance of a PropertyMaker. The property name is set to "UNKNOWN". Construct an instance of a PropertyMaker for the given property. The name of the property to be made. Default implementation of isInherited. A boolean indicating whether this property is inherited. Return a boolean indicating whether this property inherits the "specified" value rather than the "computed" value. The default is to inherit the "computed" value. If true, property inherits the value specified. Return an object implementing the PercentBase interface. This is used to handle properties specified as a percentage of some "base length", such as the content width of their containing box. Overridden by subclasses which allow percent specifications. See the documentation on properties.xsl for details. Return a Maker object which is used to set the values on components of compound property types, such as "space". Overridden by property maker subclasses which handle compound properties. The name of the component for which a Maker is to returned, for example "optimum", if the FO attribute is space.optimum='10pt'. Return a property value for the given component of a compound property. NOTE: this is only to ease porting when calls are made to PropertyList.get() using a component name of a compound property, such as get("space.optimum"). The recommended technique is: get("space").getOptimum(). Overridden by property maker subclasses which handle compound properties. A property value for a compound property type such as SpaceProperty. The name of the component whose value is to be returned. Return a property value for a compound property. If the property value is already partially initialized, this method will modify it. The Property object representing the compound property, such as SpaceProperty. The name of the component whose value is specified. The propertyList being built. The FO whose properties are being set. A compound property object. Set a component in a compound property and return the modified compound property object. This default implementation returns the original base property without modifying it. It is overridden by property maker subclasses which handle compound properties. The Property object representing the compound property, such as SpaceProperty. The name of the component whose value is specified. A Property object holding the specified value of the component to be set. The modified compound property object. Create a Property object from an attribute specification. The PropertyList object being built for this FO. The attribute value. The current FO whose properties are being set. The initialized Property object. Return a String to be parsed if the passed value corresponds to a keyword which can be parsed and used to initialize the property. For example, the border-width family of properties can have the initializers "thin", "medium", or "thick". The foproperties.xml file specifies a length value equivalent for these keywords, such as "0.5pt" for "thin". These values are considered parseable, since the Length object is no longer responsible for parsing unit expresssions. The string value of property attribute. A string containging a parseable equivalent or null if the passed value isn't a keyword initializer for this Property. Return a Property object based on the passed Property object. This method is called if the Property object built by the parser isn't the right type for this property. It is overridden by subclasses when the property specification in foproperties.xml specifies conversion rules. The Property object return by the expression parser The PropertyList object being built for this FO. The current FO whose properties are being set. A Property of the correct type or null if the parsed value can't be converted to the correct type. Return a Property object representing the initial value. The PropertyList object being built for this FO. Return a Property object representing the initial value. The PropertyList object being built for this FO. The parent FO for the FO whose property is being made. A Property subclass object holding a "compound" property object initialized to the default values for each component. Return a Property object representing the value of this property, based on other property values for this FO. A special case is properties which inherit the specified value, rather than the computed value. The PropertyList for the FO. Property A computed Property value or null if no rules are specified (in foproperties.xml) to compute the value. Return the name of the property whose value is being set. base class for extension objects base class for representation of formatting objects and their processing Value of marker before layout begins value of marker after break-after where the layout was up to. for FObjs it is the child number for FOText it is the character number lets outside sources access the property list first used by PageNumberCitation to find the "id" property returns null by default, overide this function when there is a property list @param name - the name of the desired property to obtain @returns the property At the start of a new span area layout may be partway through a nested FO, and balancing requires rollback to this known point. The snapshot records exactly where layout is at. @param snapshot a Vector of markers (Integer) @returns the updated Vector of markers (Integers) When balancing occurs, the flow layout() method restarts at the point specified by the current marker snapshot, which is retrieved and restored using this method. @param snapshot the Vector of saved markers (Integers) adds characters (does nothing here) @param data text @param start start position @param length length of the text generates the area or areas for this formatting object and adds these to the area. This method should always be overridden by all sub classes @param area returns the name of the formatting object @return the name of this formatting objects lets outside sources access the property list first used by PageNumberCitation to find the "id" property @param name - the name of the desired property to obtain @return the property Return the "content width" of the areas generated by this FO. This is used by percent-based properties to get the dimension of the containing block. If an FO has a property with a percentage value, that value is usually calculated on the basis of the corresponding dimension of the area which contains areas generated by the FO. NOTE: subclasses of FObj should implement this to return a reasonable value! removes property id @param idReferences the id to remove Set writing mode for this FO. Find nearest ancestor, including self, which generates reference areas and use the value of its writing-mode property. If no such ancestor is found, use the value on the root FO. @param parent the parent formatting object @param propertyList the explicit properties of this object Called for extensions within a page sequence or flow. These extensions are allowed to generate visible areas within the layout. @param area Called for root extensions. Root extensions aren't allowed to generate any visible areas. They are used for extra items that don't show up in the page layout itself. For example: pdf outlines @param areaTree The parent outline object if it exists an opaque renderer context object, e.g. PDFOutline for PDFRenderer By default, functions have no percent-based arguments. Return the specified or initial value of the property on this object. Return the name as a String (should be specified with quotes!) Construct a Numeric object from a Number. @param num The number. Construct a Numeric object from a Length. @param l The Length. Construct a Numeric object from a PercentLength. @param pclen The PercentLength. v * Construct a Numeric object from a TableColLength. * @param tclen The TableColLength. Return the current value as a Length if possible. This constructs a new Length or Length subclass based on the current value type of the Numeric. If the stored value has a unit dimension other than 1, null is returned. Return the current value as a Number if possible. Calls asDouble(). Return a boolean value indiciating whether the currently stored value consists of different "types" of values (absolute, percent, and/or table-unit.) Subtract the operand from the current value and return a new Numeric representing the result. @param op The value to subtract. @return A Numeric representing the result. @throws PropertyException If the dimension of the operand is different from the dimension of this Numeric. Add the operand from the current value and return a new Numeric representing the result. @param op The value to add. @return A Numeric representing the result. @throws PropertyException If the dimension of the operand is different from the dimension of this Numeric. Multiply the the current value by the operand and return a new Numeric representing the result. @param op The multiplier. @return A Numeric representing the result. @throws PropertyException If both Numerics have "mixed" type. Divide the the current value by the operand and return a new Numeric representing the result. @param op The divisor. @return A Numeric representing the result. @throws PropertyException If both Numerics have "mixed" type. Return the absolute value of this Numeric. @return A new Numeric object representing the absolute value. Return a Numeric which is the maximum of the current value and the operand. @throws PropertyException If the dimensions or value types of the object and the operand are different. Return a Numeric which is the minimum of the current value and the operand. @throws PropertyException If the dimensions or value types of the object and the operand are different. This class holds context information needed during property expression evaluation. It holds the Maker object for the property, the PropertyList being built, and the FObj parent of the FObj for which the property is being set. Return whether this property inherits specified values. Propagates to the Maker. @return true if the property inherits specified values, false if it inherits computed values. Return the PercentBase object used to calculate the absolute value from a percent specification. Propagates to the Maker. @return The PercentBase object or null if percentLengthOK()=false. Return the current font-size value as base units (milli-points). Construct a new PropertyTokenizer object to tokenize the passed string. @param s The Property expressio to tokenize. Return the next token in the expression string. This sets the following package visible variables: currentToken An enumerated value identifying the recognized token currentTokenValue A string containing the token contents currentUnitLength If currentToken = TOK_NUMERIC, the number of characters in the unit name. @throws PropertyException If un unrecognized token is encountered. Attempt to recognize a valid NAME token in the input expression. Attempt to recognize a valid sequence of decimal digits in the input expression. Attempt to recognize a valid sequence of hexadecimal digits in the input expression. Return a bool value indicating whether the following non-whitespace character is an opening parenthesis. Return a bool value indicating whether the argument is a decimal digit (0-9). @param c The character to check Return a bool value indicating whether the argument is a hexadecimal digit (0-9, A-F, a-f). @param c The character to check Return a bool value indicating whether the argument is whitespace as defined by XSL (space, newline, CR, tab). @param c The character to check Return a bool value indicating whether the argument is a valid name start character, ie. can start a NAME as defined by XSL. @param c The character to check Return a bool value indicating whether the argument is a valid name character, ie. can occur in a NAME as defined by XSL. @param c The character to check Public entrypoint to the Property expression parser. @param expr The specified value (attribute on the xml element). @param propInfo A PropertyInfo object representing the context in which the property expression is to be evaluated. @return A Property object holding the parsed result. @throws PropertyException If the "expr" cannot be parsed as a Property. Private constructor. Called by the static parse() method. @param propExpr The specified value (attribute on the xml element). @param propInfo A PropertyInfo object representing the context in which the property expression is to be evaluated. Parse the property expression described in the instance variables. Note: If the property expression String is empty, a StringProperty object holding an empty String is returned. @return A Property object holding the parsed result. @throws PropertyException If the "expr" cannot be parsed as a Property. Try to parse an addition or subtraction expression and return the resulting Property. Try to parse a multiply, divide or modulo expression and return the resulting Property. Try to parse a unary minus expression and return the resulting Property. Checks that the current token is a right parenthesis and throws an exception if this isn't the case. Try to parse a primary expression and return the resulting Property. A primary expression is either a parenthesized expression or an expression representing a primitive Property datatype, such as a string literal, an NCname, a number or a unit expression, or a function call expression. Parse a comma separated list of function arguments. Each argument may itself be an expression. This method consumes the closing right parenthesis of the argument list. @param nbArgs The number of arguments expected by the function. @return An array of Property objects representing the arguments found. @throws PropertyException If the number of arguments found isn't equal to the number expected. Evaluate an addition operation. If either of the arguments is null, this means that it wasn't convertible to a Numeric value. @param op1 A Numeric object (Number or Length-type object) @param op2 A Numeric object (Number or Length-type object) @return A new NumericProperty object holding an object which represents the sum of the two operands. @throws PropertyException If either operand is null. Evaluate a subtraction operation. If either of the arguments is null, this means that it wasn't convertible to a Numeric value. @param op1 A Numeric object (Number or Length-type object) @param op2 A Numeric object (Number or Length-type object) @return A new NumericProperty object holding an object which represents the difference of the two operands. @throws PropertyException If either operand is null. Evaluate a unary minus operation. If the argument is null, this means that it wasn't convertible to a Numeric value. @param op A Numeric object (Number or Length-type object) @return A new NumericProperty object holding an object which represents the negative of the operand (multiplication by *1). @throws PropertyException If the operand is null. Evaluate a multiplication operation. If either of the arguments is null, this means that it wasn't convertible to a Numeric value. @param op1 A Numeric object (Number or Length-type object) @param op2 A Numeric object (Number or Length-type object) @return A new NumericProperty object holding an object which represents the product of the two operands. @throws PropertyException If either operand is null. Evaluate a division operation. If either of the arguments is null, this means that it wasn't convertible to a Numeric value. @param op1 A Numeric object (Number or Length-type object) @param op2 A Numeric object (Number or Length-type object) @return A new NumericProperty object holding an object which represents op1 divided by op2. @throws PropertyException If either operand is null. Evaluate a modulo operation. If either of the arguments is null, this means that it wasn't convertible to a Number value. @param op1 A Number object @param op2 A Number object @return A new NumberProperty object holding an object which represents op1 mod op2. @throws PropertyException If either operand is null. Parses a double value using a culture insensitive locale. The double value as a string. The double value parsed. Return an object which implements the PercentBase interface. Percents in arguments to this function are interpreted relative to 255. Return true if the passed area is on the left edge of its nearest absolute AreaContainer (generally a page column). base class for representation of mixed content formatting objects and their processing Return the content width of the boxes generated by this FO. Return the content width of the boxes generated by this block container FO. this class represents the flow object 'fo:character'. Its use is defined by the spec: "The fo:character flow object represents a character that is mapped to a glyph for presentation. It is an atomic unit to the formatter. When the result tree is interpreted as a tree of formatting objects, a character in the result tree is treated as if it were an empty element of type fo:character with a character attribute equal to the Unicode representation of the character. The semantics of an "auto" value for character properties, which is typically their initial value, are based on the Unicode codepoint. Overrides may be specified in an implementation-specific manner." (6.6.3) PageSequence container Vector to store snapshot flow-name attribute Content-width of current column area during layout Return the content width of this flow (really of the region in which it is flowing). returns the maker for this object. @return the maker for SVG objects constructs an instream-foreign-object object (called by Maker). @param parent the parent formatting object @param propertyList the explicit properties of this object layout this formatting object. @param area the area to layout the object into @return the status of the layout inner class for making SVG objects. make an SVG object. @param parent the parent formatting object @param propertyList the explicit properties of this object @return the SVG object Implements fo:leader; main property of leader leader-pattern. The following patterns are treated: rule, space, dots. The pattern use-content is ignored, i.e. it still must be implemented. adds a leader to current line area of containing block area the actual leader area is created in the line area @return int +1 for success and -1 for none Return the content width of the boxes generated by this FO. The page the marker was registered is put into the renderer queue. The marker is transferred to it's own marker list, release the area for GC. We also know now whether the area is first/last. This has actually nothing to do with resseting this marker, but the 'marker' from FONode, marking layout status. Called in case layout is to be rolled back. Unregister this marker from the page, it isn't laid aout anyway. More hackery: reset layout status marker. Called before the content is laid out from RetrieveMarker. 6.6.11 fo:page-number-citation Common Usage: The fo:page-number-citation is used to reference the page-number for the page containing the first normal area returned by the cited formatting object. NOTE: It may be used to provide the page-numbers in the table of contents, cross-references, and index entries. Areas: The fo:page-number-citation formatting object generates and returns a single normal inline-area. Constraints: The cited page-number is the number of the page containing, as a descendant, the first normal area returned by the formatting object with an id trait matching the ref-id trait of the fo:page-number-citation (the referenced formatting object). The cited page-number string is obtained by converting the cited page-number in accordance with the number to string conversion properties specified on the ancestor fo:page-sequence of the referenced formatting object. The child areas of the generated inline-area are the same as the result of formatting a result-tree fragment consisting of fo:character flow objects; one for each character in the cited page-number string and with only the "character" property specified. Contents: EMPTY The following properties apply to this formatting object: [7.3 Common Accessibility Properties] [7.5 Common Aural Properties] [7.6 Common Border, Padding, and Background Properties] [7.7 Common Font Properties] [7.10 Common Margin Properties-Inline] [7.11.1 "alignment-adjust"] [7.11.2 "baseline-identifier"] [7.11.3 "baseline-shift"] [7.11.5 "dominant-baseline"] [7.36.2 "id"] [7.17.4 "keep-with-next"] [7.17.5 "keep-with-previous"] [7.14.2 "letter-spacing"] [7.13.4 "line-height"] [7.13.5 "line-height-shift-adjustment"] [7.36.5 "ref-id"] [7.18.4 "relative-position"] [7.36.6 "score-spaces"] [7.14.4 "text-decoration"] [7.14.5 "text-shadow"] [7.14.6 "text-transform"] [7.14.8 "word-spacing"] Return true if any column has an unfinished vertical span. Done with a row. Any spans with only one row left are done This means that we can now set the total height for this cell box Loop over all cells with spans and find number of rows remaining if rows remaining = 1, set the height on the cell area and then remove the cell from the list of spanned cells. For other spans, add the rowHeight to the spanHeight. If the cell in this column is in the last row of its vertical span, return the height left. If it's not in the last row, or if the content height <= the content height of the previous rows of the span, return 0. helper method to prevent infinite loops if keeps or spans are not fitting on a page @param true if keeps and spans should be ignored helper method (i.e. hack ;-) to prevent infinite loops if keeps or spans are not fitting on a page @return true if keeps or spans should be ignored Return the height remaining in the span. Optimum inline-progression-dimension Minimum inline-progression-dimension Maximum inline-progression-dimension Return the content width of the boxes generated by this table FO. Initialize table inline-progression-properties values Offset of content rectangle in inline-progression-direction, relative to table. Dimension of allocation rectangle in inline-progression-direction, determined by the width of the column(s) occupied by the cell Offset of content rectangle, in block-progression-direction, relative to the row. Offset of content rectangle, in inline-progression-direction, relative to the column start edge. Adjust to theoretical column width to obtain content width relative to the column start edge. Minimum ontent height of cell. Set to true if all content completely laid out. Border separation value in the block-progression dimension. Used in calculating cells height. Return the allocation height of the cell area. Note: called by TableRow. We adjust the actual allocation height of the area by the value of border separation (for separate borders) or border height adjustment for collapse style (because current scheme makes cell overestimate the allocation height). Set the final size of cell content rectangles to the actual row height and to vertically align the actual content within the cell rectangle. @param h Height of this row in the grid which is based on the allocation height of all the cells in the row, including any border separation values. Calculate cell border and padding, including offset of content rectangle from the theoretical grid position. Set the column width value in base units which overrides the value from the column-width Property. Called by parent FO to initialize information about cells started in previous rows which span into this row. The layout operation modifies rowSpanMgr Before starting layout for the first time, initialize information about spanning rows, empty cells and spanning columns. Return column which doesn't already contain a span or a cell If past the end or no free cells after colNum, return -1 Otherwise return value >= input value. Return type of cell in colNum (1 based) Return cell in colNum (1 based) Store cell starting at cellColNum (1 based) and spanning numCols If any of the columns is already occupied, return false, else true Implementation for fo:wrapper formatting object. The wrapper object serves as a property holder for it's children objects. Content: (#PCDATA|%inline;|%block;)* Properties: id Returns the "master-reference" attribute of this page master reference Checks whether or not a region name exists in this master set @returns true when the region name specified has a region in this LayoutMasterSet Base PageMasterReference class. Provides implementation for handling the master-reference attribute and containment within a PageSequenceMaster Classes that implement this interface can be added to a PageSequenceMaster, and are capable of looking up an appropriate PageMaster. Called before a new page sequence is rendered so subsequences can reset any state they keep during the formatting process. Gets the formating object name for this object. Subclasses must provide this. @return the element name of this reference. e.g. fo:repeatable-page-master-reference Checks that the parent is the right element. The default implementation checks for fo:page-sequence-master Returns the "master-reference" attribute of this page master reference This class uses the 'format', 'groupingSeparator', 'groupingSize', and 'letterValue' properties on fo:page-sequence to return a string corresponding to the supplied integer page number. This provides pagination of flows onto pages. Much of the logic for paginating flows is contained in this class. The main entry point is the format method. The parent root object the set of layout masters (provided by the root object) Map of flows to their flow name (flow-name, Flow) the "master-reference" attribute, which specifies the name of the page-sequence-master or page-master to be used to create pages in the sequence specifies page numbering type (auto|auto-even|auto-odd|explicit) used to determine whether to calculate auto, auto-even, auto-odd the current subsequence while formatting a given page sequence the current index in the subsequence list the name of the current page master Runs the formatting of this page sequence into the given area tree Creates a new page area for the given parameters @param areaTree the area tree the page should be contained in @param firstAvailPageNumber the page number for this page @param isFirstPage true when this is the first page in the sequence @param isEmptyPage true if this page will be empty (e.g. forced even or odd break) @return a Page layout object based on the page master selected from the params Formats the static content of the current page Returns the next SubSequenceSpecifier for the given page sequence master. The result is bassed on the current state of this page sequence. Returns the next simple page master for the given sequence master, page number and other state information Returns true when there is more flow elements left to lay out. Returns the flow that maps to the given region class for the current page master. This is an abstract base class for pagination regions Creates a Region layout object for this pagination Region. Returns the default region name (xsl-region-before, xsl-region-start, etc.) Returns the element name ("fo:region-body", "fo:region-start", etc.) Returns the name of this region Checks to see if a given region name is one of the reserved names @param name a region name to check @return true if the name parameter is a reserved region name Max times this page master can be repeated. INFINITE is used for the unbounded case The fo:root formatting object. Contains page masters, root extensions, page-sequences. keeps count of page number from over PageSequence instances Some properties, such as 'force-page-count', require a page-sequence to know about some properties of the next. @returns succeeding PageSequence; null if none Page regions (regionClass, Region) Called by subclass if no match found. This object may be also be a subclass of Length, such as PercentLength, TableColLength. Set the appropriate components when the "base" property is set. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Set the appropriate components when the "base" property is set. Set the appropriate components when the "base" property is set. public Double getDouble() { return new Double(this.number.doubleValue()); } public Integer getInteger() { return new Integer(this.number.intValue()); } Return object used to calculate base Length for percent specifications. Set the appropriate components when the "base" property is set. Set the appropriate components when the "base" property is set. Set the appropriate components when the "base" property is set. Set the appropriate components when the "base" property is set. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Set the appropriate components when the "base" property is set. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. Return object used to calculate base Length for percent specifications. The fo:root formatting object. Contains page masters, root extensions, page-sequences. Builds the formatting object tree. Table mapping element names to the makers of objects representing formatting objects. Class that builds a property list for each formatting object. Current formatting object being handled. The root of the formatting object tree. Set of names of formatting objects encountered but unknown. The class that handles formatting and rendering to a stream. Sets the stream renderer that will be used as output. Add a mapping from element name to maker. Add a mapping from property name to maker. Return the value explicitly specified on this FO. @param propertyName The name of the property whose value is desired. It may be a compound name, such as space-before.optimum. @return The value if the property is explicitly set or set by a shorthand property, otherwise null. Return the value explicitly specified on this FO. @param propertyName The name of the property whose value is desired. It may be a compound name, such as space-before.optimum. @return The value if the property is explicitly set, otherwise null. Return the value explicitly specified on this FO. @param propertyName The name of the base property whose value is desired. @return The value if the property is explicitly set, otherwise null. Return the value of this property inherited by this FO. Implements the inherited-property-value function. The property must be inheritable! @param propertyName The name of the property whose value is desired. @return The inherited value, otherwise null. Return the property on the current FlowObject if it is specified, or if a corresponding property is specified. If neither is specified, it returns null. Return the property on the current FlowObject. If it isn't set explicitly, this will try to compute it based on other properties, or if it is inheritable, to return the inherited value. If all else fails, it returns the default value. Return the property on the current FlowObject. Depending on the passed flags, this will try to compute it based on other properties, or if it is inheritable, to return the inherited value. If all else fails, it returns the default value. Return the "nearest" specified value for the given property. Implements the from-nearest-specified-value function. @param propertyName The name of the property whose value is desired. @return The computed value if the property is explicitly set on some ancestor of the current FO, else the initial value. Return the value of this property on the parent of this FO. Implements the from-parent function. @param propertyName The name of the property whose value is desired. @return The computed value on the parent or the initial value if this FO is the root or is in a different namespace from its parent. Given an absolute direction (top, bottom, left, right), return the corresponding writing model relative direction name for the flow object. Uses the stored writingMode. Given a writing mode relative direction (start, end, before, after) return the corresponding absolute direction name for the flow object. Uses the stored writingMode. Set the writing mode traits for the FO with this property list. Name of font-size property attribute to set first. This seems to be just a helper method that looks up a property maker and creates the property. Convenience function to return the Maker for a given property. classes representating the status of laying out a formatting object This represents an unknown element. For example with unsupported namespaces. This prevents any further problems arising from the unknown data. returns the maker for this object. @return the maker for an unknown xml object constructs an unknown xml object (called by Maker). @param parent the parent formatting object @param propertyList the explicit properties of this object inner class for making unknown xml objects. make an unknown xml object. @param parent the parent formatting object @param propertyList the explicit properties of this object @return the unknown xml object A bitmap image that will be referenced by fo:external-graphic. This class and the associated ColorSpace class are PDF specific ideally will be moved to the PDF library project at some point in the future. Internally, Apoc should handle images using the standard framework Bitmap class. Filter that will be applied to image data Constructs a new ApocImage using the supplied bitmap. Does not hold a reference to the passed bitmap. Instead the image data is extracted from bitmap on construction. The location of bitmap The image data Extracts the raw data from the image into a byte array suitable for including in the PDF document. The image is always extracted as a 24-bit RGB image, regardless of it's original colour space and colour depth. The from which the data is extracted A byte array containing the raw 24-bit RGB data Return the image URL. the image URL (as a string) Return the image width. the image width Return the image height. the image height Return the number of bits per pixel. number of bits per pixel Return the image data size The image data size Return the image data (uncompressed). the image data Return the image color space. the image color space (Apoc.Datatypes.ColorSpace) Returns the implementation that should be applied to the bitmap data. Creates ApocImage instances. Creates a ApocImage from the supplied resource locator. The ApocImageFactory does cache images, therefore this method may return a reference to an existing ApocImage A Uniform Resource Identifier A reference to a ApocImage Total height of content of this area. Creates a new Area instance. @param fontState a FontState value @param allocationWidth the inline-progression dimension of the content rectangle of the Area @param maxHeight the maximum block-progression dimension available for this Area (its allocation rectangle) Set the allocation width. @param w The new allocation width. This sets content width to the same value. Currently only called during layout of Table to set the width to the total width of all the columns. Note that this assumes the column widths are explicitly specified. Tell whether this area contains any children which are not DisplaySpace. This is used in determining whether to honour keeps. Returns content height of the area. @return Content height in millipoints Returns allocation height of this area. The allocation height is the sum of the content height plus border and padding in the vertical direction. @return allocation height in millipoints Return absolute Y position of the current bottom of this area, not counting any bottom padding or border. This is used to set positions for link hotspots. In fact, the position is not really absolute, but is relative to the Ypos of the column-level AreaContainer, even when the area is in a page header or footer! Set "absolute" Y position of the top of this area. In fact, the position is not really absolute, but relative to the Ypos of the column-level AreaContainer, even when the area is in a page header or footer! It is set from the value of getAbsoluteHeight() on the parent area, just before adding this area. Return space remaining in the vertical direction (height). This returns maximum available space - current content height Note: content height should be based on allocation height of content! @return space remaining in base units (millipoints) Set the content height to the passed value if that value is larger than current content height. If the new content height is greater than the maximum available height, set the content height to the max. available (!!!) @param height allocation height of content in millipoints amount of space added since the original layout - needed by links Parses the contents of a JPEG image header to infer the colour space and bits per pixel. JPEG image data Contains number of bitplanes, color space and optional ICC Profile Raw ICC Profile Class constructor. Reads a 16-bit integer from the underlying stream Reads a 32-bit integer from the underlying stream Reads the specified number of bytes from theunderlying stream and converts them to a string using the ASCII encoding. Reads the initial marker which should be SOI. After invoking this method the stream will point to the location immediately after the fiorst marker. Reads the next JPEG marker and returns its marker code. Skips over the parameters for any marker we don't want to process. Parses a <uri-specification> as defined by section 5.11 of the XSL specification. This class may be better expressed as a datatype residing in Telerik.Apoc.DataTypes. This is NOT the content width of the instream-foreign-object. This is the content width for a Box. This is NOT the content height of the instream-foreign-object. This is the content height for a Box. @param ul true if text should be underlined And eatable InlineSpace is discarded if it occurs as the first pending element in a LineArea Store all hyphenation related properties on an FO. Public "structure" allows direct member access. Store all hyphenation related properties on an FO. Public "structure" allows direct member access. object containing information on available fonts, including metrics List of root extension objects Auxillary function for retrieving markers. Auxillary function for retrieving markers. Auxillary function for retrieving markers. Store all hyphenation related properties on an FO. Public "structure" allows direct member access. This class represents a Block Area. A block area is made up of a sequence of Line Areas. This class is used to organise the sequence of line areas as inline areas are added to this block it creates and ands line areas to hold the inline areas. This uses the line-height and line-stacking-strategy to work out how to stack the lines. Add a Line Area to this block area. Used internally to add a completed line area to this block area when either a new line area is created or this block area is completed. @param la the LineArea to add Get the current line area in this block area. This is used to get the current line area for adding inline objects to. This will return null if there is not enough room left in the block area to accomodate the line area. @return the line area to be used to add inlie objects Create a new line area to add inline objects. This should be called after getting the current line area and discovering that the inline object will not fit inside the current line. This method will create a new line area to place the inline object into. This will return null if the new line cannot fit into the block area. @return the new current line area, which will be empty. Notify this block that the area has completed layout. Indicates the the block has been fully laid out, this will add (if any) the current line area. Return the maximum space remaining for this area's content in the block-progression-dimension. Remove top and bottom padding and spacing since these reduce available space for content and they are not yet accounted for in the positioning of the object. Depending on the column-count of the next FO, determine whether a new span area needs to be constructed or not, and return the appropriate ColumnArea. The next cut of this method should also inspect the FO to see whether the area to be returned ought not to be the footnote or before-float reference area. @param fo The next formatting object @returns the next column area (possibly the current one) Add a new span area with specified number of column areas. @param numColumns The number of column areas @returns AreaContainer The next column area This almost does what getNewArea() does, without actually returning an area. These 2 methods can be reworked. @param fo The next formatting object @returns bool True if we need to balance. This is where the balancing algorithm lives, or gets called. Right now it's primitive: get the total content height in all columns, divide by the column count, and add a heuristic safety factor. Then the previous (unbalanced) span area is removed, and a new one added with the computed max height. Determine remaining height for new span area. Needs to be modified for footnote and before-float reference areas when those are supported. @returns int The remaining available height in millipoints. Used by resetSpanArea() and addSpanArea() to adjust the main reference area height before creating a new span. Used in Flow when layout returns incomplete. @returns bool Is this the last column in this span? This variable is unset by getNextArea(), is set by addSpanArea(), and may be set by resetSpanArea(). @returns bool Is the span area new or not? Return a full copy of the BorderAndPadding information. This clones all padding and border information. @return The copy. Creates a key from the given strings Class constructor Defaults the letter spacing to 0 millipoints. Gets width of given character identifier plus in millipoints (1/1000ths of a point). Map a Unicode character to a code point Any Unicode character. Store all hyphenation related properties on an FO. Public "structure" allows direct member access. A font descriptor specifies metrics and other attributes of a font, as distinct from the metrics of individual glyphs. See page 355 of PDF 1.4 specification for more information. Gets a collection of flags providing various font characteristics. Gets the smallest rectangle that will encompass the shape that would result if all glyhs of the font were placed with their origins coincident. Gets the main italic angle of the font expressed in tenths of a degree counterclockwise from the vertical. TODO: The thickness, measured horizontally, of the dominant vertical stems of the glyphs in the font. Gets a value that indicates whether this font has kerning support. Gets a value that indicates whether this font program may be legally embedded within a document. Gets a value that indicates whether this font program my be subsetted. Gets a byte array representing a font program to be embedded in a document. If is false it is acceptable for this method to return null. Gets kerning information for this font. If is false it is acceptable for this method to return null. Interface for font metric classes Gets the width of a character in 1/1000ths of a point size located at the supplied codepoint. For a type 1 font a code point is an octal code obtained from a character encoding scheme (WinAnsiEncoding, MacRomaonEncoding, etc). For example, the code point for the space character is 040 (octal). For a type 0 font a code point represents a GID (Glyph index). A character code point. Specifies the maximum distance characters in this font extend above the base line. This is the typographic ascent for the font. Specifies the maximum distance characters in this font extend below the base line. This is the typographic descent for the font. Gets the vertical coordinate of the top of flat captial letters. Gets the value of the first character used in the font Gets the value of the last character used in the font Gets a reference to a font descriptor. A descriptor is akin to the PDF FontDescriptor object (see page 355 of PDF 1.4 spec). Gets the widths of all characters in 1/1000ths of a point size. adds text to line area @return int character position adds a Leader; actually the method receives the leader properties and creates a leader area or an inline area which is appended to the children of the containing line area. leader pattern use-content is not implemented. adds pending inline areas to the line area normally done, when the line area is filled and added as child to the parent block area aligns line area Balance (vertically) the inline areas within this line. sets hyphenation related traits: language, country, hyphenate, hyphenation-character and minimum number of character to remain one the previous line and to be on the next line. creates a leader as String out of the given char and the leader length and wraps it in an InlineArea which is returned calculates the width of space which has to be inserted before the start of the leader, so that all leader characters are aligned. is used if property leader-align is set. At the moment only the value for leader-align="reference-area" is supported. calculates the used space in this line area extracts a complete word from the character data Calculates the wordWidth using the actual fontstate adds a single character to the line area tree Same as addWord except that characters in wordBuf is mapped to the current fontstate's encoding adds a InlineArea containing the String startChar+wordBuf to the line area children. Checks if it's legal to break a word in the middle based on the current language property. @return true if legal to break word in the middle Helper method for getting the width of a unicode char from the current fontstate. This also performs some guessing on widths on various versions of space that might not exists in the font. Helper method to determine if the character is a space with normal behaviour. Normal behaviour means that it's not non-breaking Method to determine if the character is a nonbreaking space. @return true if the character represents any kind of space Add a word that might contain non-breaking spaces. Split the word into WordArea and InlineSpace and add it. If addToPending is true, add to pending areas. an object that stores a rectangle that is linked, and the LineArea that it is logically associated with @author Arved Sandstrom @author James Tauber the linked Rectangle the associated LineArea the associated InlineArea a set of rectangles on a page that are linked to a common destination the destination of the links the set of rectangles Store all hyphenation related properties on an FO. Public "structure" allows direct member access. Store all hyphenation related properties on an FO. Public "structure" allows direct member access. Ensure that page is set not only on B.A.C. but also on the three top-level reference areas. @param area The region-body area container (special) Store all hyphenation related properties on an FO. Public "structure" allows direct member access. This class holds information about text-decoration @return true if text should be underlined set text as underlined @return true if text should be overlined Class that represents the Control Value Program table ('prep'). Class derived by all TrueType table classes. The dictionary entry for this table. Class constructor The table name. Table directory entry. Reads the contents of a table from the current position in the supplied stream. If the supplied stream does not contain enough data. Writes the contents of a table to the supplied writer. This method should not be concerned with aligning the table output on the 4-byte boundary. Gets or sets a directory entry for this table. Gets the unique name of this table as a 4-character string. Note that some TrueType tables are only 3 characters long (e.g. 'cvt'). In this case the returned string will be padded with a extra space at the end of the string. Gets the table name encoded as a 32-bit unsigned integer. Set of instructions executed whenever point size or font or transformation change. Creates an instance of the class. Reads the contents of the "prep" table from the current position in the supplied stream. Writes out the array of instructions to the supplied stream. Class that represents the Control Value table ('cvt'). List of N values referenceable by instructions. Creates an instance of the class. Reads the contents of the "cvt" table from the current position in the supplied stream. Writes out the array of values to the supplied stream. Gets the value representing the number of values that can be referenced by instructions. Class that represents the Font Program table ('fpgm'). List of N instructions. Creates an instance of the class. Reads the contents of the "fpgm" table from the current position in the supplied stream. Writes out the array of instructions to the supplied stream. Gets the value representing the number of instructions in the font program. Instantiates a font table from a table tag. Prevent instantiation since this is a factory class. Creates an instance of a class that implements the FontTable interface. One of the pre-defined TrueType tables from the class. A subclass of that is capable of parsing a TrueType table. If a class capable of parsing tableName is not available. Class that represents the Glyf Data table ('glyf'). http://www.microsoft.com/typography/otspec/glyf.htm Maps a glyph index to a object. Creates an instance of the class. Reads the contents of the "glyf" table from the current position in the supplied stream. Writes the contents of the glyf table to the supplied stream. Gets the instance located at glyphIndex Gets the number of glyphs. Represents either a simple or composite glyph description from the 'glyf' table. This class is nothing more than a wrapper around a byte array. The index of this glyph as obtained from the 'loca' table. Contains glyph description as raw data. List of composite glyph indices. Class constructor. Sets the glyph data (duh!). Add the supplied glyph index to list of children. Writes a glyph description to the supplied stream. Gets or sets the index of this glyph. Gets the length of the glyph data buffer. Gets a ilst of child glyph indices. Gets a value indicating whether or not this glyph represents a composite glyph. Class that represents the Font Header table. http://www.microsoft.com/typography/otspec/head.htm Class constructor. Reads the contents of the "head" table from the current position in the supplied stream. Returns a DateTime instance which is the result of adding seconds to BaseDate. If an exception occurs, BaseDate is returned. Writes the contents of the head table to the supplied stream. Gets a value that indicates whether glyph offsets in the loca table are stored as a int or ulong. Class that represents the Horizontal Header table. http://www.microsoft.com/typography/otspec/hhea.htm Table version number 0x00010000 for version 1.0. Typographic ascent. (Distance from baseline of highest ascender). Typographic descent. (Distance from baseline of lowest descender). Typographic line gap. Negative LineGap values are treated as zero in Windows 3.1, System 6, and System 7. Maximum advance width value in 'hmtx' table. Minimum left sidebearing value in 'hmtx' table. Minimum right sidebearing value. Max(lsb + (xMax - xMin)). Used to calculate the slope of the cursor (rise/run); 1 for vertical. 0 for vertical. The amount by which a slanted highlight on a glyph needs to be shifted to produce the best appearance. Set to 0 for non-slanted fonts. 0 for current format. Number of hMetric entries in 'hmtx' table. Class constructor. Reads the contents of the "hhea" table from the current position in the supplied stream. Gets the number of horiztonal metrics. Summary description for HorizontalMetric. Class that represents the Horizontal Metrics ('hmtx') table. http://www.microsoft.com/typography/otspec/hmtx.htm Initialises a new instance of the class. Initialises a new instance of the HorizontalMetricsTable class. Reads the contents of the "hmtx" table from the supplied stream at the current position. Returns the number of horizontal metrics stored in the hmtx table. Gets the located at index. Class that represents the Index To Location ('loca') table. http://www.microsoft.com/typography/otspec/loca.htm Initialises a new instance of the class. Initialises a new instance of the IndexToLocationTable class. Reads the contents of the "loca" table from the supplied stream at the current position. Removes all offsets. Includes the supplied offset. Gets the number of glyph offsets. Gets or sets the glyph offset at index index. A glyph index. Class that represents the Kerning table. http://www.microsoft.com/typography/otspec/kern.htm Class constructor. Reads the contents of the "kern" table from the current position in the supplied stream. No supported. Gets a boolean value that indicates this font contains format 0 kerning information. Returns a collection of kerning pairs. If HasKerningInfo returns false, this method will always return null. Class that represents the Horizontal Metrics ('maxp') table. http://www.microsoft.com/typography/otspec/maxp.htm Table version number The number of glyphs in the font. Maximum points in a non-composite glyph. Maximum contours in a non-composite glyph. Only set if versionNo is 1.0. Maximum points in a composite glyph. Only set if versionNo is 1.0. Maximum contours in a composite glyph. Only set if versionNo is 1.0. 1 if instructions do not use the twilight zone (Z0), or 2 if instructions do use Z0; should be set to 2 in most cases. Only set if versionNo is 1.0. Maximum points used in Z0. Only set if versionNo is 1.0. Number of Storage Area locations. Only set if versionNo is 1.0. Number of FDEFs. Only set if versionNo is 1.0. Number of IDEFs. Only set if versionNo is 1.0. Maximum stack depth2. Only set if versionNo is 1.0. Maximum byte count for glyph instructions. Only set if versionNo is 1.0. Maximum number of components referenced at "top level" for any composite glyph. Only set if versionNo is 1.0. Maximum levels of recursion; 1 for simple components. Only set if versionNo is 1.0. Initialises a new instance of the class. Reads the contents of the "maxp" table from the supplied stream at the current position. Gets the number of glyphs Class that represents the Naming ('name') table http://www.microsoft.com/typography/otspec/name.htm Offset to start of string storage (from start of table). Reads the contents of the "name" table from the supplied stream at the current position. Reads a string from the storage area beginning at offset consisting of length bytes. The returned string will be converted using the Unicode encoding. Big-endian font stream. The offset in bytes from the beginning of the string storage area. The length of the string in bytes. Not supported. Get the font family name. Gets the font full name composed of the family name and the subfamily name. Class that represents the OS/2 ('OS/2') table

For detailed information on the OS/2 table, visit the following link: http://www.microsoft.com/typography/otspec/os2.htm

For more details on the Panose classification metrics, visit the following URL: http://www.panose.com/hardware/pan2.asp

 Reads the contents of the "os/2" table from the supplied stream at the current position. Gets a boolean value that indicates whether this font contains italic characters. Gets a boolean value that indicates whether characters are in the standard weight/style. Gets a boolean value that indicates whether characters possess a weight greater than or equal to 700. Gets a boolean value that indicates whether this font contains characters that all have the same width. Gets a boolean value that indicates whether this font contains special characters such as dingbats, icons, etc. Gets a boolean value that indicates whether characters do possess serifs Gets a boolean value that indicates whether characters are designed to simulate hand writing. Gets a boolean value that indicates whether characters do not possess serifs Gets a boolean value that indicates whether this font may be legally embedded. Gets a boolean value that indicates whether this font may be subsetted. Class that represents the PostScript ('post') table http://www.microsoft.com/typography/otspec/post.htm 0x00010000 for version 1.0 0x00020000 for version 2.0 0x00025000 for version 2.5 (deprecated) 0x00030000 for version 3.0 Italic angle in counter-clockwise degrees from the vertical. Zero for upright text, negative for text that leans to the right (forward). This is the suggested distance of the top of the underline from the baseline (negative values indicate below baseline). Suggested values for the underline thickness. Set to 0 if the font is proportionally spaced, non-zero if the font is not proportionally spaced (i.e. monospaced). Minimum memory usage when an OpenType font is downloaded. Maximum memory usage when an OpenType font is downloaded. Minimum memory usage when an OpenType font is downloaded as a Type 1 font. Maximum memory usage when an OpenType font is downloaded as a Type 1 font. Class constructor. Reads the contents of the "post" table from the supplied stream at the current position. Gets a boolean value that indicates whether this font is proportionally spaced (fixed pitch) or not. Class that represents the Offset and Directory tables. http://www.microsoft.com/typography/otspec/otff.htm Gets a value indicating whether or not this font contains the supplied table. A table name. Gets a DirectoryEntry object for the supplied table. A 4-character code identifying a table. A DirectoryEntry object or null if the table cannot be located. If tableName does not represent a table in this font. Gets the number tables. Represents an entry in the directory table Gets an instance of an implementation that is capable of parsing the table identified by tab. Returns the table tag as a string Gets the table tag encoded as an unsigned 32-bite integer. Gets or sets a value that represents a offset, i.e. the number of bytes from the beginning of the file. Gets or sets a value representing the number number of bytes a object occupies in a stream. Gets or sets value that represents a checksum of a . Class designed to parse a TrueType font file. A Big Endian stream. Used to identity a font within a TrueType collection. Maps a table name (4-character string) to a A dictionary of cached instances. The index is the table name. Maps a glyph index to a subset index. Class constructor. Font data stream. Class constructor. Font data stream. Name of a font in a TrueType collection. Gets a value indicating whether or not this font contains the supplied table. A table name. Gets a reference to the table structure identified by tableName Only the following tables are supported: - Font header, - Horizontal header, - Horizontal metrics, - Maximum profile, - Index to location, - Glyf data, - Control value, - Control value program, - Font program A 4-character code identifying a table. If tableName does not represent a table in this font. Gets a object for the supplied table. A 4-character code identifying a table. A object or null if the table cannot be located. If tag does not represent a table in this font. Reads the Offset and Directory tables. If the FontFileStream represents a TrueType collection, this method will look for the aforementioned tables belonging to fontName. This method can handle a TrueType collection. Caches the following tables: 'head', 'hhea', 'maxp', 'loca' Sets the stream position to the offset in the supplied directory entry. Also ensures that the FontFileStream has enough bytes available to read a font table. Throws an exception if this condition is not met. If the supplied stream does not contain enough data. Gets or sets a dictionary containing glyph index to subset index mappings. Gets the underlying . Gets the number tables. Class designed to read and write primitive datatypes from/to a TrueType font file.

All OpenType fonts use Motorola-style byte ordering (Big Endian).

The following table lists the primitives and their definition. Note the difference between the .NET CLR definition of certain types and the TrueType definition.

BYTE 8-bit unsigned integer. CHAR 8-bit signed integer. USHORT 16-bit unsigned integer. SHORT 16-bit signed integer. ULONG 32-bit unsigned integer. LONG 32-bit signed integer. Fixed 32-bit signed fixed-point number (16.16) FWORD 16-bit signed integer (SHORT) that describes a quantity in FUnits. UFWORD 16-bit unsigned integer (USHORT) that describes a quantity in FUnits. F2DOT14 16-bit signed fixed number with the low 14 bits of fraction (2.14). LONGDATETIME Date represented in number of seconds since 12:00 midnight, January 1, 1904. The value is represented as a signed 64-bit integer. Tag Array of four uint8s (length = 32 bits) used to identify a script, language system, feature, or baseline GlyphID Glyph index number, same as uint16(length = 16 bits) Offset Offset to a table, same as uint16 (length = 16 bits), NULL offset = 0x0000

Initialises a new instance of the class using the supplied byte array as the underlying buffer. The font data encoded in a byte array. data is a null reference. data is a zero-length array. Initialises a new instance of the class using the supplied stream as the underlying buffer. Reference to an existing stream. stream is a null reference. Reads an unsigned byte from the font file. Writes an unsigned byte from the font file. Reads an signed byte from the font file. Writes a signed byte from the font file. Reads a short (16-bit signed integer) from the font file. Writes a short (16-bit signed integer) to the font file. Reads a short (16-bit signed integer) from the font file. Writes a short (16-bit signed integer) to the font file. Reads a int (16-bit unsigned integer) from the font file. Writes a int (16-bit unsigned integer) to the font file. Reads a int (16-bit unsigned integer) from the font file. Writes a int (16-bit unsigned integer) to the font file. Reads an int (32-bit signed integer) from the font file. Writes an int (32-bit signed integer) to the font file. Reads a int (32-bit unsigned integer) from the font file. Writes a int (32-bit unsigned integer) to the font file. Reads an int (32-bit signed integer) from the font file. Writes an int (32-bit unsigned integer) to the font file. Reads a long (64-bit signed integer) from the font file. Writes a long (64-bit signed integer) to the font file. Reads a tag (array of four bytes) from the font stream. Writes a tab (array of four bytes) to the font file. Ensures the stream is padded on a 4-byte boundary. This method will output between 0 and 3 bytes to the stream. A value between 0 and 3 (inclusive). Writes a sequence of bytes to the underlying stream. Reads a block of bytes from the current stream and writes the data to buffer. A byte buffer big enough to store count bytes. The byte offset in buffer to begin reading. Number of bytes to read. Offsets the stream position by the supplied number of bytes. Saves the current stream position onto a marker stack. Returns the current stream position. Sets the stream using the marker at the head of the marker stack. Returns the stream position before it was reset. If the markers stack is empty. Gets or sets the current position of the font stream. Gets the length of the font stream in bytes. A specialised stream writer for creating OpenType fonts. Size of the offset table in bytes. The underlying stream. List of font tables to write. Creates a new instance of the class using stream as the underlying stream object. If stream is not writable. If streamm is a null reference. Queues the supplied for writing to the underlying stream. The method will not immediately write the supplied font table to the underlying stream. Instead it queues the font table since the offset table must be written out before any tables. Writes the header and font tables to the underlying stream. Updates the checkSumAdjustment field in the head table. Writes out each table to the font stream. Writes the offset table that appears at the beginning of every TrueType/OpenType font. Does not actually write the table directory - simply "allocates" space for it in the stream. Returns the maximum power of 2 <= max Calculates the checksum of the entire font. The underlying must be aligned on a 4-byte boundary. Calculates the checksum of a . The supplied stream must be positioned at the beginning of the table. Gets the underlying . Generates a subset from a TrueType font. Creates a new instance of the FontSubset class. TrueType font parser. Writes the font subset to the supplied output stream. Reads a glyph description from the specified offset. Populate the compositesIList containing all child glyphs that this glyph uses. The stream parameter must be positioned 10 bytes from the beginning of the glyph description, i.e. the flags field. Gets the length of the glyph description in bytes at index index. Bit masks of the flags field in a composite glyph. Utility class that stores a list of glyph indices and their asociated subset indices. Maps a glyph index to a subset index. Maps a subset index to glyph index. Class constructor. Determines whether a mapping exists for the supplied glyph index. Returns the subset index for glyphIndex. If a subset index does not exist for glyphIndex one is generated. A subset index. Adds the list of supplied glyph indices to the index mappings using the next available subset index for each glyph index. Gets the subset index of glyphIndex. A glyph index or -1 if a glyph to subset mapping does not exist. Gets the glyph index of subsetIndex. A subset index or -1 if a subset to glyph mapping does not exist. Gets the number of glyph to subset index mappings. Gets a list of glyph indices sorted in ascending order. Gets a list of subset indices sorted in ascending order. Key - Kerning pair identifier Value - Kerning amount Creates an instance of KerningPairs allocating space for 100 kerning pairs. Creates an instance of KerningPairs allocating space for numPairs kerning pairs. Returns true if a kerning value exists for the supplied glyph index pair. Glyph index for left-hand glyph. Glyph index for right-hand glyph. Creates a new kerning pair. This method will ignore duplicates. The glyph index for the left-hand glyph in the kerning pair. The glyph index for the right-hand glyph in the kerning pair. The kerning value for the supplied pair. Returns a kerning pair identifier. Gets the kerning amount for the supplied glyph index pair. Gets the number of kernings pairs. A helper designed that provides the size of each TrueType primitives. List of all TrueType and OpenType tables Converts one of the predefined table names to an unsigned integer. The ABC structure contains the width of a character in a TrueType font. TODO: Figure out why CreateFontIndirect fails when this class is converted to a struct. The OUTLINETEXTMETRIC structure contains metrics describing a TrueType font. The PANOSE structure describes the PANOSE font-classification values for a TrueType font. These characteristics are then used to associate the font with other fonts of similar appearance but different names. The Point structure defines the x- and y- coordinates of a point. The Rect structure defines the coordinates of the upper-left and lower-right corners of a rectangle The TEXTMETRIC structure contains basic information about a physical font. All sizes are specified in logical units; that is, they depend on the current mapping mode of the display context. A very lightweight wrapper around a Win32 device context Pointer to device context created by ::CreateDC() Creates a new device context that matches the desktop display surface Invokes . Delete the device context freeing the associated memory. Selects a font into a device context (DC). The new object replaces the previous object of the same type. Handle to object. A handle to the object being replaced. Gets a handle to an object of the specified type that has been selected into this device context. Returns a handle to the underlying device context A thin wrapper around a handle to a font Class constructor A handle to an existing font. Class destructor Creates a font based on the supplied typeface name and size. The typeface name of a font. The height, in logical units, of the font's character cell or character. Creates a font whose height is equal to the negative value of the EM Square The typeface name of a font. Retrieves all pertinent TrueType tables by invoking GetFontData. Summary description for GdiFontEnumerator. Class constructor. A non-null reference to a wrapper around a GDI device context. Returns a list of font styles associated with familyName. Returns a list of font family names sorted in ascending order. Class that obtains OutlineTextMetrics for a TrueType font Gets font metric data for a TrueType font or TrueType collection. Retrieves the widths, in PDF units, of consecutive glyphs. An array of integers whose size is equal to the number of glyphs specified in the 'maxp' table. The width at location 0 is the width of glyph with index 0, The width at location 1 is the width of glyph with index 1, etc... Returns the width, in PDF units, of consecutive glyphs for the WinAnsiEncoding only. An array consisting of 256 elements. Translates the supplied character to a glyph index using the currently selected font. A unicode character. Retrieves the typeface name of the font that is selected into the device context supplied to the GdiFontMetrics constructor. Specifies the number of logical units defining the x- or y-dimension of the em square for this font. The common value for EmSquare is 2048. The number of units in the x- and y-directions are always the same for an em square.) Gets the main italic angle of the font expressed in tenths of a degree counterclockwise from the vertical. Regular (roman) fonts have a value of zero. Italic fonts typically have a negative italic angle (that is, they lean to the right). Specifies the maximum distance characters in this font extend above the base line. This is the typographic ascent for the font. Specifies the maximum distance characters in this font extend below the base line. This is the typographic descent for the font. Gets the distance between the baseline and the approximate height of uppercase letters. Gets the distance between the baseline and the approximate height of non-ascending lowercase letters. TODO: The thickness, measured horizontally, of the dominant vertical stems of the glyphs in the font. Gets the value of the first character defined in the font Gets the value of the last character defined in the font Gets the average width of glyphs in a font. Gets the maximum width of glyphs in a font. Gets a value indicating whether the font can be legally embedded within a document. Gets a value indicating whether the font can be legally subsetted. Gets the font's bounding box. This is the smallest rectangle enclosing the shape that would result if all the glyphs of the font were placed with their origins cooincident and then filled. Gets a collection of flags defining various characteristics of a font (e.g. serif or sans-serif, symbolic, etc). Gets a collection of kerning pairs. Gets a collection of kerning pairs for characters defined in the WinAnsiEncoding scheme only. Class constructor. Kerning pairs read from the TrueType font file. Class to convert from TTF to PDF units. Returns true if a kerning value exists for the supplied character index pair. Gets the number of kerning pairs. Gets the kerning amount for the supplied index pair or 0 if a kerning pair does not exist. Installs a collection of private fonts on the system and uninstalls them when disposed. Specifies that only the process that called the AddFontResourceEx function can use this font. Specifies that no process, including the process that called the AddFontResourceEx function, can enumerate this font. Collection of absolute filenames. Adds filename to this private font collection. Absolute path to a TrueType font or collection. If filename is null. If filename is the empty string. Adds fontFile to this private font collection. Absolute path to a TrueType font or collection. If fontFile does not exist. If fontFile has already been added. If fontFile cannot be added to the system font collection. Custom collection that maintains a list of Unicode ranges a font supports and the glyph indices of each character. The list of ranges is obtained by invoking GetFontUnicodeRanges, however the associated glyph indices are lazily instantiated as required to save memory. List of unicode ranges in ascending numerical order. The order is important since a binary search is used to locate and uicode range from a charcater. Class constuctor. Loads all the unicode ranges. Locates the for the supplied character. The object housing c or null if a range does not exist for c. Translates the supplied character to a glyph index. Any unicode character. A glyph index for c or 0 the supplied character does not exist in the font selected into the device context. Gets the number of unicode ranges. Converts from logical TTF units to PDF units. Class constructor. Specifies the number of logical units defining the x- or y-dimension of the em square of a font. Convert the supplied integer from TrueType units to PDF units based on the EmSquare If the value of emSquare is zero, this method will always return value. Class that represents a unicode character range as returned by the GetFontUnicodeRanges function. Array of glyph indices for each character represented by this range begining at . Class constructor. Value representing start of unicode range. Value representing end of unicode range. Returns the glyph index of c. Populates the indices array with the glyph index of each character represented by this rnage starting at . Gets a value representing the start of the unicode range. Gets a value representing the end of the unicode range. Summary description for UnicodeRangeComparer. Maps a Unicode character to a WinAnsi codepoint value. First column is codepoint value. Second column is unicode value. ARC4 is a fast, simple stream encryption algorithm that is compatible with RSA Security's RC4 algorithm. Initialises internal state from the passed key. Can be called again with a new key to reuse an Arc4 instance. The encryption key. Encrypts or decrypts the passed byte array. The data to be encrypted or decrypted. The location that the encrypted or decrypted data is to be placed. The passed array should be at least the same size as dataIn. It is permissible for the same array to be passed for both dataIn and dataOut. Generates a pseudorandom byte used to encrypt or decrypt. Implements Adobe's standard security handler. A security handler is a software module that implements various aspects of the encryption process. Constructs a new standard security manager. The user supplied PDF options that provides access to the passwords and the access permissions. The PDF document's file identifier (see section 8.3 of PDF specification). Computes the master key that is used to encrypt string and stream data in the PDF document. The user supplied PDF options that provides access to the passwords and the access permissions. The PDF document's file identifier (see section 8.3 of PDF specification). Computes the O(owner) value in the encryption dictionary. Corresponds to algorithm 3.3 on page 69 of the PDF specficiation. The user supplied PDF options that provides access to the passwords. Computes the U(user) value in the encryption dictionary. Corresponds to algorithm 3.4 on page 70 of the PDF specficiation. The user supplied PDF options that provides access to the passwords. Encrypts the passed byte array using the ARC4 cipher. Computes an encryption key that is used to encrypt string and stream data in the PDF document. Corresponds to algorithm 3.1 in section 3.5 of the PDF specficiation. Computes an encryption key that is used to encrypt string and stream data in the PDF document. Corresponds to algorithm 3.2 in section 3.5 of the PDF specficiation. Pads or truncates a password string to exactly 32-bytes. Corresponds to step 1 of algorithm 3.2 on page 69 of the PDF 1.3 specficiation. The password to pad or truncate. A byte array of length 32 bytes containing the padded or truncated password. Determines if the passed password matches the user password used to initialise this security manager. Used for testing purposes only. Corresponds to algorithm 3.5 in the PDF 1.3 specification. True if the password is correct. Performs the actual checking of the user password. Checks the owner password. Compares two byte arrays and returns true if they are equal. Access to the raw user entry byte array. Required for testing purposes; Access to the raw owner entry byte array. Required for testing purposes; Password that disables all security permissions The user password Collection of flags describing permissions granted to user who opens a file with the user password. The given initial value zero's out first two bits. The PDF specification dictates that these entries must be 0. Enables or disables printing. If true enables printing otherwise false Enable or disable changing the document other than by adding or changing text notes and AcroForm fields. Enable or disable copying of text and graphics from the document. Enable or disable adding and changing text notes and AcroForm fields. Returns the owner password as a string. The default value is null Returns the user password as a string. The default value is null The document access privileges encoded in a 32-bit unsigned integer The default access priviliges are:
  • Printing disallowed
  • Modifications disallowed
  • Copy and Paste disallowed
  • Addition or modification of annotation/form fields disallowed
To override any of these priviliges see the , , , methods A collection of instances. Adds the supplied to the end of the collection. Returns an ArrayList enumerator that references a read-only version of the BfEntry list. Gets the at index. Gets the number of objects contained by this Returns the number of instances that represent bfrange's Returns the number of instances that represent bfchar's A class can represent either a bfrange or bfchar. Class cosntructor. Increments the end index by one. Incrementing the end index turns this BfEntry into a bfrange. Returns true if this BfEntry represents a glyph range, i.e. the start index is not equal to the end index. Returns true if this BfEntry represents a bfchar entry, i.e. the start index is equal to the end index. A File Identifier is described in section 8.3 of the PDF specification. The first string is a permanent identifier based on the contents of the file at the time it was originally created, and does not change as the file is incrementally updated. The second string is a changing identifier based on the file's contents the last time it was updated. If this class were being use to update a PDF's file identifier, we'd need to add a method to parse an existing file identifier. Initialises the CreatedPart and ModifiedPart to a randomly generated GUID. Initialises the CreatedPart and ModifiedPart to the passed string. Returns the CreatedPart as a byte array. Returns the ModifiedPart as a byte array. Thrown during creation of PDF font object if the font's license is violated, e.g. attempting to subset a font that does not permit subsetting. The root of a document's object hierarchy is the catalog dictionary. The document catalog is described in section 3.6.1 of the PDF specification. A dictionary that contains information about a CIDFont program. A Type 0 CIDFont contains glyph descriptions based on Adobe's Type 1 font format, whereas those in a Type 2 CIDFont are based on the TrueType font format. A dictionary containing entries that define the character collection of the CIDFont. Class that defines a mapping between character codes (CIDs) to a character selector (Identity-H encoding) TODO: This method is temporary. I'm assuming that all string should be represented as a PdfString object? Adds the supplied glyph -> unicode pairs. Both the key and value must be a int. Adds the supplied glyph index to unicode value mapping. Overriden to create CMap content stream. Writes the bfchar entries to the content stream in groups of 100. Writes the bfrange entries to the content stream in groups of 100. Was originally called PdfDocument, but this name is now in use by the Telerik.Pdf library. Eventually all code in this class should either be moved to either the Telerik.Pdf library, or to the PdfRenderer. Get the root Outlines object. This method does not write the outline to the Pdf document, it simply creates a reference for later. Make an outline object and add it to the given outline @param parent parent PdfOutline object @param label the title for the new outline object @param action the PdfAction to reference get the /Resources object for the document @return the /Resources object PDF defines a standard date format. The PDF date format closely follows the format defined by the international standard ASN.1. The format of the PDF date is defined in section 3.8.2 of the PDF specification. A class that enables a well structured PDF document to be generated. Responsible for allocating object identifiers. Class representing a file trailer. File trailers are described in section 3.4.4 of the PDF specification. Returns the internal name used for this font. Creates all the necessary PDF objects required to represent a font object in a PDF document. Generates object id's. Returns a subclass of the PdfFont class that may be one of PdfType0Font, PdfType1Font or PdfTrueTypeFont. The type of subclass returned is determined by the type of the font parameter. The PDF font identifier, e.g. F15 Underlying font object. Creates a character indexed font from cidFont The font and cidFont will be different object references since the font parameter will most likely be a . The Pdf font identifier, e.g. F15 Required to access the font descriptor. The underlying CID font. Returns the next available Pdf object identifier. Creates an instance of the class The Pdf font identifier, e.g. F15 Creates an instance of the class that defaults the font encoding to WinAnsiEncoding. A ProxyFont must first be resolved before getting the IFontMetircs implementation of the underlying font. An enumeration listing all the fonts types available in Pdf. An enumeration listing all the font subtypes An International Color Code stream Represents a Identity-H character encoding Maps 2-byte character codes ranging from 0 to 65,535 to the same 2-byte CID value, interpreted high-order byte first Do not call this method directly Do not call this method directly Class representing a document information dictionary. Document information dictionaries are described in section 9.2.1 of the PDF specification. Well-known PDF name objects. This represents a single Outline object in a PDF, including the root Outlines object. Outlines provide the bookmark bar, usually rendered to the right of a PDF document in user agents such as Acrobat Reader List of sub-entries (outline objects) Parent outline object. Root Outlines parent is null Title to display for the bookmark entry Class constructor. The object id number The title of the outline entry (can only be null for root Outlines obj) The page which this outline refers to. Add a sub element to this outline The pages of a document are accessed through a structure known as the page tree. The page tree is described in section 3.6.2 of the PDF specification. Returns this PdfString expressed using the 'literal' convention. A literal string is written as an arbitrary number of characters enclosed in parentheses. Any characters may appear in a string except unbalanced parentheses and the backslash, which must be treated specially. Balanced pairs of parentheses within a string require no special treatment. Used by ToPdfHexadecimal. Returns the PdfString expressed using the 'hexadecimal' convention. Strings may also be written in hexadecimal form; this is useful for including arbitrary binary data in a PDF file. A hexadecimal string is written as a sequence of hexadecimal digits (0–9 and either A–F or a–f) enclosed within angle brackets (< and >). The convention used when outputing the string to the PDF document. Defaults to format. Determines if the string should bypass encryption, even when available. Some PDF strings need to appear unencrypted in a secure PDF document. Most noteably those in the encryption dictionary itself. This property allows those strings to be flagged. The PDF specification describes two conventions that can be used to embed a string in a PDF document. This enumeration, along with the property can be used to select how a string will be formatted in the PDF file. A unique object number. The name by which the font is reference in the Font subdictionary The PostScript name of the font. Sets a value representing the character encoding. Sets the font descriptor. Sets the first character code defined in the font's widths array The default value is 0. Sets the last character code defined in the font's widths array The default value is 255. Sets the array of character widths. A Type 0 font is a composite font whose glyphs are obtained from a font like object called a CIDFont (a descendant font). All versions of the PDF specification up to and including version 1.4 only support a single descendant font. Sets the stream containing a CMap that maps character codes to unicode values. Sets the descendant font. Sets a value representing the character encoding. Sets a value representing the character encoding. Array class used to represent the /W entry in the CIDFont dictionary. A single section in a PDF file's cross-reference table. The cross-reference table is described in section 3.4.3 of the PDF specification. Right now we only support a single subsection. Adds an entry to the section. Writes the cross reference section to the passed PDF writer. A sub-section in a PDF file's cross-reference table. The cross-reference table is described in section 3.4.3 of the PDF specification. This entries contained in this subsection. Creates a new blank sub-section, that initially contains no entries. Adds an entry to the sub-section. Writes the cross reference sub-section to the passed PDF writer. Structure representing a single cross-reference entry. The object number and generation number. The number of bytes from the beginning of the file to the beginning of the object. Implementation of IComparable. A PDF file's cross-reference table. The cross-reference table is described in section 3.4.3 of the PDF specification. Right now we only support a single section. Adds an entry to the table. Writes the cross reference table to the passed PDF writer. Base class for the standard 14 fonts as defined in the PDF spec. Base class for PDF font classes Maps a Unicode character to a character index. A Unicode character. See Get the encoding of the font. A font encoding defines a mapping between a character code and a code point. Gets the base font name. Gets the type of font, e.g. Type 0, Type 1, etc. Gets the font subtype. Gets a reference to a FontDescriptor Gets a boolean value indicating whether this font supports multi-byte characters See See See See See See Class constructor. Will always return null since the standard 14 fonts do not have a FontDescriptor. It is possible to override the default metrics, but the current version of Apoc does not support this feature. Base class for a CID (Character Indexed) font. There are two types of CIDFont: Type 0 and Type 2. A Type 0 CIDFont contains glyph description based on Adobe Type 1 font format; a Type 2 CIDFont contains glyph descriptions based on the TrueType font format. See page 338 of the Adode PDF 1.4 specification for futher details. Gets the PostScript name of the font. Gets a dictionary mapping character codes to unicode values Returns . Gets a string identifying the issuer of the character collections. The default implementation returns . Gets a string that uniquely names the character collection. The default implementation returns . Gets the supplement number of the character collection. The default implementation returns . Gets the default width for all glyphs. The default implementation returns Represents a collection of font descriptor flags specifying various characterisitics of a font. The following lists the bit positions and associated flags: 1 - FixedPitch 2 - Serif 3 - Symbolic 4 - Script 6 - Nonsymbolic 7 - Italic 17 - AllCap 18 - SmallCap 19 - ForceBold Default class constructor. Class constructor. Initialises the flags BitVector with the supplied integer. Gets the font descriptor flags as a 32-bit signed integer. Handy enumeration used to reference individual bit positions in the BitVector32. Collection of font properties such as face name and whether the a font is bold and/or italic. Class constructor. Regular : bold=false, italic=false Bold : bold=true, italic=false Italic : bold=false, italic=true BoldItalic : bold=true, italic=true Font face name, e.g. Arial. Bold flag. Italic flag. A proxy object that delegates all operations to a concrete subclass of the Font class. Flag that indicates whether the underlying font has been loaded. Font details such as face name, bold and italic flags The font that does all the work. Determines what type of "real" font to instantiate. Class constructor. Loads the underlying font. Gets the underlying font. Represents a TrueType font program. Wrapper around a Win32 HDC. Provides font metrics using the Win32 Api. List of kerning pairs. Maps a glyph index to a PDF width Class constructor Creates a object from baseFontName See A WinAnsi codepoint. Returns . A Type 2 CIDFont is a font whose glyph descriptions are based on the TrueType font format. TODO: Support font subsetting Wrapper around a Win32 HDC. Provides font metrics using the Win32 Api. List of kerning pairs. Maps a glyph index to a PDF width Windows font name, e.g. 'Arial Bold' Maps a glyph index to a character code. Maps character code to glyph index. The array is based on the value of . Class constructor. Creates a object from baseFontName Class destructor. Returns . A subclass of Type2CIDFont that generates a subset of a TrueType font. Maps a glyph index to a subset index. Quasi-unique six character name prefix. Class constructor. Creates the index mappings list and adds the .notedef glyphs Sets up the PDF fonts. Assigns the font (with metrics) to internal names like "F1" and assigns family-style-weight triplets to the fonts. First 16 indices are used by base 14 and generic fonts Handles mapping font triplets to a IFontMetric implementor Adds all the system fonts to the FontInfo object. Adds metrics for basic fonts and useful family-style-weight triplets for lookup. Determines what type of font to instantiate. Returns true is familyName represents one of the base 14 fonts; otherwise false. Gets the next available font name. A font name is defined as an integer prefixed by the letter 'F'. Add the fonts in the font info to the PDF document. Object that creates PdfFont objects. Resources object to add fonts too. Enumeration that dictates how Apoc should treat fonts when producing a PDF document.

Each of the three alernatives has particular advantages and disadvantages, which will be explained here.

The member specifies that all fonts should be linked. This option will produce the smallest PDF document because the font program required to render individual glyphs is not embedded in the PDF document. However, this option does possess two distinct disadvantages:

  1. Only characters in the WinAnsi character encoding are supported (i.e. Latin)
  2. The PDF document will not render correctly if the linked font is not installed.
///

The option will copy the contents of the entire font program into the PDF document. This will guarantee correct rendering of the document on any system, however certain fonts - especially CJK fonts - are extremely large. The MS Gothic TrueType collection, for example, is 8MB. Embedding this font file would produce a ridicuously large PDF.

Finally, the option will only copy the required glyphs required to render a PDF document. This option will ensure that a PDF document is rendered correctly on any system, but does incur a slight processing overhead to subset the font.

 Fonts are linked. The entire font program is embedded. The font program is subsetted and embedded. The current vertical position in millipoints from bottom. The current horizontal position in millipoints from left. The horizontal position of the current area container. The PDF Document being created. The /Resources object of the PDF document being created. The current stream to add PDF commands to. The current annotation list to add annotations to. The current page to add annotations to. True if a TJ command is left to be written. The previous Y coordinate of the last word written. Used to decide if we can draw the next word on the same line. The previous X coordinate of the last word written. Used to calculate how much space between two words. The width of the previous word. Used to calculate space between. Reusable word area string buffer to reduce memory usage. TODO: remove use of this. User specified rendering options. The current (internal) font name. The current font size in millipoints. The current color/gradient to fill shapes with. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Previous values used for text-decoration drawing. Provides triplet to font resolution. Handles adding base 14 and all system fonts. The IDReferences for this document. Create the PDF renderer. add a line to the current stream @param x1 the start x location in millipoints @param y1 the start y location in millipoints @param x2 the end x location in millipoints @param y2 the end y location in millipoints @param th the thickness in millipoints @param r the red component @param g the green component @param b the blue component add a line to the current stream @param x1 the start x location in millipoints @param y1 the start y location in millipoints @param x2 the end x location in millipoints @param y2 the end y location in millipoints @param th the thickness in millipoints @param rs the rule style @param r the red component @param g the green component @param b the blue component add a rectangle to the current stream @param x the x position of left edge in millipoints @param y the y position of top edge in millipoints @param w the width in millipoints @param h the height in millipoints @param stroke the stroke color/gradient add a filled rectangle to the current stream @param x the x position of left edge in millipoints @param y the y position of top edge in millipoints @param w the width in millipoints @param h the height in millipoints @param fill the fill color/gradient @param stroke the stroke color/gradient add a filled rectangle to the current stream @param x the x position of left edge in millipoints @param y the y position of top edge in millipoints @param w the width in millipoints @param h the height in millipoints @param fill the fill color/gradient render image area to PDF @param area the image area to render render a foreign object area render inline area to PDF @param area inline area to render Convert a char to a multibyte hex representation Checks to see if we have some text rendering commands open still and writes out the TJ command to the stream if we do render page into PDF @param page page to render defines a string containing dashArray and dashPhase for the rule style Renders an area's background. The area whose background is to be rendered. The x position of the left edge in millipoints. The y position of top edge in millipoints. The width in millipoints. The height in millipoints. Renders an image, rendered at the image's intrinsic size. This by default calls drawImageScaled() with the image's intrinsic width and height, but implementations may override this method if it can provide a more efficient solution. The x position of left edge in millipoints. The y position of top edge in millipoints. The image to be rendered. Renders an image, scaling it to the given width and height. If the scaled width and height is the same intrinsic size of the image, the image is not scaled The x position of left edge in millipoints. The y position of top edge in millipoints. The width in millipoints. The height in millipoints. The image to be rendered. Renders an image, clipping it as specified. The x position of left edge in millipoints. The y position of top edge in millipoints. The left edge of the clip in millipoints. The top edge of the clip in millipoints. The clip width in millipoints. The clip height in millipoints. The image to be rendered. render display space @param space the display space to render render inline space @param space space to render render leader area @param area area to render Assigns renderer options to this PdfRenderer This property will only accept an instance of the PdfRendererOptions class If value is not an instance of PdfRendererOptions This class can be used to control various properties of PDF files created by Apoc XSL-FO. Can be used to control certain values in the generated PDF's information dictionary. These values are typically displayed in a document summary dialog of PDF viewer applications. This class also allows security settings to be specified that will cause generated PDF files to be encrypted and optionally password protected. A marker interface to indicate an object can be passed to the property. The given initial value zero's out first two bits. The PDF specification dictates that these entries must be 0. Adds a keyword to the PDF document. Keywords are embedded in the PDF information dictionary. The keyword to be added. Adds fileInfo to the private font collection. Absolute path to a TrueType font or collection. If fileInfo is null. If fileInfo does not exist. If fileInfo has already been added. If fileInfo cannot be added to the system font collection. Specifies the Title of the PDF document. The default value is null. This value will be embedded in the PDF information dictionary. Specifies the Subject of the PDF document. The default value is null. This value will be embedded in the PDF information dictionary. Specifies the Author of the PDF document. The default value is null. This value will be embedded in the PDF information dictionary. Returns the Creator of the PDF document. This method will always return "XSL-FO http://www.w3.org/1999/XSL/Format". Returns the Producer of the PDF document. This method will return the assembly name and version of Apoc. Returns a list of keywords as a comma-separated string If no keywords exist the empty string is returned Specifies the owner password that will protect full access to any generated PDF documents. If either the owner or the user password is specified, then the document will be encrypted. The default value is null. Specifies the user password that will protect access to any generated PDF documents. If either the owner or the user password is specified, then the document will be encrypted. The default value is null. Returns true if any permissions have been set. Returns the PDF permissions encoded as an 32-bit integer. Enables or disables printing. The default value is true. Enables or disables modifying document contents (other than text annotations and interactive form fields). The default value is true. Enables or disables copying of text and graphics. The default value is true. Enables or disables adding or modifying text annotations and interactive form fields. The default value is true. Specifies how Apoc should treat fonts. The default value is FontType.Link Gets or sets a value that indicates whether to enable kerning. The default value is false This class can be used to control various properties of PDF files created by the XML tree renderer. Default XML renderer properties Determines if the XMLRenderer should use verbose output Specifies the output format that Apoc XSL-FO should render to. Currently the only useful format supported is PDF. The XML format is intended for informational/debugging purposes only. Instructs Apoc to output an XML representation. This format is useful only for informational/debugging purposes. Instructs Apoc to output PDF. maxDelimChar stores the value of the delimiter character with the highest value. It is used to optimize the detection of delimiter characters. Set maxDelimChar to the highest char in the delimiter set. Constructs a string tokenizer for the specified string. All characters in the delim argument are the delimiters for separating tokens.
If the returnDelims flag is true, then the delimiter characters are also returned as tokens. Each delimiter is returned as a string of length one. If the flag is false, the delimiter characters are skipped and only serve as separators between tokens. Constructs a string tokenizer for the specified string. The characters in the delim argument are the delimiters for separating tokens. Delimiter characters themselves will not be treated as tokens. a string to be parsed. the delimiters. Constructs a string tokenizer for the specified string. The tokenizer uses the default delimiter set, which is the space character, the tab character, the newline character, the carriage-return character, and the form-feed character. Delimiter characters themselves will not be treated as tokens. a string to be parsed Skips delimiters starting from the specified position. If retDelims is false, returns the index of the first non-delimiter character at or after startPos. If retDelims is true, startPos is returned. Skips ahead from startPos and returns the index of the next delimiter character encountered, or maxPosition if no such delimiter is found. Returns the next token from this string tokenizer. the next token from this string tokenizer. Returns the same value as the hasMoreTokens method. It exists so that this class can implement the Enumeration interface. true if there are more tokens; false otherwise. Tests if there are more tokens available from this tokenizer's string. If this method returns true, then a subsequent call to nextToken with no argument will successfully return a token. true if and only if there is at least one token in the string after the current position; false otherwise. Calculates the number of times that this tokenizer's nextToken method can be called before it generates an exception. The current position is not advanced. the number of tokens remaining in the string using the current delimiter set. Returns the same value as the nextToken method, except that its declared return value is Object rather than String. It exists so that this class can implement the Enumeration interface. ApocDriver provides the client with a single interface to invoking Apoc XSL-FO. The examples belows demonstrate several ways of invoking Apoc XSL-FO. The methodology is the same regardless of how Apoc is embedded in your system (ASP.NET, WinForm, Web Service, etc). // This example demonstrates rendering an XSL-FO file to a PDF file. ApocDriver driver = ApocDriver.Make(); driver.Render( new FileStream("readme.fo", FileMode.Open), new FileStream("readme.pdf", FileMode.Create)); // This example demonstrates rendering an XSL-FO file to a PDF file. Dim driver As ApocDriver = ApocDriver.Make driver.Render( _ New FileStream("readme.fo", FileMode.Open), _ New FileStream("readme.pdf", FileMode.Create)) // This example demonstrates rendering the result of an XSLT transformation // into a PDF file. ApocDriver driver = ApocDriver.Make(); driver.Render( XslTransformer.Transform("readme.xml", "readme.xsl"), new FileStream("readme.pdf", FileMode.Create)); // This example demonstrates rendering the result of an XSLT transformation // into a PDF file. Dim driver As ApocDriver = ApocDriver.Make driver.Render( _ XslTransformer.Transform("readme.xml", "readme.xsl"), _ New FileStream("readme.pdf", FileMode.Create)) // This example demonstrates using an XmlDocument as the source of the // XSL-FO tree. The XmlDocument could easily be dynamically generated. XmlDocument doc = new XmlDocument() doc.Load("reader.fo"); ApocDriver driver = ApocDriver.Make(); driver.Render(doc, new FileStream("readme.pdf", FileMode.Create)); // This example demonstrates using an XmlDocument as the source of the // XSL-FO tree. The XmlDocument could easily be dynamically generated. Dim doc As XmlDocument = New XmlDocument() doc.Load("reader.fo") Dim driver As ApocDriver = ApocDriver.Make driver.Render(doc, New FileStream("readme.pdf", FileMode.Create)) This interface is implemented by the ApocDriver class to permit usage from COM applications. This is the recommended method of supporting invocation from COM application as it permits interface versioning. Controls the output format of the renderer. Defaults to PDF. Determines if the output stream passed to should be closed upon completion or if a fatal exception occurs. Options to supply to the renderer. Maps a set of credentials to an internet resource The ResourceManager embedded in the core dll. The active driver. Permits the product key to be specified using code, rather than the flakey licenses.licx method. Constructs a new ApocDriver and registers the newly created driver as the active driver. An instance of ApocDriver Sets the the 'baseDir' property in the Configuration class using the value returned by Directory.GetCurrentDirectory(). An optional image handler that can be registered to load image data for external graphic formatting objects. Executes the conversion reading the source tree from the supplied XmlDocument, converting it to a format dictated by the renderer and writing it to the supplied output stream. An in-memory representation of an XML document (DOM). Any subclass of the Stream class. Any exceptions that occur during the render process are arranged into three categories: information, warning and error. You may intercept any or all of theses exceptional states by registering an event listener. See for an example of registering an event listener. If there are no registered listeners, the exceptions are dumped to standard out - except for the error event which is wrapped in a . Executes the conversion reading the source tree from the input reader, converting it to a format dictated by the renderer and writing it to the supplied output stream. A character orientated stream Any subclass of the Stream class Executes the conversion reading the source tree from the file inputFile, converting it to a format dictated by the renderer and writing it to the file identified by outputFile. If the file outputFile does not exist, it will created otherwise it will be overwritten. Creating a file may generate a variety of exceptions. See for a complete list.
 Path to an XSL-FO file Path to a file Executes the conversion reading the source tree from the file inputFile, converting it to a format dictated by the renderer and writing it to the supplied output stream. Path to an XSL-FO file Any subclass of the Stream class, e.g. FileStream Executes the conversion reading the source tree from the input stream, converting it to a format dictated by the render and writing it to the supplied output stream. Any subclass of the Stream class, e.g. FileStream Any subclass of the Stream class, e.g. FileStream Executes the conversion reading the source tree from the input reader, converting it to a format dictated by the render and writing it to the supplied output stream. The evaluation copy of this class will output an evaluation banner to standard out Reader that provides fast, non-cached, forward-only access to XML data Any subclass of the Stream class, e.g. FileStream Retrieves the string resource with the specific key using the default culture A resource key The resource string identified by key from the current culture's setting The key parameter is a null reference The value of the specified resource is not a string No usable set of resources has been found, and there are no neutral culture resources Sends an 'error' event to all registered listeners. If there are no listeners, a is thrown immediately halting execution Any error message, which may be null If no listener is registered for this event, a SystemException will be thrown Sends a 'warning' event to all registered listeners If there are no listeners, message is written out to the console instead Any warning message, which may be null Sends an 'info' event to all registered lisetners If there are no listeners, message is written out to the console instead An info message, which may be null Utility method that creates an for the supplied file The returned interprets all whitespace Utility method that creates an for the supplied file The returned interprets all whitespace Utility method that creates an for the supplied file The returned interprets all whitespace A multicast delegate. The error event Apoc publishes. The method signature for this event handler should match the following: 

                void ApocError(object driver, ApocEventArgs e);
The first parameter driver will be a reference to the active ApocDriver instance. Subscribing to the 'error' event 
[C#]

                {
                ApocDriver driver = ApocDriver.Make();
                driver.OnError += new ApocDriver.ApocEventHandler(ApocError);
                ...
                }
A multicast delegate. The warning event Apoc publishes. The method signature for this event handler should match the following: 

                void ApocWarning(object driver, ApocEventArgs e);
The first parameter driver will be a reference to the active ApocDriver instance. A multicast delegate. The info event Apoc publishes. The method signature for this event handler should match the following: 

                void ApocInfo(object driver, ApocEventArgs e);
The first parameter driver will be a reference to the active ApocDriver instance. Determines if the output stream should be automatically closed upon completion of the render process. Gets or sets the active . An instance of created via the factory method . Determines which rendering engine to use. A value from the enumeration. The default value is . Gets or sets the base directory used to locate external resourcs such as images. Defaults to the current working directory. Gets or sets the handler that is responsible for loading the image data for external graphics. If null is returned from the image handler, then Apoc will perform normal processing. Gets or sets the time in milliseconds until an HTTP image request times out. The default value is 100000 milliseconds. The timeout value in milliseconds Gets a reference to a object that manages credentials for multiple Internet resources. The purpose of this property is to associate a set of credentials against an Internet resource. These credentials are then used by Apoc when fetching images from one of the listed resources. ApocDriver driver = ApocDriver.Make(); NetworkCredential nc1 = new NetworkCredential("foo", "password"); driver.Credentials.Add(new Uri("http://www.chive.com"), "Basic", nc1); NetworkCredential nc2 = new NetworkCredential("john", "password", "UK"); driver.Credentials.Add(new Uri("http://www.xyz.com"), "Digest", nc2); Write only property that can be used to bypass licenses.licx and set a product key directly. Returns the product key. Options that are passed to the rendering engine. An object that implements the marker interface. The default value is null, in which case all default options will be used. An instance of is typically passed to this property. True if the current license is an evaluation license. The delegate subscribers must implement to receive Apoc events. The parameter will be a reference to the active ApocDriver. The parameter will contain a human-readable error message. A reference to the active ApocDriver Encapsulates a human readable error message The delegat subscribers must implement to handle the loading of image data in response to external-graphic formatting objects. A class containing event data for the Error, Warning and Info events defined in . Initialises a new instance of the ApocEventArgs class. The text of the event message. Retrieves the event message. A string which may be null. Converts this ApocEventArgs to a string. A string representation of this class which is identical to . This exception is thrown by Apoc when an error occurs. Initialises a new instance of the ApocException class. The property will be initialised to innerException.Message The exception that is the cause of the current exception Initialises a new instance of the ApocException class. The error message that explains the reason for this exception Initialises a new instance of the ApocException class. The error message that explains the reason for this exception The exception that is the cause of the current exception This class acts as a bridge between the XML:FO parser and the formatting/rendering classes. It will queue PageSequences up until all the IDs required by them are satisfied, at which time it will render the pages. StreamRenderer is created by Driver and called from FOTreeBuilder when a PageSequence is created, and AreaTree when a Page is formatted. Keep track of the number of pages rendered. The renderer being used. The formatting results to be handed back to the caller. The FontInfo for this renderer. The list of pages waiting to be renderered. The current set of IDReferences, passed to the areatrees and pages. This is used by the AreaTree as a single map of all IDs. The list of extensions. The list of markers. Format the PageSequence. The PageSequence formats Pages and adds them to the AreaTree, which subsequently calls the StreamRenderer instance (this) again to render the page. At this time the page might be printed or it might be queued. A page might not be renderable immediately if the IDReferences are not all valid. In this case we defer the rendering until they are all valid. Try to process the queue from the first entry forward. If an entry can't be processed, then the queue can't move forward, so return. Auxillary function for retrieving markers. Auxillary function for retrieving markers. Auxillary function for retrieving markers. A RenderQueueEntry consists of the Page to be queued, plus a list of outstanding ID references that need to be resolved before the Page can be renderered. The Page that has outstanding ID references. MG - to replace the outer this Java nonsense */ A list of ID references (names). See if the outstanding references are resolved in the current copy of IDReferences. A subclass of FileStream that automatically deletes the file supplied to the class constructor when Close() is invoked Default class constuctor that opens the supplied file filename using the FileMode.Open parameter.
 Overriden. Attempts to delete the filename supplied to the class constructor using . If an exception is thrown, it is caught and ignored Provides a static method that applies an XSL stylesheet to an XML document Private constructor to prevent instantiation Applies the style sheet xslFile to the XML document identified by xmlFile. Path to an XML document Path to an XSL stylesheet A Stream representing a sequence of XSL:FO elements The files xmlFile and xslFile do not exist or are inaccessible. The XSL file cannot be compiled This method will create a temporary filename in the system's temporary directory, which is automatically deleted when the returned stream is closed.