Library BSXnotesUtilsUI

Properties Detail

• CurrentDataType (Get)

  Public Property Get CurrentDataType As String
  Current Data Type for the active ui LSX Configuration form.

• CurrentDataType (Set)

  Public Property Set CurrentDataType As String
  Current Data Type for the active ui LSX Configuration form.

Methods Detail

• addConstantToProject

  Public Function addConstantToProject(source As NotesUIDocument, ndoc As NotesDocument, newconstant As String) As Boolean
  Add a new constant to the currently open UI Project document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		the current UI Document being edited.
  2	ndoc	NotesDocument		Document backing the source UI Document (source.Document)
  3	newconstant	String		The new constant to be added

• composeElementDocument

  Public Function composeElementDocument(targetform As String) As Boolean
  Composes an Element (Class, Method, Property, etc) Document and presents it in the UI Called from action buttons in the Projects views
  idx	Argument	Data Type	Attributes	Comments
  1	targetform	String		Name of the Form to be used for the newly composed document
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if targetForm is Blank
  MSG_DOCUMENT_NOT_FOUND	1020	if the current selected document in the view is neither a project nor a class, and it's Parent document cannot be found.

• getCurrentUIDocument

  Public Function getCurrentUIDocument() As NotesUIDocument
  Gets the current open UI document

• getCurrentUIWorkspace

  Public Function getCurrentUIWorkspace() As NotesUIWorkspace
  Gets the current UI Workspace

• getTargetDirectory_APIdoc

  Public Function getTargetDirectory_APIdoc() As String
  Conditionally queries the user for the current APIdoc Target Directory.

• getTargetDirectory_VSE

  Public Function getTargetDirectory_VSE() As String
  Conditionally queries the user for the current VSE Target Directory.

• getTargetDirectory_VSS

  Public Function getTargetDirectory_VSS() As String
  Conditionally queries the user for the current VSS Target Directory.

• querysave_class_pt1

  Public Function querysave_class_pt1(source As NotesUIDocument, ndoc As NotesDocument, currProject As NotesDocument) As Boolean
  Performs Part 1 of QuerySave validation for a class or class_script document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		NotesUIDocument representing the class_script document being edited.
  2	ndoc	NotesDocument		[OUTBOUND] NotesDocument backing the source NotesUIDocument
  3	currProject	NotesDocument		[OUTBOUND] Current Project document for which the document is a member

• querysave_class_pt2

  Public Function querysave_class_pt2(nuiwsp As NotesUIWorkspace, source As NotesUIDocument, ndoc As NotesDocument, currProject As NotesDocument) As Boolean
  Performs Part 2 of QuerySave validation for a class or class_script document
  idx	Argument	Data Type	Attributes	Comments
  1	nuiwsp	NotesUIWorkspace		NotesUIWorkspace for the class_script Form.
  2	source	NotesUIDocument		NotesUIDocument representing the class_script document being edited.
  3	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument
  4	currProject	NotesDocument		Current Project document for which the document is a member
  Throws Exceptions
  Message	Error Code	Comments
  MSG_PARAMETER_BLANK	1199	if nuiwsp, source, ndoc, or currProject is Nothing

• querysave_event

  Public Function querysave_event(source As NotesDocument, ndoc As NotesDocument, classname As String) As Boolean
  Performs QuerySave validation for an event document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesUIDocument representing the document being edited.
  2	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument
  3	classname	String		[OUTBOUND] Effective class name for the event

• querysave_method

  Public Function querysave_method(source As NotesDocument, ndoc As NotesDocument, classname As String) As Boolean
  Performs QuerySave validation for a method or method_script document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesUIDocument representing the document being edited.
  2	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument
  3	classname	String		[OUTBOUND] Effective class name for the method

• querysave_project

  Public Function querysave_project(source As NotesDocument, ndoc As NotesDocument) As Boolean
  Performs QuerySave validation for a project or project_script document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesUIDocument representing the document being edited.
  2	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument

• querysave_property

  Public Function querysave_property(source As NotesDocument, ndoc As NotesDocument, classname As String) As Boolean
  Performs QuerySave validation for a property or property_script document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesUIDocument representing the document being edited.
  2	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument
  3	classname	String		[OUTBOUND] Effective class name for the property

• querysave_type

  Public Function querysave_type(source As NotesDocument, ndoc As NotesDocument) As Boolean
  Performs QuerySave validation for a type_script document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesUIDocument representing the document being edited.
  2	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument

• querysave_variable

  Public Function querysave_variable(source As NotesDocument, ndoc As NotesDocument, classname As String) As Boolean
  Performs QuerySave validation for a variable or variable_script document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesDocument		NotesUIDocument representing the document being edited.
  2	ndoc	NotesDocument		NotesDocument backing the source NotesUIDocument
  3	classname	String		[OUTBOUND] Effective class name for the variable

• validateNameField

  Public Function validateNameField(source As NotesUIDocument, ndoc As NotesDocument, label As String, fieldname As String, fieldvalue As String, parentname As String, maxlen As Integer, skipValidateSiblings As Boolean) As Boolean
  Validates a named field from an open NotesUIDocument
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		UI Document for which to validate the named field.
  2	ndoc	NotesDocument		Document backing the source NotesUIDocument
  3	label	String		Label of the Field to validate
  4	fieldname	String		Name of the Field to validate
  5	fieldvalue	String		[OUTBOUND] text value of the field.
  6	parentname	String		[OUTBOUND] name of the parent class / type (if applicable)
  7	maxlen	Integer		Maximum number of characters for the value of the field.
  8	skipValidateSiblings	Boolean		Flag indicating if name validation for sibling documents should be skipped.

