ArcObjects Library Reference (PublisherControls)  

IARGlobeControlDefault.LoadDocument Method

Loads the Published Map File (*.PMF) into the control.

[Visual Basic .NET]
Public Sub LoadDocument ( _
    ByVal sFilename As String, _
    [ByVal sPassword As String] _
)
[C#]
public void LoadDocument (
    string sFilename,
    string sPassword
);
[C#]

Optional Values

sPassword   Supply as a default value.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

Loads the specified Published Map File (*.pmf) into the ArcReaderGlobeControl. Use the CheckDocument method to determine if the specified Published Map File can be loaded successfully.

If a document was password protected when it was published and the password is not passed within the LoadDocument method, the user will be prompted automatically for a password. If an incorrect password is supplied twice in succession a custom error will be returned.

If a document is successfully loaded the CurrentARGlobeTool will be set. The default CurrentARGlobeTool  is specified by the DefaultGlobeTool setting in the ARConfiguration. The DocumentFilename property will update itself with the path and filename of the currently loaded document, and the DocumentComment property to update itself with any comments that were supplied by the publisher of the document.

See Also

IARGlobeControlDefault Interface