IServicePropertiesDialog.ShowPropertyPage method
Applies To: IServicePropertiesDialog
Shows the specified property page embedded in a parent form as specified by the handle.
It is typically used by client applications for showing the property pages embedded in another forms or controls.
[Visual Basic 6.0]
variable = Object.ShowPropertyPage(pageId, parentHandle)
Arguments
[in] pageId
Property page. It is an Enum defined in the client library.
Constant |
Value |
Description |
VALUE |
MetadataPage |
For embedding metadata control |
VALUE |
ServicePropertiesPage |
For embedding service properties |
VALUE |
ViewPointPage |
For embedding viewpoint control |
[in] parentHandle
Long. Handle of the parent window
Return Value
Boolean that determines the availability state
Remarks
The IsPropertyPageAvailable method should be used to first check if the page can be embedded.
Requirements
Platform |
32 bit Windows OS (WinXP) |
Environment |
.NET Framework, COM, ANSI C / C++ Standard compliant |
Dependency |
ESRI.ImageServer.ISClient.dll (.NET Framework), ISClient.dll (COM/C++), ISClientC.dll (C/C++) |
Include |
isclientc.h (ANSI C) |
Example
[Visual Basic 6.0]
Private Sub Form1_Load()
Dim client As New CClientObject
Dim strConfigPath As String
strConfigPath = "c:\Program Files\ArcGIS\ImageServer10.0\XADefs\ISViewer.ISCConfig"
If client.Init(strConfigPath) = False Then
MsgBox client.Status
Exit Sub
End If
Dim cService As CImageService
Set cService = client.OpenImageService("ImageService://hawkings:10000/Dxb_Tif", "")
Dim spDialog As ImageServerClient.IServicePropertiesDialog
Set spDialog = cService.GetServicePropertiesDialog()
If spDialog Is Nothing Then
MsgBox "The Image Service could not return the properties dialog."
Exit Sub
End If
If spDialog.IsPropertyPageAvailable(ServicePropertiesPage) = True Then
spDialog.ShowPropertyPage ServicePropertiesPage, Me.hWnd
End If
End Sub
For a detailed example, please see the ISViewer Sample in VB 6.0 or the Client Application Sample in ANSI C in [ArcGIS Image Server installation folder]\Developer Kit\Client Applications\Samples\ folder.
Related Topics
See also: GetServicePropertiesDialog, IsPropertyPageAvailable