Public Class Library As Project

Properties Detail

• hasIncludeExternalLibraries (Get)

  Public Property Get hasIncludeExternalLibraries As Boolean
  Flag indicating if the object has IncludeExternalLibraries

• hasMajorElements (Get)

  Public Property Get hasMajorElements As Boolean
  Overridden to check for Types and Classes @see MajorElement.Classes

• hasOptions (Get)

  Public Property Get hasOptions As Boolean
  Flag indicating if the Library has Options

• hasTypes (Get)

  Public Property Get hasTypes As Boolean
  Flag indicating if the Object has Types

• hasUseLibraries (Get)

  Public Property Get hasUseLibraries As Boolean
  Flag indicating if the object has UseLibraries

• hasUseVSEs (Get)

  Public Property Get hasUseVSEs As Boolean
  Flag indicating if the object has UseVSE

• IncludeExternalLibraries (Get)

  Public Property Get IncludeExternalLibraries As StringQueue
  External Libraries needed by this Library @return StringsCarrier containing names of External Libraries to be included

• LibraryName (Get)

  Public Property Get LibraryName As String
  Name of the Library

• MajorElements (Get)

  Public Property Get MajorElements As Variant
  Array containing MajorElements contained by the Object Note: The only MajorElement objects that can be contained by an explicit MajorElement object are ObjectClass objects. Therefore, this Property is a wrapper for the MajorElement.Classes property. @see MajorElement.Classes

• Options (Get)

  Public Property Get Options As Variant
  String Array containing Options for the Library

• Types (Get)

  Public Property Get Types As Variant
  Array containing Types contained by the Object

• UseLibraries (Get)

  Public Property Get UseLibraries As StringQueue
  Libraries Used by this Library @return StringsCarrier containing names of Libraries used by this Library

• UseVSEs (Get)

  Public Property Get UseVSEs As StringQueue
  VSEs used by the Library @return StringQueue containing names of VSEs used by this Libary

Methods Detail

• removeIncludeExternalLibrary

  Public Function removeIncludeExternalLibrary(libraryname As String) As Boolean
  removes an External Library Name frome the "%Include" option of the object
  idx	Argument	Data Type	Attributes	Comments
  1	libraryname	String		Library to be removed.

• removeUseLibrary

  Public Function removeUseLibrary(libraryname As String) As Boolean
  removes a Library Name frome the "Use" option of the object
  idx	Argument	Data Type	Attributes	Comments
  1	libraryname	String		Library to be removed.

• removeUseVSE

  Public Function removeUseVSE(lsxname As String) As Boolean
  removes an VSE Name frome the "UseVSE" option of the object
  idx	Argument	Data Type	Attributes	Comments
  1	lsxname	String		VSE to be removed.

• appendIncludeExternalLibrary

  Public Sub appendIncludeExternalLibrary(library As String)
  appends an External Library Name to the "%Include" option of the object
  idx	Argument	Data Type	Attributes	Comments
  1	library	String		Name of the Library to append.

• appendOption

  Public Sub appendOption(source As String)
  Appends an Option to the Library
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		Formatted string representing the option to be added examples: Declare Public Base 1 Compare NoCase NoPitch

• appendType

  Public Sub appendType(source As ObjectType)
  Appends a Type to the Object
  idx	Argument	Data Type	Attributes	Comments
  1	source	ObjectType		ObjectType instance to be appended

• appendUseLibrary

  Public Sub appendUseLibrary(libraryname As String)
  appends a Library Name to the "Use" option of the object
  idx	Argument	Data Type	Attributes	Comments
  1	libraryname	String		Library to append

• appendUseVSE

  Public Sub appendUseVSE(lsxname As String)
  appends a VSE Name to the "UseVSE" option of the object
  idx	Argument	Data Type	Attributes	Comments
  1	lsxname	String		VSE to append

• New

  Public Sub New(Parent As CodeElement, LibraryName As String, Summary As String, Description As String)
  Constructor
  idx	Argument	Data Type	Attributes	Comments
  1	Parent	CodeElement		Parent Object for the Object
  2	LibraryName	String		Label Label (Name) for the Object
  3	Summary	String		Summary information about the Object
  4	Description	String		Detailed Description of the Object
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if LibraryName is Blank