Click or drag to resize

Altova.RaptorXml.Xbrl Namespace

The Altova.RaptorXml.Xbrl namespace provides a .NET API for the XBRL 2.1 specification.

This .NET interface enables the user to navigate the XBRL instance document and access information from any fact item or tuple.

Classes
  ClassDescription
Public classArcroleRefCollection
The ArcroleRefCollection class represents a collection of ArcroleRef objects.
Public classAspect

The Aspect enumeration represents the various aspects defined in the Variables 1.0 specification. See here for more details.

Please note that the dimension aspects are represented as instances of the Dimension.

Public classAspectSet

AspectSet()

An AspectSet class represents a set of XBRL aspects represented by Aspect and Dimension classes.

Public classAspectValue

AspectValue

The AspectValue class represents the base class for all types of aspect values.

Public classAttributeValuesDictionary
The AttributeValuesDictionary class represents a collection of attributes and their corresponding values. It is implemented as a dictionary of attribute QNames (QName) to string values.
Public classConceptAspectValue

ConceptAspectValue(Concept concept)

An ConceptAspectValue class represents a particular value for the concept aspect.

Public classConstants

Constants()

The Constants class defines constants for common namespaces.

Public classConstraintSet

ConstraintSet(constraints=None)

An ConstraintSet class represents a set of XBRL aspect constraints. For each aspect a constraint with an aspect value can be set. When a constraint set is passed to the Filter(QName, Context, Unit, Boolean)() method, facts that don't match the specified aspect values will be filtered out.

Public classContext

Context()

An Context class represents an XBRL context in the XBRL instance.

Public classContextEntityData

__Entity()

An ContextEntityData class represents an <xbrli:entity> element with an XBRL context in the XBRL instance.

Public classContextEntityDataIdentifierData
Public classContextEntityDataSegmentData
Public classContextPeriodData

__Period()

An ContextPeriodData class represents a <xbrli:period> element with an XBRL context in the XBRL instance.

Public classContextPeriodDataEndDateData
Public classContextPeriodDataForeverData
Public classContextPeriodDataInstantData
Public classContextPeriodDataStartDateData
Public classContextScenarioData

__Scenario()

An ContextScenarioData class represents a <xbrli:scenario> element with an XBRL context in the XBRL instance.

Public classContextCollection
The ContextCollection class represents a collection of Context objects.
Public classContextDimensionAspectValueCollection
The ContextDimensionAspectValueCollection class represents a collection of DimensionAspectValue objects.
Public classContextExplicitDimensionAspectValueCollection
Public classContextTypedDimensionAspectValueCollection
The ContextTypedDimensionAspectValueCollection class represents a collection of TypedDimensionAspectValue objects.
Public classDecimals

Decimals

The Decimals class represents the value of the @decimals attribute on an XBRL numeric fact.

Public classDimensionAspectValue

DimensionAspectValue

The DimensionAspectValue class represents the base class for explicit and typed dimension aspect values.

Public classDimensionAspectValueCollection
The DimensionAspectValueCollection class represents a collection of DimensionAspectValue objects.
Public classDomainMemberList
The DomainMemberList class represents a list of Item objects.
Public classDomainMemberListDomainMemberListEnumerator
Public classDuplicateFactSet

DuplicateFactSet()

A DuplicateFactSet class represents a set of duplicate XBRL facts in an instance.

Public classDuplicateFactSetCollection
The DuplicateFactSetCollection class represents a collection of DuplicateFactSet objects.
Public classEntityIdentifierAspectValue

EntityIdentifierAspectValue(unicode identifier, unicode scheme)

An EntityIdentifierAspectValue class represents a particular value for the entity identifier aspect.

Public classEnumerationValueCollection
The EnumerationValueCollection class represents a collection of Item objects.
Public classExplicitDimensionAspectValue

ExplicitDimensionAspectValue(Dimension dim, Item value=None)

An ExplicitDimensionAspectValue class represents a particular value for the dimension aspect of explicit dimensions.

Public classExplicitDimensionAspectValueCollection
The ExplicitDimensionAspectValueCollection class represents a collection of ExplicitDimensionAspectValue objects.
Public classFact

Fact()

An Fact class represents a fact in an XBRL instance document.

Public classFactSet

FactSet(facts=None)

A FactSet class represents a set of XBRL facts in an instance.

