HiraokaHyperTools.iTextSharp-LGPL  0.2.5
Public Member Functions | Protected Attributes | Properties | List of all members
iTextSharp.text.pdf.PdfString Class Reference
Inheritance diagram for iTextSharp.text.pdf.PdfString:
iTextSharp.text.pdf.PdfObject iTextSharp.text.pdf.PdfDate

Public Member Functions

 PdfString ()
 
 PdfString (string value)
 
 PdfString (string value, string encoding)
 
 PdfString (byte[] bytes)
 
override void ToPdf (PdfWriter writer, Stream os)
 
override string ToString ()
 
String ToUnicodeString ()
 
override byte[] GetBytes ()
 
byte[] GetOriginalBytes ()
 
PdfString SetHexWriting (bool hexWriting)
 
bool IsHexWriting ()
 
- Public Member Functions inherited from iTextSharp.text.pdf.PdfObject
bool CanBeInObjStm ()
 
override string ToString ()
 
bool IsNull ()
 
bool IsBoolean ()
 
bool IsNumber ()
 
bool IsString ()
 
bool IsName ()
 
bool IsArray ()
 
bool IsDictionary ()
 
bool IsStream ()
 
bool IsIndirect ()
 

Protected Attributes

string value = NOTHING
 
string originalValue = null
 
string encoding = TEXT_PDFDOCENCODING
 
int objNum = 0
 
int objGen = 0
 
bool hexWriting = false
 
- Protected Attributes inherited from iTextSharp.text.pdf.PdfObject
byte[] bytes
 
int type
 
PRIndirectReference indRef
 

Properties

string Encoding [get]
 
- Properties inherited from iTextSharp.text.pdf.PdfObject
int Length [get]
 
string Content [set]
 
int Type [get]
 
PRIndirectReference IndRef [get, set]
 

Additional Inherited Members

- Static Public Attributes inherited from iTextSharp.text.pdf.PdfObject
const int BOOLEAN = 1
 
const int NUMBER = 2
 
const int STRING = 3
 
const int NAME = 4
 
const int ARRAY = 5
 
const int DICTIONARY = 6
 
const int STREAM = 7
 
const int NULL = 8
 
const int INDIRECT = 10
 
const string NOTHING = ""
 
const string TEXT_PDFDOCENCODING = "PDF"
 
const string TEXT_UNICODE = "UnicodeBig"
 
- Protected Member Functions inherited from iTextSharp.text.pdf.PdfObject
 PdfObject (int type)
 
 PdfObject (int type, string content)
 
 PdfObject (int type, byte[] bytes)
 

Detailed Description

A PdfString-class is the PDF-equivalent of a JAVA-string-object.

A string is a sequence of characters delimited by parenthesis. If a string is too long to be conveniently placed on a single line, it may be split across multiple lines by using the backslash character () at the end of a line to indicate that the string continues on the following line. Within a string, the backslash character is used as an escape to specify unbalanced parenthesis, non-printing ASCII characters, and the backslash character itself. Use of the <I>ddd escape sequence is the preferred way to represent characters outside the printable ASCII character set.
This object is described in the 'Portable Document Format Reference Manual version 1.3' section 4.4 (page 37-39).

See also
PdfObject
BadPdfFormatException

Constructor & Destructor Documentation

◆ PdfString() [1/4]

iTextSharp.text.pdf.PdfString.PdfString ( )

Constructs an empty PdfString-object.

◆ PdfString() [2/4]

iTextSharp.text.pdf.PdfString.PdfString ( string  value)

Constructs a PdfString-object.

Parameters
valuethe content of the string

◆ PdfString() [3/4]

iTextSharp.text.pdf.PdfString.PdfString ( string  value,
string  encoding 
)

Constructs a PdfString-object.

Parameters
valuethe content of the string
encodingan encoding

◆ PdfString() [4/4]

iTextSharp.text.pdf.PdfString.PdfString ( byte[]  bytes)

Constructs a PdfString-object.

Parameters
bytesan array of byte

Member Function Documentation

◆ GetBytes()

override byte [] iTextSharp.text.pdf.PdfString.GetBytes ( )
virtual

Gets the presentation of this object in a byte array

Returns
a byte array

Reimplemented from iTextSharp.text.pdf.PdfObject.

◆ GetOriginalBytes()

byte [] iTextSharp.text.pdf.PdfString.GetOriginalBytes ( )

◆ IsHexWriting()

bool iTextSharp.text.pdf.PdfString.IsHexWriting ( )

◆ SetHexWriting()

PdfString iTextSharp.text.pdf.PdfString.SetHexWriting ( bool  hexWriting)

◆ ToPdf()

override void iTextSharp.text.pdf.PdfString.ToPdf ( PdfWriter  writer,
Stream  os 
)
virtual

Returns the PDF representation of this PdfString.

Returns
an array of bytes

Reimplemented from iTextSharp.text.pdf.PdfObject.

◆ ToString()

override string iTextSharp.text.pdf.PdfString.ToString ( )

Returns the string value of the PdfString-object.

Returns
a string

◆ ToUnicodeString()

String iTextSharp.text.pdf.PdfString.ToUnicodeString ( )

Member Data Documentation

◆ encoding

string iTextSharp.text.pdf.PdfString.encoding = TEXT_PDFDOCENCODING
protected

The encoding.

◆ hexWriting

bool iTextSharp.text.pdf.PdfString.hexWriting = false
protected

◆ objGen

int iTextSharp.text.pdf.PdfString.objGen = 0
protected

◆ objNum

int iTextSharp.text.pdf.PdfString.objNum = 0
protected

◆ originalValue

string iTextSharp.text.pdf.PdfString.originalValue = null
protected

◆ value

string iTextSharp.text.pdf.PdfString.value = NOTHING
protected

The value of this object.

Property Documentation

◆ Encoding

string iTextSharp.text.pdf.PdfString.Encoding
get

Gets the encoding of this string.

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