| 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. |
| Attributes |
System.IO.FileAttributes |
The attributes of the linked file.A combination of the following flags:
- ReadOnly: The file is read-only.
- Hidden: The file is hidden, and thus is not included in an ordinary directory listing.
- System: The file is a system file. That is, the file is part of the operating system or is used exclusively by the operating system.
- Directory: The file is a directory.
- Archive: The file is a candidate for backup or removal.
- Device: Reserved for future use.
- Normal: The file is a standard file that has no special attributes. This attribute is valid only if it is used alone.
- Temporary: The file is temporary. A temporary file contains data that is needed while an application is executing but is not needed after the application is finished. File systems try to keep all the data in memory for quicker access rather than flushing the data back to mass storage. A temporary file should be deleted by the application as soon as it is no longer needed.
- SparseFile: The file is a sparse file. Sparse files are typically large files whose data consists of mostly zeros.
- ReparsePoint: The file contains a reparse point, which is a block of user-defined data associated with a file or a directory.
- Compressed: The file is compressed.
- Offline: The file is offline. The data of the file is not immediately available.
- NotContentIndexed: The file will not be indexed by the operating system's content indexing service.
- Encrypted: The file or directory is encrypted. For a file, this means that all data in the file is encrypted. For a directory, this means that encryption is the default for newly created files and directories.
- IntegrityStream: The file or directory includes data integrity support. When this value is applied to a file, all data streams in the file have integrity support. When this value is applied to a directory, all new files and subdirectories within that directory, by default, include integrity support.
- NoScrubData: The file or directory is excluded from the data integrity scan. When this value is applied to a directory, by default, all new files and subdirectories within that directory are excluded from data integrity.
|
| CreatedBy |
System.String |
The name of the user who created the document. |
| CreatedTime |
System.DateTime |
The creation time of the linked file. |
| DirectoryName |
System.String |
The name of the directory in which the linked file resides. |
| DisplaySize |
System.String |
The length of the document content, in bytes. |
| Extension |
System.String |
The extension of the linked file. |
| FetchError |
System.String |
If set, indicates an error which occurred while attempting to access the remote object. |
| Filename |
System.String |
The file name associated with the document. |
| FilePath |
System.String |
The full path to the linked file. |
| FullPath |
System.String |
The full path of the file.
|
| 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. |
| LastAccessTime |
System.DateTime |
The last access time of the linked file. |
| LastModifiedBy |
System.String |
The name of the user who last modified the document. |
| LastModifiedTime |
System.DateTime |
The last write time of the linked file. |
| MimeType |
System.String |
The MimeType of the file.
|
| Name |
System.String |
The name of the file.
|
| 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. |
|
| GetContentStream() As ContentStream |
Reads the content stream from the link. |
| 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. |
