Share

BrowserPane Object


Description

The BrowserPane object represents an independent window or panel inside the browser that is currently associated with the active document.

Methods

Name Description
Activate Method that causes the pane to become the active browser pane.
AddBrowserFolder Creates a new browser folder at the location specified by the input nodes.
ClearPreSelect Clears any pre-selection(s) for this pane.
Delete Method that deletes the browser pane. If this pane is currently active, the default Inventor pane will become active. This method will fail for built-in browser panes.
GetBrowserNodeFromObject Returns the browser node that corresponds to the input object. The method returns an error if no corresponding node is found within this pane. If multiple matches are found, the method returns the first match.
GetDockingState Method that gets the docking state of the browser pane.
Refresh Rebuilds assembly browser by incorporating information from sub-doc(s) default browser pane into the top level document's 'Model' pane. Should be used on a top level assembly's 'Model' pane after a sub-doc's default pane is changed via BrowserPane::Default.
Reorder Moves a node or group of nodes to a new target position within the browser pane.
SetDockingState Method that sets the docking state of the browser pane.
Update Refreshes the browser view. Should be used after changing browser node status (e.g. DisplayState).

Properties

Name Description
Application Returns the top-level parent application object. When used the context of Inventor, an Application object is returned. When used in the context of Apprentice, an ApprenticeServer object is returned.
BuiltIn Property that specifies if the pane is a standard Inventor pane or not. Built-in panes have restrictions in the edits that can be performed.
Control Property that returns the ActiveX control that may be associated with the pane. This property will return Nothing in the case this is a Tree Browser Pane.
Default Specifies if this pane is set as the default when the document is opened.
InternalName Gets either control identifier or the internal identifier depending on whether this browser pane is a ActiveX control identifier or an Inventor tree browser.
Name Property that gets and sets the name of the pane. When setting the name, an error will occur if the name is not unique with respect to the other panes of the document. The name of built-in panes cannot be set.
Parent Gets the parent object from whom this object can logically be reached.
SearchBox Read-only property that gets SearchBox object.
TopNode Gets the top browser node.
TreeBrowser Gets the property that specifies if the pane hosts TreeBrowser nodes constructed by Inventor.
Type Returns an ObjectTypeEnum indicating this object's type.
Visible Gets and sets the boolean flag which can turn the availability of browser pane in the UI, off or on.

Events

Name Description
OnActivate The OnActivate event notifies a client when the BrowserPane has become the active pane.
OnDeactivate The OnDeactivate event notifies a client when a BrowserPane is deactivated.
OnHelp The OnHelp event notifies a client when the end-user clicks the help button on the browser pane.

Accessed From

BrowserPanes.ActivePane, BrowserPanes.Add, BrowserPanes.AddByManifest, BrowserPanes.AddTreeBrowserPane, BrowserPanes.Item

Samples

Name Description
Add assembly occurrences to a new folder Demonstrates assembly occurrences to a new folder
Demote occurence This sample demonstrates how to demote a top level occurrence in an assembly into a new sub-assembly occurrence.
Promote occurence This sample demonstrates how to promote an occurrence.
Dock browser pane to a custom ViewFrame This sample demonstrates how to dock the browser pane to a custom ViewFrame.

Version

Introduced in version 5

Was this information helpful?