|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetAttributeValueARGB (type, index) |
| Get an ARGB value (specified by index) for specified attribute type. More... | |
| def | GetAttributeValueCount (type) |
| Get value count of a specified attribute type. More... | |
| def | GetAttributeValueElement (type, index) |
| Get an structure element object (specified by index) for specified attribute type. More... | |
| def | GetAttributeValueEnum (type, index) |
| Get an enum value (specified by index) for specified attribute type. More... | |
| def | GetAttributeValueFloat (type, index) |
| Get a float value (specified by index) for specified attribute type. More... | |
| def | GetAttributeValueInt32 (type, index) |
| Get an integer value (specified by index) for specified attribute type. More... | |
| def | GetAttributeValueString (type, index) |
| Get a string value (specified by index) for specified attribute type. More... | |
| def | GetAttributeValueType (type) |
| Get attribute value type for a specified attribute type. More... | |
| def | GetBBox () |
| Get bounding box. More... | |
| def | GetChild (index) |
| Get a child element by index. More... | |
| def | GetChildCount () |
| Get the count of children elements. More... | |
| def | GetParentElement () |
| Get the parent element. More... | |
| def | GetSupportedAttribute (index) |
| Get a supported attribute type by index. More... | |
| def | GetSupportedAttributeCount () |
| Get supported attribute count. More... | |
This class represents a structure element. A structure element can be used to construct a tree, like graphics structure element, paragraph structure element, span structure element and so on.
| def fsdk.LRStructureElement.GetAttributeValueARGB | ( | type, | |
| index | |||
| ) |
Get an ARGB value (specified by index) for specified attribute type.
This function is available for attributes whose value type is fsdk.LRStructureElementE_AttributeValueTypeARGB or fsdk.LRStructureElementE_AttributeValueTypeARGBArray . For other value type, this function will return 0.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| [in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetAttributeValueCount . |
| def fsdk.LRStructureElement.GetAttributeValueCount | ( | type | ) |
Get value count of a specified attribute type.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| def fsdk.LRStructureElement.GetAttributeValueElement | ( | type, | |
| index | |||
| ) |
Get an structure element object (specified by index) for specified attribute type.
This function is available for attributes whose value type is fsdk.LRStructureElementE_AttributeValueTypeElement or fsdk.LRStructureElementE_AttributeValueTypeElementArray . For other value type, this function will return a structure element whose function LRStructureElement::IsEmpty returns true.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| [in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetAttributeValueCount . |
| def fsdk.LRStructureElement.GetAttributeValueEnum | ( | type, | |
| index | |||
| ) |
Get an enum value (specified by index) for specified attribute type.
This function is available for attributes whose value type is fsdk.LRStructureElementE_AttributeValueTypeEnum or fsdk.LRStructureElementE_AttributeValueTypeEnumArray . For other value type, this function will return fsdk.LRStructureElementE_AttributeValueEnumInvalid .
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| [in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetAttributeValueCount . |
| def fsdk.LRStructureElement.GetAttributeValueFloat | ( | type, | |
| index | |||
| ) |
Get a float value (specified by index) for specified attribute type.
This function is available for attributes whose value type is fsdk.LRStructureElementE_AttributeValueTypeFloat or fsdk.LRStructureElementE_AttributeValueTypeFloatArray . For other value type, this function will return 0.0.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| [in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetAttributeValueCount . |
| def fsdk.LRStructureElement.GetAttributeValueInt32 | ( | type, | |
| index | |||
| ) |
Get an integer value (specified by index) for specified attribute type.
This function is available for attributes whose value type is fsdk.LRStructureElementE_AttributeValueTypeInt32 or fsdk.LRStructureElementE_AttributeValueTypeInt32Array . For other value type, this function will return 0.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| [in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetAttributeValueCount . |
| def fsdk.LRStructureElement.GetAttributeValueString | ( | type, | |
| index | |||
| ) |
Get a string value (specified by index) for specified attribute type.
This function is available for attributes whose value type is fsdk.LRStructureElementE_AttributeValueTypeWStr or fsdk.LRStructureElementE_AttributeValueTypeWStrArray . For other value type, this function will return an empty string.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| [in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetAttributeValueCount . |
| def fsdk.LRStructureElement.GetAttributeValueType | ( | type | ) |
Get attribute value type for a specified attribute type.
| [in] | type | Attribute type. Please refer to values starting from fsdk.LRStructureElementE_AttributeTypeRole and this should be one of these values. |
| def fsdk.LRStructureElement.GetBBox | ( | ) |
Get bounding box.
| def fsdk.LRStructureElement.GetChild | ( | index | ) |
Get a child element by index.
| [in] | index | Index of a child element to be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetChildCount . |
| def fsdk.LRStructureElement.GetChildCount | ( | ) |
Get the count of children elements.
| def fsdk.LRStructureElement.GetParentElement | ( | ) |
Get the parent element.
| def fsdk.LRStructureElement.GetSupportedAttribute | ( | index | ) |
Get a supported attribute type by index.
| [in] | index | Index for a supported attribute whose type is to be retrieved. Valid range: from 0 to (count-1). count is returned by function fsdk.LRStructureElement.GetSupportedAttributeCount . |
| def fsdk.LRStructureElement.GetSupportedAttributeCount | ( | ) |
Get supported attribute count.