Extending product function with VBA : The System Architect object model : Object model classes : Diagram class : Diagram fields
  
Diagram fields
The diagram field property can contain a number of properties held about the diagram. They typically contain information that a user cannot enter directly but is derived during normal use. Within the Object Model there is an enumerated type called DGMFLD. This is passed as a parameter to the operation GetField(FieldID as DGMFLD) and SetField(FieldID as DGMFLD, Value as String). This enables the Microsoft VBA programmer to both read and update low level diagram fields.
DGMFLD constants
DIAGFLD_BBORDER
Toggles the Report Border check box in the Page Setup window. This enables the user to place a border around the report.
O" = unchecked
1" = checked
DIAGFLD_BDGMBORDER
Selects a border from the diagram border drop-list in the Page Setup window.
0" = no form/ no border
1" = simple border
DIAGFLD_BDGMPDEFAULT
Sets the Page Setup settings as the default settings.
0" = Off
1" = On
DIAGFLD_BORDEROFFSET
Sets the Offset value in the Page Setup window. This field sets the border off from the report text by the specified value.
String
Numeric value in hundredths of an inch.
DIAGFLD_BPRESENTATIONMENU
Toggles the automatic inclusion of the Presentation menu in the drawing toolbox. The extra symbols included in the Presentation menu include a basic shape for a computer, phone, person, disk and printer. The symbols are drawn on the diagram by the same method as any other block symbol and may be named as appropriate.
0" = Off
1" = On
DIAGFLD_BREADONLY
Makes the diagram object read-only.
0" = False
1" = True
DIAGFLD_BSHOWGRID
Toggles the automatic display of the underlying grid.
0" = Off
1" = On
DIAGFLD_BSHOWLINESHADOW
Toggles the automatic inclusion of a shadow around all line symbols.
0" = Off
1" = On
DIAGFLD_BSHOWNODESHADOW
Toggles the automatic inclusion of a shadow around all node symbols.
0" = Off
1" = On
DIAGFLD_BSHOWPAGES
Toggles the Pages check box in the Diagram Display Options window. When checked the page print areas will be displayed as dotted lines so that if the diagram is printed in Actual Size mode then the page boundaries may be previewed.
O" = unchecked
1" = checked
DIAGFLD_BSHOWRULER
Toggles the display of the x and y axis ruler markers measured in centimeters or inches depending upon the local settings on the PC. The x and y rules are saved with the drawing when toggled on.
0" = Off
1" = On
DIAGFLD_BSHOWSCROLL
Toggles the automatic display of the scroll bars that allow the user to move around a diagram if it is larger that one screen in the current view mode. This option defaults to checked.
O" = unchecked
1" = checked
DIAGFLD_BSHOWTEXTSHADOW
Toggles the automatic inclusion of a shadow around all text symbols.
0" = Off
1" = On
DIAGFLD_BSNAPGRIDENT
Snaps all node symbols to the nearest grid line (normally invisible) on the diagram, after you have changed the grid setting to a coarser or finer grid setting.
0" = Off
1" = On
DIAGFLD_BSNAPGRIDLIN
Snaps all line symbols to the nearest grid line (normally invisible) on the diagram, after you have changed the grid setting to a coarser or finer grid setting.
0" = Off
1" = On
DIAGFLD_CGRAPHNAME
The name of the diagram.
String
DIAGFLD_CLEVELNUMBER
Level number of the diagram
Read-only
String
DIAGFLD_DDDIAGRAM_DDIDENTITY
Data dictionary ID number for the diagram
Read-only
Numeric
DIAGFLD_IDGMFORM
Selects the border form from the diagram border drop-down list in the Page Setup window.
0" = no form/ no border
1" = IDEF0 Working
2" = IDEF0 Publication
3" = IDEF3
4" = IDEF3 Released
5" = SSADM Form
DIAGFLD_IGRAPHTYPE
The System Architect Type of diagram
String
Internal constant number of diagram. A complete listing can be found in the diagrm.bas file in the System Architect directory.
DIAGFLD_PGRIDNUMENT
Node symbol Grid Points per inch.
[Vertical] [Horizontal]"
must be used in conjunction with DIAGFLD_PGRIDSIZEENT
DIAGFLD_PGRIDNUMLIN
Line symbol Grid Points per inch.
[Vertical] [Horizontal]"
must be used in conjunction with DIAGFLD_PGRIDSIZELIN
DIAGFLD_PGRIDSIZEENT
Node symbol Inches per Grid Point
[Vertical] [Horizontal]" in hundredths of an inch.
must be used in conjunction with DIAGFLD_PGRIDNUMENT
DIAGFLD_PGRIDSIZELIN
Line symbol Inches per Grid Point
[Vertical] [Horizontal]" in hundredths of an inch.
must be used in conjunction with DIAGFLD_PGRIDNUMLIN
DIAGFLD_PGRIDUNIT100
Sets the distance an object can be dragged within the grid. Default value="100 100"
[Vertical] [Horizontal]" in hundredths of an inch.
DIAGFLD_PSHADOWDELTA
Sets the distance the shadow is placed from the symbol. Default value = "20 10"
[Vertical] [Horizontal]" in hundredths of an inch.
DIAGFLD_RGBSHADOWCOLOR
Sets shadow color.
[RGB Color]"
DIAGFLD_RMARGIN
Sets Margins in Page Setup window.
[Left] [Top] [Right] [Bottom]" in hundredths of an inch.
DIAGFLD_SAAUDITID
Diagram Audit ID
Read-only
String
DIAGFLD_SAIDENTITY
Data dictionary ID number for the diagram.
Read-only
Numeric
DIAGFLD_SALOCK
Locks the diagram.
0" = Unlocked
1" = Locked
DIAGFLD_SAMAJORTYPE
Major Type (i.e. Diagram).
Read-only
String
DIAGFLD_SAMAJORTYPENUMBER
Major Type Number (i.e. 1).
Read-only
Numeric
DIAGFLD_SANAME
Name of diagram.
Read-only
String
DIAGFLD_SANUMBER
Level Number of diagram (IDEF0 only)
Read-only
Numeric
DIAGFLD_SATYPE
Type of diagram (e.g. Process Chart, Entity Relation, etc.).
Read-only
String
DIAGFLD_SATYPENUMBER
Internal constant number of diagram.
Read-only
Numeric
DIAGFLD_SAUPDATEDATE
Date of last update.
Read-only
Date Field
DIAGFLD_SAUPDATETIME
Time of last update.
Read-only
Time Field
DIAGFLD_USEDENTCOUNT
Number of symbols on the diagram.
Long (Hexadecimal)
Read-only
DIAGFLD_WBORDERPENSTYLE
Pen style of border in the Page Setup window.
[SymPenStyle number]"
For a complete listing of all System Architect Pen styles, see chapter 7.
DIAGFLD_WORIENTATION
Diagram Printing Orientation in the Page Setup window.
0" = Printer Default
1" = Portrait
2" = Landscape
3" = Best Fit
See also
Diagram class