DataView class

Inherits from

GEOCALCPBW_NAMESPACE::GeoBase

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.

Public Constructors

Constructor	Description
DataView	Creates a new instance of a DataView

Public Methods

Method	Description
AddObject	Adds an object to the view
AddFolder	Adds a new folder to the view
CommitToFile	Saves the view to a file
get_CalculatedSignature	Retrieves the signature calculated from the contents of the view file, if one exists
get_FailOnInvalidSig	Retrieves the boolean indicating whether a load of the view should fail if the view file appears to have been hand-edited.
get_FileName	Returns the name of the view file
get_IsLoaded	Returns true if the view file has been loaded
get_IsSignatureValid	Returns false if the view file has been manually edited (ie if the signature in the file does not match the calculated signature), or true otherwise
get_SignatureFromFile	Returns the signature string from the view file (if one exists)
get_UnsavedChanges	Returns true if there are changes that have not been saved to a view file.
GetFolder	Retrieves the specified folder
GetFolderIDByObjectType	Retrieves the folder id for the appropriate default folders (which are organized by object type)
GetObjectDisplayName	Retrieves the display name for an object (or an empty string if none has been specified)
InitDefault	Populates the view with folders for each of the base object types and for the various datum shift types.
LoadFile	Load the view from a specified file
MergeDataViews	Merge two DataView files
RemoveFolder	Remove the specified folder from the view (Note: the actual objects will not be deleted from the datasource)
RemoveObject	Remove the specified object.
Reset	Revert to an empty, un-loaded view (unsaved changes will be lost)
set_FailOnInvalidSig	Sets whether we should throw an exception during the call if the base data source file has been manually edited.
set_FileName	Sets the name of the file where the view should get loaded from or saved out to
SetFolderName	Sets the name of a folder that already exists in the view to the specified value.
SetObjectDisplayName	Sets the display name for the specified object
SetObjectHidden	Sets the specified object to be hidden in the view