Skip to content

WPF-Redundant-GridTreeControl(Classic) : Avoid redundant words in WPF… #2709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Dinesh-rangasamy wants to merge 1 commit into
base: development
Choose a base branch
from
Open

WPF-Redundant-GridTreeControl(Classic) : Avoid redundant words in WPF… #2709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions wpf/Classic/GridTree/Architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,19 @@ documentation: ug

# Architecture in WPF GridTreeControl

The GridTree control derives from the WPF ContentControl, which allows it to support a ControlTemplate to define its content. By default, its content includes a Border object, which contains a ScrollViewer object that contains a GridControlImpl object. GridControlImpl is a GridControlBase derived class that provides the ‘multi-column grid’ functionality to the GridTree control.
The GridTreeControl derives from the WPF ContentControl, which allows it to support a ControlTemplate to define its content. By default, its content includes a Border object, which contains a ScrollViewer object that contains a GridControlImpl object. GridControlImpl is a GridControlBase derived class that provides the ‘multi-column grid’ functionality to the GridTreeControl.

For each node in the tree, there is a GridTreeNode object that holds the information of the node such as the underlying data item, whether the node is expanded, etc. The GridTreeNodes collection can be accessed by the GridTreeControl.InternalGrid.Nodes collection. InternalGrid is the GridTreeControlImpl object associated with the GridTree control.
For each node in the tree, there is a GridTreeNode object that holds the information of the node such as the underlying data item, whether the node is expanded, etc. The GridTreeNodes collection can be accessed by the GridTreeControl.InternalGrid.Nodes collection. InternalGrid is the GridTreeControlImpl object associated with the GridTreeControl.

The following screen shot illustrates the GridTree control architecture.
The following screen shot illustrates the GridTreeControl architecture.

![Architecture_img1](Architecture_images/Architecture_img1.jpeg)



## Accessing the Underlying Grid control

The GridTree control is a ContentControl derived class. To get its grid-like behavior, the GridTree control has a Grid control derived property named InternalGrid. InternalGrid is a GridTreeControlImpl class, which is derived from the Grid control. The GridTreeControlImpl is a virtual Grid control, which uses the virtual events to bind to the GridTreeControl.Nodes collection. So, to access the underlying Grid control associated with the GridTree control, you can use the GridTreeControl.InternalGrid property.
The GridTreeControl is a ContentControl derived class. To get its grid-like behavior, the GridTreeControl has a Grid control derived property named InternalGrid. InternalGrid is a GridTreeControlImpl class, which is derived from the Grid control. The GridTreeControlImpl is a virtual Grid control, which uses the virtual events to bind to the GridTreeControl.Nodes collection. So, to access the underlying Grid control associated with the GridTreeControl, you can use the GridTreeControl.InternalGrid property.

All the properties exposed in GridTree control (with the exception of Internal Grid) are mirrored in GridTreeControlImpl. There are methods and properties exposed on the Internal Grid that are not exposed on the GridTree control itself. In particular, to control the look of the Expand cell, you need to use the Internal Grid as discussed below. The Internal Grid has many protected methods that provide access to the tree-like functionality. So, deriving GridTreeControlImpl gives you access to this functionality if you need to use it for any reason.
All the properties exposed in GridTreeControl (with the exception of Internal Grid) are mirrored in GridTreeControlImpl. There are methods and properties exposed on the Internal Grid that are not exposed on the GridTreeControl itself. In particular, to control the look of the Expand cell, you need to use the Internal Grid as discussed below. The Internal Grid has many protected methods that provide access to the tree-like functionality. So, deriving GridTreeControlImpl gives you access to this functionality if you need to use it for any reason.

48 changes: 24 additions & 24 deletions wpf/Classic/GridTree/Columns.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ documentation: ug

# Columns in WPF GridTreeControl

The GridTree control’s columns are divided into two types. They are:
The GridTreeControl’s columns are divided into two types. They are:

