mcs/class/System.Xml.Linq/Documentation/en/System.Xml.Linq/XObjectChange.xml

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <Type Name="XObjectChange" FullName="System.Xml.Linq.XObjectChange">
   3   <TypeSignature Language="C#" Value="public enum XObjectChange" />
   4   <TypeSignature Language="ILAsm" Value=".class public auto ansi sealed XObjectChange extends System.Enum" />
   5   <AssemblyInfo>
   6     <AssemblyName>System.Xml.Linq</AssemblyName>
   7     <AssemblyVersion>4.0.0.0</AssemblyVersion>
   8   </AssemblyInfo>
   9   <Base>
  10     <BaseTypeName>System.Enum</BaseTypeName>
  11   </Base>
  12   <Docs>
  13     <remarks>
  14       <attribution license="cc4" from="Microsoft" modified="false" />
  15       <para>This enum specifies the event type when an event is raised for an <see cref="T:System.Xml.Linq.XObject" />.</para>
  16       <para>All operations that modify the XML tree break down to a series of primitives. There are four types of primitives. Two of the primitives (Add and Remove) act on collections. Two of them (Name and Value) act on instances. There is a corresponding event for each of these primitives. </para>
  17       <para>You should be careful when modifying an XML tree within one of these events, because doing this might lead to unexpected results. For example, if you receive a <see cref="E:System.Xml.Linq.XObject.Changing" /> event, and while the event is being processed you remove the node from the tree, you might not receive the <see cref="E:System.Xml.Linq.XObject.Changed" /> event. When an event is being processed, it is valid to modify an XML tree other than the one that contains the node that is receiving the event; it is even valid to modify the same tree provided the modifications do not affect the specific nodes on which the event was raised. However, if you modify the area of the tree that contains the node receiving the event, the events that you receive and the impact to the tree are undefined. </para>
  18     </remarks>
  19     <summary>
  20       <attribution license="cc4" from="Microsoft" modified="false" />
  21       <para>Specifies the event type when an event is raised for an <see cref="T:System.Xml.Linq.XObject" />.</para>
  22     </summary>
  23   </Docs>
  24   <Members>
  25     <Member MemberName="Add">
  26       <MemberSignature Language="C#" Value="Add" />
  27       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Xml.Linq.XObjectChange Add = int32(0)" />
  28       <MemberType>Field</MemberType>
  29       <AssemblyInfo>
  30         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  31       </AssemblyInfo>
  32       <ReturnValue>
  33         <ReturnType>System.Xml.Linq.XObjectChange</ReturnType>
  34       </ReturnValue>
  35       <Docs>
  36         <summary>
  37           <attribution license="cc4" from="Microsoft" modified="false" />
  38           <para>An <see cref="T:System.Xml.Linq.XObject" /> has been or will be added to an <see cref="T:System.Xml.Linq.XContainer" />.</para>
  39         </summary>
  40       </Docs>
  41     </Member>
  42     <Member MemberName="Name">
  43       <MemberSignature Language="C#" Value="Name" />
  44       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Xml.Linq.XObjectChange Name = int32(2)" />
  45       <MemberType>Field</MemberType>
  46       <AssemblyInfo>
  47         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  48       </AssemblyInfo>
  49       <ReturnValue>
  50         <ReturnType>System.Xml.Linq.XObjectChange</ReturnType>
  51       </ReturnValue>
  52       <Docs>
  53         <summary>
  54           <attribution license="cc4" from="Microsoft" modified="false" />
  55           <para>An <see cref="T:System.Xml.Linq.XObject" /> has been or will be renamed.</para>
  56         </summary>
  57       </Docs>
  58     </Member>
  59     <Member MemberName="Remove">
  60       <MemberSignature Language="C#" Value="Remove" />
  61       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Xml.Linq.XObjectChange Remove = int32(1)" />
  62       <MemberType>Field</MemberType>
  63       <AssemblyInfo>
  64         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  65       </AssemblyInfo>
  66       <ReturnValue>
  67         <ReturnType>System.Xml.Linq.XObjectChange</ReturnType>
  68       </ReturnValue>
  69       <Docs>
  70         <summary>
  71           <attribution license="cc4" from="Microsoft" modified="false" />
  72           <para>An <see cref="T:System.Xml.Linq.XObject" /> has been or will be removed from an <see cref="T:System.Xml.Linq.XContainer" />.</para>
  73         </summary>
  74       </Docs>
  75     </Member>
  76     <Member MemberName="Value">
  77       <MemberSignature Language="C#" Value="Value" />
  78       <MemberSignature Language="ILAsm" Value=".field public static literal valuetype System.Xml.Linq.XObjectChange Value = int32(3)" />
  79       <MemberType>Field</MemberType>
  80       <AssemblyInfo>
  81         <AssemblyVersion>4.0.0.0</AssemblyVersion>
  82       </AssemblyInfo>
  83       <ReturnValue>
  84         <ReturnType>System.Xml.Linq.XObjectChange</ReturnType>
  85       </ReturnValue>
  86       <Docs>
  87         <summary>
  88           <attribution license="cc4" from="Microsoft" modified="false" />
  89           <para>The value of an <see cref="T:System.Xml.Linq.XObject" /> has been or will be changed. In addition, a change in the serialization of an empty element (either from an empty tag to start/end tag pair or vice versa) raises this event.</para>
  90         </summary>
  91       </Docs>
  92     </Member>
  93   </Members>
  94 </Type>