Content Links define references to content stored outside of Grooper, such as file on a file system or a document in a CMIS Repository.
| Property Name |
Property Type |
Description |
| AsDocument |
Grooper.Core.DocumentLink |
Casts the link object as a DocumentLink. Use this to access properties specific to documents, such as MIME type and size. |
| CreatedBy |
System.String |
The name of the user who created the document. |
| CreatedTime |
System.DateTime |
The date the document was created. |
| FetchError |
System.String |
If set, indicates an error which occurred while attempting to access the remote object. |
| FullPath |
System.String |
The full path to the linked object. |
| HasReferenceProperties |
System.Boolean |
Returns true if the object has properties which reference Grooper Node objects. |
| Id |
System.String |
Unique Id for the document. |
| 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. |
| LastModifiedBy |
System.String |
The name of the user who last modified the document. |
| LastModifiedTime |
System.DateTime |
The date the document was last modified. |
| Name |
System.String |
The filename associated with the document. |
| 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. |
| Path |
System.String |
The path to the linked object, minus the name. |
| PathSegments |
System.Collections.Generic.IEnumerable(Of T) |
A sequence of path segments representing the location of the remote object. |
| Root |
Grooper.GrooperRoot |
Returns the root node |
| Method Name |
Description |
| ClearCache() |
Clears any temporary objects which were cached during property reads. |
| ClearExecutionCache() |
|
| FormatPathSegments(FirstSegmentIndex As Int32, LastSegmentIndex As Int32, Separator As String) As String |
Returns a sub-portion of the path, formatted with a new separator.
| Parameters |
| FirstSegmentIndex |
| Type: Int32 |
| The starting path segment. |
| |
| LastSegmentIndex |
| Type: Int32 |
| The ending path segment. |
| |
| Separator |
| Type: String |
| The separator to be used between each path segment in the output. |
|
| FormatPathSegments(FirstSegmentIndex As Int32, Separator As String) As String |
Returns a sub-portion of the path, formatted with a new separator.
| Parameters |
| FirstSegmentIndex |
| Type: Int32 |
| The starting path segment. All segments from this segment until the last will be included in the output. |
| |
| Separator |
| Type: String |
| The separator to be used between each path segment in the output. |
|
| GetCustomValue(Name As String) As Object |
Fetches a custom value from the link.
| Parameters |
| Name |
| Type: String |
| |
|
| GetPathSegment(SegmentIndex As Int32) As String |
Returns a specific path segment from the path associated with this link.
| Parameters |
| SegmentIndex |
| Type: Int32 |
| The index of the segment to return. |
|
| 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 |
| |
|
| 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 the dislay name. |
| ValidateProperties() As ValidationErrorList |
Validates the properties of the object, returning a list of validation errors. |