• validateNonDuplicateSiblings

  Public Function validateNonDuplicateSiblings(source As NotesUIDocument, parent As NotesDocument, ndoc As NotesDocument, label As String, fielname As String, fieldvalue As String) As Boolean
  Validates that a given document has no duplicate siblings for a specified field value.
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		UI Document being worked on.
  2	parent	NotesDocument		parent document to the source NotesUIDocument
  3	ndoc	NotesDocument		Document backing the source NotesUIDocument
  4	label	String		Label of the Field to validate
  5	fielname	String		Name of the Field to validate
  6	fieldvalue	String		text value of the field.

• validateProjectConstants

  Public Function validateProjectConstants(source As NotesUIDocument, ndoc As NotesDocument, token As String, value As String, tokenvalue As String) As Boolean
  Validates the Token and Value fields (Constants) of a Project document
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		UI Document representing the Project being edited.
  2	ndoc	NotesDocument		Document backing the source NotesUIDocument
  3	token	String		[OUTBOUND] value of C_Token field.
  4	value	String		[OUTBOUND] value of C_Value field
  5	tokenvalue	String		[OUTBOUND] Validated formatted token value string (if successful). Empty string oherwise.

• ArgByVal_Entering

  Public Sub ArgByVal_Entering(fieldsuffix As Integer)
  Field Entering UI logic for Argument ByValue fields 09 DEC 2022 - Added error trapping (Rock)
  idx	Argument	Data Type	Attributes	Comments
  1	fieldsuffix	Integer		Number used to identify the specific Argument field being entered.

• ArgDataType_Entering

  Public Sub ArgDataType_Entering(fieldsuffix As Integer)
  Field Entering UI logic for Argument Data Type fields 09 DEC 2022 - Added error trapping (Rock)
  idx	Argument	Data Type	Attributes	Comments
  1	fieldsuffix	Integer		Number used to identify the specific Argument field being entered.

• ArgDataType_Exiting

  Public Sub ArgDataType_Exiting(fieldsuffix As Integer)
  Field Exiting UI logic for Argument Data Type fields 09 DEC 2022 - Added error trapping (Rock)
  idx	Argument	Data Type	Attributes	Comments
  1	fieldsuffix	Integer		Number used to identify the specific Argument field being exited.

• checkForceEditMode

  Public Sub checkForceEditMode(source As NotesUIDocument)
  Conditionally forces a UI document into edit mode
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		UI document to conditionally force into edit mode

• clearArgumentOptions

  Public Sub clearArgumentOptions(source As NotesUIDocument, idx As Integer)
  Clears values of options fields for a specific argument on a NotesUIdocument
  idx	Argument	Data Type	Attributes	Comments
  1	source	NotesUIDocument		Currently open UI document
  2	idx	Integer		integer indicating the specific instance field names to use

• exportSkeletonsAsFiles

  Public Sub exportSkeletonsAsFiles()
  Exports Skeleton documents as files.

• importSkeletonsAsFiles

  Public Sub importSkeletonsAsFiles()
  Queries the user and Imports LSX Skeleton Files into the database

• PlatformLimitationKeywordAdvisory

  Public Sub PlatformLimitationKeywordAdvisory(label As String, elementname As String)
  Opens a messagebox advising that, due to platform limitations an an element cannot be checked for language keywords.
  idx	Argument	Data Type	Attributes	Comments
  1	label	String		Label for the element.
  2	elementname	String		Name of the element.

• refreshArguments

  Public Sub refreshArguments()
  This sub is called from the refresh and on the save of LSX Design Docs It updates the list of arguments for the current method or event Then the count is wrtten to an existing temp field - F_TempArgCount

• RenameClasses

  Public Sub RenameClasses(projectUNID As String, classUNID As String, classOldName As String, classNewName As String)
  Replaces the old classname with a new classname for all documents in a project
  idx	Argument	Data Type	Attributes	Comments
  1	projectUNID	String		Project UniversalID
  2	classUNID	String		Class UniversalID
  3	classOldName	String		Old name of class
  4	classNewName	String		New name of class

• setArgumentOptions

  Public Sub setArgumentOptions(idx As Integer)
  Checks and sets options for arguments on the current UI document
  idx	Argument	Data Type	Attributes	Comments
  1	idx	Integer		integer indicating the specific instance field names to use

• SetConfiguration

  Public Sub SetConfiguration()
  Presents the configuration dialog to the user and saves the user's changes.

• UpdateArgList

  Public Sub UpdateArgList()
  This sub is called from the refresh and on the save of LSX Design Docs. It updates the list of arguments for the current method or event Then the count is wrtten to an existing temp field - F_TempArgCount

• UpdateClassList

  Public Sub UpdateClassList()
  This sub is called from the exit event of all fields on LSX Design Docs It creates an up-to-date list of classes for the current project, then write the list of an existing temp field - F_TempClassList Added code to clear advanced argument properties when argument name and type are cleared.