Library BSXnotesUtils

Methods Detail

• ArchiveTag

  Public Function ArchiveTag(S1 As String, S2 As String) As String
  Generates an Archive Tag from two strings. PATTERN: (s1)[s2]
  idx	Argument	Data Type	Attributes	Comments
  1	S1	String		1st string for the tag
  2	S2	String		2nd string for the tag

• generateLibrary

  Public Function generateLibrary(source As NotesDocument, parent As CodeElement) As Library
  Generates a BSXdocumentationUtils.VSE object for a VSE
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesDocument representing the Library from which to generate the Library Object
  2	parent	CodeElement		Parent VSID object.

• generateVSE

  Public Function generateVSE(source As NotesDocument, parent As CodeElement) As VSE
  Generates a BSXdocumentationUtils.VSE object for a VSE
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesDocument representing the VSE from which to generate the VSE Object
  2	parent	CodeElement		Parent VSID for the VSE

• generateVSID

  Public Function generateVSID(includeVSEs As Boolean, includeLibraries As Boolean) As VSID
  Generates a BSXdocumentationUtils.VSID object for the VSID Database **IMPORTANT NOTE: "Project" forms are associated with "VSE" classes The VSID class represents the VSID Database, and can contain MULTIPLE VSE classes generated from MULTIPLE Project forms!!!
  idx	Argument	Data Type	Attributes	Comments
  1	includeVSEs	Boolean		Flag indicating if VSE (form = "project") content should be included.
  2	includeLibraries	Boolean		Flag indicating if Script Library (form = "project_script") content should be included.

• getConstructorUNIDforClassName

  Public Function getConstructorUNIDforClassName(project As NotesDocument, classname As String) As String
  Gets the UniversalID of the Constructor Method document ("New" Method) for the specified child class of a Project
  idx	Argument	Data Type	Attributes	Comments
  1	project	NotesDocument		the Project NotesDocument for which to retrieve the child Class document UniversalID
  2	classname	String		Name of the child class.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if the project is Nothing or the classname is blank

• getDataTypeCategory

  Public Function getDataTypeCategory(datatypename As String) As Integer
  Gets the Category Number for the specific Data Type
  idx	Argument	Data Type	Attributes	Comments
  1	datatypename	String		Name of the Data Type
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source is blank

• getItemNamesPotentialHTML

  Public Function getItemNamesPotentialHTML(form As String) As StringStack
  Gets item names for a specific form that may potentially contain HTML content
  idx	Argument	Data Type	Attributes	Comments
  1	form	String		Name of the Form for which to get the item names

• getToolKitConfigDoc

  Public Function getToolKitConfigDoc(clearcache As Boolean) As NotesDocument
  getToolKitConfigDoc
  idx	Argument	Data Type	Attributes	Comments
  1	clearcache	Boolean		Flag indicating to clear the cache

• getUNIDforClassName

  Public Function getUNIDforClassName(project As NotesDocument, classname As String) As String
  Gets the UniversalID for a specified child class of a Project
  idx	Argument	Data Type	Attributes	Comments
  1	project	NotesDocument		the Project NotesDocument for which to retrieve the child Class document UniversalID
  2	classname	String		Name of the child class.
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if the project is Nothing
  MSG_PARAMETER_BLANK	1199	if the classname is blank

• getUNIDsByForm

  Public Function getUNIDsByForm(form As String) As StringQueue
  Gets the UniversalIDs of all Documents matching a specified form.
  idx	Argument	Data Type	Attributes	Comments
  1	form	String		Name of the form for which to retrive the UniversalIDs

• GenerateLSXClassID

  Public Function GenerateLSXClassID(ProjectDoc As NotesDocument, ClassName As String, CreateIfNotFound As Boolean) As Long
  Generates a classid for a new class in an LSX wizard project. This function checks the archive item in the project doc first, to preserve old IDs. reo 07/14/2007 Created
  idx	Argument	Data Type	Attributes	Comments
  1	ProjectDoc	NotesDocument		Project Document for LSX
  2	ClassName	String		Name of the class
  3	CreateIfNotFound	Boolean		Flag indicating if a new LSX ClassID should be generated

