The symbol field property can contain a number of properties held about the symbol. Typically, it contains information that a user cannot enter directly but is derived during normal use. Examples include Update Time, Audit, Position, Size, and TypeName.
Within the Object Model there is an enumerated type called SYMBOLFIELD. This is passed as a parameter to the operation GetField(FieldID asSYMBOLFIELD) and SetField(FieldID asSYMBOLFIELD, Value as String). This allows the Microsoft VBA programmer to both read and update low level symbol fields.
SYMFLD_AUDITID
Audit Id of the Symbol.
Data type: String
Read-only
SYMFLD_BARRANGMENT
Arrangement of symbol tree.
0" = Arrange Children Horizontally
1" = Arrange Children Vertically
2" = Arrange Children as a Block
SYMFLD_BOTHERSYMBOLOGY
Displays alternate form of symbol (for example, symbol stereotype)
Data type: Boolean
SYMFLD_CBGCOLOR
Background color of a symbol on a Character Screen diagram.
0" = Black
1" = Blue
2" = Green
3" = Cyan
4" = Red
5" = Magenta
6" = Brown/yellow
7" = white
SYMFLD_CFGCOLOR
Foreground color of a symbol on a Character Screen diagram.
0" = Black
1" = Blue
2" = Green
3" = Cyan
4" = Red
5" = Magenta
6" = Brown/yellow
7" = white
SYMFLD_COCCOFFSET
Determines the spacing between each iteration of values for some input field on a Character Screen diagram.
Data type: Numeric
SYMFLD_COCCURS
Allows multiple iteration of values for some input field on a Character Screen diagram.
Data type: Numeric
SYMFLD_COMMENT
Sets the graphic comment property of the symbol.
Data type: String
SYMFLD_CPROMPT
Cobalt Prompt Character of symbol on Character Screen diagram
Data type: 1-bit String
SYMFLD_CUNCLECOUNT
Returns the number of symbols that are directly attached to the parent symbol by flow lines.
Data type: Hexadecimal
Read-only
SYMFLD_DDCOMMENT
Data dictionary ID number of symbol’s comment symbol
Data type: Numeric
Read-only
SYMFLD_DDIDENTITY
Data dictionary Id number of the symbol.
Data type: Numeric
Read-only
SYMFLD_DESCLOCX
Location of the graphic comment of the symbol.
Data type: Pos YPos"
Numeric
SYMFLD_DESCSIZEX
Size of the graphic comment of the symbol.
Size YSize"
Data type: Numeric
SYMFLD_DWSTYLE
Reflects what the user has selected as options for a graphic screen symbol on a Graphic Screen diagram.
Data type: Hexadecimal
SYMFLD_ENDLOCX
Location of where line symbol ends.
Data type: Pos YPos"
Numeric
SYMFLD_ERROR1
First error detected by System Architect.
Data type: Error number
SYMFLD_ERROR2
Second error detected by System Architect.
Data type: Error number
SYMFLD_FONTFLAGS
Toggles Bold, Italic, Underline, or Strikethrough for Symbol font.
Data type: Hexadecimal
0x0002" = Bold
0x0005" = Italic
0x000B" = Underline
0x0010" = Strikethrough
SYMFLD_FONTHEIGHT
Symbol font size
Data type: Hexadecimal
SYMFLD_FONTNAME
Symbol font name (for example, Arial, Times New Roman)
Data type: String
SYMFLD_FREXARCCHAR
Inserts an exclusive arc at the from end of a line symbol.
Data type: Boolean
SYMFLD_FROMCARDINALITY
Returns FromCardinality name (for example, exactly one, one or many, and so forth.) For a complete list of FromCardinality values see FromCardinality attribute in Symbol class attributes.
Data type: String
Read-only
SYMFLD_FROMCARDNUMBER
Returns FromCardinality constant number. For a complete list of FromCardinality values see FromCardinality attribute in Symbol class attributes.
Data type: Numeric
Read-only
SYMFLD_FROMCONNECTCOMPASSPOINT
Returns N,E,S, or W for start point of an ICOM Arrow connected at the from end
Data type: String
Read-only
SYMFLD_HASFROMARROW
Returns true if line has an arrow at the <codeph>from</codeph> end
Data type: Boolean
Read-only
SYMFLD_HASFROMTUNNEL
Returns true if ICOM arrow is tunneled at the from end
Data type: Boolean
Read-only
SYMFLD_HASTOARROW
Returns true if line has an arrow at the to end
Data type: Boolean
Read-only
SYMFLD_LINESTYLE
Symbol line style
Data type: 4-byte hexadecimal
SYMFLD_LOC
Location of symbol on the diagram.
Data type: XPos YPos"
Numeric
SYMFLD_NAME
Symbol name
Data type: String
SYMFLD_NAMECRLF
Symbol names can have new lines (CRLF). The SYMFLD_NAMECRLF stores the information about where in a name the new lines are located. There are four positions, indicated as SYMFLD_NAMECRLF1, SYMFLD_NAMECRLF2, SYMFLD_NAMECRLF3, SYMFLD_NAMECRLF4, and these contain the number of characters before each CRLF in the string. SYMFLD_NAMECRLF is a way of addressing all four positions in one go. System Architect normally maintains these fields if the name changes, therefore users should not change these fields..
Data type: String
SYMFLD_NAMECRLF1
If the name were to appear as string of continuous text (for example, JimJaneTomLouRon), the character number at which the text starts on the second line (that is, 4).
Data type: Numeric
SYMFLD_NAMECRLF2
If the name were to appear as string of continuous text (for example, JimJaneTomLouRon), the character number at which the text starts on the third line (that is, 8).
Data type: Numeric
SYMFLD_NAMECRLF3
If the name were to appear as string of continuous text (for example, JimJaneTomLouRon), the character number at which the text starts on the fourth line (that is, 11).
Data type: Numeric
SYMFLD_NAMECRLF4
If the name were to appear as string of continuous text (for example, JimJaneTomLouRon), the character number at which the text starts on the fifth line (that is, 14).
Data type: Numeric
SYMFLD_NAMELOC
Location of Symbol Name Field.
Data type: XPos YPos"
Numeric
SYMFLD_NAMESIZE
Size of Symbol Name Field
Data type: XSize YSize"
Numeric
SYMFLD_ORDER
Ordering of Association End
O" = Unordered
1" = Ordered
2" = Sorted
SYMFLD_PENSTYLE
Symbol Pen style and width
4-byte hexadecimal
SYMFLD_ROTATION
Rotates Flag symbol on Structure Chart
Data type: Numeric values of 0 to 31 rotate flag symbol clockwise, for example:
0" = south
8" = west
16" = north
24" = east
SYMFLD_SAMAJORTYPE
Major Type (that is, Symbol)
Data type: String
Read-only
SYMFLD_SAMAJORTYPENUMBER
Major Type number (that is, 2)
Data type: Numeric
Read-only
SYMFLD_SEQNUM
Entity Number on entity symbols.
Data type: Numeric
SYMFLD_SIZE
Symbol size
XSize YSize"
Data type: Numeric
SYMFLD_STARTLOC
Location of where line symbol starts.
XPos YPos"
Data type: Numeric
SYMFLD_STYLEFLAGS
Enables Symbol colors
Data type: Hexadecimal
0x0001" = Pen color
0x0002" = Fill color
0x0004" = Font color
SYMFLD_SUPERSUB
Sets Super-sub relationship value of the symbol
0" = neither
1" = Super
2" = Sub
SYMFLD_TEXTFLAGS
Text properties of symbol
Data type: Hexadecimal
SYMFLD_TOCARDINALITY
Returns ToCardinality name (for example, exactly one, one or many, and so on) For a complete list of ToCardinality values see ToCardinality attribute in Symbol class attributes.
Data type: String
Read-only
SYMFLD_TOCARDNUMBER
Returns ToCardinality constant number. For a complete list of ToCardinality values see ToCardinality attribute in Symbol class attributes.
Data type: Numeric
Read-only
SYMFLD_TOCONNECTCOMPASSPOINT
Returns N,E,S, or W for start point of an ICOM Arrow connected at the to end
Data type: String
Read-only
SYMFLD_TOEXARCCHAR
Inserts an exclusive arc at the to end of a line symbol.
Data type: Boolean
SYMFLD_TYPE
Symbol SA Type
Data type: Internal Constant number of SAType.
SYMFLD_TYPENAME
Symbol SA type name (for example, Entity, ICOM Arrow, and so on)
Data type: String
Read-only
SYMFLD_U_S1_WPICTYPE
Picture Type (added graphic file to diagram).
Data type: String
Read-only
SYMFLD_U_S1_ZPPICFILE
Path name of file being used to display picture.
Data type: String
Read-only
SYMFLD_UPDATEDATE
Date of last update
Data type: Date field
Read-only
SYMFLD_UPDATEDATEINTL
Date of last update (International Format)
Data type: Date Field
Read-only
SYMFLD_UPDATETIMEINTL
Time of last update (International Format)
Data type: Time Field
Read-only
SYMFLD_XPENTITY
Internal number given to symbol.
Data type: Numeric
Read-only
SYMFLD_XPGROUP
Internal number given to parent of the symbol.
Data type: Numeric
Read-only
SYMFLD-XPLINK
Internal number of symbol that the selected symbol is linked to (for example, Referent linked to a Unit of Behavior in an IDEF3 Process Flow diagram).