Public Class BSXscriptNode As ValuedElement

Properties Detail

• authorNodeFQNs (Get)

  Public Property Get authorNodeFQNs As StringQueue
  FQNs of all descendent nodes that represent VSID Author Blocks @return StringQueue containing the FQNs of all descendent VSID Author Nodes.

• Arguments (Get)

  Public Property Get Arguments As Variant
  Array containing the Object Arguments

• childCount (Get)

  Public Property Get childCount As Integer
  Number of Child Nodes for this object

• Classes (Get)

  Public Property Get Classes As Variant
  All child BSXscriptNodes that have an instancecode of SIGNATURE_VALUE_CLASS @return Array of all child BSXscriptNodes that have an instancecode of SIGNATURE_VALUE_CLASS. If no such nodes exist, returns a single-element array containing Nothing

• CodeSample (Get)

  Public Property Get CodeSample As String
  CodeSample for the object

• Comment (Get)

  Public Property Get Comment As String
  Comment for the object

• FirstRemContent (Get)

  Public Property Get FirstRemContent As String
  Everything between the first child node that begins with "%REM" and the first child node that begins with "%END REM" @return First Rem Content, concatenated with a CRLF

• FQN (Get)

  Public Property Get FQN As String
  Fully Qualified Name of the Object @return Fully Qualified Name of the Object

• hasArguments (Get)

  Public Property Get hasArguments As Boolean
  Flag indicating if the Object has Arguments

• hasChildNodes (Get)

  Public Property Get hasChildNodes As Boolean
  Flag indicating the object has child nodes

• isClass (Get)

  Public Property Get isClass As Boolean
  Flag indicating if the Object is a Class

• isEvent (Get)

  Public Property Get isEvent As Boolean
  Flag indicating if the Object represents an Event

• isFunction (Get)

  Public Property Get isFunction As Boolean
  Flag indicating if the Object represents a Function

• isGetter (Get)

  Public Property Get isGetter As Boolean
  Flag indicating if the Object represents a Getter

• isInstanceComplete (Get)

  Public Property Get isInstanceComplete As Boolean
  Flag indicating the current Instance element being parsed is complete (has reached and read the "End XXX" line)

• isLastChildComplete (Get)

  Public Property Get isLastChildComplete As Boolean
  Flag indicating the last child object of the current Instance element is considered complete (has reached and read the "End XXX" line) @return if last child exists, the value of lastchild.isInstanceComplete.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_OPERATION_PROHIBITED	1003	if Last Child is Nothing

• isLastChildRemarkComplete (Get)

  Public Property Get isLastChildRemarkComplete As Boolean
  Flag indicating the last child object of the current Instance element is a Remark (%REM...%END REM) and is complete @return if the last child exists, the value of (lastchild.isRemark AND lastchild.isInstanceComplete).
  Throws Exceptions
  Message	Error Code	Comments
  MSG_OPERATION_PROHIBITED	1003	if Last Child is Nothing

• isLibrary (Get)

  Public Property Get isLibrary As Boolean
  Flag indicating if the Object represents a Library

• isProperty (Get)

  Public Property Get isProperty As Boolean
  Flag indicating if the Object represents a Property

• isRemark (Get)

  Public Property Get isRemark As Boolean
  Flag indicating if the Object represents a Remark

• isSetter (Get)

  Public Property Get isSetter As Boolean
  Flag indicating if the Object represents a Setter

• isSub (Get)

  Public Property Get isSub As Boolean
  Flag indicating if the Object represents a Sub

• isType (Get)

  Public Property Get isType As Boolean
  Flag indicating if the Object represents a Type

• isVariable (Get)

  Public Property Get isVariable As Boolean
  Flag indicating if the Object represents a Variable

• isVSID_AUTHOR_BLOCK (Get)

  Public Property Get isVSID_AUTHOR_BLOCK As Boolean
  Flag indicating if this object instance a VSID Author Block

• InstanceCode (Get)

  Public Property Get InstanceCode As Long
  Numeric code indicating the Instance Type (such as Sub, Function, or Property)

• InstanceNumber (Get)

  Public Property Get InstanceNumber As Long
  Instance number of the node (relative to sibling nodes)

• InstanceType (Get)

  Public Property Get InstanceType As String
  String representing the Instance Type (such as Sub, Function, or Property)

• LastChild (Get)

  Public Property Get LastChild As BSXscriptNode
  The last child BSXscriptNode contained by the object.

