Class GridTreeExpandCellRenderer
CellRenderer that displays indented tree-like node layout.
Inheritance
Implements
Inherited Members
Namespace: Syncfusion.Windows.Controls.Grid
Assembly: Syncfusion.Grid.Wpf.dll
Syntax
public class GridTreeExpandCellRenderer : GridCellTextBoxRenderer, IGridCellRenderer, ICellRenderer, IHitTestSelectCells, IStyleChanged, IDisposable, IAllowKeepAliveOnlyCurrentCell
Constructors
GridTreeExpandCellRenderer()
Deault constructor.
Declaration
public GridTreeExpandCellRenderer()
Properties
ExpandGlyphType
Gets or sets the type of the glyph shown in the expand cell.
Declaration
public GridTreeExpandGlyph ExpandGlyphType { get; set; }
Property Value
Type |
---|
GridTreeExpandGlyph |
Remarks
The default value is a triangle. You can also set a +- glyph, or a +-glyph with tree lines, or a custom drawn glyph. The property NodeColumnWidth reserves the required width of your glyph. The default value of NodeColumnWidth is 10 which is the setting used for the triangle glyph. For the +- glyph, the value of NodeColumnWidth is set to 14. If you want to explicitly provide a particular NodeColumnWidth, then you need to explicitly reset its value after you set ExpandGlyphType as setting ExpandGlypType also possibly resets NodeColumnWidth.
ExpandWidgetBrush
Gets or sets the Brush used for drawing of the primary expand glyph drawing.
Declaration
public Brush ExpandWidgetBrush { get; set; }
Property Value
Type |
---|
System.Windows.Media.Brush |
ExpandWidgetPen
Gets or sets the Pen used to draw the borders of the expand glyph.
Declaration
public Pen ExpandWidgetPen { get; set; }
Property Value
Type |
---|
System.Windows.Media.Pen |
HotExpandWidgetBrush
Gets or sets the Brush used for drawing the epand glyph when it is under the mouse.
Declaration
public Brush HotExpandWidgetBrush { get; set; }
Property Value
Type |
---|
System.Windows.Media.Brush |
NodeColumnWidth
Gets or sets the width of the expand glyph area.
Declaration
public double NodeColumnWidth { get; set; }
Property Value
Type |
---|
System.Double |
Remarks
When the expand glyph is the triangle, this value is set to 10. When the expand glyph is a +-, this value is set to 14. If you want to explicitly provide a particular NodeColumnWidth, then you need to explicitly reset its value after you set ExpandGlyphType as setting ExpandGlypType also possibly resets NodeColumnWidth.
VisualStyle
Gets or sets the visual style.
Declaration
public IGridTreeVisualStyle VisualStyle { get; set; }
Property Value
Type | Description |
---|---|
IGridTreeVisualStyle | The visual style. |
Methods
add_GlyphDrawing(GridTreeGlyphDrawingHandler)
Declaration
public void add_GlyphDrawing(GridTreeGlyphDrawingHandler value)
Parameters
Type | Name | Description |
---|---|---|
GridTreeGlyphDrawingHandler | value |
ClipNodeImage(Rect, Double, Double, GridRenderStyleInfo)
This function used to Find the image rectangle Hight, width and positions
Declaration
protected virtual Rect ClipNodeImage(Rect cellRect, double imageWidth, double imageHeight, GridRenderStyleInfo style)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Rect | cellRect | |
System.Double | imageWidth | |
System.Double | imageHeight | |
GridRenderStyleInfo | style |
Returns
Type |
---|
System.Windows.Rect |
Dispose(Boolean)
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
Overrides
OnGlyphDrawing(GridTreeGlyphDrawingEventArgs)
Raises the GlyphDrawing event.
Declaration
protected virtual void OnGlyphDrawing(GridTreeGlyphDrawingEventArgs e)
Parameters
Type | Name | Description |
---|---|---|
GridTreeGlyphDrawingEventArgs | e | The event argument. |
OnRender(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
Called when [render].
Declaration
protected override void OnRender(DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Media.DrawingContext | dc | The dc. |
RenderCellArgs | rca | The rca. |
GridRenderStyleInfo | style | The style. |
Overrides
OnRenderExpander(GridTreeControlImpl, DrawingContext, RenderCellArgs, GridRenderStyleInfo)
Called when [render expander].
Declaration
protected virtual void OnRenderExpander(GridTreeControlImpl tree, DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)
Parameters
Type | Name | Description |
---|---|---|
GridTreeControlImpl | tree | The tree. |
System.Windows.Media.DrawingContext | dc | The dc. |
RenderCellArgs | rca | The rca. |
GridRenderStyleInfo | style | The style. |
OnRenderImage(GridTreeControlImpl, DrawingContext, RenderCellArgs, GridRenderStyleInfo)
Called when [render image].
Declaration
protected virtual double OnRenderImage(GridTreeControlImpl tree, DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)
Parameters
Type | Name | Description |
---|---|---|
GridTreeControlImpl | tree | The tree. |
System.Windows.Media.DrawingContext | dc | The dc. |
RenderCellArgs | rca | The rca. |
GridRenderStyleInfo | style | The style. |
Returns
Type |
---|
System.Double |
OnRenderText(DrawingContext, RenderCellArgs, GridRenderStyleInfo)
Called when [render text].
Declaration
public virtual void OnRenderText(DrawingContext dc, RenderCellArgs rca, GridRenderStyleInfo style)
Parameters
Type | Name | Description |
---|---|---|
System.Windows.Media.DrawingContext | dc | The dc. |
RenderCellArgs | rca | The rca. |
GridRenderStyleInfo | style | The style. |
remove_GlyphDrawing(GridTreeGlyphDrawingHandler)
Declaration
public void remove_GlyphDrawing(GridTreeGlyphDrawingHandler value)
Parameters
Type | Name | Description |
---|---|---|
GridTreeGlyphDrawingHandler | value |
Events
GlyphDrawing
Event used to provide access to the glyph in the expand cell.
Declaration
public event GridTreeGlyphDrawingHandler GlyphDrawing
Event Type
Type |
---|
GridTreeGlyphDrawingHandler |
Remarks
Setting ExpandGlyphType = Custom will cause this event to be raised when the glyph is drawn.