ArcObjects Library Reference (PublisherControls)  

IARControlDefault.ShowARWindow Method

Shows or hides the specified control window.

[Visual Basic .NET]
Public Sub ShowARWindow ( _
    ByVal win As esriARWindows, _
    [ByVal Show As Boolean], _
    [ByVal data As Object] _
)
[C#]
public void ShowARWindow (
    esriARWindows win,
    bool Show,
    object data
);
[C#]

Optional Values

Show   Supply true as a default value.
data   To indicate that this parameter is undefined, pass in Type.Missing.

Product Availability

Available with ArcGIS Desktop. Requires Publisher Extension.

Description

The ShowARWindow shows or hides the specified built in window. By default all of the esriARWindows are closed. Before using the ShowARWindow method make one or all of the following checks:

A modal window requires a response from the user, before they can interact with another part of the application. A modeless window will stay on the screen, available for use, but allow the user to interact with other parts of the application. When the LoadDocument or ReloadDocument methods are used, any modeless windows will be automatically closed.

Errors Returned

2003 800A07D3: No document loaded

2012 800A07DC: The specified window is invalid 

2013 800A07DD: Invalid URL specified for Internet Browser 

2102 800A0836: The current document does not have permission to perform a find operation 
2103 800A0837: The current document does not have permission to perform an identify operation 

2109 800A083D: The current document does not have permission to print 

Remarks

esriARWindowsFind: A modeless dialog for finding features by their attribute values in the IARPageLayout::FocusARMap. Optionally, supply an ARLayer as the data parameter to perform the find on a particular layer. The ShowARWindow method will return an error if the currently loaded document was not published with permission to Find. Use the IARControlDefault::HasDocumentPermission method to determine this.

esriARWindowsMagnifier: A modeless window that works like a magnifying glass as it is moved over the CurrentView displaying it in more detail.

esriARWindowsSearchHelp: Not yet implemented.

esriARWindowsHelpContents: Not yet implemented.

esriARWindowsFileProperties: A modal dialog displaying file property, disabled functionality and inaccessible layer information about the currently loaded document.

esriARWindowsAddInternetSite: A modal dialog for adding an internet site. If an address is entered begining with "www" this is automatically appended with '?mode=arcreadermap' in order to open the site at the location of Published Map Files. The internet site is automatically opened within a browser and added to the esriARWindowsManageInternetSite window.

esriARWindowsManageInternetSite: A modal dialog for managing any internet sites that have previoulsy been added.

esriARWindowsInternetBrowser: Opens an internet browser at the internet site specified by the data parameter. The data parameter can either be a String consisting of a valid URL (the URL must contain ""www"") or a Long representing the index of a URL that has previously been added. Note that an index of 0 is reserved and represents the ESRI website and an index of 1 is reserved and represents the ESRI Geography Network. Any URL that has previoulsy been added will start at the index value of 2.

esriARWindowsPageSetup: A modal window for setting up the CurrentView prior to printing. The ShowARWindow method will return an error if the currently loaded document was not published with permission to Print. Use the IARControlDefault::HasDocumentPermission method to determine this.

esriARWindowsPrinter: A modal window for sending the CurrentView to a printer. The ShowARWindow method will return an error if the currently loaded document was not published with permission to Print. Use the IARControlDefault::HasDocumentPermission method to determine this.

esriARWindowsIdentify: A modeless dialog for displaying identify results when the CurrentARTool is set to esriARToolMapIdentify.The ShowARWindow method will return an error if the currently loaded document was not published with permission to Identify. Use the IARControlDefault::HasDocumentPermission method to determine this.

[C#]
if (axArcReaderControl1.HasDocumentPermission(esriARDocumentPermissions.esriARDocumentPermissionsFind)) 
{
    //Get the first layer in the focus map
    IARLayer arLayer = axArcReaderControl1.ARPageLayout.FocusARMap.get_ARLayer(0);
    //Open the find window set to perform a find on the layer
    axArcReaderControl1.ShowARWindow(esriARWindows.esriARWindowsFind, true, arLayer);
}

[Visual Basic .NET]
If AxArcReaderControl1.HasDocumentPermission(esriARDocumentPermissions.esriARDocumentPermissionsFind) Then
    Dim pARLayer As IARLayer
    'Get the first layer in the focus map
    pARLayer = AxArcReaderControl1.ARPageLayout.FocusARMap.ARLayer(0)
    'Open the find window set to perform a find on the layer
    AxArcReaderControl1.ShowARWindow(esriARWindows.esriARWindowsFind, True, pARLayer)
End If

See Also

IARControlDefault Interface