com.esri.arcgis.framework
Interface IDocumentDirty2

All Superinterfaces:
IDocumentDirty, Serializable
All Known Implementing Classes:
IDocumentDirty2Proxy, MxDocument

public interface IDocumentDirty2
extends IDocumentDirty, Serializable

Provides access to the dirty flag of the Document.

Remarks

If the document's dirty flag is set to True, then you will be prompted to save the document when the document is closed or the ArcMap application is shut down.

Product Availability

Available with ArcGIS Desktop.


Method Summary
 void setClean()
          Resets the dirty flag on the document.
 
Methods inherited from interface com.esri.arcgis.framework.IDocumentDirty
setDirty
 

Method Detail

setClean

void setClean()
              throws IOException,
                     AutomationException
Resets the dirty flag on the document.

Remarks

If the document's dirty flag is set to True, then you will be prompted to save the document when the document is closed or when the ArcMap application is shut down. If you don't want to be prompted to save the document when you close the document or when the ArcMap application is shutdown, then you can use the SetClean method to set the document's dirty flag to False.

The SetDirty method on IDocumentDirty does the opposite of this.

Product Availability

Available with ArcGIS Desktop.

Supported Platforms

Windows

Throws:
IOException - If there are interop problems.
AutomationException - If the ArcObject component throws an exception.