ESRI banner

IServicePropertiesDialog.IsPropertyPageAvailable method

Applies To: IServicePropertiesDialog

Returns whether a Property page is available in and exported by the current Image Service instance.

This method is mainly used by client applications for showing the property pages embedded in another forms or controls.

[Visual Basic 6.0]

variable = Object.IsPropertyPageAvailable(pageId)

Arguments

[in] pageId

PropertyPage. 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

Return Value

Boolean that determines the availability state

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\Common Files\ESRI\Image Server\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", "")

  If cService Is Nothing Then Exit Sub

 

  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 , ShowPropertyPage