• LastRemContent (Get)

  Public Property Get LastRemContent As String
  Everything between the last child node that begins with "%REM" and the last child node that begins with "%END REM" @return Last Rem Content, concatenated with a CRLF

• LineCount (Get)

  Public Property Get LineCount As Long
  Total Lines of Code for the object (and all children) @return Number of lines of code for the object, including all childre

• MethodType (Get)

  Public Property Get MethodType As String
  String representation of the Method Type (Sub, Function, or Property)

• nodeTags (Get)

  Public Property Get nodeTags As StringQueue
  Tags for all nodes (and child nodes) contained within this object. @return StringQueue containing tags for all nodes. If no nodes exist, StringQueue will be empty

• ParentFQN (Get)

  Public Property Get ParentFQN As String
  Fully Qualified Name of the Object's Parent @return Fully Qualified Name of the Object's Parent

• QN (Get)

  Public Property Get QN As String
  Qualified Name of the Object QN is the FQNprefix (a constructor argument) concatenated (using a period character) with the object's Label. NOTE: All whitespace in the QN Prefix and Label will be removed.

• Script (Get)

  Public Property Get Script As String
  Generated Script Source Code for the object

• SignatureCode (Get)

  Public Property Get SignatureCode As Long
  Numeric code indicating the Instance Type (such as Sub, Function, or Property)

• ValueType (Get)

  Public Property Get ValueType As String
  Extrapolated type (such as String, Integer, etc) - pulled from the first line of the object's Script property

• InstanceCode (Set)

  Public Property Set InstanceCode As Long
  Numeric code indicating the Instance Type (such as Sub, Function, or Property)

• QN (Set)

  Public Property Set QN As String
  Qualified Name of the Object QN is the FQNprefix (a constructor argument) concatenated (using a period character) with the object's Label. NOTE: All whitespace in the QN Prefix and Label will be removed.

• SignatureCode (Set)

  Public Property Set SignatureCode As Long
  Numeric code indicating the Instance Type (such as Sub, Function, or Property)

Methods Detail

• getNode

  Public Function getNode(key As String) As BSXscriptNode
  Retrieves the child node matching the associated key. Searches for direct child node first, if none found then searches in all partially matched child nodes.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String	ByVal	QN identifier of the child node to retrive
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if key is blank.

• hasNode

  Public Function hasNode(key As String) As Boolean
  Indicates if the object has a child node matching the specified key. Searches for direct child node first, if none found then searches in all partially matched child nodes.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String	ByVal	QN identifier of the child node for which to search
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if key is blank.

• insertNode

  Public Function insertNode(source As BSXscriptNode) As Boolean
  Inserts the specified node to the object. Uses the node's QN to determine the appropritate location to place the node (either as a direct child or as a descendent within the appropriate childe node). If the new node does not have an appropriate matching node to replace it will be added as a new child node.
  idx	Argument	Data Type	Attributes	Comments
  1	source	BSXscriptNode		Node to be added to the object.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source Node is Nothing
  MSG_OPERATION_PROHIBITED	1003	if source Node's QN matches the QN of the object.

• removeNode

  Public Function removeNode(key As String) As Boolean
  Removes a child node matching the associated key. Searches for direct child node first, if none found then searches in all partially matched child nodes. If a matching node is found it will be removed.
  idx	Argument	Data Type	Attributes	Comments
  1	key	String		QN identifier of the child node to retrive
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if key is blank.

• spawnBSXScriptCodeObject

  Public Function spawnBSXScriptCodeObject(objParent As CodeElement) As Variant
  Spawns a CodeOjbect from the Script Node.
  idx	Argument	Data Type	Attributes	Comments
  1	objParent	CodeElement		Parent Object for the Object
  Throws Exceptions
  Message	Error Code	Comments
  ERR_PARAMETER_BLANK	1199	if objParent is Nothing

• appendArgument

  Public Sub appendArgument(source As ValuedElement)
  Appends an Argument to the Object
  idx	Argument	Data Type	Attributes	Comments
  1	source	ValuedElement		Argument to be appended

• clearInstanceCode

  Public Sub clearInstanceCode()
  Sets the object's InstanceCode to zero

• markIncomplete

  Public Sub markIncomplete()
  Sets the object's isInstanceComplete flag to False

• New

  Public Sub New(parent As BSXscriptNode, FQNprefix As String, Comment As String)
  Constructor
  idx	Argument	Data Type	Attributes	Comments
  1	parent	BSXscriptNode		BSXscriptNode for the Object
  2	FQNprefix	String		Fully Qualified Name Prefix for the Object
  3	Comment	String		Comment about the Object