* Bound Column
* Unbound Column
Expand Down Expand Up @@ -44,7 +44,7 @@ Data Type</th></tr>
<tr>
<td>
AutoPopulateColumns</td><td>
By setting this property to {{ '_true_' | markdownify }}, the GridTree control populates the properties that are present in the underlying collection without defining them in the XAML or in C#.</td><td>
By setting this property to {{ '_true_' | markdownify }}, the GridTreeControl populates the properties that are present in the underlying collection without defining them in the XAML or in C#.</td><td>
Dependency Property</td><td>
Boolean</td></tr>
<tr>
Expand All @@ -58,7 +58,7 @@ Boolean</td></tr>

### AutoPopulateColumns

In the GridTree control, you can populate the columns automatically by setting the AutoPopulateColumns property to True.
In the GridTreeControl, you can populate the columns automatically by setting the AutoPopulateColumns property to True.

{% tabs %}
{% highlight xaml %}
Expand All @@ -81,11 +81,11 @@ treeGrid.AutoPopulateColumns = true;
{% endtabs %}


When we set this property to true, the properties that are available in underlying collection populates in the GridTree control as GridTreeColumn.
When we set this property to true, the properties that are available in underlying collection populates in the GridTreeControl as GridTreeColumn.

### AutoGenerateColumnsInfo

By setting the AutoGenerateColumnsInfo property to _true_, the GridTree control assigns the appropriate cell type for each column automatically. The following common cell types loaded for the corresponding data.
By setting the AutoGenerateColumnsInfo property to _true_, the GridTreeControl assigns the appropriate cell type for each column automatically. The following common cell types loaded for the corresponding data.


<table>
Expand Down Expand Up @@ -282,15 +282,15 @@ To know more about the GridStyleInfo and StyleInfo properties please refer the f

## Cell Types

In GridTree control you can define the cell type for each column by using the property “CellType”. When you leave a column without defining the cell type then that column’s cell type is considered as “Static” cell type. The list of cell types that are available in the GridTree control are as follows.
In GridTreeControl you can define the cell type for each column by using the property “CellType”. When you leave a column without defining the cell type then that column’s cell type is considered as “Static” cell type. The list of cell types that are available in the GridTreeControl are as follows.

<table>
<tr>
<td>
* Static* TextBlock* TextBox* RichText* ExpanderCell* Data Template* ComboBox* DropDownList* CheckBox* Currency edit* Double edit* DateTime edit* Integer edit* Mask edit* Percent edit* Up Down edit* TimeSpan edit* Image* Hyperlink* Button</td></tr>
<tr>
<td>
> <br>It is not possible to change the cell type for the first column of the GridTree control.</td></tr>
> <br>It is not possible to change the cell type for the first column of the GridTreeControl.</td></tr>
</table>

## Static
Expand Down Expand Up @@ -554,9 +554,9 @@ GridTree RichText Cell Type

### ExpanderCell

In the GridTree control by default, the ExpanderCell type is present at the first column. This column helps you to expand the parent node and navigate into the child nodes. In general, ExpanderCell contains a glyph to expand/collapse the parent nodes.
In the GridTreeControl by default, the ExpanderCell type is present at the first column. This column helps you to expand the parent node and navigate into the child nodes. In general, ExpanderCell contains a glyph to expand/collapse the parent nodes.

The following are the list of glyphs in the GridTree control.
The following are the list of glyphs in the GridTreeControl.

Glyph Types

Expand All @@ -572,15 +572,15 @@ PlusMinus—contains a plus/minus symbol. The plus symbol appears when the node

PlusMinusLine—contains a plus/minus symbol with lines. When the plus symbol is visible then a line is drawn from the parent node to its child node and each child node has the line with its parent node.

Themed—loads the glyph based on the theme applied for the GridTree control. The patch applied in the theme for the glyph loads as a glyph for the all nodes.
Themed—loads the glyph based on the theme applied for the GridTreeControl. The patch applied in the theme for the glyph loads as a glyph for the all nodes.

