SampleApp.Form1 Class
Form1 is the main form for the application. It contains three tabbed pages. The first page diplays the File Plan. The second page displays Life Cycle batch operation results. The third page displays logging and error information.

Access: Public
Base Classes: Form
  Members Description  
    Form1 Constructor:

Configuration setting are read from the app.config file.

The value Form1.m_isHostLogin determines if the login or hostLogin method will be used to authenticate with the Records Manager.

The value Form1.m_serverNamePort specifies the Records Manager Web Services server name and port.

The value Form1.m_databaseName specifies the Records Manager databa source to use.

Form1.m_language specifies the language to use.

Form1.m_userName specifies the user name to use for logging in.

 
    Dispose Clean up any resources being used.

 
    InitializeComponent Required method for Designer support - do not modify the contents of this method with the code editor.

 
    Main The main entry point for the application.

 
    irmFactory Returns the current ClientSession object.

 
    SetFilePlanTabActive Activates the File Plan Explorer tab.

 
    FindTreeNode Given the File Plan Component ID, the View ID and the Definition ID of a component this method searches the File Plan for it's location. The method expands all tree nodes along the path to the component and then highlights the component node. Given enough info you can automatically find anything.

 
    log This method appends text to the text box on the Log Messages Tab.

 
    appendText This method appends text to the text box on the Log Messages Tab.

 
    initClientSession This method creates a new Client Session object (if needed) using information determined in the Form1 constructor and then calls the appropriate login method.

 
    DeleteFilePlanComponent Delete the specified File Plan Component and all it's children.

 
    DeleteFilePlanView Delete the specified File Plan View. Note it will not be possible to delete a View unless all it's children and relationship definitions have been deleted.

 
    autoGen Automatically generates child components under the selected component node.

 
    tvFilePlan_AfterSelect This event is called after a tree node is selected. When a tree node is selected the children for the selected node will be displayed in the corresponding List View.

 
    mnuDeleteTreeItem_Click This event responds to the tree view context menu delete command. The delete operation depends upon the type of component selected.

 
    menuLifeCycleQuery_Click This event responds to the tree view Life Cycle Query... command. First a Saved Life Cycle Query list will be displayed then the Query will be executed using the Full Path of the selected node as the context for the search. The Search results are displayed in a modeless window.

 
    mnuSearchTreeItem_Click This event responds to the tree view Life Cycle Query... command. First a Saved Query list will be displayed then the Query will be executed using the Full Path of the selected node as the context for the search. The Search results are displayed in a modeless window.

 
    mnuAddTreeItemTarget_Click This event responds to the tree view Add command. If the selected component has more than one type of target that is allowed to be added then a list window is displayed showing available target types. If only one type is allowed then the component properties form is displayed immediately. Note the Component Properties form that is displayed uses the current users assigned profile and default values. Currently this form only displays the most primitive type of imput controls (Text Boxes) and no signicant client side business logic or validation is performed.

 
    mnuEditTreeItem_Click This event responds to the tree view Edit command. Note the Component Properties form that is displayed uses the current users assigned profile and current values. Currently this form only displays the most primitive type of imput controls (Text Boxes) and no signicant client side business logic or validation is performed.

 
    mnuAutoGen_Click Responds to the tree view Autogen command Automatically generates 10 of each allowed target for the selected component.

 
    cntxtMnuTreeView_Popup Called before the tree view context menu pops up. Use this method to configure the context menu depending on the definition type of the selected component.

 
    tvFilePlan_BeforeExpand Called just before a tree view item is about to expand. Use this method to get the list of targets (children) for the selected component so that they may be displayed. The event is not triggered if the selected node has already had this event called upon it.

 
    mnuRefreshTreeItem_Click Responds to the treeview Refresh command. This method will walk down through the branches of the selected node and call the Records Manager Engine to get updated File Plan information and adjust the tree view to reflect the current state.

 
    mnuViewTreeItem_Click This event responds to the tree view "View" command. Note the Component Properties form that is displayed uses the current users assigned profile and current values. Currently this form only displays the most primitive type of display controls (Text Boxes) and no signicant client side business logic is performed.

 
    DisplayViewList Gets the List of File Plan Views and displays their information in the File Plan Explorer List View.

 
    RefreshContainerView Refreshes the tree branch under the specified View. Used when components are put in a container (linked to an external source).

 
    mnuEditListItem_Click This event responds to the List view Edit command. Note the Component Properties form that is displayed uses the current users assigned profile and default values. Currently this form only displays the most primitive type of imput controls (Text Boxes) and no signicant client side business logic or validation is performed.

 
    mnuMigrateListItems_Click Responds to the List View context menu "Put in Container" command. This method takes the selected components and adds a specified source to each component. This is sometimes called migration. The selected components (if allowed) will become targets to the specified source component. This can simulate physical records being placed in a box. The records are physically in the box yet they still belong to a logical classification scheme.

 
    mnuUnMigrateListItems_Click Responds to the List View context menu "Remove from Container" command. This method takes the selected components and removes them from the source that they are displayed in. This could simulate removing records from a box. Note components cannot remove the source link in their primary view.

 
    mnuViewListItem_Click This event responds to the List view "View" command. Note the Component Properties form that is displayed uses the current users assigned profile and current values. Currently this form only displays the most primitive type of display controls (Text Boxes) and no signicant client side business logic is performed.

 
    mnuDeleteListItem_Click This method deletes the selected list of File Plan Components.

 
    cntxtMnuListView_Popup Called before the List View context menu pops up. Use this method to configure the context menu depending on the definition type of the selected component.

 
    addFilePlanComponents Adds nCount components for all allowed targets to the specified File Plan Component. See Autogen.

 
    Form1_Load Logs into the Records Manager

 
    mnuLogin_Click Logs into the Records Manager using login method

 
    mnuHostLogin_Click Logs into the Records Manager using hostLogin method

 
    doLogin Executes Login

 
    mnuTestCode_Click Test Code - use this area to try things out. Display results on Log Message page.

 
    tabControl2_SelectedIndexChanged Fired when a tab selection is made. Refresh the Life Cycle results if that page is selected.

 
    mnuViewLifeCycleResults_Click Responds to the Life Cycle Reports List View context menu command - "View Results" Displays the results of the Life Cycle Query for the selected item.

 
    mnuDeleteLifeCycleResults_Click Responds to the Life Cycle Reports List View context menu command - "Delete" Deletes the selected batch operation and all associated operations.

 
    mnuTransitionLifeCycleResults_Click Responds to the Life Cycle Reports List View context menu command - "Transition" Transitions the list of File Plan Components in the selected Life Cycle Results item.

 
    menuViewTransitionResults_Click Responds to the Life Cycle Reports List View context menu command - "Show Transition Results..." Shows the status values for the Transitions executed on the selected Life Cycle Results item.

 
    DrawLifeCycleReports Draws the status items for all batch Life Cycle Reports for the current user.

 
    m_LookUp    
    util    
    m_session    
    m_isHostLogin    
    m_serverNamePort    
    m_databaseName    
    m_databaseJNDIName    
    m_language    
    m_extUserId    
    m_userName    
    m_bLoggedIn    
    m_lastSelectedNode    
    mainMenu1    
    menuItem1    
    openFileDialog1    
    menuItem3    
    cntxtMnuListView    
    menuItem9    
    mnuEditListItem    
    mnuViewListItem    
    mnuDeleteListItem    
    cntxtMnuTreeView    
    mnuEditTreeItem    
    mnuViewTreeItem    
    mnuDeleteTreeItem    
    menuItem8    
    mnuSearchTreeItem    
    menuItem6    
    mnuAutoGen    
    tabControl2    
    tabFilePlanExplorer    
    statusBar1    
    splitter1    
    tabTextPage    
    textBox1    
    tvFilePlan    
    splitter2    
    columnHeaderName    
    columnHeaderComponent    
    columnHeaderTitle    
    lvComponents    
    mnuTestCode    
    menuLifeCycleQuery    
    imageList1    
    mnuAddTreeItemTarget    
    mnuAddListItemTarget    
    components    
    mnuRefreshTreeItem    
    tabLifeCycleReports    
    lvLifeCycleReports    
    cntxtMnuBatchList    
    mnuViewLifeCycleResults    
    mnuDeleteLifeCycleResults    
    mnuTransitionLifeCycleResults    
    menuViewTransitionResults    
    mnuMigrateLitsItems    
    mnuUnMigrateListItems    
    mnuLogin    
    mnuHostLogin