The Report type exposes the following members.
Back to Top
Back to Top
Back to Top
Back to Top
Back to Top
Constructors
Name | Description | |
---|---|---|
Report | Initializes a new instance of the Report class | |
Report(Reporting) | Initializes a new instance of the Report class |
Methods
Name | Description | |
---|---|---|
ApplyDataFilters | ||
Clear |
Clears the Report Build and Data.
| |
ClearBuild |
Clears the Report Build.
| |
ClearData |
Clears the Report Data.
| |
ClearFileImages |
Removes Temporary File Images used by the Report Build.
| |
ClearIndexes | ||
ClearLog |
Clears the Report Log.
| |
Clone |
Clone the object, and returning a reference to a cloned object.
(Inherited from EngineClassBase.) | |
Close |
Closes the Report and Data Source.
| |
CopyItem |
Function Copies the Report Item.
| |
CopyObject |
Creates a copy of the current Object.
(Inherited from EngineClassBase.) | |
CopyProperties(Boolean) |
Copies the Properties of the current Object.
(Inherited from EngineClassBase.) | |
CopyProperties(EngineClassBase, Boolean) |
Copies the Properties of the supplied Object.
(Inherited from EngineClassBase.) | |
CopyProperties T1, T2 (T1, T2) |
Copies the Properties by Name of the Source Object to the Destination Object.
(Inherited from EngineClassBase.) | |
CreateHandle |
Create a Report Handle.
| |
DecompressZIPPackage |
Decompress Report ZIP Package.
| |
DeepClone |
Creates a deep clone of the current object.
(Inherited from EngineClassBase.) | |
DeepCopy |
Creates a deep copy of the current Object.
(Inherited from EngineClassBase.) | |
Deserialize(TextReader) | Deserializes to an instance of EngineClassBase. (Inherited from EngineClassBase.) | |
Deserialize(String) | Deserializes to an instance of EngineClassBase. (Inherited from EngineClassBase.) | |
Deserialize(XmlDocument) | Deserializes to an instance of EngineClassBase. (Inherited from EngineClassBase.) | |
DeserializeFile(String) |
Deserializes the specified XML File.
(Inherited from EngineClassBase.) | |
DeserializeFile(String, Encoding) |
Deserializes the specified XML File.
(Inherited from EngineClassBase.) | |
DeSerializeMe |
Deserializes the XML String.
(Inherited from EngineClassBase.) | |
Dispose |
Releases all resources used by the Object.
(Inherited from EngineClassBase.) | |
Dispose(Boolean) | Releases the unmanaged resources used by the Report and optionally releases the managed resources (Overrides EngineClassBase Dispose(Boolean).) | |
Equals | (Inherited from Object.) | |
EvaluatePython(String, XdmItem, ReportNamespace) | ||
EvaluatePython(String, String, ReportNamespace) | ||
EvaluatePython(String, XdmItem, String, String) | ||
EvaluatePython(String, String, XdmItem, ReportNamespace, String, Boolean) |
Function Evaluates the Query using Python.
| |
EvaluateXPath |
Function Evaluates an XPath Expression.
| |
EvaluateXQuery(String, XdmItem, ReportNamespace) |
Function Evaluates an XQuery Expression.
| |
EvaluateXQuery(String, XdmItem, String, String) |
Function Evaluates an XQuery Expression.
| |
EvaluateXQuery(String, String, XdmItem, String, String) | ||
EvaluateXQuery(String, String, XdmItem, ReportNamespace, String, Boolean) |
Function Evaluates the XQuery.
| |
Finalize | Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) | |
GetDataContext |
Function gets the Shared Report Data Source Context.
| |
GetDataFormat |
Function gets the Data Format Object for specified Name.
| |
GetDataFormats | ||
GetDataLocation |
Gets the Location of the Report Data File.
| |
GetDataXML |
Function gets the Data XML for the Report.
| |
GetDefaultNamespace | ||
GetExpression |
Function gets the Shared Report Expression.
| |
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) | |
GetLicenseData | ||
GetNamespace |
Function gets the Namespace Object for specified Name.
| |
GetPath |
Gets the Path of the Report File.
| |
GetPropertyNames |
Function Gets the Names of the Member Properties.
(Inherited from EngineClassBase.) | |
GetQuery(String) |
Function gets the shared Query Content.
| |
GetQuery(ReportQuery) |
Parses the Content for the Queries.
| |
GetQuery(String, String) |
Gets the Content for the Queries.
| |
GetQuery(String, String , String ) |
Function Gets the shared Query and Content.
| |
GetQueryContent |
Function gets the shared XQuery Content.
| |
GetRDL |
Gets the Report RDL (Report Definition Language) as XML.
| |
GetReportExpressions |
Function gets a sorted list of Report Expressions.
| |
GetReportGlobal |
Function gets a Report Global.
| |
GetResource |
Function gets the Shared Report Resource.
| |
GetRule(String) |
Function gets the shared Rule Content.
| |
GetRule(String, String , String ) |
Function Gets the shared Query and Content.
| |
GetRuleContent |
Function gets the shared XQuery Content.
| |
GetRunningTotal |
Function gets a Report Running Total.
| |
GetStyle |
Function gets the Shared Report Style.
| |
GetTableName |
Gets the Table Name from the Command Text.
| |
GetTempImageFile |
Function gets a Temp Image File.
| |
GetType | Gets the Type of the current instance. (Inherited from Object.) | |
HasDataFormat |
Function Returns True if the Report contains a Data Format.
| |
HasNamespace |
Function Returns True if the Report contains a Namespace.
| |
HasProperty |
Function returns True if the Property Name exists.
(Inherited from EngineClassBase.) | |
HasResources |
Function Returns True if the Report contains Shared Resources.
| |
HasStyles |
Function Returns True if the Report contains Shared Styles.
| |
Initialize |
Initialize the Report.
| |
IsDifferent(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.) | |
LoadData |
Loads the Report Data Source from the Data File.
| |
LoadData(DataSet) |
Loads the Report Data Source with the specified Data Set.
| |
LoadData(Object) |
Loads the Report Data Source.
| |
LoadData(String) |
Loads the Report Data Source with the specified Data String.
| |
LoadData(Uri) |
Loads the Report Data Source from the specified URI.
| |
LoadData(XmlDocument) |
Loads the Report Data Source with the specified XML Document.
| |
LoadData(String, String) |
Loads the Report Data Source with the specified Data String.
| |
LoadTOC |
Loads the Table of Contents.
| |
LoadXLSX |
Loads the Report Data from an XLS or XLSX Data File.
| |
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) | |
OnChanged |
Raises the Changed Event.
(Inherited from EngineClassBase.) | |
OnClearing |
Raises the Clearing Event.
(Inherited from EngineClassBase.) | |
OnDirty |
Raises the Dirty Event.
(Inherited from EngineClassBase.) | |
OnPropertyChanged |
Raises the On Property Changed Event.
(Inherited from EngineClassBase.) | |
ParseQuery |
Parses the Query Content for Queries.
| |
PropertiesToCSV |
Returns a Copy of the Object Properties to Comma Separated Values.
(Inherited from EngineClassBase.) | |
PropertiesToString |
Returns a Copy of the Object Properties to a Delimited String.
(Inherited from EngineClassBase.) | |
PropertiesToXML |
Returns a Copy of the Object Properties to a XML formatted String.
(Inherited from EngineClassBase.) | |
RuleToBoolean(String, String, ReportSharedQuery QueryTypes, String, XdmItem) |
Function returns the Report Item Rule as a Boolean.
| |
RuleToBoolean(String, String, ReportSharedQuery QueryTypes, String, String) |
Function returns the Report Item Rule as a Boolean.
| |
Serialize |
Serializes the Object and writes the XML document to a String.
(Inherited from EngineClassBase.) | |
Serialize(String) |
Serializes the Object and writes the XML to a File.
(Inherited from EngineClassBase.) | |
Serialize(Encoding) |
Serializes the Object and writes the XML document to a String.
(Inherited from EngineClassBase.) | |
Serialize(XmlWriterSettings) |
Serializes the Object and writes the XML document to a String.
(Inherited from EngineClassBase.) | |
Serialize(String, Encoding) |
Serializes the Object and writes the XML to a File.
(Inherited from EngineClassBase.) | |
SerializeMe |
Serializes the Object and writes the XML document to a String and optionally to a File.
(Inherited from EngineClassBase.) | |
SetError |
Sets an Error for the Object.
(Inherited from EngineClassBase.) | |
SetException |
Sets an Exception for the Object.
(Inherited from EngineClassBase.) | |
SetIsChanged |
Sets the Object to the Is Changed state.
(Inherited from EngineClassBase.) | |
SetIsClean |
Sets the Object to the Is Clean state.
(Inherited from EngineClassBase.) | |
SetIsDirty |
Sets the Object to the Is Dirty state.
(Inherited from EngineClassBase.) | |
SetLicenseData | ||
SetOutputCSSFile |
Sets the Report Output CSS File URI.
| |
SetOutputHTMLFile |
Sets the Report Output HTML File URI.
| |
SetOutputPath |
Sets the Report Output Path URI.
| |
SetRDL |
Sets the Report Structure using RDL (Report Definition Language) as XML.
| |
ShallowClone |
Creates a shallow clone of the current Object.
(Inherited from EngineClassBase.) | |
ShallowCopy |
Creates a shallow copy of the current Object.
(Inherited from EngineClassBase.) | |
ToString | (Inherited from Object.) | |
ValidateRDL(String) | ||
ValidateRDL(String, Type) |
Fields
Name | Description | |
---|---|---|
JET_PROVIDER |
Provider String Constant for Microsoft Jet.
| |
JET_PROVIDER_OLEDB |
Provider String Constant for Microsoft Access OLEDB.
| |
MSDASQL_PROVIDER |
Provider String Constant for MSDASQL.
| |
PDFBuild | ||
SQL_PROVIDER |
Provider String Constant for SQL OLEDB.
| |
SubReportCacheGUID |
Properties
Name | Description | |
---|---|---|
Anchors |
Gets or sets the Anchors option to allow Navigation to Report Items in Design Mode.
| |
Author |
Gets or sets the Report Author.
| |
Background |
Gets or sets the Report Background.
| |
BodyOnly |
Gets or sets the option to Output only the Body HTML Content for the Report.
| |
Cancelled |
Returns True if the Report Build was Cancelled.
| |
ClassType |
Gets the Class Type. Read-only.
(Inherited from EngineClassBase.) | |
Collapsible |
Gets or sets the Report as Collapsible.
| |
ConstantsFile |
Gets or sets the Shared Report Constants File.
| |
Copyright |
Gets or sets the Report Copyright.
| |
CoverPage |
Gets or sets the Report Cover Page.
| |
CSS |
Gets or sets the Report CSS Style.
| |
CSSFile |
Gets or sets the Report CSS File Location.
| |
CSSOn |
Gets or sets the Report CSS On.
| |
DataContextsFile |
Gets or sets the Shared Report Data Source Contexts File.
| |
DataEncrypted |
Gets or sets the Encrypted option for the Report Data Source File.
| |
DataEncryption |
Gets or sets the Report Data Source Encryption.
| |
DataFile |
Gets or sets the Report Data Source.
| |
DataFormatsFile |
Gets or sets the Report Data Formats File.
| |
DataSource |
Gets or sets Report Data Source.
| |
DataType |
Gets or sets the Report Data Source Type.
| |
DataXDM |
Gets the Report Data Source as an XDM Node.
| |
DataXML |
Gets or sets Report Data Source XML used for XQueries.
| |
DataXSD |
Gets or sets Report Data Source XSD.
| |
Date |
Gets or sets the Report Date.
| |
Description |
Gets or sets the Report Description.
| |
DisableEmbeddedImages |
Gets or sets the option to Disable all Embedded Images.
| |
Disposed |
Gets a value indicating whether the object has been disposed of. Read-only.
(Inherited from EngineClassBase.) | |
ExpressionsFile |
Gets or sets the File for the Report Expressions.
| |
FieldLogging |
Gets or sets Field Error Logging for debugging.
| |
FileConstants |
Gets or sets the Report File Constants.
| |
FileDataContexts | ||
FileDataFormats |
Gets or sets the File Data Formats.
| |
FileExpressions | ||
FileGlobals | ||
FileInfo | ||
FileNamespaces |
Gets or sets the File Namespaces.
| |
FileQueries |
Gets or sets the Report File Queries.
| |
FileResources |
Gets or sets the Report File Resources.
| |
FileRules |
Gets or sets the Report File Rules.
| |
FileRunningTotals | ||
FileStyles |
Gets or sets the Report File Styles.
| |
FullImagePath |
Gets or sets the option to Output the Full Image Path in the Report HTML.
| |
GlobalsFile |
Gets or sets the File for the Report Globals.
| |
GUID |
Gets or sets the Report GUID.
| |
Handle |
Gets or sets the Report Handle used to generate the Images associated with the Report Content.
| |
HandleExceptions |
Gets or sets the option to Handle Exceptions.
(Inherited from EngineClassBase.) | |
HasData |
Returns True if the Report has Data.
| |
ImageFiles | ||
ImageIndex | ||
ImageSrc | ||
IsChanged |
Gets or sets the Is Changed flag indicating if the Object has changed.
(Inherited from EngineClassBase.) | |
IsDirty |
Gets or sets the Is Dirty flag indicating if any Data Properties within the Object have been Set.
(Inherited from EngineClassBase.) | |
ItemIndex | ||
ItemKey |
Gets or sets the associated Collection Item Key for the Object.
(Inherited from EngineClassBase.) | |
Keywords |
Gets or sets the Report Keywords.
| |
Language |
Gets or sets the Report Language.
| |
LastErrDescription |
Returns the last Error Description for the Object.
(Inherited from EngineClassBase.) | |
LastErrNumber |
Returns the last Error Number for the Object.
(Inherited from EngineClassBase.) | |
LastErrSource |
Returns the last Error Source for the Object.
(Inherited from EngineClassBase.) | |
LastException |
Returns the last Exception for the Object.
(Inherited from EngineClassBase.) | |
License |
Gets or sets the Report License.
| |
LicenseData | ||
Log |
Gets the Report Build Log. Read-only.
| |
Manifest |
Gets or sets the Report Manifest.
| |
Margins |
Gets or sets the Report Page Margins.
| |
Name |
Gets or sets the Report Name.
| |
Namespace |
Gets or sets the Report Namespace.
| |
NamespacesFile |
Gets or sets the Report Namespaces File.
| |
Notes |
Gets or sets the Report Notes.
| |
OnDirtyEvent |
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.) | |
Organization |
Gets or sets the Report Organization.
| |
OutputCSSFile |
Gets the Report Output CSS File URI. Read-only.
| |
OutputHTMLFile |
Gets the Report Output HTML File URI. Read-only.
| |
OutputPath |
Gets the Output Path URI for the Report. Read-only.
| |
OutputType |
Gets or sets the Report Output Type as HTML or Text Content.
| |
Padding |
Gets or sets the Report Padding.
| |
PDFPageNumbers |
Gets or sets the option to Output Page Numbers on PDF Prints.
| |
PDFSettings |
Gets or sets the Report PDF Document Settings.
| |
Properties |
Discovers the attributes of the Properties of the Class and provides access to Property metadata. Read-only.
(Inherited from EngineClassBase.) | |
PublishFile |
Gets or sets the Report Publish File for Publishing HTML / PDF Content to the Web.
| |
QueriesFile |
Gets or sets the Shared Report Queries File.
| |
RaiseError |
If True then when SetError is called an Event will be raised.
(Inherited from EngineClassBase.) | |
Reference |
Gets or sets the Report Reference.
| |
Region |
Gets or sets the Report Region.
| |
RemotePath |
Gets or sets the Remote Path for the Report Build.
| |
ReportConstants |
Gets or sets the Report Constants.
| |
ReportDataFormats |
Gets or sets the Report Data Formats.
| |
ReportDataSourceContexts |
Gets or sets the Report Data Source Contexts.
| |
ReportExpressions |
Gets or sets the list of Report Expressions.
| |
ReportGlobals |
Gets or sets the list of Report Globals.
| |
Reporting |
Returns the Reporting for the Report. Read-only.
| |
ReportNamespaces |
Gets or sets the Report Namespaces.
| |
ReportQueries |
Gets or sets the Report Queries.
| |
ReportResources |
Gets or sets the Shared Report Resources for the Report as Embedded Data or Files.
| |
ReportRules |
Gets or sets the Report Rules.
| |
ReportRunningTotals |
Gets or sets the list of Report Running Totals.
| |
ReportStyles |
Gets or sets the Report Shared Styles.
| |
ReportXDM |
Gets the Report RDL as an XDM Node.
| |
ResourcesFile |
Gets or sets the Shared Report Resources File.
| |
RulesFile |
Gets or sets the Shared Report Rules File.
| |
RunningTotalsFile |
Gets or sets the File for the Report Running Totals.
| |
SchemaFile |
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.
| |
SchemaOn |
Gets or sets the Schema Definition File (XSD) On.
| |
SectionIndex | ||
SecurityProtocol |
Gets or sets the Security Protocol for Data over a secure Internet connection.
| |
ShowErrors |
Gets or sets the Report Debugging option.
| |
ShowFields |
Gets or sets the Report Show Fields if Empty or Null for debugging.
| |
Sortable |
Gets or sets the Report has Sortable Items in HTML.
| |
StylesFile |
Gets or sets the Shared Report Resources File.
| |
Tag |
Gets or sets the associated Tag for the Object.
(Inherited from EngineClassBase.) | |
Title |
Gets or sets the Report Title.
| |
TOC |
Gets or sets the Report Table of Contents.
| |
TOCEnabled | ||
TOCIndex | ||
TypeClassName |
Gets Class Name of the associated Class. Read-only.
(Inherited from EngineClassBase.) | |
URI |
The URI Location of the Report.
| |
Version |
Gets or sets the Report Version.
| |
XProcessor |
Returns the XProcessor for the Report. Read-only.
| |
XQueryCompiler |
Returns the XQueryCompiler for the Report. Read-only.
| |
XSLT |
Gets or sets the Report Data XSLT.
| |
ZIPPackage |
Gets or sets the Report ZIP Package.
|
Events
Name | Description | |
---|---|---|
Changed |
This Event is fired if the SetIsChanged method is called with the 'Notify' argument set to True.
(Inherited from EngineClassBase.) | |
DataLoaded | ||
Dirty |
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.) | |
PropertyChanged |
Occurs when a property value changes.
(Inherited from EngineClassBase.) |
See Also