[]
        
(Showing Draft Content)

GrapeCity.Documents.Layout.Composition.Surface

Surface Class

Represents a surface that can draw its views on a GcGraphics.

Inheritance
Surface
Namespace: GrapeCity.Documents.Layout.Composition
Assembly: DS.Documents.Imaging.dll
Syntax
public class Surface
Public Class Surface

Constructors

Name Description
Surface()

Initializes a new instance of the Surface object with a LayoutHost.

Properties

Name Description
BaseTransform

Gets the transformation matrix of the GcGraphics object when it was passed to the Render(GcGraphics) method.

Returns an identity matrix when checked outside of the Render(GcGraphics) method.

BottomLayer

Gets the view that appears below all other views on this Surface.

LayoutHost

Gets the associated LayoutHost object.

Name

Gets or sets the name of the Surface.

Tag

Gets or sets an object that contains arbitrary data associated with this surface.

ThrowIfNotFit

Gets or sets a value indicating whether a LayoutException should be thrown if the width or height of some LayoutRects becomes negative.

The default is true.

TopLayer

Gets the view that appears above all other views on this Surface.

Methods

Name Description
CreateView(float, float)

Creates a View object that encapsulates a LayoutView and adds it as the top layer.

CreateView(float, float, Action<GcGraphics, Layer>)

Creates a View object that encapsulates a LayoutView and adds it as the top layer.

GetViews()

Returns the array of views on this Surface.

PerformLayout()

Recalculates the layout of all Visual and Space objects on this Surface.

Render(GcGraphics)

Draws this Surface on a specified GcGraphics object.

This method first calls PerformLayout(), if the call succeeds it then draws all layers starting with the bottom layer and going up. For each layer, it draws all visuals from the bottom to the top one, followed by drawing the layer's sub-layers. The process repeats until the topmost visual of the top layer has been drawn.

ToString()

Returns a string that represents the current Surface.