Triangle—loads the triangle symbol for each node that contains the child nodes. The collapsed node’s triangle symbol appears horizontal and the expanded node’s triangle turns vertical.

Custom—a custom type glyph is user based and you can load any kind of path into it.

Node image support

In the GridTree control, you can display image in each ExpanderCell and it can be achieved by handling the RequestNodeImage event and applying _true_ to the SupportNodeImages property
In the GridTreeControl, you can display image in each ExpanderCell and it can be achieved by handling the RequestNodeImage event and applying _true_ to the SupportNodeImages property

The following code snippet shows how to load the image in ExpanderCell.

Expand Down Expand Up @@ -609,7 +609,7 @@ GridTree ExpanderCell with Image

### DataTemplate

In the GridTree control, DataTemplate cell type allows you to replace the visual appearance of a cell. You can load any controls into a cell and display the CellBoundValue or custom values. This provides an extensible way to display the cells. The DataContext of a DataTemplate is same as that of the GridTree control.
In the GridTreeControl, DataTemplate cell type allows you to replace the visual appearance of a cell. You can load any controls into a cell and display the CellBoundValue or custom values. This provides an extensible way to display the cells. The DataContext of a DataTemplate is same as that of the GridTreeControl.

The following are the list of properties specific for this cell type.

Expand Down Expand Up @@ -1020,7 +1020,7 @@ The following screenshot shows a simple demo of the DropDownList cell type.



GridTree Control DropDownList Cell Type
GridTreeControl DropDownList Cell Type
{:.caption}

### CheckBox
Expand Down Expand Up @@ -1094,7 +1094,7 @@ The following screenshot shows a simple demo of CheckBox cell type.



GridTree Control CheckBox Cell Type
GridTreeControl CheckBox Cell Type
{:.caption}

