Modules | Classes | Enumerations | Functions
Design Files

The DgnFile class is used to access physical files in various formats. More...

Modules

 Document Manager
 A document manager virtualizes access to physical files so that a host program and its applications can be written to work equally well with the native file system or a document management system (DMS).
 
 Integration Manager
 An integration manager locates and loads DMS instegration modules for the host program.
 
 DgnFile C Api
 Find an element in one of the loaded DgnModels of a DgnPlatform::DgnFile by ID.
 
 Design Models
 A model is a collection of elements in a Bentley::DgnPlatform::DgnFile.
 
 Levels
 
 Geographic Coordinate Systems
 A Geographic Coordinate System describes the way that coordinates on the earth's surface (which are generally described in degrees of longitude, degrees of latitude, and elevation above the surface) are transformed to a cartesian coordinate system that can be represented on an inherently planar medium such as a sheet of paper or a computer screen.
 
 Auxiliary Coordinate Systems
 The Auxiliary Coordinate System interface allows programs to manipulate named coordinate systems stored in dgn files.
 
 Named Groups
 Named Groups are a mechanism for grouping graphical elements within a design.
 
 Units
 
 DigitalSignatureAPI
 
 Digital Rights
 
 Provenance API
 Provenance traces the origins and history of the content contained in an i-model.
 
 Design History
 Design history is a mechanism for recording changes to a design file.
 

Classes

struct  SeedData
 Seed data. More...
 
struct  DgnFileAppData
 Applications subclass from this class to store their DgnFile specific data on a DgnFile via DgnFile::AddAppData. More...
 
struct  DgnFile
 A DgnFile is an in-memory representation of a physical file, regardless of its format. More...
 
struct  FilesToEmbedList
 ! List of files to embed within an I-Model package. More...
 

Enumerations

enum  ProcessChangesWhen { BeforeProcessing = 0, AfterProcessing = 1 }
 File-Save hooks get called before and after processing changes. More...
 
enum  DgnFileChanges { Abandon = 0, Save = 1, FullSave = 2 }
 Possible values for DgnFileChanges. More...
 
enum  DgnSaveReason {
  UserInitiated = 1, ApplInitiated = 2, ReferenceFileSave = 3, FileClose = 4,
  FileCompress = 5, FileSaveAs = 6, AutoTime = 7, PreCommit = 8,
  SaveSettings = 9, Backup = 10, Encrypt = 11, PreCompress = 12
}
 Save reasons set to FileSave callback. More...
 
enum  SeedCopyFlags {
  None = 0, TCBData = (1 << 1), DefaultViews = (1 << 2), AllViewGroups = (1 << 3),
  LevelTable = (1 << 4), ColorTable = (1 << 5), FontTable = (1 << 6), TextStyleTable = (1 << 7),
  DimStyleTable = (1 << 8), MlineStyleTable = (1 << 9), LineStyleTable = (1 << 10), FilterTable = (1 << 11),
  DictionaryTable = (1 << 12), ReferenceAttach = (1 << 13), RasterRefs = (1 << 14), AllNamedViews = (1 << 15),
  NamedViewsOfSeed = (1 << 16), ApplicationInfo = (1 << 17), AuxCoordSystem = (1 << 18), AllLevelTables = (1 << 19),
  CreateDefaultModel = (1 << 20), MaterialPalette = (1 << 21), GeoCoordinateSystem = (1 << 22), LevelNameDictionary = (1 << 23),
  NoViewGroups = (1 << 24), DisplayStyles = (1 << 25), DefaultData = (TCBData | DefaultViews | LevelTable | LevelNameDictionary | ColorTable | LineStyleTable | MaterialPalette | GeoCoordinateSystem), AllData = ((0x7fffffff) & ~(AllLevelTables | CreateDefaultModel))
}
 Seed copy flags for new DgnFile creation. More...
 
enum  DgnFileOpenMode { ReadOnly = 1, ReadWrite = 2, PreferablyReadWrite = 3, ReadWriteFromCopiedFile = 4 }
 File open mode. More...
 