• GenerateLSXMethodID

  Public Function GenerateLSXMethodID(ProjectDoc As NotesDocument, ClassName As String, MethodName As String, AddIfNotFound As Boolean) As Long
  Each property/event/method in an LSX DLL has an ID value associated with it that is compiled into lotuscript. To prevent reshuffling of these IDs every time we regenerate the code for the DLL, we keep an archive of all the p/m/e names we've used thus far and their ID values, only extending the list. This provides a degree of backwards compatibility across compiled LotusScript and new versions of LSX DLLs. NOTE: This function saves the current LSX project document! We're currently called by the form methods: Method.QuerySave(), Property.QuerySave(), and Event.QuerySave() We're also called by CreateNewMethodDocument to handle the New() function for each class. reo 07/14/2007 Created
  idx	Argument	Data Type	Attributes	Comments
  1	ProjectDoc	NotesDocument		Project Document
  2	ClassName	String		Name of the Class
  3	MethodName	String		Name of the Method
  4	AddIfNotFound	Boolean		Flag indicating that a new LSXMethodID should be generated if one cannot be found for the current Project, Class, and Method.

• importProjects

  Public Function importProjects(source As NotesDatabase) As StringQueue
  Imports all Project documents and their descendents from another (VSE Wizard / VSID / VSID) database.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDatabase		Database from which to import the Project documents and their descendents
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if source database is Nothing

• isValidGUID

  Public Function isValidGUID(source As String) As Boolean
  idx	Argument	Data Type	Attributes	Comments
  1	source	String		String to test.

• resetCollectionAncestorIDs

  Public Function resetCollectionAncestorIDs(unids As StringQueue) As Integer
  Conditionally resets the ancestor ID fields (F_ProjectID, F_ClassID, F_TypeID) for documents matching UniversalIDs
  idx	Argument	Data Type	Attributes	Comments
  1	unids	StringQueue		unids UniversalIDs of all documents to reset. NOTE: UniversalIDs will be popped from this StringQueue, causing it to be EMPTY after this method exits successfully.

• updateProjects

  Public Function updateProjects() As Integer
  Updates all Project documents and their descendants.

• writeAPIdoc_supportFiles

  Public Function writeAPIdoc_supportFiles(writer As VSIDwriter) As StringQueue
  Writes the supporting files for balidoc (css, images, etc) to the target directory.
  idx	Argument	Data Type	Attributes	Comments
  1	writer	VSIDwriter		VSID API Documentation Writer to use
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if writer is Nothing
  MSG_OPERATION_FAILED	1000	if file system exception on failure.

• CreateLSXArchivesIfMissing

  Public Sub CreateLSXArchivesIfMissing(ProjectDoc As NotesDocument)
  Checks for the existence for class and method ID archive items on the project document. If they do not exist, we reorder the class and method IDs and archive them to be backwards compatible in the future. This method changes and saves the project doc. (RO) reo 08/03/2007 Created
  idx	Argument	Data Type	Attributes	Comments
  1	ProjectDoc	NotesDocument		Document for which to create the LSX Archives.

• CreateNewMethodDocument

  Public Sub CreateNewMethodDocument(source As NotesDocument)
  Creates a new Method document for the specified class document.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		Class document to which the method should become a response.

• DeleteFileSilently

  Public Sub DeleteFileSilently(theFileName As String)
  Quietly kills a specified file.
  idx	Argument	Data Type	Attributes	Comments
  1	theFileName	String		filepath of the file that should be deleted.

• DumpSkeletons

  Public Sub DumpSkeletons()
  Dump the UNID of the Skeleton documents to a text file. Can be called from the LSX Skeletons view.

• loadVSIDstubContent

  Public Sub loadVSIDstubContent(vsidsuffix As String)
  Loads the VSID Stub Content StringsCarrierList with content from VSIDxxx File Resources which match the suffix
  idx	Argument	Data Type	Attributes	Comments
  1	vsidsuffix	String		suffix for VSIDxxx named File Resources to match

• getAttributeNameStubs

  Static Public Function getAttributeNameStubs() As Variant
  Gets a string array containining Name Stubs for VSE Attributes

• getAttributeNameStubs_Script

  Static Public Function getAttributeNameStubs_Script() As Variant
  Gets a string array containining Name Stubs for VSS Attributes