Layer Class

Represents a drawing layer with visuals, optional clipping, and nested layers.

Inheritance

Layer

Namespace: GrapeCity.Documents.Layout.Composition

Assembly: DS.Documents.Imaging.dll

Syntax

public class Layer

Public Class Layer

Properties

Name	Description
BaseLayer	Gets the owner Layer if this is a nested Layer.
BottomNestedLayer	Gets the nested Layer that appears below all other nested Layers on this Layer.
BottomVisual	Gets the Visual that appears below all other Visuals on this Layer.
ClipRect	Gets or sets a LayoutRect that affects the transformation matrix when clipping this Layer. If the CreateClipRegion delegate is not assigned, the ClipRect rectangle is also used as a clipping region.
CreateClipRegion	Gets or sets a delegate that creates a clipping region (IClipRegion) taking GcGraphics and Layer as parameters. The transformation matrix of the clipping region is defined by the ClipRect.Transform property. If the ClipRect property is not assigned, the transformation matrix of the owner View is used.
Draw	Gets or sets a delegate that accepts a GcGraphics object and a Layer and draws the layer on the graphics.
IsDetached	Gets true if this Layer is not associated with any Surface, false otherwise.
LayerAbove	Gets the sibling Layer that appears on top of the current Layer.
LayerBelow	Gets the sibling Layer that appears below the current Layer.
Name	Gets or sets the name of this Layer.
Surface	Gets the owner Surface object.
Tag	Gets or sets an object that contains arbitrary data associated with this layer.
TopNestedLayer	Gets the nested Layer that appears on top of all other nested Layers on this Layer.
TopVisual	Gets the Visual that appears on top of all other Visuals on this Layer.
View	If the current object is a Layer, gets the owner View. If the current object is a View, gets this object.
Visible	Gets or sets a value indicating whether this Layer is visible.

Methods

Name	Description
BringToFront()	Moves the layer to the front. It becomes the topmost nested layer of the base Layer or the top layer of the Surface.
CreateSpace()	Creates a Space object that represents an invisible helper rectangle for easy layout of other elements.
CreateSpace(int)	Creates a Space object that represents an invisible helper rectangle for easy layout of other elements.
CreateSubLayer()	Creates a nested Layer object and adds it on top of other nested layers.
CreateSubLayer(Action<GcGraphics, Layer>)	Creates a nested Layer object and adds it on top of other nested layers.
CreateSubView(float, float)	Creates a nested View object and adds it on top of other nested layers.
CreateSubView(float, float, Action<GcGraphics, Layer>)	Creates a nested View object and adds it on top of other nested layers.
CreateVisual(AnchorPoint[])	Creates a Visual object that represents a polygon based on the given AnchorPoints.
CreateVisual(AnchorPoint[], Action<GcGraphics, Visual>)	Creates a Visual object that represents a polygon based on the given AnchorPoints.
CreateVisual(Contour, bool)	Creates a Visual object that represents an element drawing the Contour.
CreateVisual(Contour, bool, Action<GcGraphics, Visual>)	Creates a Visual object that represents an element drawing the Contour.
CreateVisual(Action<GcGraphics, Visual>)	Creates a Visual object that represents a drawing element.
CreateVisual(bool)	Creates a Visual object that represents a drawing element.
CreateVisual(int, bool)	Creates a Visual object that represents a drawing element.
Detach()	Detaches this Layer from the owner Surface.
GetNestedLayers()	Returns the array of nested layers and views on this Layer.
GetVisuals()	Returns the array of Visual objects.
MoveAbove(Layer)	Moves the current Layer to the position on top of the specified `layer`.
MoveBelow(Layer)	Moves the current Layer to the position below the specified `layer`.
SendToBack()	Moves the layer to the back. It becomes the bottom nested layer of the base Layer or the bottom layer of the Surface.
ToString()	Returns a string that represents the current Layer.