GrapeCity.Documents.Layout.LayoutHost
Class LayoutHost
- Namespace
- GrapeCity.Documents.Layout
- Assembly
- GcDocs.Imaging.dll
Represents the host and origin of a coordinate system for LayoutView objects.
public class LayoutHost- Inheritance
-
objectLayoutHost
- Inherited Members
-
object.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()
Constructors
LayoutHost(object)
Initializes a new instance of the LayoutHost object.
public LayoutHost(object tag = null)Parameters
tagobjectThe object that contains data about the LayoutHost.
- See Also
Properties
Dirty
Gets a value indicating if the LayoutHost contains rectangles with unresolved changes.
public bool Dirty { get; }Property Value
- bool
- See Also
Frozen
Gets a value indicating if the LayoutHost does not allow any modifications or recalculations.
public bool Frozen { get; }Property Value
- bool
- See Also
Tag
Gets or sets the object that contains data about the LayoutHost.
public object Tag { get; set; }Property Value
- object
- See Also
ThrowIfNotFit
Gets or sets a value indicating whether a LayoutException should be thrown if the width or height of some LayoutRect becomes negative.
The default is true.
public bool ThrowIfNotFit { get; set; }Property Value
- bool
- See Also
ZeroTolerance
Gets or sets a value for which all absolute numbers smaller than are considered equal to zero.
Possible values are between 0.00001f and 1f. The default is 0.01f.
public float ZeroTolerance { get; set; }Property Value
- float
- See Also
Methods
CreateView(float, float, Matrix, object)
Creates a new LayoutView and associates it with the LayoutHost.
public LayoutView CreateView(float width, float height, Matrix transform = null, object tag = null)Parameters
widthfloatThe width of the view rectangle.
heightfloatThe height of the view rectangle.
transformMatrixThe transformation matrix for the LayoutView.
tagobjectThe object that contains data about the LayoutView.
Returns
- LayoutView
The created LayoutView object.
- See Also
Freeze()
Releases all memory resources required for recalculating the layout.
public void Freeze()- See Also
PerformLayout()
Recalculates the layout of all "dirty" LayoutRect objects in the LayoutHost.
public bool PerformLayout()Returns
- bool
true if successful, false if the width or height of any LayoutRect has become negative and the ThrowIfNotFit is false.
- See Also