PdfSharp-GDI  1.31.7289
PdfSharp.Pdf.PdfStringObject Class Reference

Represents an indirect text string value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object. More...

Inheritance diagram for PdfSharp.Pdf.PdfStringObject:
PdfSharp.Pdf.PdfObject PdfSharp.Pdf.PdfItem

Public Member Functions

 PdfStringObject ()
 Initializes a new instance of the PdfStringObject class. More...
 
 PdfStringObject (PdfDocument document, string value)
 Initializes a new instance of the PdfStringObject class. More...
 
 PdfStringObject (string value, PdfStringEncoding encoding)
 Initializes a new instance of the PdfStringObject class. More...
 
override string ToString ()
 Returns the string. More...
 
- Public Member Functions inherited from PdfSharp.Pdf.PdfObject
new PdfObject Clone ()
 Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. More...
 
- Public Member Functions inherited from PdfSharp.Pdf.PdfItem
PdfItem Clone ()
 Creates a copy of this object. More...
 

Properties

int? Length [get]
 Gets the number of characters in this string. More...
 
PdfStringEncoding Encoding [get, set]
 Gets or sets the encoding. More...
 
bool? HexLiteral [get, set]
 Gets a value indicating whether the string is a hexadecimal literal. More...
 
string???? Value [get, set]
 Gets or sets the value as string More...
 
- Properties inherited from PdfSharp.Pdf.PdfObject
virtual PdfDocument Owner [get]
 Gets the PdfDocument this object belongs to. More...
 
bool IsIndirect [get]
 Indicates whether the object is an indirect object. More...
 
PdfObjectInternals Internals [get]
 Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument. More...
 
PdfReference Reference [get, set]
 Gets the indirect reference of this object. If the value is null, this object is a direct object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PdfSharp.Pdf.PdfObject
 PdfObject ()
 Initializes a new instance of the PdfObject class. More...
 
 PdfObject (PdfDocument document)
 Initializes a new instance of the PdfObject class. More...
 
 PdfObject (PdfObject obj)
 Initializes a new instance from an existing object. Used for object type transformation. More...
 
override object Copy ()
 Implements the copy mechanism. Must be overridden in derived classes. More...
 

Detailed Description

Represents an indirect text string value. This type is not used by PDFsharp. If it is imported from an external PDF file, the value is converted into a direct object.

Constructor & Destructor Documentation

◆ PdfStringObject() [1/3]

PdfSharp.Pdf.PdfStringObject.PdfStringObject ( )

Initializes a new instance of the PdfStringObject class.

◆ PdfStringObject() [2/3]

PdfSharp.Pdf.PdfStringObject.PdfStringObject ( PdfDocument  document,
string  value 
)

Initializes a new instance of the PdfStringObject class.

Parameters
documentThe document.
valueThe value.

◆ PdfStringObject() [3/3]

PdfSharp.Pdf.PdfStringObject.PdfStringObject ( string  value,
PdfStringEncoding  encoding 
)

Initializes a new instance of the PdfStringObject class.

Parameters
valueThe value.
encodingThe encoding.

Member Function Documentation

◆ ToString()

override string PdfSharp.Pdf.PdfStringObject.ToString ( )

Returns the string.

Property Documentation

◆ Encoding

PdfStringEncoding PdfSharp.Pdf.PdfStringObject.Encoding
getset

Gets or sets the encoding.

◆ HexLiteral

bool? PdfSharp.Pdf.PdfStringObject.HexLiteral
getset

Gets a value indicating whether the string is a hexadecimal literal.

◆ Length

int? PdfSharp.Pdf.PdfStringObject.Length
get

Gets the number of characters in this string.

◆ Value

string???? PdfSharp.Pdf.PdfStringObject.Value
getset

Gets or sets the value as string


The documentation for this class was generated from the following file: