IPXS_Inst Interface

From Tracker Software PDF SDK
Jump to: navigation, search
(Methods)
Line 11: Line 11:
 
|-
 
|-
 
| [[PXV:IPXS_Inst_AtomToStr|AtomToStr]]
 
| [[PXV:IPXS_Inst_AtomToStr|AtomToStr]]
| ...
+
| Gets the string associated with the specified atom.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_AtomToStrRaw|AtomToStrRaw]]
 
| [[PXV:IPXS_Inst_AtomToStrRaw|AtomToStrRaw]]
| ...
+
| Gets string associated with the specified atom as a raw string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_Create_EncodeFiltersArray|Create_EncodeFiltersArray]]
 
| [[PXV:IPXS_Inst_Create_EncodeFiltersArray|Create_EncodeFiltersArray]]
| ...
+
| Creates empty [[PXV::IPXS_EncodeFiltersArray|IPXS_EncodeFiltersArray]] object.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_CreateCabPDFDataProvider|CreateCabPDFDataProvider]]
 
| [[PXV:IPXS_Inst_CreateCabPDFDataProvider|CreateCabPDFDataProvider]]
| ...
+
| Creates empty Cab Data Provider object that uses PDF as a storage for CAB.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_CreateNewDoc|CreateNewDoc]]
 
| [[PXV:IPXS_Inst_CreateNewDoc|CreateNewDoc]]
| ...
+
| Creates empty [[PXV::IPXS_Document|document]] object.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_GetStreamDecoder|GetStreamDecoder]]
 
| [[PXV:IPXS_Inst_GetStreamDecoder|GetStreamDecoder]]
| ...
+
| Get a stream [[PXV::IPXS_DecodeFilter|decoder]] of specified type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_GetStreamEncoder|GetStreamEncoder]]
 
| [[PXV:IPXS_Inst_GetStreamEncoder|GetStreamEncoder]]
| ...
+
| Get a stream [[PXV::IPXS_EncodeFilter|encoder]] of specified type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_HasAtom|HasAtom]]
 
| [[PXV:IPXS_Inst_HasAtom|HasAtom]]
Line 38: Line 38:
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar|NewVar]]
 
| [[PXV:IPXS_Inst_NewVar|NewVar]]
| Creates new [[PXV::IPXS_PDFVariant|IPXS_PDFVariant]] object of specified type.
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] object based on specified value.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Array|NewVar_Array]]
 
| [[PXV:IPXS_Inst_NewVar_Array|NewVar_Array]]
| Creates new <code>IPXS_PDFVariant</code> with <tt>PVT_ARRAY</tt> type.
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Array]] type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Boolean|NewVar_Boolean]]
 
| [[PXV:IPXS_Inst_NewVar_Boolean|NewVar_Boolean]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Boolean]] type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Dict|NewVar_Dict]]
 
| [[PXV:IPXS_Inst_NewVar_Dict|NewVar_Dict]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Dictinary]] type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Double|NewVar_Double]]
 
| [[PXV:IPXS_Inst_NewVar_Double|NewVar_Double]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Double]] type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_DoubleEx|NewVar_DoubleEx]]
 
| [[PXV:IPXS_Inst_NewVar_DoubleEx|NewVar_DoubleEx]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Double]] type with specified precision.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_FromBuf|NewVar_FromBuf]]
 
| [[PXV:IPXS_Inst_NewVar_FromBuf|NewVar_FromBuf]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] based on its raw representation.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Int|NewVar_Int]]
 
| [[PXV:IPXS_Inst_NewVar_Int|NewVar_Int]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Integer]] type.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Int64|NewVar_Int64]]
 
| [[PXV:IPXS_Inst_NewVar_Int64|NewVar_Int64]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Integer]] type for values exceeds 32-bit integer limits.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Name|NewVar_Name]]
 
| [[PXV:IPXS_Inst_NewVar_Name|NewVar_Name]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Name]] type from string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_NameAtom|NewVar_NameAtom]]
 
| [[PXV:IPXS_Inst_NewVar_NameAtom|NewVar_NameAtom]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Name]] type from atom.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_NameRaw|NewVar_NameRaw]]
 
| [[PXV:IPXS_Inst_NewVar_NameRaw|NewVar_NameRaw]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Name]] type from raw string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Null|NewVar_Null]]
 
| [[PXV:IPXS_Inst_NewVar_Null|NewVar_Null]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Null]].
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_Stream|NewVar_Stream]]
 
| [[PXV:IPXS_Inst_NewVar_Stream|NewVar_Stream]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_Stream]].
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_String|NewVar_String]]
 
| [[PXV:IPXS_Inst_NewVar_String|NewVar_String]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_String]] from string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_NewVar_StringRaw|NewVar_StringRaw]]
 
| [[PXV:IPXS_Inst_NewVar_StringRaw|NewVar_StringRaw]]
| ...
+
| Creates new [[PXV:IPXS_PDFVariant|IPXS_PDFVariant]] with [[PXV:PDFVariantType|PVT_String]] from raw string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_RegisterStreamFilter|RegisterStreamFilter]]
 
| [[PXV:IPXS_Inst_RegisterStreamFilter|RegisterStreamFilter]]
| ...
+
| Add specified [[PXV:IPXS_DecodeFilter|filter] to the list of registered filters.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_StrToAtom|StrToAtom]]
 
| [[PXV:IPXS_Inst_StrToAtom|StrToAtom]]
| ...
+
| Gets atom for the specified string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_StrToAtomRaw|StrToAtomRaw]]
 
| [[PXV:IPXS_Inst_StrToAtomRaw|StrToAtomRaw]]
| ...
+
| Gets atom for the specified raw string.
 
|-
 
|-
 
| [[PXV:IPXS_Inst_UnregisterStreamFilter|UnregisterStreamFilter]]
 
| [[PXV:IPXS_Inst_UnregisterStreamFilter|UnregisterStreamFilter]]
| ...
+
| Remove specified [[PXV:IPXS_DecodeFilter|filter] from the list of registered filters.
 
|}
 
|}

Revision as of 15:04, 29 March 2015

The interface of object of PDF-XChange Editor SDK.

Methods

Method Description
AtomToStr Gets the string associated with the specified atom.
AtomToStrRaw Gets string associated with the specified atom as a raw string.
Create_EncodeFiltersArray Creates empty IPXS_EncodeFiltersArray object.
CreateCabPDFDataProvider Creates empty Cab Data Provider object that uses PDF as a storage for CAB.
CreateNewDoc Creates empty document object.
GetStreamDecoder Get a stream decoder of specified type.
GetStreamEncoder Get a stream encoder of specified type.
HasAtom Tests whether an atom exists for the specified string
HasAtomRaw Tests whether an atom exists for the specified raw string
NewVar Creates new IPXS_PDFVariant object based on specified value.
NewVar_Array Creates new IPXS_PDFVariant with PVT_Array type.
NewVar_Boolean Creates new IPXS_PDFVariant with PVT_Boolean type.
NewVar_Dict Creates new IPXS_PDFVariant with PVT_Dictinary type.
NewVar_Double Creates new IPXS_PDFVariant with PVT_Double type.
NewVar_DoubleEx Creates new IPXS_PDFVariant with PVT_Double type with specified precision.
NewVar_FromBuf Creates new IPXS_PDFVariant based on its raw representation.
NewVar_Int Creates new IPXS_PDFVariant with PVT_Integer type.
NewVar_Int64 Creates new IPXS_PDFVariant with PVT_Integer type for values exceeds 32-bit integer limits.
NewVar_Name Creates new IPXS_PDFVariant with PVT_Name type from string.
NewVar_NameAtom Creates new IPXS_PDFVariant with PVT_Name type from atom.
NewVar_NameRaw Creates new IPXS_PDFVariant with PVT_Name type from raw string.
NewVar_Null Creates new IPXS_PDFVariant with PVT_Null.
NewVar_Stream Creates new IPXS_PDFVariant with PVT_Stream.
NewVar_String Creates new IPXS_PDFVariant with PVT_String from string.
NewVar_StringRaw Creates new IPXS_PDFVariant with PVT_String from raw string.
RegisterStreamFilter Add specified [[PXV:IPXS_DecodeFilter|filter] to the list of registered filters.
StrToAtom Gets atom for the specified string.
StrToAtomRaw Gets atom for the specified raw string.
UnregisterStreamFilter Remove specified [[PXV:IPXS_DecodeFilter|filter] from the list of registered filters.