Reports display statistical information on operations performed within Grooper.
Can be used to author customized Reports by providing a Report Definition Language Client (rdlc) file as a Stream, Data Source(s) for the rdlc resource,
and optional Report Parameters.
| Property Name |
Property Type |
Description |
| DataSources |
System.Collections.Generic.IEnumerable(Of T) |
Collection of Report Data Sources to be used in this Report. |
| HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
| IsEmpty |
System.Boolean |
Returns true if all properties with a ViewableAttribute are set to their default value. |
| IsWriteable |
System.Boolean |
Returns true if the object is writable, or false if it is not. |
| Owner |
Grooper.ConnectedObject |
Returns the node that owns the connected object, if any. |
| OwnerNode |
Grooper.GrooperNode |
Returns the node that owns the connected object, if any. |
| Parameters |
System.Collections.Generic.IEnumerable(Of T) |
Collection of Report Parameters to be used in this Report. |
| ReportSettingsText |
System.String |
Settings text for the standard Grooper Report header. Set this string property instead of overriding the GetParameters function. |
| Root |
Grooper.GrooperRoot |
Returns the root node |
| Method Name |
Description |
| GetDataSources() As IEnumerable(Of ReportDataSource) |
Override this function to return a collection of Report Data Sources to be used for the Report. |
| GetDomainUserNames(dt As DataTable&, UserColumnName As String) |
Replaces the values for the indicated column, with the domain account owner's full name as returned from Directory Services Account Management.
| Parameters |
| dt |
| Type: DataTable& |
| The table containing domain accounts to be replaced with full names. |
| |
| UserColumnName |
| Type: String |
| The column in the passed data table containing the domain accounts to be replaced with full names. |
|
| GetParameters() As IEnumerable(Of ReportParameter) |
Override this property to indicate the Report Parameters (name/value pairs) to be used in the report. |
| GetProperties() As PropertyDescriptorCollection |
|
| GetRdlcStream() As ContentStream |
Override this function to return a Report Definition Language Client (rdlc) object stream. |
| GetReferences() As List(Of GrooperNode) |
Returns a list of GrooperNode objects referenced in the properties of this object. |
| GetScriptResource(ResourceName As String) As ContentStream |
Streams a class contained in an Object Library script project.
| Parameters |
| ResourceName |
| Type: String |
| The name of the class to be returned as a Content Stream. |
|
| GetWhereClause(WhereElements As IEnumerable(Of String)) As String |
| Parameters |
| WhereElements |
| Type: IEnumerable`1 |
| |
|
| IsPropertyEnabled(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently enabled.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the enabled state for. |
|
| IsPropertyVisible(PropertyName As String) As Nullable(Of Boolean) |
Defines whether a property is currently visible.
| Parameters |
| PropertyName |
| Type: String |
| The name of the property to determine the visible state for. |
|
| IsType(Type As Type) As Boolean |
Returns true if the object is of the type specified, or if it derives from the type specfied.
| Parameters |
| Type |
| Type: Type |
| The type to check. |
|
| Serialize() As String |
Serializes the object. |
| SetDatabase(Database As GrooperDb) |
Sets the database connection of the object.
| Parameters |
| Database |
| Type: GrooperDb |
| |
|
| SetOwner(Owner As ConnectedObject, SkipInitialization As Boolean) |
Sets the owner of the connected object with another object that implements the IConnected interface.
| Parameters |
| Owner |
| Type: ConnectedObject |
| |
| |
| SkipInitialization |
| Type: Boolean |
| |
|
| ToString() As String |
Returns a string value representation of the connected object. |
| ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |