Obj Class |
Obj is a concrete class for all SDF/Cos objects. Obj hierarchy implements the composite design pattern. As a
result, you can invoke a member function of any 'derived' object through Obj interface. If the member
function is not supported (e.g. if you invoke Obj::GetNumber() on a boolean object) an Exception will be
thrown.
You can use GetType() or obl.Is???() member functions to find out type-information at run time, however most
of the time the type can be inferred from the PDF specification. Therefore when you call Doc::GetTrailer()
you can assume that returned object is a dictionary. If there is any ambiguity use Is???() methods.
Objects can't be shared across documents, however you can use Doc::ImportObj() to copy objects from one
document to another.
Objects can be shared within a document provided that they are created as indirect. Indirect objects are the
ones that are referenced in cross-reference table. To create an object as indirect use
Doc::CreateIndirect???()(where ? is the Object type).
Inheritance HierarchyNamespace: pdftron.SDF
Assembly: pdftron (in pdftron.dll) Version: 255.255.255.255
Syntaxpublic sealed class Obj : IClosable
The Obj type exposes the following members.
Methods| Name | Description | |
|---|---|---|
 | Close | |
| Equals | (Inherited from Object.) |
| Erase(String) |
Removes an element in the dictionary that matches the given key.
|
| Erase(DictIterator) |
Removes an element in the dictionary from specified position.
|
| EraseAt |
Checks whether the position is within the Array bounds and then removes it from the
Array and moves each subsequent element to the slot with the next smaller index and
decrements the Arrays length by 1.
|
 | Find |
