AJE Components
ReportFieldFormatting MembersAJE Data Report Engine Help

The ReportFieldFormatting type exposes the following members.
Constructors

  NameDescription
Public methodReportFieldFormatting
Initializes a new instance of the ReportFieldFormatting class
Back to Top
Methods

  NameDescription
Public methodBuild
Builds the Output Content for the Report Item.
(Inherited from ReportBaseOutput.)
Public methodBuildTOC (Inherited from ReportBaseOutput.)
Public methodClearContext
Clears the Context Item.
(Inherited from ReportBaseContext.)
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 ReportBase.)
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 methodDrawText
Function Draws Text as an Image.
(Inherited from ReportBaseOutput.)
Public methodOnlineEquals
Determines whether the specified OnlineObject is equal to the current OnlineObject.
(Inherited from OnlineObject.)
Public methodEvaluatePython
Function Evaluates the Query using Python.
(Inherited from ReportBase.)
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 methodGetBuildOption
Gets the Report Output Build Option.
(Inherited from ReportBaseOutput.)
Public methodGetConstantOutput
Function gets the Constant Output for the Report Data.
(Inherited from ReportDataFormatBase.)
Public methodGetContextItem
Gets the Report Item Context Item.
(Inherited from ReportBaseContext.)
Public methodGetContextName (Inherited from ReportBaseContext.)
Public methodGetContextSource (Inherited from ReportBaseContext.)
Public methodGetContextXML
Gets the Report Item Data Context XML.
(Inherited from ReportBaseContext.)
Public methodGetDataContext
Gets the Report Local Item Data Context.
(Inherited from ReportBaseContext.)
Public methodGetDataFormat
Function gets the Data Format Object for specified Name.
(Inherited from ReportBase.)
Public methodGetDataFormats
Function Parses and gets the List of Report Data Formats for the Names delimited by a Space or a Comma.
(Inherited from ReportBase.)
Public methodGetFileURI (Inherited from ReportBase.)
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 methodGetOutput 
Function Gets the Output Content for the Report Item.
(Inherited from ReportBaseOutput.)
Public methodGetOutput(ReportBaseOutput)
Function Gets the Output Content for the Report Item.
(Inherited from ReportBaseOutput.)
Public methodGetParent
Gets the Report Item Parent.
(Inherited from ReportBase.)
Public methodGetParentContainer(Guid)
Gets the Report Item Parent Container.
(Inherited from ReportBase.)
Public methodGetParentContainer(String)
Gets the Report Item Parent Container.
(Inherited from ReportBase.)
Public methodGetParentContextItem
Gets the Report Parent Context Item.
(Inherited from ReportBase.)
Public methodGetParentGroup
Gets the Report Item Parent Group.
(Inherited from ReportBase.)
Public methodGetParentSection
Gets the Report Item Parent Section.
(Inherited from ReportBase.)
Public methodGetParentXQueryContextList
Function Gets the Literal Context List up to the Root Container.
(Inherited from ReportBaseContext.)
Public methodGetPropertyNames
Function Gets the Names of the Member Properties.
(Inherited from EngineClassBase.)
Public methodGetRDL
Gets the Report Item RDL (Report Definition Language) as XML.
(Inherited from ReportBase.)
Public methodGetReportItem(Guid)
Gets the Report Item.
(Inherited from ReportBase.)
Public methodGetReportItem(String)
Gets the Report Item.
(Inherited from ReportBase.)
Public methodGetSection
Function Returns the Report Item Section Container.
(Inherited from ReportBaseOutput.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodGetXQueryContextList
Function Gets the Literal Context List up to the Root Container.
(Inherited from ReportBaseContext.)
Public methodGetXQueryContextPath
Function Returns the full XPath for the Context.
(Inherited from ReportBaseContext.)
Public methodHasAnyContext
Function Returns True if the Report Item has any Data Context as a Literal or File.
(Inherited from ReportBaseContext.)
Public methodHasAnyFileContext
Function Returns True if the Report Item has any File Context.
(Inherited from ReportBaseContext.)
Public methodHasAnyLiteralContext
Function Returns True if the Report Item has any Literal Context as either XQuery / XPath or Python.
(Inherited from ReportBaseContext.)
Public methodHasAnyXQueryContext
Function Returns True if the Report Item has any Literal Context as XQuery / XPath.
(Inherited from ReportBaseContext.)
Public methodHasFileContext
Function Returns True if there is a File Context.
(Inherited from ReportBaseContext.)
Public methodHasLiteralContext
Function Returns True if there is a Literal Context as XQuery / XPath or Python.
(Inherited from ReportBaseContext.)
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 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 methodLoadContext
Loads the Data Context for the Report Item.
(Inherited from ReportBaseOutput.)
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 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 methodReadFile(String) (Inherited from ReportBase.)
Public methodReadFile(Uri) (Inherited from ReportBase.)
Public methodRuleToBoolean 
Function returns the Report Item Rule as a Boolean.
(Inherited from ReportDataFormatBase.)
Public methodRuleToBoolean(String, String, ReportSharedQuery QueryTypes)
Function returns the Report Item Rule as a Boolean.
(Inherited from ReportBaseContext.)
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 methodSetBuildOption
Sets the Report Output Build Option.
(Inherited from ReportBaseOutput.)
Public methodSetContextItem
Sets the Report Context Item.
(Inherited from ReportBase.)
Public methodSetContextName (Inherited from ReportBaseContext.)
Public methodSetContextSource (Inherited from ReportBaseContext.)
Public methodSetDataContext
Sets the Report Local Item Data Context.
(Inherited from ReportBaseContext.)
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 methodSetItem  (Inherited from ReportBaseContext.)
Public methodSetItem(Report, ReportBase) (Inherited from ReportBaseContext.)
Public methodSetItem(Report, Object) (Inherited from ReportBaseContext.)
Public methodSetItem(Report, ReportBase, Object) (Inherited from ReportBaseContext.)
Public methodSetItem(Report, ReportBase, Object, String)
Sets the Report Item Parent Report, Parent, ContextItem and Namespace.
(Inherited from ReportBase.)
Public methodSetNamespace
Sets the Report Item Namespace.
(Inherited from ReportBase.)
Public methodSetParent (Inherited from ReportBaseContext.)
Public methodSetRDL
Sets the Report Item Structure using RDL (Report Definition Language) as XML.
(Inherited from ReportBase.)
Public methodSetReport
Sets the Report Item Parent Report.
(Inherited from ReportBaseContext.)
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)
Function returns the Formatted Content.
(Inherited from ReportBaseDataFormat.)
Public methodToFormatted(String, ReportDataFormat, Boolean) (Inherited from ReportDataFormatBase.)
Public methodToFormatted(String, ReportDataFormats, Boolean) (Inherited from ReportDataFormatBase.)
Public methodToFormatted(String, String, Boolean) (Inherited from ReportDataFormatBase.)
Public methodToOutput
Function Builds and returns the Output Content for the Report Item.
(Inherited from ReportBaseOutput.)
Public methodToString (Inherited from ReportBaseItem.)
Public methodValidateRDL(String) (Inherited from ReportBase.)
Public methodWriteError (Inherited from ReportBaseOutput.)
Back to Top
Properties

  NameDescription
