IPWorks OFX 2020 Python Edition

Questions / Feedback?

OFXAggregate Class

Properties   Methods   Events   Configuration Settings   Errors  

The OFXAggregate class supports parsing of XML aggregates that can be retrieved from other classes.

Syntax

class ipworksofx.OFXAggregate

Remarks

The OFXAggregate class supports simple XML aggregate traversal functionality. Simply set the aggregate property to the value received from any aggregate property of any class in the package (e.g. the TxAggregate property from BankStatement or CCStatement). You can then use x_path to walk the Document Object Model (DOM) tree.

Property List


The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

aggregateThe full text of the current aggregate.
namespace_countThe number of records in the Namespace arrays.
namespace_prefixThe Prefix for the Namespace .
namespace_uriNamespace URI associated with the corresponding Prefix .
x_child_countThe number of records in the XChild arrays.
x_child_nameThe Name property provides the local name (without prefix) of the element.
x_child_namespaceNamespace of the element.
x_child_prefixPrefix of the element (if any).
x_child_x_textThe inner text of the element.
x_elementThe name of the current element.
x_namespaceThe namespace of the current element.
x_parentThe parent of the current element.
x_pathProvides a way to point to a specific element in the document.
x_prefixThe prefix of the current element.
x_textThe text of the current element.

Method List


The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

configSets or retrieves a configuration setting.
has_x_pathChecks whether a certain XPath exists inside the aggregate.

Event List


The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

on_errorInformation about errors during data delivery.

Configuration Settings


The following is a list of configuration settings for the class with short descriptions. Click on the links for further details.

CacheContentIf true, the original XML is saved in a buffer.
ErrorOnEmptyAttrIf true, passing an invalid attribute to the Attr method will throw an exception.
IgnoreBadAttributePrefixesIf true, bad (unknown) attribute prefixes are ignored.
IgnoreBadElementPrefixesIf true, bad (unknown) element prefixes are ignored.
PreserveWhitespaceIf true, leading and trailing whitespace in element text is preserved.
BuildInfoInformation about the product's build.
CodePageThe system code page used for Unicode to Multibyte translations.
LicenseInfoInformation about the current license.
ProcessIdleEventsWhether the class uses its internal event loop to process events when the main thread is idle.
SelectWaitMillisThe length of time in milliseconds the class will wait when DoEvents is called if there are no events to process.
UseInternalSecurityAPITells the class whether or not to use the system security libraries or an internal implementation.

Copyright (c) 2021 /n software inc. - All rights reserved.
IPWorks OFX 2020 Python Edition - Version 20.0 [Build 7941]