PdfEncodedContentString Struct

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

Represents a sequence of character codes, with optionally individually positioned glyphs, that represent a text in a PDF content stream encoded by a PdfBasicFont.

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

This type is a lower-level counterpart of the PdfContentString.

Methods

Create(PdfArray)

Creates a PdfEncodedContentString from the specified PdfArray.

public static PdfEncodedContentString Create(PdfArray value)
Public Shared Function Create(value As PdfArray) As PdfEncodedContentString
Parameters
value
PdfArray

The PdfArray value.

Returns
PdfEncodedContentString

A new PdfEncodedContentString instance.

Exceptions
System.ArgumentNullException

The value is null.

System.ArgumentException

The value is empty.

Create(PdfString)

Creates a PdfEncodedContentString from the specified PdfString.

public static PdfEncodedContentString Create(PdfString value)
Public Shared Function Create(value As PdfString) As PdfEncodedContentString
Parameters
value
PdfString

The PdfString value.

Returns
PdfEncodedContentString

A new PdfEncodedContentString instance.

Exceptions
System.ArgumentNullException

The value is null.

System.ArgumentException

The value is empty.

Equals(PdfEncodedContentString)

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

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

The other content encoded string to compare with this content encoded string instance.

Returns
System.Boolean

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

Equals(Object)

Determines whether the specified System.Object is equal to this PdfEncodedContentString 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 content encoded string instance.

Returns
System.Boolean

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

Overrides
System.ValueType.Equals(System.Object)

GetHashCode()

Returns a hash code for this PdfEncodedContentString instance.

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

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

Overrides
System.ValueType.GetHashCode()

ToString()

Returns a System.String that represents this PdfEncodedContentString instance.

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

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

Determines whether first and second PdfEncodedContentStrings are equal.

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

The first content encoded string.

second
PdfEncodedContentString

The second content encoded string.

Returns
System.Boolean

true if first and second content encoded strings are equal; otherwise, false.

Inequality(PdfEncodedContentString, PdfEncodedContentString)

Determines whether first and second PdfEncodedContentStrings are not equal.

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

The first content encoded string.

second
PdfEncodedContentString

The second content encoded string.

Returns
System.Boolean

true if first and second content encoded strings are not equal; otherwise, false.

Implements

System.IEquatable<T>

Extension Methods

See Also