AJE Components
ReportBaseField MembersAJE Data Report Engine Help

The ReportBaseField type exposes the following members.
Constructors

  NameDescription
Public methodReportBaseField
Initializes a new instance of the ReportBaseField class
Back to Top
Methods

  NameDescription
Public methodClone 
Clone the object, and returning a reference to a cloned object.
(Inherited from EngineClassBase.)
Public methodCopyItem
Function Copies the Report Item.
(Inherited from ReportBaseItem.)
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 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 methodEvaluateXQuery
Function Evaluates the XQuery.
(Inherited from ReportBase.)
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 methodGetConstantOutput
Function gets the Constant Output for the Report Data.
(Inherited from ReportDataFormatBase.)
Public methodGetContext
Gets the Context for the Report Item
(Inherited from ReportBaseItem.)
Public methodGetContextItem
Gets the Report Item Context Item.
(Inherited from ReportBaseItem.)
Public methodGetContexts
Function Gets the Context List up to the Root Container.
(Inherited from ReportBaseItem.)
Public methodGetContextsXQuery
Function Returns the full XPath for the Context
(Inherited from ReportBaseItem.)
Public methodGetContextXML
Gets the Report Item Context XML.
(Inherited from ReportBaseItem.)
Public methodGetFieldContext
Gets the Context of the Field by Parsing the XQuery.
Public methodOnlineGetHashCode
Serves as a hash function for a particular type.
(Inherited from OnlineObject.)
Public methodGetNamespace
Gets the Report Item Namespace.
(Inherited from ReportBase.)
Public methodGetParentContextItem
Gets the Report Parent Context Item.
(Inherited from ReportBaseItem.)
Public methodGetPropertyNames
Function Gets the Names of the Member Properties.
(Inherited from EngineClassBase.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodHasAnyContext
Function Returns True if the Report Item has any Context.
(Inherited from ReportBaseItem.)
Public methodHasAnyFileContext
Function Returns True if the Report Item has any File Context.
(Inherited from ReportBaseItem.)
Public methodHasAnyXPathContext
Function Returns True if the Report Item has any XPath Context.
(Inherited from ReportBaseItem.)
Public methodHasFileContext
Function Returns True if there is a File Context.
(Inherited from ReportBaseItem.)
Public methodHasNamespace
Function Returns True if the Report and the Report Item have a Namespace.
(Inherited from ReportBase.)
Public methodHasProperty
Function returns True if the Property Name exists.
(Inherited from EngineClassBase.)
Public methodHasXPathContext
Function Returns True if there is a XPath Context.
(Inherited from ReportBaseItem.)
Public methodIsDifferent
Function compares the Properties of the current Object and the supplied one and returns True if any are not Equal.
(Inherited from EngineClassBase.)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodOnChanged
Raises the Changed Event.
(Inherited from EngineClassBase.)
Public methodOnDirty
Raises the Dirty Event.
(Inherited from EngineClassBase.)
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 
Function returns the Report Item Rule as a Boolean.
(Inherited from ReportDataFormatBase.)
Public methodRuleToBoolean(String, String)
Function returns the Report Item Rule as a Boolean.
(Inherited from ReportBaseItem.)
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 methodSetContainer (Overrides ReportBaseItem SetContainer(ReportBaseItem).)
Public methodSetContext
Sets the Report Item Context.
(Inherited from ReportBaseItem.)
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 methodSetNamespace
Sets the Report Item Namespace.
(Inherited from ReportBase.)
Public methodSetReport
Sets the Report Item Parent Report.
(Inherited from ReportBaseItem.)
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 methodToFormatted(String) (Inherited from ReportFieldFormatting.)
Public methodToFormatted(String, String)
Function returns the Formatted Field Content.
(Inherited from ReportDataFormatBase.)
Public methodToOutput 
Function Builds and returns the Output Content for the Report Field.
(Overrides ReportItem ToOutput .)
Protected methodToOutput(String, String, ReportQuery, String)
Function Builds and returns the Content for the Report Field.
Public methodToString (Inherited from ReportBaseItem.)
Back to Top
Properties

  NameDescription
Public propertyClassName
Gets Class Name of the associated Class. Read-only.
(Inherited from EngineClassBase.)
Public propertyClassType
Gets the Class Type. Read-only.
(Inherited from EngineClassBase.)
Public propertyComments (Inherited from ReportFieldFormatting.)
Public propertyConstant
Gets or sets the Report Field Constant.
(Overrides ReportDataFormatBase Constant.)
Public propertyContainer
Gets or sets the Report Item Container.
(Inherited from ReportBaseItem.)
Public propertyContent
Gets or sets the Report Field Query Content.
Public propertyContext
Gets or sets the Report Field Context.
Public propertyContextIndex
Gets or sets the Context Index for the Report Item.
(Inherited from ReportBase.)
Public propertyContextItem
Gets or sets the Context Item for the Report Item.
(Inherited from ReportBase.)
Public propertyConversion
Gets or sets the Field Formatting String Conversion.
(Inherited from ReportDataFormatBase.)
Public propertyCurrency
Gets or sets the Field Formatting Currency.
(Inherited from ReportDataFormatBase.)
Public propertyDataFormat
Gets or sets the Name of the Report Data Format.
(Inherited from ReportFieldFormatting.)
Public propertyDataString
Gets or sets the Data Formatting String Function for the Report Data.
(Inherited from ReportDataFormatBase.)
Public propertyDataType
Gets or sets the Field Output Data Type as a String or a Number.
(Inherited from ReportDataFormatBase.)
Public propertyDisposed
Gets a value indicating whether the object has been disposed of. Read-only.
(Inherited from EngineClassBase.)
Public propertyEnabled
Gets or sets the Report Item Enabled.
(Inherited from ReportItemBase.)
Public propertyExpression
Gets or sets the Expression for the Report Field Data.
Public propertyFormatString
Gets or sets the Field Format String.
(Inherited from ReportDataFormatBase.)
Public propertyFunction
Gets or sets the Function for Field Formatting.
(Inherited from ReportDataFormatBase.)
Public propertyFunctionLocation
Gets or sets the Function Location for Field Formatting.
(Inherited from ReportDataFormatBase.)
Public propertyGUID
Gets or sets the Report Item GUID.
(Inherited from ReportBaseItem.)
Public propertyHandleExceptions
Gets or sets the option to Handle Exceptions.
(Inherited from EngineClassBase.)
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.)
Public propertyItemKey
Gets or sets the associated Collection Item Key for the Object.
(Inherited from EngineClassBase.)
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 propertyName
Gets or sets the Report Field Name.
(Overrides ReportFieldFormatting Name.)
Public propertyNamespace
Gets or sets the Report Item Namespace.
Public propertyNullSpecifier
Gets or sets the Null Specifier for the Report Data Field.
(Inherited from ReportDataFormatBase.)
Public propertyNumberFormat
Gets or sets the Report Number Format.
(Inherited from ReportDataFormatBase.)
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 propertyParent
Gets or sets the Report Item Parent.
(Inherited from ReportBaseItem.)
Public propertyPrefix
Gets or sets Report Data Field Prefix.
(Inherited from ReportDataFormatBase.)
Public propertyProperties
Discovers the attributes of the Properties of the Class and provides access to Property metadata. Read-only.
(Inherited from EngineClassBase.)
Public propertyRaiseError
If True then when SetError is called an Event will be raised.
(Inherited from EngineClassBase.)
Public propertyRegEx
Gets or sets the Regular Expression for the Report Data Field.
(Inherited from ReportDataFormatBase.)
Public propertyReport
The Report that the Report Item belongs too.
(Inherited from ReportBase.)
Public propertyRounding
Gets or sets the Field Numerical Rouding.
(Inherited from ReportDataFormatBase.)
Public propertyRule
Gets or sets the Report Condition / Rule as XQuery.
(Inherited from ReportItem.)
Public propertyRuleName
Gets or sets the Report Item Condition / Rule Name.
(Inherited from ReportItem.)
Public propertySeparator
Gets or sets the Text Separator for the Report Data Field.
(Inherited from ReportDataFormatBase.)
Public propertySequenceSeparator
Gets or sets the Text Sequence Separator for the Report Data Field XQuery Sequence.
Public propertySuffix
Gets or sets Report Data Field Suffix.
(Inherited from ReportDataFormatBase.)
Public propertyTabDelimited
Gets or sets the Tab Delimiter for the Report Data Field.
(Inherited from ReportDataFormatBase.)
Public propertyTag
Gets or sets the associated Tag for the Object.
(Inherited from EngineClassBase.)
Public propertyTextQualifier
Gets or sets the Text Qualifier for the Report Data Field.
(Inherited from ReportDataFormatBase.)
Public propertyTruncateLength
Gets or sets the Truncate Length for the Report Data Field.
(Inherited from ReportDataFormatBase.)
Public propertyXSLT
Gets or sets the XSLT for the Report Field Data.
Public propertyZeroSpecifier
Gets or sets the Zero Value Specifier for the Report Data Field.
(Inherited from ReportDataFormatBase.)
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 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.)
Back to Top
See Also