Searches this dictionary for a given key.
|
| FindObj |
Searches this dictionary for a given key.
|
| Get |
Searches this dictionary for a given key and throw an exception if the key is not found.
|
| GetAsPDFText |
Convert the SDF/Cos String object to 'PDF Text String'(a Unicode string).
PDF Text Strings are not used to represent page content, however they are used in text annotations,
bookmark names, article names, document information etc. These strings are encoded in either
PDFDocEncoding or Unicode Character encoding. For more information on PDF Text Strings, please refer to
section 3.8.1 'Text Strings' in PDF Reference.
|
| GetAt |
Gets the object from the specified index.
|
| GetBool |
Gets the bool value of this Obj.
|
| GetBuffer |
Gets the buffer of this Obj.
|
| GetDecodedStream |
Gets the decoded stream.
|
| GetDictIterator |
Gets the DictIterator used for traversing the items in this Dict Obj.
|
| GetDoc |
Gets the SDFDoc.
|
| GetGenNum |
Gets the generation number.
|
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetName |
Gets the name value of this Obj.
|
| GetNumber |
Gets the number value of this Obj.
|
| GetObjNum |
Gets the Obj number.
|
| GetOffset |
Gets the offset of this Obj.
|
| GetRawBuffer | Gets the buffer.
|
| GetRawStream |
Gets the raw stream.
|
| GetRawStreamLength |
Gets the raw stream length.
|
| GetType |
Gets the Obj type.
|
| Insert |
Inserts an existing Obj in this Array.
|
| InsertArray |
Inserts an ObjType::e_Array object in the Array.
|
| InsertBool |
Inserts an ObjType::e_bool object in the Array.
|
| InsertDict |
Inserts an ObjType::e_dict object in the Array.
|
| InsertMatrix | |
| InsertName |
Inserts an ObjType::e_name object in the Array.
|
| InsertNull |
Inserts an ObjType::e_null object in the Array.
|
| InsertNumber |
Inserts an ObjType::e_number object in the Array.
|
| InsertRect |
Inserts an Array of 4 numbers in this Array.
|
| InsertString(Int32, Byte) |
Inserts an ObjType::e_string object in the Array.
|
| InsertString(Int32, String) |
Inserts an ObjType::e_string object in the Array.
|
| InsertText |
Inserts an ObjType::e_string object in the Array.
|
| IsArray |
Checks if this Obj is an Array object.
|
| IsBool |
Checks if this Obj is a Bool object.
|
| IsContainer |
Checks if this Obj is a Container object.
|
| IsDict |
Checks if this Obj is a Dictionary object.
|
| IsEqual |
Checks if this Obj is equal to the specified Obj.
|
| IsFree |
Checks if this Obj is free.
|
| IsIndirect |
Checks if this Obj is an Indirect object.
|
| IsLoaded |
Checks if this Obj is loaded in memory.
|
| IsMarked |
Checks if this Obj is marked.
|
| IsName |
Checks if this Obj is a Name object.
|
| IsNull |
Checks if this Obj is a Null object.
|
| IsNumber |
Checks if this Obj is a Number object.
|
| IsStream |
Checks if this Obj is a Stream object.
|
| IsString |
Checks if this Obj is a String object.
|
| PushBack |
Appends an existing Obj at the end of the Array.
|
| PushBackArray |
Appends a new ObjType::e_Array object at the end of the Array.
|
| PushBackBool |
Appends a new ObjType::e_bool object at the end of the Array.
|
| PushBackDict |
Appends a new ObjType::e_dict object at the end of the Array.
|
| PushBackMatrix |
Appends an Array of 6 numbers at the end of the Array.
|
| PushBackName |
Appends a new ObjType::e_name object at the end of the Array.
|
| PushBackNull |
Appends a new ObjType::e_null object at the end of the Array.
|
| PushBackNumber |
Appends a new ObjType::e_number object at the end of the Array.
|
| PushBackRect |
Appends an Array of 4 numbers at the end of the Array.
|
| PushBackString(Byte) |
Appends a new ObjType::e_string object at the end of the Array.
|
| PushBackString(String) |
Appends a new ObjType::e_string object at the end of the Array.
|
| PushBackText |
Appends a new ObjType::e_string object at the end of the Array.
|
| Put |
Inserts a <key, Obj> pair in the dictionary.
|
| PutArray |
Inserts a <key, ObjType::e_Array> pair in the dictionary.
|
| PutBool |
Inserts a <key, ObjType::e_bool> pair in the dictionary.
|
| PutDict |
Inserts a <key, ObjType::e_dict> pair in the dictionary.
|
| PutMatrix |
Inserts a <key, [a,b,c,d,h,v]> pair in the dictionary.
|
| PutName |
Inserts a <key, ObjType::e_name> pair in the dictionary.
|
| PutNull |
Inserts a <key, ObjType::e_null> pair in the dictionary.
|
| PutNumber |
Inserts a <key, ObjType::e_number> pair in the dictionary.
|
| PutRect |
Inserts a <key, [x1,y1,x2,y2]> pair in the dictionary.
|
| PutString(String, Byte) |
Inserts a <key, ObjType::e_string> pair in the dictionary.
|
| PutString(String, String) |
Inserts a <key, ObjType::e_string> pair in the dictionary.
|
| PutText |
Inserts a <key, ObjType::e_string> pair in the dictionary.
|
| Rename |
Change the key value of a dictionary entry. The key can't be renamed if another key with the same name
already exists in the dictionary. In this case, Rename returns false.
|
| SetBool |
Sets the bool value of this Obj.
|
| SetMark |
Set the object mark. Mark is a boolean value that can be associated with every indirect object. This is
especially useful when and object graph should be traversed and an operation should be performed on each
node only once.
|
| SetName |
Sets the name value of this Obj.
|
| SetNumber |
Sets the number value of this Obj.
|
| SetStreamData(Byte) |
Sets the stream data of this Obj. This method allows to replacing the content stream with a new one
without creating a new object.
|
| SetStreamData(Byte, IFilter) |
Sets the stream data of this Obj. This method allows to replacing the content stream with a new one
without creating a new object.
|
| SetString(Byte) |
Sets the string value of this Obj.
|
| SetString(String) |
Sets the string value of this Obj.
|
| Size |
Gets the size of this Obj.
|
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Write |
Writes the Obj to the output stream.
|
See Also