PdfPortfolioSortLevel Struct

Namespace:
GemBox.Pdf.Portfolios
Assembly:
GemBox.Pdf.dll

Represents settings for a single sort level of a PdfPortfolio.

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

Constructors

PdfPortfolioSortLevel(PdfName, Boolean)

Initializes a new instance of the PdfPortfolioSortLevel structure from the specified PdfName key of the PdfPortfolioField in the Fields and the optional ordering preference.

public PdfPortfolioSortLevel(PdfName fieldKey, bool ascending = true)
Public Sub New(fieldKey As PdfName, ascending As Boolean = True)
Parameters
fieldKey
PdfName

The PdfName key of the PdfPortfolioField in the Fields by which PdfFileSpecification and PdfPortfolioFolder in the PdfPortfolio are sorted.

ascending
System.Boolean

true to sort the values in the ascending order; otherwise, false.

Properties

Ascending

Gets a value indicating whether to sort the values in the ascending order.

public readonly bool Ascending { get; }
Public ReadOnly Property Ascending As Boolean
Property Value
System.Boolean

true to sort the values in the ascending order; otherwise, false.

FieldKey

Gets the PdfName key of the PdfPortfolioField in the Fields by which PdfFileSpecification and PdfPortfolioFolder in the PdfPortfolio are sorted.

public readonly PdfName FieldKey { get; }
Public ReadOnly Property FieldKey As PdfName
Property Value
PdfName

The PdfName key of the PdfPortfolioField in the Fields by which PdfFileSpecification and PdfPortfolioFolder in the PdfPortfolio are sorted.

Methods

Equals(PdfPortfolioSortLevel)

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

public readonly bool Equals(PdfPortfolioSortLevel other)
Public Function Equals(other As PdfPortfolioSortLevel) As Boolean
Parameters
other
PdfPortfolioSortLevel

The other Portfolio sort level to compare with this Portfolio sort level instance.

Returns
System.Boolean

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

Equals(Object)

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

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

The System.Object to compare with this Portfolio sort level instance.

Returns
System.Boolean

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

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfPortfolioSortLevel instance.

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

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

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this PdfPortfolioSortLevel instance.

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

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

Determines whether first and second PdfPortfolioSortLevels are equal.

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

The first Portfolio sort level.

second
PdfPortfolioSortLevel

The second Portfolio sort level.

Returns
System.Boolean

true if first and second Portfolio sort levels are equal; otherwise, false.

Inequality(PdfPortfolioSortLevel, PdfPortfolioSortLevel)

Determines whether first and second PdfPortfolioSortLevels are not equal.

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

The first Portfolio sort level.

second
PdfPortfolioSortLevel

The second Portfolio sort level.

Returns
System.Boolean

true if first and second Portfolio sort levels are not equal; otherwise, false.

Implements

System.IEquatable<T>

See Also