Public classFactSetConceptAspectValueCollection
The FactSetConceptAspectValueCollection class represents a collection of ConceptAspectValue objects.
Public classFactSetDimensionAspectValueCollection
The FactSetDimensionAspectValueCollection class represents a collection of DimensionAspectValue objects.
Public classFactSetEntityIdentifierAspectValueCollection
Public classFactSetNonXdtScenarioAspectValueCollection
The FactSetNonXdtScenarioAspectValueCollection class represents a collection of ScenarioAspectValue objects.
Public classFactSetNonXdtSegmentAspectValueCollection
The FactSetNonXdtSegmentAspectValueCollection class represents a collection of SegmentAspectValue objects.
Public classFactSetPeriodAspectValueCollection
The FactSetPeriodAspectValueCollection class represents a collection of PeriodAspectValue objects.
Public classFactSetUnitAspectValueCollection
The FactSetUnitAspectValueCollection class represents a collection of UnitAspectValue objects.
Public classFootnoteCollection
The FootnoteCollection class represents a collection of Footnote objects.
Public classFootnoteLinkCollection
The FootnoteLinkCollection class represents a collection of ExtendedLink objects.
Public classFootnoteRelationshipCollection
The FootnoteRelationshipCollection class represents a collection of FootnoteRelationship objects.
Public classFraction

Fraction

The Fraction class represents the value of XBRL fraction numeric facts.

Public classInlineXbrlDocumentSet

InlineXBRLDocumentSet()

An InlineXbrlDocumentSet object represents an Inline XBRL document set.

Public classInlineXBRLReportBuilder
Public classInlineXbrlSettings

InlineXbrlSettings

The InlineXbrlSettings class allows to modify the settings used to validate and transform Inline XBRL documents.

Public classInlineXbrlTargetDocumentDictionary
The InlineXbrlTargetDocumentDictionary class represents the ouptput of an Inline XBRL transformation. It is implemented as a dictionary of target names to the output XML document (DocumentInformationItem).
Public classInlineXbrlTargetInstanceDictionary
The InlineXbrlTargetInstanceDictionary class represents the ouptput of an Inline XBRL transformation. It is implemented as a dictionary of target names to the output XBRL instance (Instance).
Public classInlineXbrlTransformationRegistry

InlineXBRLTransformationRegistry()

An InlineXbrlTransformationRegistry object represents a set of InlineXbrlTransformFunction.

Public classInlineXbrlTransformFunction

InlineXBRLTransformFunction()

An InlineXbrlTransformFunction object represents one Transformation defined in an Inline XBRL Transformation Registry.

Public classInlineXbrlValidationSettings

InlineXbrlValidationSettings

The InlineXbrlValidationSettings class allows to modify the settings used to validate Inline XBRL documents.

Public classInstance

Instance()

An Instance object represents an XBRL instance document.

Public classInstanceDocumentBuilder

InstanceDocumentBuilder(DTS dts, add_generated_by_comment=True, add_xbrl_root_element=True, add_dts_references=False)

The InstanceDocumentBuilder class provides a high-level API to construct new XBRL instance documents.

Public classInstanceSettings

InstanceSettings

The InstanceSettings class allows to modify the settings used to load and validate XBRL instance documents.

Public classInstanceValidationSettings

InstanceValidationSettings

The InstanceValidationSettings class allows to modify the settings used to validate XBRL instance documents.

Public classItem

Item()

An Item class represents an item in an XBRL instance document.

Public classIXTVersionDictionary
Public classLinkbaseRefCollection
The LinkbaseRefCollection class represents a collection of LinkbaseRef objects.
Public classLocationAspectValue

LocationAspectValue()

An LocationAspectValue class represents a particular value for the location aspect.

Public classMeasureCollection
Public classNonXdtElementCollection
The NonXdtElementCollection class represents a collection of ElementInformationItem objects.
Public classOccAspectValue

OccAspectValue

The OccAspectValue class represents the base class for segment and scenario aspect values.

Public classOccElementCollection
The OccElementCollection class represents a collection of ElementInformationItem objects.
Public classPeriodAspectValue

PeriodAspectValue()

An PeriodAspectValue class represents a particular value for the period aspect.

Public classPrecision

Precision

The Precision class represents the value of the @precision attribute on an XBRL numeric fact.

Public classQNameCollection
The QNameCollection class represents a collection of QName objects.
Public classReportInfo

ReportInfo()

An ReportInfo object represents an XBRL report within a report package.

Public classReportInfoCollection
The ReportInfoCollection class represents a collection of ReportInfo objects.
Public classReportPackage

ReportPackage()

An ReportPackage object represents an XBRL report package.

Public classReportPackageBuilder

ReportPackageBuilder(top_level_directory_name, report_package_type, catalog=None, *, **kargs)

The ReportPackageBuilder specifies an interface to create XBRL Report Packages.

Public classReportPackageSettings
Public classRoleRefCollection
The RoleRefCollection class represents a collection of RoleRef objects.
Public classScenarioAspectValue

ScenarioAspectValue(elements=None)

An ScenarioAspectValue class represents a particular value for the scenario aspect.

Public classSchemaRefCollection
The SchemaRefCollection class represents a collection of SchemaRef objects.
Public classSegmentAspectValue

SegmentAspectValue(elements=None)

