DataView class

Inherits from

System.Object

Description

A DataView contains the information for the display and organization of datasource objects. It consists of a set of folders (each stored as a DisplayFolder), which themselves may contain additional sub-folders as well as lists of actual objects (each stored as a DisplayObject). A DataView may be saved out as file with the .xvw extension, and then loaded in again from that file. This may be done independently of a DataSource, or as part of the Load and CommitToFile functions on that class.

Constructors

Constructor	Description
DataView	Creates a new instance of a DataView

Properties

Property	Description
FailOnInvalidSignature	Gets or sets whether or not to throw if the signature in the dataview is invalid.
FileName	Gets or sets the file name.
HasUnsavedChanges	Gets whether there are any unsaved changed.
IsLoaded	Gets if this dataview is loaded.
IsSignatureValid	Gets indication if dataview has a valid signature.
NumberOfUnsavedChanges	Gets the number of unsaved changed.
Signature	Gets signature of the dataview.

Methods

Method	Description
AddFolder	Adds a new folder to the view
AddObject	Adds an object to the dataview and to its folder (if it has a valid folder id).
AddObjectToDefault	Adds object, GC code, to the default folder.
Clone	Creates a clone of this object.
CommitToFile	Write out the in memory dataview to file.
Dispose	Implement IDisposable.
FindFolderOfObject	Gets the folder from the data view.
GetFolder	Returns the name of the view file
GetFolderIDByObjectType	Gets the folder ID of the specified object type.
GetHiddenListByType	Populates a list of GC Identifier codes for those objects of the specified type that are hidden in this view.
GetObjectDisplayName	Gets the object's display name.
GetTypeNameFromConstant	Get the "folder" name for this type of object, from the list of constant strings.
GetTypeNameSingular	Get a reader-friendly "type" name for this type of object, from the list of constant strings.
GetVisibileListByType	Populates a list of GC Identifier codes for those objects of the specified type that are visible in this view.
HasDefaults	Checks to see if the view has all the default folders for basic object types.
HideFolder	Hides the folder in the data view.
InitDefault	Initializes the view to a somewhat usable state. Most importantly it adds all the Serializable groupings.
IsObjectHidden	Checks if object is hidden.
IsStandard	Check if a given folder is one of the top-level "standard" folders.
LoadFile	Load the view from a specified file.
LoadStream	Loads the specified dataview file as a stream.
MergeDataViews	Merge the folderization of any new objects from some base view into our current view. Note that changes must be committed to be written out to the file. If you wish to back up the current view you must do so before calling this function. Existing objects will not be re-folderized.
RemoveFolder	Removes the folder from the data view.
RemoveObject	Removes the child object from its folder and the data view.
Reset	Resets the dataview to a very primitive and unusable state.
SetFolderName	Changes the name of the existing folder.
SetObjectDisplayName	Sets the object's display name.
SetObjectHidden	Sets the object's display name.
SetVisibleHiddenByType	Sets hidden and visibile property on an entire object type.
Inherited Method	Description
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object).
GetHashCode	Serves as the default hash function. (Inherited from Object).
GetType	Gets the Type of the current instance. (Inherited from Object).
ToString	Returns a string that represents the current object. (Inherited from Object).