PdfPortfolioFieldValue Struct

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

Represents a Portfolio field value that provides the data corresponding to the related PdfPortfolioField in the Fields, and it provides a means of associating a prefix string with that data value. The prefix shall be ignored by the sorting algorithm.

public readonly struct PdfPortfolioFieldValue : IEquatable<PdfPortfolioFieldValue>, IFormattable
Public Structure PdfPortfolioFieldValue
    Implements IEquatable(Of PdfPortfolioFieldValue), IFormattable
Implements
System.IEquatable<PdfPortfolioFieldValue>
System.IFormattable

Constructors

PdfPortfolioFieldValue(DateTimeOffset, String)

Initializes a new instance of the PdfPortfolioFieldValue structure from the specified System.DateTimeOffset data and the optional prefix.

public PdfPortfolioFieldValue(DateTimeOffset data, string prefix = null)
Public Sub New(data As DateTimeOffset, prefix As String = Nothing)
Parameters
data
System.DateTimeOffset

The System.DateTimeOffset data.

prefix
System.String

The optional prefix.

PdfPortfolioFieldValue(Double, String)

Initializes a new instance of the PdfPortfolioFieldValue structure from the specified System.Double data and the optional prefix.

public PdfPortfolioFieldValue(double data, string prefix = null)
Public Sub New(data As Double, prefix As String = Nothing)
Parameters
data
System.Double

The System.Double data.

prefix
System.String

The optional prefix.

PdfPortfolioFieldValue(String, String)

Initializes a new instance of the PdfPortfolioFieldValue structure from the specified System.String data and the optional prefix.

public PdfPortfolioFieldValue(string data, string prefix = null)
Public Sub New(data As String, prefix As String = Nothing)
Parameters
data
System.String

The System.String data.

prefix
System.String

The optional prefix.

Exceptions
System.ArgumentNullException

data is null.

Properties

Data

(Optional) The PdfPortfolioFieldValue data. The type of data shall match the data type identified by the DataType property of the corresponding PdfPortfolioField.

Possible types: System.String, System.DateTimeOffset, System.Double, or null.

Default value: null.

public readonly object Data { get; }
Public ReadOnly Property Data As Object
Property Value
System.Object
See Also

Prefix

(Optional) A prefix string that shall be concatenated with the text string presented to the user. This entry is ignored when a conforming reader sorts the items in the collection.

Default value: null.

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

The prefix.

Methods

Equals(PdfPortfolioFieldValue)

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

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

The other Portfolio field value to compare with this Portfolio field value instance.

Returns
System.Boolean

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

Equals(Object)

Determines whether the specified System.Object is equal to this PdfPortfolioFieldValue 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 field value instance.

Returns
System.Boolean

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

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfPortfolioFieldValue 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 PdfPortfolioFieldValue instance.

Overrides
System.ValueType.GetHashCode()

ToString()

Converts the current PdfPortfolioFieldValue to its equivalent string representation.

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

A string representation of a PdfPortfolioFieldValue.

Overrides
System.ValueType.ToString()

ToString(String, IFormatProvider)

Converts the current PdfPortfolioFieldValue to its equivalent string representation using the specified format and culture-specific format information.

public readonly string ToString(string format, IFormatProvider formatProvider)
Public Function ToString(format As String, formatProvider As IFormatProvider) As String
Parameters
format
System.String

A format string.

formatProvider
System.IFormatProvider

An object that supplies culture-specific formatting information.

Returns
System.String

A string representation of the current PdfPortfolioFieldValue, as specified by format and formatProvider.

Operators

Equality(PdfPortfolioFieldValue, PdfPortfolioFieldValue)

Determines whether first and second PdfPortfolioFieldValues are equal.

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

The first Portfolio field value.

second
PdfPortfolioFieldValue

The second Portfolio field value.

Returns
System.Boolean

true if first and second Portfolio field values are equal; otherwise, false.

Inequality(PdfPortfolioFieldValue, PdfPortfolioFieldValue)

Determines whether first and second PdfPortfolioFieldValues are not equal.

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

The first Portfolio field value.

second
PdfPortfolioFieldValue

The second Portfolio field value.

Returns
System.Boolean

true if first and second Portfolio field values are not equal; otherwise, false.

Implements

System.IEquatable<T>
System.IFormattable

Examples

See Also