An SegmentAspectValue class represents a particular value for the segment aspect.

Public classTransformationRegistryList
The TransformationRegistryList class represents a list of transformation registry URIs.
Public classTuple

Tuple()

An Tuple class represents a tuple in an XBRL instance document.

Public classTypedDimensionAspectValue

TypedDimensionAspectValue(Dimension dim, ElementInformationItem value=None)

An TypedDimensionAspectValue class represents a particular value for the dimension aspect of typed dimensions.

Public classTypedDimensionAspectValueCollection
The TypedDimensionAspectValueCollection class represents a collection of TypedDimensionAspectValue objects.
Public classUnit

Unit()

An Unit class represents an XBRL unit in the XBRL instance.

Public classUnitMeasureData

__Measure()

An UnitMeasureData class represents a <xbrli:measure> element with an XBRL unit in an XBRL instance.

Public classUnitAspectValue

UnitAspectValue(numerator, denominator=None)

An UnitAspectValue class represents a particular value for the unit aspect.

Public classUnitCollection
The UnitCollection class represents a collection of Unit objects.
Public classUnitsRegistry

UnitsRegistry()

An UnitsRegistry object represents an XBRL Units Registry.

Public classUnitsRegistryUnitData

__utr_Unit()

This class represents the <utr:unit> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataBaseStandardData

__utr_BaseStandard()

This class represents the <utr:baseStandard> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataConversionContentData

__utr_ConversionContent()

This class represents the <utr:conversionContent> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataConversionPresentationData

__utr_ConversionPresentation()

This class represents the <utr:conversionPresentation> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataDefinitionData

__utr_Definition()

This class represents the <utr:definition> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataDenominatorItemTypeData

__utr_DenominatorItemType()

This class represents the <utr:denominatorItemType> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataItemTypeData

__utr_ItemType()

This class represents the <utr:itemType> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataItemTypeDateData

__utr_ItemTypeDate()

This class represents the <utr:itemTypeDate> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataNsDenominatorItemTypeData

__utr_NsDenominatorItemType()

This class represents the <utr:nsDenominatorItemType> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataNsItemTypeData

__utr_NsItemType()

This class represents the <utr:nsItemType> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataNsNumeratorItemTypeData

__utr_NsNumeratorItemType()

This class represents the <utr:nsNumeratorItemType> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataNsUnitData

__utr_NsUnit()

This class represents the <utr:nsUnit> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataNumeratorItemTypeData

__utr_NumeratorItemType()

This class represents the <utr:numeratorItemType> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataStatusData

__utr_Status()

This class represents the <utr:status> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataSymbolData

__utr_Symbol()

This class represents the <utr:symbol> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataUnitIdData

__utr_UnitId()

This class represents the <utr:unitId> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataUnitNameData

__utr_UnitName()

This class represents the <utr:unitName> element in the Units Registry utr.xml file.

Public classUnitsRegistryUnitDataVersionDateData

__utr_VersionDate()

This class represents the <utr:versionDate> element in the Units Registry utr.xml file.

Public classUnitsRegistrySettings

UnitsRegistrySettings

The UnitsRegistrySettings class allows to modify the settings used to load XBRL Units Registries.

Public classUnitsRegistryStatusList
The UnitsRegistryStatusList class represents a list of String objects.
Public classUnitsRegistryUnitCollection
Public classXPathExpression

XPathExpression()

A XPathExpression class represents an XPath expression in the DTS.

Enumerations
  EnumerationDescription
Public enumerationAspectType

AspectType

The AspectType enumeration represents the different types of aspects defined by the non-dimensional and dimensional aspect models.

Public enumerationCalc11RoundingMode
Public enumerationCalculationsMode
Public enumerationDuplicateClass

DuplicateClass

The DuplicateClass enum represents the various classes of duplicates defined in the Handling Duplicate Facts in XBRL and Inline XBRL 1.0 working group note. See here for more details.

Public enumerationInlineXbrlVersion

InlineXbrlVersion

The InlineXbrlVersion enum indicates the version of the Inline XBRL specification that should be used to validate and tranform Inline XBRL instance documents.

Public enumerationInlineXbrlWhitespace

InlineXbrlWhitespace

The InlineXbrlWhitespace enum indicates the default whitespace normalization during transformation of Inline XBRL tags.

Public enumerationPeriodType

The PeriodType enumeration represents the various possible choices how date intervals can be represented in an XBRL instance. See here for more details.

Public enumerationReportPackageType

The ReportPackageType enumeration specifies the type of the report package. See here for more details.

Public enumerationReportType

The ReportType enumeration specifies the type of report. See here for more details.

Public enumerationUriTransformationStrategy

UriTransformationStrategy

The UriTransformationStrategy enum allows to specify how uris in source documents should be copied to generated output documents.

See Also