GeometryGuide Struct

Namespace:
GemBox.Presentation
Assembly:
GemBox.Presentation.dll

Represents a geometry guide that is used to govern the geometry of a GeometryShape.

public struct GeometryGuide : IEquatable<GeometryGuide>
Public Structure GeometryGuide
    Implements IEquatable(Of GeometryGuide)
Implements
System.IEquatable<GeometryGuide>

Properties

Formula

Gets the formula that is used to calculate the value for a guide.

public readonly string Formula { get; }
Public ReadOnly Property Formula As String
Property Value
System.String

The formula that is used to calculate the value for a guide.

Remarks

Each formula has a certain number of arguments and a specific set of operations to perform on these arguments in order to generate a value for a guide. There are a total of 17 different formulas available.

Name

Gets the name that is used to reference to this guide.

public readonly string Name { get; }
Public ReadOnly Property Name As String
Property Value
System.String

The name that is used to reference to this guide.

Methods

Equals(GeometryGuide)

Determines whether the other GeometryGuide is equal to this GeometryGuide instance.

public bool Equals(GeometryGuide other)
Public Function Equals(other As GeometryGuide) As Boolean
Parameters
other
GeometryGuide

The other geometry guide to compare with this geometry guide instance.

Returns
System.Boolean

true if the other GeometryGuide is equal to this GeometryGuide instance; otherwise, false.

Equals(Object)

Determines whether the specified System.Object is equal to this GeometryGuide instance.

public override bool Equals(object obj)
Public Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
System.Object

The System.Object to compare with this geometry guide instance.

Returns
System.Boolean

true if the specified System.Object is a GeometryGuide and is equal to this GeometryGuide instance; otherwise, false.

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this GeometryGuide instance.

public override int GetHashCode()
Public Overrides Function GetHashCode As Integer
Returns
System.Int32

An integer value that specifies a hash value for this GeometryGuide instance.

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this GeometryGuide instance.

public override string ToString()
Public Overrides Function ToString As String
Returns
System.String

A System.String that represents this GeometryGuide instance.

Overrides
System.ValueType.ToString()
Remarks

This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).

Operators

Equality(GeometryGuide, GeometryGuide)

Determines whether first and second GeometryGuides are equal.

public static bool operator ==(GeometryGuide first, GeometryGuide second)
Public Shared Operator =(first As GeometryGuide, second As GeometryGuide) As Boolean
Parameters
first
GeometryGuide

The first geometry guide.

second
GeometryGuide

The second geometry guide.

Returns
System.Boolean

true if first and second geometry guides are equal; otherwise, false.

Inequality(GeometryGuide, GeometryGuide)

Determines whether first and second GeometryGuides are not equal.

public static bool operator !=(GeometryGuide first, GeometryGuide second)
Public Shared Operator <>(first As GeometryGuide, second As GeometryGuide) As Boolean
Parameters
first
GeometryGuide

The first geometry guide.

second
GeometryGuide

The second geometry guide.

Returns
System.Boolean

true if first and second geometry guides are not equal; otherwise, false.

Implements

System.IEquatable<T>