Classes | Typedefs | Enumerations
View Groups

ViewGroups contain information about the contents, positioning, and ordering of a user-specified collection of views that are displayed simultaneously. More...

Classes

struct  ViewGroupCollection
 Each DgnFile has one associated ViewGroupCollection. More...
 
struct  ViewGroupCopyOptions
 The ViewGroupCopyOptions class holds information about how a caller to ViewGroup::From and ViewGroup::Copy wants certain aspects of the copying process to be handled. More...
 
struct  ViewGroup
 ViewGroups contain information about the contents, positioning, and ordering of a user-specified collection of views that are displayed simultaneously. More...
 

Typedefs

typedef RefCountedPtr< ViewGroup > ViewGroupPtr
 A reference counted pointer to a ViewGroup. More...
 
typedef RefCountedPtr
< ViewGroupCopyOptions > 
ViewGroupCopyOptionsPtr
 A reference counted pointer to a ViewGroupCopyOptions. More...
 

Enumerations

enum  ViewGroupStatus {
  VG_Success = 0, VG_NameTooShort = VIEW_GROUP_ERROR_BASE + 1, VG_NameTooLong = VIEW_GROUP_ERROR_BASE + 2, VG_NameNotUnique = VIEW_GROUP_ERROR_BASE + 3,
  VG_NameIllegalCharacter = VIEW_GROUP_ERROR_BASE + 4, VG_OwningDgnFileUnknown = VIEW_GROUP_ERROR_BASE + 5, VG_WrongFile = VIEW_GROUP_ERROR_BASE + 6, VG_CantCreateElement = VIEW_GROUP_ERROR_BASE + 7,
  VG_CantWriteToFile = VIEW_GROUP_ERROR_BASE + 8, VG_TransientNotSaved = VIEW_GROUP_ERROR_BASE + 9, VG_CantDeleteFromFile = VIEW_GROUP_ERROR_BASE + 10, VG_NotInCollection = VIEW_GROUP_ERROR_BASE + 11,
  VG_ActivateRejected = VIEW_GROUP_ERROR_BASE + 12, VG_NoReplacementActiveFound = VIEW_GROUP_ERROR_BASE + 13, VG_CantSetElementId = VIEW_GROUP_ERROR_BASE + 14, VG_BadArgument = VIEW_GROUP_ERROR_BASE + 15,
  VG_ViewGroupNotFound = VIEW_GROUP_ERROR_BASE + 16, VG_OpenViewNotFound = VIEW_GROUP_ERROR_BASE + 17
}
 Possible status values returned from ViewGroup and ViewGroupCollection methods. More...
 
enum  ViewGroupCopyTypeOption { SourceType = -1, MakeTransient = 0, MakePermanent = 1 }
 Options for Copying ViewGroups. More...
 

Detailed Description

ViewGroups contain information about the contents, positioning, and ordering of a user-specified collection of views that are displayed simultaneously.

Each ViewGroup contains information about eight numbered views, any of which can be turned off by the user. There is a ViewInfo and a ViewPortInfo associated with each numbered view, and these contain all of the information necessary to position and size a window to hold each view, and to determine what subset of DgnFile information that the user has chosen to display. Each ViewInfo contains a Root Model, which is always one of the DgnModels that are contained within the DgnFile that contains the ViewGroup. Different Views can display different Root Models.

There are one or more ViewGroups stored within a DgnFile. Each ViewGroup has a name that is unique within a DgnFile. At runtime, users select the ViewGroup displays the information within the DgnFile that they want to view.

Every DgnFile has one associated ViewGroupCollection, and individual ViewGroups are accessed and activated through that collection.

ViewGroups retain the current viewing state while an interactive session is in progress. That state information is not written back to the design file unless ViewGroup::SaveChanges. Since a user can activate multiple ViewGroups (sequentially, not simultaneously) during a session, the settings are generally saved by getting the ViewGroupCollection associated with the DgnFile and calling ViewGroupCollection::SaveChanges, which saves the changes for each ViewGroup that has been changed.

Typedef Documentation

typedef RefCountedPtr<ViewGroupCopyOptions> ViewGroupCopyOptionsPtr

A reference counted pointer to a ViewGroupCopyOptions.

typedef RefCountedPtr<ViewGroup> ViewGroupPtr

A reference counted pointer to a ViewGroup.

Enumeration Type Documentation

enum ViewGroupCopyTypeOption
strong

Options for Copying ViewGroups.

Enumerator
SourceType 

The copied ViewGroup should have the same type (transient or permanent) as the source ViewGroup.

MakeTransient 

The copied ViewGroup should be marked transient.

MakePermanent 

The copied ViewGroup should be marked as permanent.

enum ViewGroupStatus

Possible status values returned from ViewGroup and ViewGroupCollection methods.

Enumerator
VG_Success 

The method succeeded.

VG_NameTooShort 

The name specified is too short.

VG_NameTooLong 

The name specified is too long.

VG_NameNotUnique 

The name specified is not unique with the DgnFile.

VG_NameIllegalCharacter 

The name contains an illegal character.

VG_OwningDgnFileUnknown 

The ViewGroup is not yet associated with a DgnFile.

VG_WrongFile 

Attempt to add a ViewGroup to a ViewGroupCollection from a different DgnFile failed.

VG_CantCreateElement 

An error occurred when trying to create the data structure that persists the ViewGroup.

VG_CantWriteToFile 

An error occurred when trying to write the persistent data to the DgnFile. Perhaps the file is readonly.

VG_TransientNotSaved 

ViewGroups marked as transient cannot be saved to the DgnFile.

VG_CantDeleteFromFile 

The ViewGroup's persistent representation cannot be deleted from the DgnFile. Perhaps the file is readonly.

VG_NotInCollection 

A ViewGroup was specified that is not in the ViewGroupCollection.

VG_ActivateRejected 

The host rejected the request to activate the ViewGroup.

VG_NoReplacementActiveFound 

Cannot delete the active ViewGroup because there is no other ViewGroup eligible to be activated.

VG_CantSetElementId 

Cannot set the ElementId because the view group is already persistent.

VG_BadArgument 

An argument to the method was invalid.

VG_ViewGroupNotFound 

The file does not contain a viewgroup.

VG_OpenViewNotFound 

The viewgroup does not contain an open view.


Copyright © 2017 Bentley Systems, Incorporated. All rights reserved.