IRPDefDocument class

Applies To: ESRI.ImageServer.RPDefGenerator.RPDefDocument

The RPDefDocument class provides developers with functionality that lets them create and manipulate RPDef XML with ease.

[Visual Basic 6.0]

Dim myObject As ESRI.ImageServer.RPDefGenerator.IRPDefDocument = New ESRI.ImageServer.RPDefGenerator.RPDefDocument

Properties

Name

Description

RasterCount

[Read-only, Int64] Number of raster in the RPDefDocument object.

RasterIndex

[Read-only, Int64] Index of the currently selected Raster. This property is updated when the SelectRaster function is called.

Methods

Name

Description

Open

Open the RPDef XML. Any further modification to this object is performed on the internal document object, not the file directly. To gain access to the current RPDef XML, use the functions ToString or Save.

AddRaster

Adds a Raster to the RPDef document object.

RemoveRaster

Removes the currently selected raster from the document object.

SetRasterXML

Modify the currently selected raster using an XML string representation.

GetRasterXML

Get XML string representation of the currently selected Raster.

SelectRaster

Selects a raster by ID or zero-based index.

SelectDocument

Selects the document object, all access or modification using GetProperty and SetProperty is performed on the raster dataset and not on any individual raster.

SetProperty

Modify a recognized property in the document object. Properties names can be accessed using RPDefDocument.GroupProperty (for raster dataset) or RPDefDocument.RasterProperty (for rasters).

GetProperty

Access a recognized property in the document object. Properties names can be accessed using RPDefDocument.GroupProperty (for raster dataset) or RPDefDocument.RasterProperty (for rasters).

SetPropertyXML

Modify a recognized property XML in the document object. Properties names can be accessed using RPDefDocument.GroupProperty (for raster dataset) or RPDefDocument.RasterProperty (for rasters).

GetPropertyXML

Access a recognized property XML in the document object. Properties names can be accessed using RPDefDocument.GroupProperty (for raster dataset) or RPDefDocument.RasterProperty (for rasters).

SetFootprint

Update the footprint using a GML string.

GetFootprint

Obtain GML representation of the footprint shape.

SetSeamline

Update the seamline shape using a GML string.

GetSeamline

Obtain GML representation of the seamline shape.

SetMetadata

Update Metadata using string

GetMetadata

Obtain Metadata as string

UpdateFormatInfo

Update the Format Information node using a hash table.

GetProcessChain

Get the process chain object of the dataset or a raster (depends on SelectRaster or SelectDocument)

SetProcessChain

Update the process chain object of the dataset or a raster (depends on SelectRaster or SelectDocument)

Clear

Clears the document object.

Save

Save the document to an RPDef file.

ToString

Obtains the XML representation of the document object.

GetStatus

Obtain the status of the last performed operation.

Remarks

The library reference for this object is not provided. Please use the object browser to know the function signatures.

Requirements

Platform

32 bit Windows OS (WinXP)

Environment

.NET Framework

Dependency

ESRI.ImageServer.RPDefGenerator.dll (.NET Framework)