ArcObjects Library Reference (PublisherControls)  

IARControl.ReloadDocument Method

Reloads the currently loaded Published Map File (*.PMF) back into the control.

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

Optional Values

sPassword   Supply as a default value.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The ReloadDocument method loads the currently loaded Published Map File back into the ArcReaderControl. This resets the ArcReaderControl to the state of the Published Map File on disk, resetting the CurrentView, the extent of the CurrentView and layer visibility.

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

Errors Returned

2003 800A07D3: No document loaded

Remarks

The ReloadDocument method triggers the following events:

OnDocumentUnloaded
OnCurrentViewChanged
OnDocumentLoaded
OnCurrentViewChanged
OnBeforeScreenDraw
OnAfterScreenDraw

See Also

IARControl Interface