Documentation

Class BackgroundGrid

Represents a visual grid of lines usually used as background surface.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
UIElement
FrameworkElement
Panel
Canvas
BackgroundGridBase
BackgroundGrid
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI.Diagrams.Primitives
Assembly: Telerik.WinControls.RadDiagram.dll

Syntax

public class BackgroundGrid : BackgroundGridBase, IDisposable, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IStylableNode, ISupportDrop

Constructors

BackgroundGrid()

Declaration
public BackgroundGrid()

Fields

CellSizeProperty

Identifies the CellSize attached property.

Declaration
public static readonly RadProperty CellSizeProperty
Field Value
RadProperty

IsDynamicProperty

Identifies the IsDynamic attached property.

Declaration
public static readonly RadProperty IsDynamicProperty
Field Value
RadProperty

IsGridVisibleProperty

Identifies the IsGridVisible attached property.

Declaration
public static readonly RadProperty IsGridVisibleProperty
Field Value
RadProperty

LineStrokeDashArrayProperty

Identifies the LineStrokeDashArray attached property.

Declaration
public static readonly RadProperty LineStrokeDashArrayProperty
Field Value
RadProperty

LineStrokeProperty

Identifies the LineStroke attached property.

Declaration
public static readonly RadProperty LineStrokeProperty
Field Value
RadProperty

LineStrokeThicknessProperty

Identifies the LineStrokeThickness attached property.

Declaration
public static readonly RadProperty LineStrokeThicknessProperty
Field Value
RadProperty

Properties

CellSize

Gets the cell size.

Declaration
public override Size CellSize { get; set; }
Property Value
Size

Overrides

IsDynamic

Gets a value indicating whether the grid will be synchronized with the diagram viewport changes (panning and zooming).

Declaration
protected override bool IsDynamic { get; }
Property Value
System.Boolean

Overrides

LineStroke

Gets the cell size.

Declaration
public override Brush LineStroke { get; set; }
Property Value
System.Drawing.Brush

Overrides

LineStrokeDashArray

Gets the cell size.

Declaration
public override DoubleCollection LineStrokeDashArray { get; set; }
Property Value
DoubleCollection

Overrides

LineStrokeThickness

Gets the cell size.

Declaration
public override double LineStrokeThickness { get; set; }
Property Value
System.Double

Overrides

Methods

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

GetCellSize(RadObject)

Gets the cell size.

Declaration
public static Size GetCellSize(RadObject obj)
Parameters
RadObject obj

Returns
Size

GetIsDynamic(RadObject)

Gets a value indicating whether the grid will be synchronized with the diagram viewport changes (panning and zooming).

Declaration
public static bool GetIsDynamic(RadObject obj)
Parameters
RadObject obj

Returns
System.Boolean

GetIsGridVisible(RadObject)

Gets the grid visibility.

Declaration
public static bool GetIsGridVisible(RadObject obj)
Parameters
RadObject obj

Returns
System.Boolean

GetLineStroke(RadObject)

Gets the line stroke.

Declaration
public static Brush GetLineStroke(RadObject obj)
Parameters
RadObject obj

Returns
System.Drawing.Brush

GetLineStrokeDashArray(RadObject)

Gets the line stroke dash array.

Declaration
public static DoubleCollection GetLineStrokeDashArray(RadObject obj)
Parameters
RadObject obj

Returns
DoubleCollection

GetLineStrokeThickness(RadObject)

Gets the line stroke thickness.

Declaration
public static double GetLineStrokeThickness(RadObject obj)
Parameters
RadObject obj

Returns
System.Double

SetCellSize(RadObject, Size)

Sets the cell size.

Declaration
public static void SetCellSize(RadObject obj, Size value)
Parameters
RadObject obj

Size value

SetIsDynamic(RadObject, Boolean)

Sets value indicating whether the grid will be synchronized with the diagram viewport changes (panning and zooming).

Declaration
public static void SetIsDynamic(RadObject obj, bool value)
Parameters
RadObject obj

System.Boolean value

SetIsGridVisible(RadObject, Boolean)

Sets the grid visibility.

Declaration
public static void SetIsGridVisible(RadObject obj, bool value)
Parameters
RadObject obj

System.Boolean value

SetLineStroke(RadObject, Brush)

Sets the line stroke.

Declaration
public static void SetLineStroke(RadObject obj, Brush value)
Parameters
RadObject obj

System.Drawing.Brush value

SetLineStrokeDashArray(RadObject, DoubleCollection)

Sets the line stroke dash array.

Declaration
public static void SetLineStrokeDashArray(RadObject obj, DoubleCollection value)
Parameters
RadObject obj

DoubleCollection value

SetLineStrokeThickness(RadObject, Double)

Sets the line stroke thickness.

Declaration
public static void SetLineStrokeThickness(RadObject obj, double value)
Parameters
RadObject obj

System.Double value

Extension Methods