PdfString Class

Namespace:
GemBox.Pdf.Objects
Assembly:
GemBox.Pdf.dll

Represents a basic PDF object that consists of a series of zero or more bytes.

public abstract class PdfString : PdfBasicObject, PdfBasicValue, IEnumerable<Byte>, IEnumerable
Public MustInherit Class PdfString
    Inherits PdfBasicObject, PdfBasicValue
    Implements IEnumerable(Of Byte), IEnumerable
Inheritance:
PdfString

Properties

Bytes[Int32]

Gets the Byte value at a specified position in the current PdfString instance.

public byte this[int index] { get; }
Public ReadOnly Property Bytes(index As Integer) As Byte
Parameters
index
Int32

A position in the current PdfString instance.

Property Value
Byte

The Byte value at a specified position in the current PdfString instance.

Exceptions
IndexOutOfRangeException

index is greater than or equal to the Length of this PdfString instance or less than zero.

Form

Gets the form in which this PdfString instance shall be written.

public PdfStringForm Form { get; }
Public ReadOnly Property Form As PdfStringForm
Property Value
PdfStringForm

The form in which this PdfString instance shall be written.

Length

Gets the number of bytes in the current PdfString instance.

public int Length { get; }
Public ReadOnly Property Length As Integer
Property Value
Int32

The number of bytes in the current PdfString instance.

ObjectType

Gets the String value.

public override sealed PdfBasicObjectType ObjectType { get; }
Public NotOverridable Overrides ReadOnly Property ObjectType As PdfBasicObjectType
Property Value
PdfBasicObjectType

The String value.

Overrides

Methods

Create(DateTimeOffset)

Creates the date PdfString instance from the specified DateTimeOffset value.

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

The date value.

Returns
PdfString

A date PdfString instance created from the specified DateTimeOffset value.

See Also

Create(String)

Creates the literal text PdfString instance from the specified String value.

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

The string value.

Returns
PdfString

A literal text PdfString instance created from the specified String value.

Remarks

If all characters from the value can be encoded with PDFDoc encoding, then PDFDoc encoding will be used; otherwise, UTF16BE encoding will be used.

Exceptions
ArgumentNullException

value is null.

See Also

Create(String, IPdfEncoding, PdfStringForm)

Creates the PdfString instance from the specified String value.

public static PdfString Create(string value, IPdfEncoding encoding, PdfStringForm form)
Public Shared Function Create(value As String, encoding As IPdfEncoding, form As PdfStringForm) As PdfString
Parameters
value
String

The string value.

encoding
IPdfEncoding

The encoding used to encode the value.

form
PdfStringForm

The form in which created PdfString instance shall be written.

Returns
PdfString

A PdfString instance created from the specified String value.

Exceptions
ArgumentNullException

value is null or encoding is null.

Equals(Object)

Determines whether the specified Object is equal to this PdfString instance.

public override sealed bool Equals(object obj)
Public NotOverridable Overrides Function Equals(obj As Object) As Boolean
Parameters
obj
Object

The Object to compare with this PdfString instance.

Returns
Boolean

true if the specified Object is equal to this PdfString instance; otherwise, false.

Overrides

GetEnumerator()

Returns an enumerator that iterates through the PdfString.

public PdfString.Enumerator GetEnumerator()
Public Function GetEnumerator As PdfString.Enumerator
Returns
PdfString.Enumerator

GetHashCode()

Returns a hash code for this PdfString instance.

public override sealed int GetHashCode()
Public NotOverridable Overrides Function GetHashCode As Integer
Returns
Int32

A hash code for this PdfString instance, suitable for use in hashing algorithms and data structures like a hash table.

Overrides

ToString()

Returns a String that represents this PdfString instance.

public override sealed string ToString()
Public NotOverridable Overrides Function ToString As String
Returns
String

A String that represents this PdfString instance.

Overrides
Remarks

If the PdfString starts with the 0xFE 0xFF bytes, then UTF16BE encoding will be used; otherwise, if all bytes from this PdfString can be decoded with PDFDoc encoding, then PDFDoc encoding will be used; otherwise, Byte encoding is used.

ToString(IPdfEncoding)

Returns a String that represents this PdfString instance in the specified encoding.

public string ToString(IPdfEncoding encoding)
Public Function ToString(encoding As IPdfEncoding) As String
Parameters
encoding
IPdfEncoding

The encoding used to decode this PdfString instance to String.

Returns
String

A String that represents this PdfString instance in the specified encoding.

Exceptions
ArgumentNullException

encoding is null.

Explicit Interface Implementations

IEnumerable<Byte>.GetEnumerator()

IEnumerator<byte> IEnumerable<byte>.GetEnumerator()
Function g7bkfvtujxjbs2pneyxzq56rp96uzs2l     As IEnumerator(Of Byte) Implements IEnumerable(Of Byte).GetEnumerator
Returns
IEnumerator<Byte>

IEnumerable.GetEnumerator()

IEnumerator IEnumerable.GetEnumerator()
Function g7bkfvtujxjbs2pneyxzq56rp96uzs2l     As IEnumerator Implements IEnumerable.GetEnumerator
Returns
IEnumerator

Implements

Examples

See Also