com.esri.arcgis.system
Interface IDocumentVersion

All Superinterfaces:

Serializable

All Known Implementing Classes:

FileStream, GMxDocument, GxFilterLayers, GxLayer, IDocumentVersionProxy, LayerFile, MapDocument, MemoryBlobStream, MxDocument, ObjectStream, SxDocument, VariantStreamIO

public interface IDocumentVersion
extends Serializable

Provides access to members that control the document version.

Remarks

IDocumentVersion determines what version of an object should be saved. For example, if a new interface was added to an existing object to extend the object's capabilities and the object implements IDocumentVersion, its contents can be saved based on the ArcGIS version.

When To Use

Use this interface when you want an object to persist its contents based on the ArcGIS document version.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Method Summary

int	getDocumentVersion() The version of the document to save.
void	setDocumentVersion(int docVersion) The version of the document to save.

Method Detail

setDocumentVersion

void setDocumentVersion(int docVersion)
                        throws IOException,
                               AutomationException

The version of the document to save.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Parameters:

docVersion - A com.esri.arcgis.system.esriArcGISVersion constant (in)

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.

getDocumentVersion

int getDocumentVersion()
                       throws IOException,
                              AutomationException

The version of the document to save.

Remarks

Determines which version an object is persisted. This can be useful when saving an object ObjectStream or MemoryBlobStream and you want the version of that object to be compatible with previous releases of ArcGIS. Not all persistable objects implement IDocumentVersion; you should ensure the object supports this interface before accessing this property.

Product Availability

Available with ArcGIS Engine, ArcGIS Desktop, and ArcGIS Server.

Returns:

A com.esri.arcgis.system.esriArcGISVersion constant

Throws:

IOException - If there are interop problems.

AutomationException - If the ArcObject component throws an exception.