### CurrencyEdit
Expand Down Expand Up @@ -1199,7 +1199,7 @@ treeGrid.Columns.Add(new GridTreeColumn("Salary")



GridTree Control CurrencyEdit Cell Type
GridTreeControl CurrencyEdit Cell Type
{:.caption}

### IntegerEdit
Expand Down Expand Up @@ -1290,7 +1290,7 @@ treeGrid.Columns.Add(new GridTreeColumn("Employee ID")



GridTree Control IntegerEdit Cell Type
GridTreeControl IntegerEdit Cell Type
{:.caption}

### DoubleEdit
Expand Down Expand Up @@ -1513,7 +1513,7 @@ treeGrid.Columns.Add(percentColumn);



GridTree Control PercentEdit Cell Type
GridTreeControl PercentEdit Cell Type
{:.caption}

### DateTimeEdit
Expand Down Expand Up @@ -1933,7 +1933,7 @@ TimeSpanEdit Cell Type

## ImageCell

The ImageCell type is used to load images inside the graphic cells. To load the graphic image cell in the GridTree control, you have to set the CellType as ImageCell and the CellValue as BitmapImage.
The ImageCell type is used to load images inside the graphic cells. To load the graphic image cell in the GridTreeControl, you have to set the CellType as ImageCell and the CellValue as BitmapImage.

### Image CellType properties

Expand Down Expand Up @@ -2082,12 +2082,12 @@ The following screenshot shows a simple demo of Hyperlink cell.



GridTree Control Hyperlink Cell Type
GridTreeControl Hyperlink Cell Type
{:.caption}

### Button

The Button cell type allows you to load Button control in each cell of the GridTree control. To load a Button in the GridTree control cell, choose Button cell type. You can perform button click action as in the Button control.
The Button cell type allows you to load Button control in each cell of the GridTreeControl. To load a Button in the GridTreeControl cell, choose Button cell type. You can perform button click action as in the Button control.

The following table shows the events that are available for this cell type.

Expand Down Expand Up @@ -2161,9 +2161,9 @@ Button Cell Type

## Unbound Columns

The GridTree control supports unbound columns in which the data is calculated automatically according to a specified formula, format, or custom data from users.
The GridTreeControl supports unbound columns in which the data is calculated automatically according to a specified formula, format, or custom data from users.

The GridTree control provides support for adding additional columns which is not in underlying business object. Such additional columns are called as unbound columns, as they do not belong to the data source. These unbound fields can be used when you want to add some additional or custom information to the nodes. 
The GridTreeControl provides support for adding additional columns which is not in underlying business object. Such additional columns are called as unbound columns, as they do not belong to the data source. These unbound fields can be used when you want to add some additional or custom information to the nodes. 

You can create an unbound column by instantiating the GridTreeUnboundColumn class, which is a derivative of GridTreeColumn.

Expand Down Expand Up @@ -2326,7 +2326,7 @@ treeGrid.Columns.Add(new GridTreeUnboundColumn() { 



Using Formats in the GridTree Control
Using Formats in the GridTreeControl
{:.caption}

### Expression
Expand Down Expand Up @@ -2471,6 +2471,6 @@ Expression = "Quantity*Cost" });
![Columns_img22](Columns_images/Columns_img22.png)


Using Expressions in the GridTree Control
Using Expressions in the GridTreeControl
{:.caption}

6 changes: 3 additions & 3 deletions wpf/Classic/GridTree/Data-Population.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ documentation: ug

# Data Population in WPF GridTreeControl

The primary requirement of the data displayed in the GridTree control is that the parent node and the child node share the same schema (i.e. have the same columns to display). To populate the GridTree control, you need to handle the RequestTreeItems event (This event gets fired for every tree node that is being populated in order to retrieve its child nodes). In the event arguments, the ParentItem property indicates the item whose children are being requested. The list of children can be set using this property. If this property is empty, it implies that the event is requesting the root nodes. The following code example illustrates a minimal RequestTreeItems handler.
The primary requirement of the data displayed in the GridTreeControl is that the parent node and the child node share the same schema (i.e. have the same columns to display). To populate the Control, you need to handle the RequestTreeItems event (This event gets fired for every tree node that is being populated in order to retrieve its child nodes). In the event arguments, the ParentItem property indicates the item whose children are being requested. The list of children can be set using this property. If this property is empty, it implies that the event is requesting the root nodes. The following code example illustrates a minimal RequestTreeItems handler.

{% highlight c# %}

Expand Down Expand Up @@ -61,9 +61,9 @@ private void treeGrid_RequestTreeItems(object sender, GridTreeRequestTreeItemsEv

The only requirement on ChildList returned by the RequestTreeItems is that it should be an IEnumerable list of typed objects that share a single type.

## Order and Visibility of Columns in the GridTree Control
## Order and Visibility of Columns in the GridTreeControl

The default behavior of the GridTree control is to display all simple, public properties exposed in the items provided through the RequestTreeItems event (Here, properties indicate Data Source properties, which are represented as columns in the Grid control. For eg, in Customers table, CustomerID, CompanyName, etc. are termed as properties). To control the visibility and the order of the columns that appear in the Grid Tree, you can use the GridTreeControl.Columns collection of GridTreeColumn object. The order of the GridTreeColumn objects in the Columns collection determines the display order of the columns in the Grid Tree.
The default behavior of the GridTreeControl is to display all simple, public properties exposed in the items provided through the RequestTreeItems event (Here, properties indicate Data Source properties, which are represented as columns in the Grid control. For eg, in Customers table, CustomerID, CompanyName, etc. are termed as properties). To control the visibility and the order of the columns that appear in the Grid Tree, you can use the GridTreeControl.Columns collection of GridTreeColumn object. The order of the GridTreeColumn objects in the Columns collection determines the display order of the columns in the Grid Tree.

* Each GridTreeColumn contains the following five properties: MappingName-The name of the property from the tree item that is bound with this column
* HeaderText-The HeaderText property sets the text for header cell of this column. If HeaderText is empty, then the MappingName will be used as the column header text.
Expand Down
Loading