 |
This document is archived and information here might be outdated. Recommended version. |
IXmlPropertySet2.OverwriteSyncAttribute Property (ArcObjects .NET 10.8 SDK)
|
This document is archived and information here might be outdated. Recommended version. |
Indicates if the Sync attribute will be ignored when setting an element's value.
[Visual Basic .NET]
Public Property OverwriteSyncAttribute As Boolean
[C#]
public bool OverwriteSyncAttribute {get; set;}
[C++]
HRESULT get_OverwriteSyncAttribute(
VARIANT_BOOL overwriteSyncAttributes
);
[C++]
HRESULT put_OverwriteSyncAttribute(
Boolean* overwriteSyncAttributes
);
[C++] Parameters overwriteSyncAttributes [in]
overwriteSyncAttributes is a parameter of type bool overwriteSyncAttributes [out, retval]
overwriteSyncAttributes is a parameter of type bool*
By default the OverwriteSyncAttribute property is set to false. If the property is changed it remains true for the time the object is held in memory. Once the object is released, the OverwriteSyncAttribute is set back to false.
The OverwriteSyncAttribute property is set for an entire property set and not individual properties.
When the property is set to true, the syncing parameter used and the SetPropertyX methods is ignored. The SetPropertyX action, determined by the esriXmlSetPropertyAction, is then carried out. Otherwise if the OverwriteSyncAttribute property remains false, the esriXmlSetPropertyAction and value of the syncing parameter in the SetPropertyX determine the action.
A complete understanding of the syncing parameter is recommended when setting and getting the OverwriteSyncAttribute property. See the documentation for IXmlPropertySet.SetPropertyX for more information.