enum  DgnFilePurpose {
  Unknown = 0, MasterFile = 1, DgnAttachment = 2, DgnLib = 3,
  ActivatedAttachment = 4, CellLibrary = 5, WorkDgn = 6, Clipboard = 7,
  Temporary = 8, Icons = 9, LevelLibrary = 10, Overlay = 11
}
 File purpose mode. More...
 

Functions

SeedCopyFlags operator| (SeedCopyFlags a, SeedCopyFlags b)
 
SeedCopyFlags operator& (SeedCopyFlags a, SeedCopyFlags b)
 
SeedCopyFlags operator~ (SeedCopyFlags a)
 
bool operator! (SeedCopyFlags a)
 

Detailed Description

The DgnFile class is used to access physical files in various formats.

A DgnFile is composed of Design Models which contain Elements. Elements refer to levels, fonts, color definitions, line styles, etc. defined in their containing DgnFile.

Enumeration Type Documentation

enum DgnFileChanges
strong

Possible values for DgnFileChanges.

Enumerator
Abandon 
Save 
FullSave 
enum DgnFileOpenMode
strong

File open mode.

Enumerator
ReadOnly 

open readonly

ReadWrite 

open for both read and write.

PreferablyReadWrite 

try read-write, if that doesn't work, try read-only

ReadWriteFromCopiedFile 
enum DgnFilePurpose
strong

File purpose mode.

Enumerator
Unknown 

File purpose not specified.

MasterFile 

File will be the "master file".

DgnAttachment 

File opened to resolve a DgnAttachment.

DgnLib 

File opened as a DgnLib.

ActivatedAttachment 

File used as activated reference.

CellLibrary 

File opened as a DgnLib.

WorkDgn 

File opened through the "workDgn" interface.

Clipboard 

File used as a clipboard file.

Temporary 

File created for temporary use (such as Save As).

Icons 

File holds icons.

LevelLibrary 

File used as manually attached level library.

Overlay 

File used as manually attached level library.

enum DgnSaveReason
strong

Save reasons set to FileSave callback.

Enumerator
UserInitiated 

save was initiated explicitly by user

ApplInitiated 

save was initiated by an application

ReferenceFileSave 

Currently used by cell libraries when making change to remote file.

FileClose 

save was intiated by file close

FileCompress 

save was intiated by file compress

FileSaveAs 

user selected a "save as" to new file

AutoTime 

automatic (background) save

PreCommit 

save in preparation for design history commit

SaveSettings 

save settings command

Backup 

save changes before a backup command.

Encrypt 

encrypting/decrypting the file

PreCompress 
enum ProcessChangesWhen
strong

File-Save hooks get called before and after processing changes.

Enumerator
BeforeProcessing 
AfterProcessing 
enum SeedCopyFlags
strong

Seed copy flags for new DgnFile creation.

Enumerator
None 
TCBData 
DefaultViews 
AllViewGroups 
LevelTable 
ColorTable 
FontTable 
TextStyleTable 
DimStyleTable 
MlineStyleTable 
LineStyleTable 
FilterTable 
DictionaryTable 
ReferenceAttach 
RasterRefs 
AllNamedViews 
NamedViewsOfSeed 
ApplicationInfo 
AuxCoordSystem 
AllLevelTables 
CreateDefaultModel 
MaterialPalette 
GeoCoordinateSystem 
LevelNameDictionary 
NoViewGroups 
DisplayStyles 
DefaultData 
AllData 

Function Documentation

bool Bentley::DgnPlatform::operator! ( SeedCopyFlags  a)
SeedCopyFlags Bentley::DgnPlatform::operator& ( SeedCopyFlags  a,
SeedCopyFlags  b 
)
SeedCopyFlags Bentley::DgnPlatform::operator| ( SeedCopyFlags  a,
SeedCopyFlags  b 
)
SeedCopyFlags Bentley::DgnPlatform::operator~ ( SeedCopyFlags  a)

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