linux-packaging-mono/mcs/class/System.Design/Documentation/en/System.ComponentModel.Design.Data/IDesignerDataSchema.xml

<?xml version="1.0" encoding="utf-8"?>
<Type Name="IDesignerDataSchema" FullName="System.ComponentModel.Design.Data.IDesignerDataSchema">
  <TypeSignature Language="C#" Value="public interface IDesignerDataSchema" />
  <AssemblyInfo>
    <AssemblyName>System.Design</AssemblyName>
    <AssemblyVersion>2.0.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Interfaces />
  <Docs>
    <remarks>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Classes that implement the <see cref="T:System.ComponentModel.Design.Data.IDesignerDataSchema" /> interface retrieve schema information from a data store and return it to the user interface, typically to populate UI elements that enable the user to specify the data-store object that they  want to work with.</para>
      <para>The <see cref="T:System.ComponentModel.Design.Data.IDesignerDataSchema" /> interface provides two methods: the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method, which returns the requested schema objects, and the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method, which indicates whether a specified data-schema object is supported by the data store. </para>
    </remarks>
    <summary>
      <attribution license="cc4" from="Microsoft" modified="false" />
      <para>Defines methods for retrieving data-store schema information.</para>
    </summary>
  </Docs>
  <Members>
    <Member MemberName="GetSchemaItems">
      <MemberSignature Language="C#" Value="public System.Collections.ICollection GetSchemaItems (System.ComponentModel.Design.Data.DesignerDataSchemaClass schemaClass);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.ICollection</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="schemaClass" Type="System.ComponentModel.Design.Data.DesignerDataSchemaClass" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method returns a collection of all the specified schema objects in the data store. </para>
          <para>See the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class for the list of schema objects supported by the .NET Framework. Additional schema objects can be added to the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class by creating a derived type.</para>
          <para>If the data store does not support the requested schema object, the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method should return null. You can use the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method to determine whether a data store supports the requested schema object before calling the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method, to avoid returning null to your application.</para>
          <para>If the data store supports the requested object, but does not contain any instances, the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.GetSchemaItems(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method should return an empty collection.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Gets a collection of specified schema items.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>A collection of schema objects of the specified type.</para>
        </returns>
        <param name="schemaClass">
          <attribution license="cc4" from="Microsoft" modified="false" />The schema objects to return.</param>
      </Docs>
    </Member>
    <Member MemberName="SupportsSchemaClass">
      <MemberSignature Language="C#" Value="public bool SupportsSchemaClass (System.ComponentModel.Design.Data.DesignerDataSchemaClass schemaClass);" />
      <MemberType>Method</MemberType>
      <AssemblyInfo>
        <AssemblyVersion>2.0.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="schemaClass" Type="System.ComponentModel.Design.Data.DesignerDataSchemaClass" />
      </Parameters>
      <Docs>
        <remarks>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>The <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method indicates whether the data store supports a specified data-schema object. If the data store does not support the specified object, the <see cref="M:System.ComponentModel.Design.Data.IDesignerDataSchema.SupportsSchemaClass(System.ComponentModel.Design.Data.DesignerDataSchemaClass)" /> method should return false.</para>
          <para>You can add tests for additional data-schema objects by deriving from the <see cref="T:System.ComponentModel.Design.Data.DesignerDataSchemaClass" /> class.</para>
        </remarks>
        <summary>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>Returns a value indicating whether the data store contains the specified data-schema object.</para>
        </summary>
        <returns>
          <attribution license="cc4" from="Microsoft" modified="false" />
          <para>true if the data store supports the specified data-schema object; otherwise, false.</para>
        </returns>
        <param name="schemaClass">
          <attribution license="cc4" from="Microsoft" modified="false" />The schema objects to return.</param>
      </Docs>
    </Member>
  </Members>
</Type>