AJE Components
Report MembersAJE Data Report Engine Help

The Report type exposes the following members.
Constructors

  NameDescription
Public methodReport
Initializes a new instance of the Report class
Back to Top
Methods

  NameDescription
Public methodClear
Clears the Report Data and Log.
Public methodClearData
Clears the Report Data.
Protected methodClearIndexes
Public methodClone 
Clone the object, and returning a reference to a cloned object.
(Inherited from EngineClassBase.)
Public methodClose
Closes the Report and Data Source.
Public methodCopyItem
Function Copies the Report Item.
Public methodCopyObject
Creates a copy of the current Object.
(Inherited from EngineClassBase.)
Public methodCopyProperties(Boolean)
Copies the Properties of the current Object.
(Inherited from EngineClassBase.)
Public methodCopyProperties(EngineClassBase, Boolean)
Copies the Properties of the supplied Object.
(Inherited from EngineClassBase.)
Public methodCopyProperties T1, T2 (T1, T2)
Copies the Properties by Name of the Source Object to the Destination Object.
(Inherited from EngineClassBase.)
Public methodDeepClone
Creates a deep clone of the current object.
(Inherited from EngineClassBase.)
Public methodDeepCopy
Creates a deep copy of the current Object.
(Inherited from EngineClassBase.)
Public methodDeserialize(TextReader)
Deserializes to an instance of EngineClassBase.
(Inherited from EngineClassBase.)
Public methodDeserialize(String)
Deserializes to an instance of EngineClassBase.
(Inherited from EngineClassBase.)
Public methodDeserialize(XmlDocument)
Deserializes to an instance of EngineClassBase.
(Inherited from EngineClassBase.)
Public methodDeserializeFile(String)
Deserializes the specified XML File.
(Inherited from EngineClassBase.)
Public methodDeserializeFile(String, Encoding)
Deserializes the specified XML File.
(Inherited from EngineClassBase.)
Public methodDeSerializeMe
Deserializes the XML String.
(Inherited from EngineClassBase.)
Public methodDispose 
Releases all resources used by the Object.
(Inherited from EngineClassBase.)
Protected methodDispose(Boolean)
Releases all resources used by the Object.
(Inherited from EngineClassBase.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodEvaluatePython(String, XdmItem, ReportNamespace)
Public methodEvaluatePython(String, String, ReportNamespace)
Public methodEvaluatePython(String, XdmItem, String, String)
Public methodEvaluatePython(String, String, XdmItem, ReportNamespace, String)
Function Evaluates the Query using Python.
Public methodEvaluateXPath
Function Evaluates an XPath Expression.
Public methodEvaluateXQuery(String, XdmItem, ReportNamespace)
Function Evaluates an XQuery Expression.
Public methodEvaluateXQuery(String, XdmItem, String, String)
Function Evaluates an XQuery Expression.
Public methodEvaluateXQuery(String, String, XdmItem, ReportNamespace, String)
Function Evaluates the XQuery.
Public methodEvaluateXQuery(String, String, XdmItem, String, String)
Protected methodOnlineFinalize
Allows an OnlineObject to attempt to free resources and perform other cleanup operations before the OnlineObject is reclaimed by garbage collection.
(Inherited from OnlineObject.)
Public methodGetDataContext
Function gets the Shared Report Data Source Context.
Public methodGetDataFormat
Function gets the Data Format Object for specified Name.
Public methodGetDataFormats
Public methodGetDataLocation
Gets the Location of the Report Data File.
Public methodGetDataXML
Function gets the Data XML for the Report.
Public methodGetDefaultNamespace
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetLicenseData
Public methodGetNamespace
Function gets the Namespace Object for specified Name.
Public methodGetPath
Gets the Path of the Report File.
Public methodGetPropertyNames
Function Gets the Names of the Member Properties.
(Inherited from EngineClassBase.)
Public methodGetQuery(String)
Function gets the shared Query Content.
Public methodGetQuery(ReportQuery)
Parses the Content for the Queries.
Public methodGetQuery(String, String)
Gets the Content for the Queries.
Public methodGetQuery(String, String , String )
Function Gets the shared Query and Content.
Public methodGetQueryContent
Function gets the shared XQuery Content.
Public methodGetRDL
Gets the Report RDL (Report Definition Language) as XML.
Public methodGetResource
Function gets the Shared Report Resource.
Public methodGetRule(String)
Function gets the shared Rule Content.
Public methodGetRule(String, String , String )
Function Gets the shared Query and Content.
Public methodGetRuleContent
Function gets the shared XQuery Content.
Public methodGetStyle
Function gets the Shared Report Style.
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodHasDataFormat
Function Returns True if the Report contains a Data Format.
Public methodHasNamespace
Function Returns True if the Report contains a Namespace.
Public methodHasProperty
Function returns True if the Property Name exists.
(Inherited from EngineClassBase.)
Public methodHasResources
Function Returns True if the Report contains Shared Resources.
Public methodHasStyles
Function Returns True if the Report contains Shared Styles.
Public methodInitialize
Initialize the Report.
Public methodIsDifferent(Object, Boolean)
Function compares the Properties of the current Object and the supplied one and returns True if any are not Equal.
(Inherited from EngineClassBase.)
Public methodLoadData 
Loads the Report Data Source from the Data File.
Public methodLoadData(DataSet)
Loads the Report Data Source with the specified Data Set.
Public methodLoadData(Object)
Loads the Report Data Source.
Public methodLoadData(String)
Loads the Report Data Source with the specified Data String.
Public methodLoadData(Uri)
Loads the Report Data Source from the specified URI.
Public methodLoadData(XmlDocument)
Loads the Report Data Source with the specified XML Document.
Public methodLoadData(String, String)
Loads the Report Data Source with the specified Data String.
Public methodLoadTOC
Public methodLoadXLSX
Loads the Report Data from an XLS or XLSX Data File.
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnChanged
Raises the Changed Event.
(Inherited from EngineClassBase.)
Public methodOnClearing
Raises the Clearing Event.
(Inherited from EngineClassBase.)
Public methodOnDirty
Raises the Dirty Event.
(Inherited from EngineClassBase.)
Public methodOnPropertyChanged
Raises the On Property Changed Event.
(Inherited from EngineClassBase.)
Public methodParseQuery
Parses the Query Content for Queries.
Public methodPropertiesToCSV
Returns a Copy of the Object Properties to Comma Separated Values.
(Inherited from EngineClassBase.)
Public methodPropertiesToString
Returns a Copy of the Object Properties to a Delimited String.
(Inherited from EngineClassBase.)
Public methodPropertiesToXML
Returns a Copy of the Object Properties to a XML formatted String.
(Inherited from EngineClassBase.)
Public methodRuleToBoolean(String, String, ReportSharedQuery QueryTypes, String, XdmItem)
Function returns the Report Item Rule as a Boolean.
Public methodRuleToBoolean(String, String, ReportSharedQuery QueryTypes, String, String)
Function returns the Report Item Rule as a Boolean.
Public methodSerialize 
Serializes the Object and writes the XML document to a String.
(Inherited from EngineClassBase.)
Public methodSerialize(String)
Serializes the Object and writes the XML to a File.
(Inherited from EngineClassBase.)
Public methodSerialize(Encoding)
Serializes the Object and writes the XML document to a String.
(Inherited from EngineClassBase.)
Public methodSerialize(XmlWriterSettings)
Serializes the Object and writes the XML document to a String.
(Inherited from EngineClassBase.)
Public methodSerialize(String, Encoding)
Serializes the Object and writes the XML to a File.
(Inherited from EngineClassBase.)
Public methodSerializeMe
Serializes the Object and writes the XML document to a String and optionally to a File.
(Inherited from EngineClassBase.)
Public methodSetError
Sets an Error for the Object.
(Inherited from EngineClassBase.)
Public methodSetException
Sets an Exception for the Object.
(Inherited from EngineClassBase.)
Public methodSetIsChanged
Sets the Object to the Is Changed state.
(Inherited from EngineClassBase.)
Public methodSetIsClean
Sets the Object to the Is Clean state.
(Inherited from EngineClassBase.)
Public methodSetIsDirty
Sets the Object to the Is Dirty state.
(Inherited from EngineClassBase.)
Public methodSetLicenseData
Public methodSetOutputCSSFile
Sets the Report Output CSS File URI.
Public methodSetOutputHTMLFile
Sets the Report Output HTML File URI.
Public methodSetOutputPath
Sets the Report Output Path URI.
Public methodShallowClone 
Creates a shallow clone of the current Object.
(Inherited from EngineClassBase.)
Public methodShallowCopy
Creates a shallow copy of the current Object.
(Inherited from EngineClassBase.)
Public methodOnlineToString
Returns a OnlineString that represents the current OnlineObject.
(Inherited from OnlineObject.)
Back to Top
Fields

  NameDescription
Protected fieldPDFBuild
Back to Top
Properties

  NameDescription
Public propertyAnchors
Gets or sets the Anchors option to allow Navigation to Report Items in Design Mode.
Public propertyAuthor
Gets or sets the Report Author.
Public propertyBackground
Gets or sets the Report Background.
Public propertyBodyOnly
Gets or sets the option to Output only the Body HTML Content for the Report.
Public propertyCancelled
Returns True if the Report Build was Cancelled.
Public propertyClassType
Gets the Class Type. Read-only.
(Inherited from EngineClassBase.)
Public propertyConstantsFile
Gets or sets the Shared Report Constants File.
Public propertyCopyright
Gets or sets the Report Copyright.
Public propertyCoverPage
Gets or sets the Report Cover Page.
Public propertyCSS
Gets or sets the Report CSS Style.
Public propertyCSSFile
Gets or sets the Report CSS File Location.
Public propertyCSSOn
Gets or sets the Report CSS On.
Public propertyDataContextsFile
Gets or sets the Shared Report Data Source Contexts File.
Public propertyDataEncrypted
Gets or sets the Encrypted option for the Report Data Source File.
Public propertyDataEncryption
Gets or sets the Report Data Source Encryption.
Public propertyDataFile
Gets or sets the URI for the Report Data Source File.
Public propertyDataFormatsFile
Gets or sets the Report Data Formats File.
Public propertyDataSource
Gets or sets Report Data Source.
Public propertyDataType
Gets or sets the Report Data Source Type.
Public propertyDataXDM
Gets the Report Data Source as an XDM Node.
Public propertyDataXML
Gets or sets Report Data Source XML used for XQueries.
Public propertyDataXMLDocument
Gets the Report Data Source as an XML Document.
Public propertyDataXSD
Gets or sets Report Data Source XSD.
Public propertyDate
Gets or sets the Report Date.
Public propertyDescription
Gets or sets the Report Description.
Public propertyDisableEmbeddedImages
Gets or sets the option to Disable all Embedded Images.
Public propertyDisposed
Gets a value indicating whether the object has been disposed of. Read-only.
(Inherited from EngineClassBase.)
Public propertyFileConstants
Gets or sets the Report File Constants.
Public propertyFileDataContexts
Public propertyFileDataFormats
Gets or sets the File Data Formats.
Public propertyFileInfo
Public propertyFileNamespaces
Gets or sets the File Namespaces.
Public propertyFileQueries
Gets or sets the Report File Queries.
Public propertyFileResources
Gets or sets the Report File Resources.
Public propertyFileRules
Gets or sets the Report File Rules.
Public propertyFileStyles
Gets or sets the Report File Styles.
Public propertyFullImagePath
Gets or sets the option to Output the Full Image Path in the Report HTML.
Public propertyGUID
Gets or sets the Report GUID.
Public propertyHandle
Gets or sets the Report Handle used to generate the Images associated with the Report Content.
Public propertyHandleExceptions
Gets or sets the option to Handle Exceptions.
(Inherited from EngineClassBase.)
Public propertyHasData
Returns True if the Report has Data.
Protected propertyImageFiles
Protected propertyImageIndex
Protected propertyImageSrc
Public propertyIsChanged
Gets or sets the Is Changed flag indicating if the Object has changed.
(Inherited from EngineClassBase.)
Public propertyIsDirty
Gets or sets the Is Dirty flag indicating if any Data Properties within the Object have been Set.
(Inherited from EngineClassBase.)
Protected propertyItemIndex
Public propertyItemKey
Gets or sets the associated Collection Item Key for the Object.
(Inherited from EngineClassBase.)
Public propertyKeywords
Gets or sets the Report Keywords.
Public propertyLanguage
Gets or sets the Report Language.
Public propertyLastErrDescription
Returns the last Error Description for the Object.
(Inherited from EngineClassBase.)
Public propertyLastErrNumber
Returns the last Error Number for the Object.
(Inherited from EngineClassBase.)
Public propertyLastErrSource
Returns the last Error Source for the Object.
(Inherited from EngineClassBase.)
Public propertyLastException
Returns the last Exception for the Object.
(Inherited from EngineClassBase.)
Public propertyLicense
Gets or sets the Report License.
Public propertyLicenseData
Public propertyLog
Gets the Report Build Log. Read-only.
Public propertyMargins
Gets or sets the Report Page Margins.
Public propertyName
Gets or sets the Report Name.
Public propertyNamespace
Gets or sets the Report Namespace.
Public propertyNamespacesFile
Gets or sets the Report Namespaces File.
Public propertyNotes
Gets or sets the Report Notes.
Public propertyOnDirtyEvent
Used in conjunction with the SetIsDirty method to raise an Event. If True then if SetIsDirty is called the Dirty Event will be raised.
(Inherited from EngineClassBase.)
Public propertyOrganization
Gets or sets the Report Organization.
Public propertyOutputCSSFile
Gets the Report Output CSS File URI. Read-only.
Public propertyOutputHTMLFile
Gets the Report Output HTML File URI. Read-only.
Public propertyOutputPath
Gets the Output Path URI for the Report. Read-only.
Public propertyOutputType
Gets or sets the Report Output Type as HTML or Text Content.
Public propertyPadding
Gets or sets the Report Padding.
Public propertyPDFPageNumbers
Gets or sets the option to Output Page Numbers on PDF Prints.
Public propertyPDFSettings
Gets or sets the Report PDF Document Settings.
Public propertyProperties
Discovers the attributes of the Properties of the Class and provides access to Property metadata. Read-only.
(Inherited from EngineClassBase.)
Public propertyPublishFile
Gets or sets the Report Publish File for Publishing HTML / PDF Content to the Web.
Public propertyQueriesFile
Gets or sets the Shared Report Queries File.
Public propertyRaiseError
If True then when SetError is called an Event will be raised.
(Inherited from EngineClassBase.)
Public propertyReference
Gets or sets the Report Reference.
Public propertyRegion
Gets or sets the Report Region.
Public propertyReportConstants
Gets or sets the Report Constants.
Public propertyReportDataFormats
Gets or sets the Report Data Formats.
Public propertyReportDataSourceContexts
Gets or sets the Report Data Source Contexts.
Public propertyReportNamespaces
Gets or sets the Report Namespaces.
Public propertyReportQueries
Gets or sets the Report Queries.
Public propertyReportResources
Gets or sets the Shared Report Resources for the Report as Embedded Data or Files.
Public propertyReportRules
Gets or sets the Report Rules.
Public propertyReportStyles
Gets or sets the Report Shared Styles.
Public propertyResourcesFile
Gets or sets the Shared Report Resources File.
Public propertyRulesFile
Gets or sets the Shared Report Rules File.
Public propertySchemaFile
Gets or sets the URI for the Report Data Schema (XSD) File. If a Schema cannot be found then a typed Schema will be inferred from the Report Data XML.
Public propertySchemaOn
Gets or sets the Schema Definition File (XSD) On.
Protected propertySectionIndex
Public propertyShowErrors
Gets or sets the Report Debugging option.
Public propertyStylesFile
Gets or sets the Shared Report Resources File.
Public propertyTag
Gets or sets the associated Tag for the Object.
(Inherited from EngineClassBase.)
Public propertyTitle
Gets or sets the Report Title.
Public propertyTOC
Gets or sets the Report Table of Contents.
Protected propertyTOCEnabled
Protected propertyTOCIndex
Public propertyTypeClassName
Gets Class Name of the associated Class. Read-only.
(Inherited from EngineClassBase.)
Public propertyURI
The URI Location of the Report.
Public propertyVersion
Gets or sets the Report Version.
Public propertyXProcessor
Returns the XProcessor for the Report. Read-only.
Public propertyXQueryCompiler
Returns the XQueryCompiler for the Report. Read-only.
Public propertyXSLT
Gets or sets the Report Data XSLT.
Back to Top
Events

  NameDescription
Public eventChanged
This Event is fired if the SetIsChanged method is called with the 'Notify' argument set to True.
(Inherited from EngineClassBase.)
Public eventDataLoaded
Public eventDirty
This Event is fired if the OnDirtyEvent Property is True or the Optional Paramater 'Notify' in the SetIsDirty method is True when SetIsDirty is called.
(Inherited from EngineClassBase.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from EngineClassBase.)
Back to Top
See Also