CoAuthoring.xml

<Type Name="CoAuthoring" FullName="Microsoft.Office.Interop.Word.CoAuthoring">
  <TypeSignature Language="C#" Value="public interface CoAuthoring" />
  <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract CoAuthoring" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Office.Interop.Word.CoAuthoring" />
  <TypeSignature Language="VB.NET" Value="Public Interface CoAuthoring" />
  <TypeSignature Language="C++ CLI" Value="public interface class CoAuthoring" />
  <TypeSignature Language="F#" Value="type CoAuthoring = interface" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
    <AssemblyVersion>15.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.Guid("65DF9F31-B1E3-4651-87E8-51D55F302161")</AttributeName>
    </Attribute>
    <Attribute>
      <AttributeName>System.Runtime.InteropServices.TypeLibType(4288)</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>Provides the primary entry point to the co-authoring object model.</summary>
    <remarks>
      <para>The <b>CoAuthoring</b> object provides information about co-authoring at the document level. For example, the <b>CoAuthoring</b> object can provide information about whether there are any locks in the document, which users have current locks on the document, or whether or not updates to the document content is available from the server. Use the <see cref="T:Microsoft.Office.Interop.Word.Document.CoAuthoring" /> property to return the <b>CoAuthoring</b> object.</para>
      <para />
    </remarks>
  </Docs>
  <Members>
    <Member MemberName="Application">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.Application Application { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.Application Application" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Application" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Application As Application" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::Office::Interop::Word::Application ^ Application { Microsoft::Office::Interop::Word::Application ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Application : Microsoft.Office.Interop.Word.Application" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Application" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(1000)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(1000)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Interop.Word.Application</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets an <see cref="T:Microsoft.Office.Interop.Word.Application" /> object that represents the Microsoft Word application.</summary>
        <value>An <see cref="T:Microsoft.Office.Interop.Word.Application" /> object that represents the Microsoft Word application.</value>
        <remarks>
          <para>Read-only.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Authors">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.CoAuthors Authors { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.CoAuthors Authors" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Authors" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Authors As CoAuthors" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::Office::Interop::Word::CoAuthors ^ Authors { Microsoft::Office::Interop::Word::CoAuthors ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Authors : Microsoft.Office.Interop.Word.CoAuthors" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Authors" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(1)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(1)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Interop.Word.CoAuthors</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Interop.Word.CoAuthors" /> collection that represents all the co-authors currently editing the document.</summary>
        <value>A <see cref="T:Microsoft.Office.Interop.Word.CoAuthors" /> collection that represents all the co-authors currently editing the document.</value>
        <remarks>
          <para>Read-only. The collection returned by this property is static. If this collection is stored and then new users begin editing the document, or current users are no longer editing the document, the stored collection does not change.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CanMerge">
      <MemberSignature Language="C#" Value="public bool CanMerge { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool CanMerge" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.CanMerge" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanMerge As Boolean" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool CanMerge { bool get(); };" />
      <MemberSignature Language="F#" Value="member this.CanMerge : bool" Usage="Microsoft.Office.Interop.Word.CoAuthoring.CanMerge" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(9)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(9)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets whether the document can be auto-merged.</summary>
        <value>
          <b>true</b> if the document can be auto-merged; otherwise, <b>false</b>.</value>
        <remarks>
          <para>Only documents that are located on a Microsoft SharePoint Server 2010 document library can be auto-merged. Additionally, a document with the following features cannot be auto-merged:</para>
          <list type="bullet">
            <item>
              <para>Digital Rights Management</para>
            </item>
            <item>
              <para>Digital Signatures</para>
            </item>
            <item>
              <para>Final mode</para>
            </item>
            <item>
              <para>Encryption</para>
            </item>
            <item>
              <para>Master Document role</para>
            </item>
          </list>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="CanShare">
      <MemberSignature Language="C#" Value="public bool CanShare { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool CanShare" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.CanShare" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property CanShare As Boolean" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool CanShare { bool get(); };" />
      <MemberSignature Language="F#" Value="member this.CanShare : bool" Usage="Microsoft.Office.Interop.Word.CoAuthoring.CanShare" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(8)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(8)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets whether this document can be co-authored.</summary>
        <value>
          <b>true</b> if this document can be co-authored; otherwise, <b>false</b>.</value>
        <remarks>
          <para>Read-only. This property is <b>true</b> only if the <see cref="P:Microsoft.Office.Interop.Word.CoAuthoring.CanMerge" /> property is <b>true</b> and the document is a .docx file.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Conflicts">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.Conflicts Conflicts { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.Conflicts Conflicts" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Conflicts" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Conflicts As Conflicts" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::Office::Interop::Word::Conflicts ^ Conflicts { Microsoft::Office::Interop::Word::Conflicts ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Conflicts : Microsoft.Office.Interop.Word.Conflicts" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Conflicts" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(7)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(7)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Interop.Word.Conflicts</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Interop.Word.Conflicts" /> collection that represents all the conflicts in a document.</summary>
        <value>A <see cref="T:Microsoft.Office.Interop.Word.Conflicts" /> collection that represents all the conflicts in a document.</value>
        <remarks>
          <para>Read-only.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Creator">
      <MemberSignature Language="C#" Value="public int Creator { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance int32 Creator" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Creator" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Creator As Integer" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property int Creator { int get(); };" />
      <MemberSignature Language="F#" Value="member this.Creator : int" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Creator" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(1001)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(1001)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Int32</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a 32-bit integer that indicates the application in which the specified object was created. </summary>
        <value>A 32-bit integer that indicates the application in which the specified object was created.</value>
        <remarks>
          <para>Read-only <b>long</b>. If the object was created in Microsoft Word, this property returns the hexadecimal number 4D535744, which represents the string "MSWD." This property was primarily designed to be used on the Apple Macintosh, where each application has a four-character creator code. For example, Word has the creator code MSWD.</para>
          <para>
            <b>Caution</b>: This value can also be represented by the constant <b>wdCreatorCode</b>.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Locks">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.CoAuthLocks Locks { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.CoAuthLocks Locks" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Locks" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Locks As CoAuthLocks" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::Office::Interop::Word::CoAuthLocks ^ Locks { Microsoft::Office::Interop::Word::CoAuthLocks ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Locks : Microsoft.Office.Interop.Word.CoAuthLocks" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Locks" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(5)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(5)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Interop.Word.CoAuthLocks</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Interop.Word.CoAuthLocks" /> collection that represents the locks in the document.</summary>
        <value>A <see cref="T:Microsoft.Office.Interop.Word.CoAuthLocks" /> collection that represents the locks in the document.</value>
        <remarks>
          <para>Read-only.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Me">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.CoAuthor Me { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.CoAuthor Me" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Me" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Me As CoAuthor" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::Office::Interop::Word::CoAuthor ^ Me { Microsoft::Office::Interop::Word::CoAuthor ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Me : Microsoft.Office.Interop.Word.CoAuthor" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Me" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(2)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(2)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Interop.Word.CoAuthor</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Interop.Word.CoAuthor" /> object that represents the current user. </summary>
        <value>A <see cref="T:Microsoft.Office.Interop.Word.CoAuthor" /> object that represents the current user.</value>
        <remarks>
          <para>Read-only.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Parent">
      <MemberSignature Language="C#" Value="public object Parent { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance object Parent" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Parent" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Parent As Object" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property System::Object ^ Parent { System::Object ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Parent : obj" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Parent" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(1002)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(1002)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Object</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets an <see cref="T:System.Object" /> that represents the parent object of the specified <see cref="T:Microsoft.Office.Interop.Word.CoAuthoring" /> object.</summary>
        <value>An <see cref="T:System.Object" /> that represents the parent object of the specified <see cref="T:Microsoft.Office.Interop.Word.CoAuthoring" /> object.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="PendingUpdates">
      <MemberSignature Language="C#" Value="public bool PendingUpdates { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance bool PendingUpdates" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.PendingUpdates" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property PendingUpdates As Boolean" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property bool PendingUpdates { bool get(); };" />
      <MemberSignature Language="F#" Value="member this.PendingUpdates : bool" Usage="Microsoft.Office.Interop.Word.CoAuthoring.PendingUpdates" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(3)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(3)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets whether the document has pending updates that have not been accepted.</summary>
        <value>
          <b>true</b> if the document has pending updates that have not been accepted; otherwise, <b>false</b>.</value>
        <remarks>
          <para>Read-only.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
    <Member MemberName="Updates">
      <MemberSignature Language="C#" Value="public Microsoft.Office.Interop.Word.CoAuthUpdates Updates { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Office.Interop.Word.CoAuthUpdates Updates" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Office.Interop.Word.CoAuthoring.Updates" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property Updates As CoAuthUpdates" />
      <MemberSignature Language="C++ CLI" Value="public:&#xA; property Microsoft::Office::Interop::Word::CoAuthUpdates ^ Updates { Microsoft::Office::Interop::Word::CoAuthUpdates ^ get(); };" />
      <MemberSignature Language="F#" Value="member this.Updates : Microsoft.Office.Interop.Word.CoAuthUpdates" Usage="Microsoft.Office.Interop.Word.CoAuthoring.Updates" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Office.Interop.Word</AssemblyName>
        <AssemblyVersion>15.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Attributes>
        <Attribute>
          <AttributeName>System.Runtime.InteropServices.DispId(6)</AttributeName>
        </Attribute>
        <Attribute>
          <AttributeName>get: System.Runtime.InteropServices.DispId(6)</AttributeName>
        </Attribute>
      </Attributes>
      <ReturnValue>
        <ReturnType>Microsoft.Office.Interop.Word.CoAuthUpdates</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>Gets a <see cref="T:Microsoft.Office.Interop.Word.CoAuthUpdates" /> collection that represents all the updates available to the document.</summary>
        <value>A <see cref="T:Microsoft.Office.Interop.Word.CoAuthUpdates" /> collection that represents all the updates available to the document.</value>
        <remarks>
          <para>Read-only.</para>
          <para />
        </remarks>
      </Docs>
    </Member>
  </Members>
</Type>