Grooper.ConnectedObject

Represents the base class for objects which require a connection to the Grooper database.


Inherits from: Grooper.GrooperObject

Constructors

Signature Description
New (Database As GrooperDb, SkipInitialization As Boolean) Initializes a new instance of the object.
Parameters
Database
          Type: GrooperDb
          The Grooper database object.
 
SkipInitialization
          Type: Boolean
          If true, automatic initialization of data members will be suppressed.

Fields

Field Name Field Type Description
Database As Grooper.GrooperDb Grooper.GrooperDb

Properties

Property Name Property Type Description
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.
Root Grooper.GrooperRoot Returns the root node

Methods

Method Name Description
Deserialize(Json As String, Type As Type, Database As GrooperDb) As ConnectedObject Deserializes a ConnectedObject.
Parameters
Json
          Type: String
          The JSON text to deserialize.
 
Type
          Type: Type
          The type. Must inherit from ConnectedObject.
 
Database
          Type: GrooperDb
          The Grooper database.
GetProperties() As PropertyDescriptorCollection
GetReferences() As List(Of GrooperNode) Returns a list of GrooperNode objects referenced in the properties of this object.
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
          
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.