PdfLineDashPattern Struct

Namespace:
GemBox.Pdf.Content
Assembly:
GemBox.Pdf.dll

The line dash pattern controls the pattern of dashes and gaps used to stroke paths.

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

Constructors

PdfLineDashPattern(Double, Double[])

Initializes a new instance of the PdfLineDashPattern structure.

public PdfLineDashPattern(double phase, params double[] array)
Public Sub New(phase As Double, ParamArray array As Double())
Parameters
phase
System.Double

The distance into the dash pattern at which to start the dash expressed in user space units.

array
System.Double[]

The numbers that specify the lengths of alternating dashes and gaps expressed in user space units; the numbers shall be nonnegative and not all zero.

Exceptions
System.ArgumentOutOfRangeException

Line dash pattern's phase is negative or not zero if no dashes/gaps are specified.

System.ArgumentException

Line dash pattern's dash/gap is negative or dashes/gaps are all zero or phase or any element of array is either System.Double.NaN, System.Double.NegativeInfinity or System.Double.PositiveInfinity.

Properties

Array

Gets the numbers that specify the lengths of alternating dashes and gaps expressed in user space units; the numbers shall be nonnegative and not all zero.

public readonly IList<double> Array { get; }
Public ReadOnly Property Array As IList(Of Double)
Property Value
System.Collections.Generic.IList<System.Double>

The numbers that specify the lengths of alternating dashes and gaps expressed in user space units.

Phase

Gets the distance into the dash pattern at which to start the dash expressed in user space units.

public readonly double Phase { get; }
Public ReadOnly Property Phase As Double
Property Value
System.Double

The distance into the dash pattern at which to start the dash expressed in user space units.

Methods

Equals(PdfLineDashPattern)

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

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

The other line dash pattern to compare with this line dash pattern instance.

Returns
System.Boolean

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

Equals(Object)

Determines whether the specified System.Object is equal to this PdfLineDashPattern 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 line dash pattern instance.

Returns
System.Boolean

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

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfLineDashPattern instance.

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

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

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this PdfLineDashPattern instance.

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

A System.String that represents this PdfLineDashPattern 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(PdfLineDashPattern, PdfLineDashPattern)

Determines whether first and second PdfLineDashPatterns are equal.

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

The first line dash pattern.

second
PdfLineDashPattern

The second line dash pattern.

Returns
System.Boolean

true if first and second line dash patterns are equal; otherwise, false.

Inequality(PdfLineDashPattern, PdfLineDashPattern)

Determines whether first and second PdfLineDashPatterns are not equal.

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

The first line dash pattern.

second
PdfLineDashPattern

The second line dash pattern.

Returns
System.Boolean

true if first and second line dash patterns are not equal; otherwise, false.

Implements

System.IEquatable<T>

See Also