dmbSyncWithCellForm

dmbSyncWithCellForm( 
s_form 
s_synctype 
s_libraryName 
s_cellName 
[ s_viewName ] 
[ s_versionNumber ] 
)
=> t / nil

Description

Establishes synchronization between a given form and the Library Browser. The given library, cell, and view fields are filled in as you select items in the Library Browser.

Any form in the DFII software can be linked to the Library Browser. Linking ensures that the library, cell, view, and version fields of the corresponding form and the selected expansion in the Library Browser window are synchronized. One of these two functions should be called immediately before bringing up any form that is to be synchronized with the Library Browser. The last four parameters to these functions dictate which fields in the form are synchronized with the Library Browser when the dmbUpdateBrowser function is invoked. You can synchronize only one form at a time with the Library Browser.

dmbSyncWithForm and dmbSyncWithCellForm are identical, except that s_viewName is required in dmbSyncWithForm and is optional in dmbSyncWithCellForm.

Supplied for compatibility. Replace both with ddsSyncWithForm.

Arguments

s_form	Name of the form that is calling the Library Browser.
s_synctype	Specifies an action to further control the use of the Library Browser. Defines how the Library Browser is called:
	’design Opens automatically when the Open Design form is displayed in the DFII software. ’place Opens automatically when the Place Instance form appears. (There are several types of Place Instance forms.)
	’other Opens automatically when any other type of linked form is displayed in the DFII software. ’browse Opens manually by selecting the Browse button from one of the above three types of forms.
s_libraryName	Represents the symbol of the form text field that is to hold the name of the library selected. This is the same as the library form field name specified in hiCreateForm.
s_cellName	The symbol of the form text field that is to hold the cell name. It is the same as the cell form field name specified in hiCreateForm.
s_viewName	The symbol of the form text field that is to hold the view name. It is the same as the view form field name specified in hiCreateForm.
s_versionNumber	The version number form field name specified in hiCreateForm.

Value Returned

t	The function succeeds.
nil	No library is selected or the Library Browser is not synchronized with any particular form.

Examples

exampleLibName = hiCreateStringField(
        ?name 'exampleLibName
        ?prompt "Library Name"
        ?value ""
        ?callback "dmbUpdateBrowser( )"
        )
exampleCellName = hiCreateStringField(
        ?name 'exampleCellName
        ?prompt "Cell Name"
        ?callback "dmbUpdateBrowser( )"
        )
exampleViewName = hiCreateStringField(
        ?name 'exampleViewName
        ?prompt "View Name"
        ?callback "dmbUpdateBrowser( )"
        )
exampleVersionNumber = hiCreateStringField(
        ?name 'exampleVersionNumber
        ?prompt "Version Number"
        ?callback "dmbUpdateBrowser( )"
        )
exampleBrowser = hiCreateButtonBoxField(
        ?name 'exampleBrowser
        ?prompt " "
        ?choices '(" Browse ")
        ?callback list("exampleBrowser( )")
        )

hiCreateForm(
        'exampleOpenForm "Synched Form Example"
        "exampleOpenForm( )"
        list( exampleLibName
              exampleCellName
              exampleViewName
              exampleVersionNumber
              exampleBrowser )
        ""
)
procedure( exampleBrowser( )
    dmbSyncWithForm( exampleOpenForm 'browse 'exampleLibName
         'exampleCellName’exampleViewName 
     'exampleVersionNumber )
)
procedure( exampleOpenForm( )
    dmbSyncWithForm( exampleOpenForm 'other 'exampleLibName
        'exampleCellName 'exampleViewName 
        'exampleVersionNumber)
    hiDisplayForm( 'exampleOpenForm )
    dmbLibBrowserFormDone( 'other )
)

Return to top