Public propertyActiveContext
Returns the Report Item Active Data Context.
(Inherited from ReportBaseOutput.)
Public propertyClassType
Gets the Class Type. Read-only.
(Inherited from EngineClassBase.)
Public propertyCleaners
Gets or sets the Text Cleaners for the Report Data Formatting.
(Inherited from ReportBaseDataFormat.)
Public propertyComments (Overrides ReportBaseItem Comments.)
Public propertyConstant
Gets or sets the Report Field Constant.
(Inherited from ReportDataFormatBase.)
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 ReportBaseDataFormat.)
Public propertyCurrency
Gets or sets the Field Formatting Currency.
(Inherited from ReportBaseDataFormat.)
Public propertyDataString
Gets or sets the Data Formatting String Function for the Report Data.
(Inherited from ReportBaseDataFormat.)
Public propertyDataType
Gets or sets the Field Output Data Type as a String or a Number.
(Inherited from ReportBaseDataFormat.)
Public propertyDisposed
Gets a value indicating whether the object has been disposed of. Read-only.
(Inherited from EngineClassBase.)
Public propertyEditor (Inherited from ReportBaseDataFormat.)
Public propertyEnabled
Gets or sets the Report Item Output Enabled or Disabled.
(Inherited from ReportBaseOutput.)
Public propertyFormatString
Gets or sets the Field Format Strings delimited by a | separator.
(Inherited from ReportBaseDataFormat.)
Public propertyFunction
Gets or sets the Functions for Field Formatting.
(Inherited from ReportBaseDataFormat.)
Public propertyFunctionLocation
Gets or sets the Function Location for Field Formatting.
(Inherited from ReportBaseDataFormat.)
Public propertyFunctions
Gets or sets the Functions for the Report Data Formatting.
(Inherited from ReportBaseDataFormat.)
Public propertyGUID (Overrides ReportBaseOutput GUID.)
Public propertyHandleExceptions
Gets or sets the option to Handle Exceptions.
(Inherited from EngineClassBase.)
Public propertyHasContext
Returns True if the Report Item has a Data Context.
(Inherited from ReportBaseOutput.)
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 (Overrides ReportBaseItem Name.)
Public propertyNameLength
Property returns the Name Length. Read-only.
(Inherited from ReportBaseItem.)
Public propertyNullSpecifier
Gets or sets the Null Specifier for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
Public propertyNumberFormat
Gets or sets the Report Number Format.
(Inherited from ReportBaseDataFormat.)
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 propertyOutput
Gets or sets the Report Item Output Content.
(Inherited from ReportBaseOutput.)
Public propertyParent
Gets or sets the Report Item Parent.
(Inherited from ReportBase.)
Public propertyPrefix
Gets or sets Report Data Field Prefix.
(Inherited from ReportBaseDataFormat.)
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 ReportBaseDataFormat.)
Public propertyRemoveWhitespaces
Gets or sets Remove Whitespaces for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
Public propertyReport
The Report that the Report Item belongs too.
(Inherited from ReportBase.)
Public propertyRounding
Gets or sets the Field Numerical Rouding.
(Inherited from ReportBaseDataFormat.)
Public propertyRule
Gets or sets the Report Condition / Rule as either XQuery or Python.
(Inherited from ReportItem.)
Public propertyRuleName
Gets or sets the Name of the Shared Report Item Condition / Rule.
(Inherited from ReportItem.)
Public propertyRuleType
Gets or sets the Rule Type as either XQuery or Python.
(Inherited from ReportItem.)
Public propertySeparator
Gets or sets the Text Separator for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
Public propertySuffix
Gets or sets Report Data Field Suffix.
(Inherited from ReportBaseDataFormat.)
Public propertyTabDelimited
Gets or sets the Tab Delimiter for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
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 ReportBaseDataFormat.)
Public propertyTruncateLength
Gets or sets the Truncate Length for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
Public propertyTypeClassName
Gets Class Name of the associated Class. Read-only.
(Inherited from EngineClassBase.)
Public propertyTypeName
Returns the Type Name of the Report Item.
(Inherited from ReportBaseOutput.)
Public propertyZeroSpecifier
Gets or sets the Zero Value Specifier for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
Public propertyZeroValueRule
Gets or sets the Zero Value Rule for the Report Data Field.
(Inherited from ReportBaseDataFormat.)
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.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from EngineClassBase.)
Back to Top
See Also