Interface IVersionedObject

Namespace
ESRI.ArcGIS.Geodatabase
Assembly
ESRI.Server.Geodatabase.dll

Provides access to members that manage a versioned object.

[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[Guid("4A1FB361-B863-11D1-9CE7-0000F8780619")]
public interface IVersionedObject

Properties

HasUncompressedEdits

Indicates if the object has edits that haven't been compressed yet.

bool HasUncompressedEdits { get; }

Property Value

bool

IsRegisteredAsVersioned

Indicates if the object is registered as versioned.

bool IsRegisteredAsVersioned { get; }

Property Value

bool

Remarks

Returns if the underlying dataset is registered as versioned.  This only applies to datasets that exist in versioned workspaces.

Version

The object's current version.

IVersion Version { get; }

Property Value

IVersion

Remarks

The Version method returns an IVersion object that is the current version the object references. This provides a mechanism to easily detect the version of the database that an object references.

Methods

GetVersionRegistrationInfo(out bool, out bool)

Indicates if this object is registered as versioned and is moving edits to base.

void GetVersionRegistrationInfo(out bool isRegistered, out bool isMovingEditsToBase)

Parameters

isRegistered bool
isMovingEditsToBase bool

RegisterAsVersioned(bool)

Register/UnRegister the object as being versioned.

void RegisterAsVersioned(bool isVersioned)

Parameters

isVersioned bool

Remarks

The RegisterAsVersioned method registers or unregisters datasets. Feature classes that participate in feature datasets can be registered or unregistered, although it is highly recommended that the operation is performed on the entire feature dataset. The method requires a boolean argument, True to register or False to unregister the object.

Unregistering an object class as versioned permanently drops the object's delta tables. To preserve the edits, perform a compress prior to unregistering as versioned. 

Only the owner can register or unregister the object.

By programmatically registering a class participating in a geometric network as versioned it does not guarantee the entire geometric network including other participating classes will also be registered. It is then recommended the registration take place at the feature dataset level rather than on the individual feature class. This workflow is exposed by default through the user interface in ArcCatalog. If there is a need to register individual classes as versioned within a feature dataset without registering the entire dataset it is crucial that every class participating in a geometric network, including the geometric network itself, is explicitly registered individually.

Archiving must first be disabled on a class before it can be unregistered as versioned. This situation only applies to classes that have been registered as versioned with the MoveEditsToBase option set to false through the IVersionObject.RegisterAsVersioned3 method.

  

RegisterAsVersioned3(bool)

Register this object as versioned with the option to move edits to base.

void RegisterAsVersioned3(bool moveEditsToBase)

Parameters

moveEditsToBase bool

Remarks

To register datasets as versioned with the option to move edits to default.

SupportsMovingEditsToBase()

Indicates if this object supports moving edits to base as a RegisterAsVersioned3 option.

bool SupportsMovingEditsToBase()

Returns

bool

UnRegisterAsVersioned3(bool)

UnRegister this object as versioned with the option to compress the Default edits to base.

void UnRegisterAsVersioned3(bool compressDefault)

Parameters

compressDefault bool

Remarks

Unregistering a dataset or class object as versioned permanently drops the object's delta tables. To preserve the edits on the default version, set compressDefault true. 


Archiving must first be disabled on a class before it can be unregistered as versioned. This situation only applies to classes that have been registered as versioned with the MoveEditsToBase option set to false through the IVersionObject.RegisterAsVersioned3 method.