A PdfString -class is the PDF-equivalent of a JAVA- String -object. More...
Public Member Functions |
|
| PdfString (String value, String encoding) | |
| PdfString (String value) | |
| PdfString (byte[] content) | |
| override byte | GetObjectType () |
| Gets object type. More... |
|
| virtual bool | IsHexWriting () |
| virtual iText.Kernel.Pdf.PdfString | SetHexWriting (bool hexWriting) |
| virtual String | GetValue () |
| virtual String | GetEncoding () |
| Gets the encoding of this string. More... |
|
| virtual String | ToUnicodeString () |
Returns the Unicode String value of this PdfString -object. More... |
|
| virtual byte[] | GetValueBytes () |
| Gets bytes of String-value considering encoding. More... |
|
| override bool | Equals (Object o) |
| override String | ToString () |
| override int | GetHashCode () |
| virtual void | MarkAsUnencryptedObject () |
| Marks this string object as not encrypted in the encrypted document. More... |
|
 Public Member Functions inherited from iText.Kernel.Pdf.PdfPrimitiveObject |
|
| override PdfObject | MakeIndirect (PdfDocument document, PdfIndirectReference reference) |
| Marks object to be saved as indirect. More... |
|
| Public Member Functions inherited from iText.Kernel.Pdf.PdfObject |
|
| void | Flush () |
| Flushes the object to the document. More... |
|
| void | Flush (bool canBeInObjStm) |
| Flushes the object to the document. More... |
|
| virtual PdfIndirectReference | GetIndirectReference () |
| Gets the indirect reference associated with the object. More... |
|
| virtual bool | IsIndirect () |
| Checks if object is indirect. More... |
|
| virtual PdfObject | MakeIndirect (PdfDocument document) |
| Marks object to be saved as indirect. More... |
|
| virtual bool | IsFlushed () |
| Indicates is the object has been flushed or not. More... |
|
| virtual bool | IsModified () |
| Indicates is the object has been set as modified or not. More... |
|
| virtual PdfObject | Clone () |
| Creates clone of the object which belongs to the same document as original object. More... |
|
| virtual PdfObject | Clone (ICopyFilter filter) |
| Creates clone of the object which belongs to the same document as original object. More... |
|
| virtual PdfObject | CopyTo (PdfDocument document) |
| Copies object to a specified document. More... |
|
| virtual PdfObject | CopyTo (PdfDocument document, bool allowDuplicating) |
| Copies object to a specified document. More... |
|
| virtual PdfObject | CopyTo (PdfDocument document, ICopyFilter copyFilter) |
| Copies object to a specified document. More... |
|
| virtual PdfObject | CopyTo (PdfDocument document, bool allowDuplicating, ICopyFilter copyFilter) |
| Copies object to a specified document. More... |
|
| virtual PdfObject | SetModified () |
| Sets the 'modified' flag to the indirect object, the flag denotes that the object was modified since the document opening. More... |
|
| virtual bool | IsReleaseForbidden () |
| Checks if it's forbidden to release this PdfObject instance. More... |
|
| virtual void | Release () |
| virtual bool | IsNull () |
Checks if this PdfObject is of the type PdfNull. More... |
|
| virtual bool | IsBoolean () |
Checks if this PdfObject is of the type PdfBoolean. More... |
|
| virtual bool | IsNumber () |
Checks if this PdfObject is of the type PdfNumber. More... |
|
| virtual bool | IsString () |
Checks if this PdfObject is of the type PdfString. More... |
|
| virtual bool | IsName () |
Checks if this PdfObject is of the type PdfName. More... |
|
| virtual bool | IsArray () |
Checks if this PdfObject is of the type PdfArray. More... |
|
| virtual bool | IsDictionary () |
Checks if this PdfObject is of the type PdfDictionary. More... |
|
| virtual bool | IsStream () |
Checks if this PdfObject is of the type PdfStream. More... |
|
| virtual bool | IsIndirectReference () |
Checks if this PdfObject is of the type PdfIndirectReference. More... |
|
| virtual bool | IsLiteral () |
Checks if this PdfObject is of the type PdfLiteral. More... |
|
Additional Inherited Members |
|
| Static Public Attributes inherited from iText.Kernel.Pdf.PdfObject |
|
| const byte | ARRAY = 1 |
| const byte | BOOLEAN = 2 |
| const byte | DICTIONARY = 3 |
| const byte | LITERAL = 4 |
| const byte | INDIRECT_REFERENCE = 5 |
| const byte | NAME = 6 |
| const byte | NULL = 7 |
| const byte | NUMBER = 8 |
| const byte | STREAM = 9 |
| const byte | STRING = 10 |
Detailed Description
A PdfString -class is the PDF-equivalent of a JAVA- String -object.
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 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.7' section 3.2.3 (page 53-56).
- See also
- PdfObject
Member Function Documentation
◆ GetEncoding()
|
inlinevirtual |
Gets the encoding of this string.
- Returns
- the name of the encoding specifying the byte representation of current PdfString value
◆ GetObjectType()
|
inlinevirtual |
◆ GetValueBytes()
|
inlinevirtual |
Gets bytes of String-value considering encoding.
- Returns
- byte array
◆ MarkAsUnencryptedObject()
|
inlinevirtual |
Marks this string object as not encrypted in the encrypted document.
Marks this string object as not encrypted in the encrypted document.
If it's marked so, it will be considered as already in plaintext and decryption will not be performed for it. In order to have effect, this method shall be called before GetValue() and GetValueBytes() methods.
NOTE: this method is only needed in a very specific cases of encrypted documents. E.g. digital signature dictionary /Contents entry shall not be encrypted. Also this method isn't meaningful in non-encrypted documents.
