SynonymMapsAttribute.xml

<Type Name="SynonymMapsAttribute" FullName="Microsoft.Azure.Search.SynonymMapsAttribute">
  <TypeSignature Language="C#" Value="public class SynonymMapsAttribute : Attribute" />
  <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit SynonymMapsAttribute extends System.Attribute" />
  <TypeSignature Language="DocId" Value="T:Microsoft.Azure.Search.SynonymMapsAttribute" />
  <TypeSignature Language="VB.NET" Value="Public Class SynonymMapsAttribute&#xA;Inherits Attribute" />
  <TypeSignature Language="F#" Value="type SynonymMapsAttribute = class&#xA;    inherit Attribute" />
  <AssemblyInfo>
    <AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
    <AssemblyVersion>10.1.0.0</AssemblyVersion>
  </AssemblyInfo>
  <Base>
    <BaseTypeName>System.Attribute</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes>
    <Attribute>
      <AttributeName Language="C#">[System.AttributeUsage(System.AttributeTargets.Property)]</AttributeName>
      <AttributeName Language="F#">[&lt;System.AttributeUsage(System.AttributeTargets.Property)&gt;]</AttributeName>
    </Attribute>
  </Attributes>
  <Docs>
    <summary>
            Indicates that the <see cref="T:Microsoft.Azure.Search.Models.Field" /> generated by <see cref="T:Microsoft.Azure.Search.FieldBuilder" /> for
            the target property should have its <see cref="P:Microsoft.Azure.Search.Models.Field.SynonymMaps" /> property set to the
            specified value.
            </summary>
    <remarks>To be added.</remarks>
  </Docs>
  <Members>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public SynonymMapsAttribute (params string[] synonymMaps);" />
      <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string[] synonymMaps) cil managed" />
      <MemberSignature Language="DocId" Value="M:Microsoft.Azure.Search.SynonymMapsAttribute.#ctor(System.String[])" />
      <MemberSignature Language="VB.NET" Value="Public Sub New (ParamArray synonymMaps As String())" />
      <MemberSignature Language="F#" Value="new Microsoft.Azure.Search.SynonymMapsAttribute : string[] -&gt; Microsoft.Azure.Search.SynonymMapsAttribute" Usage="new Microsoft.Azure.Search.SynonymMapsAttribute synonymMaps" />
      <MemberType>Constructor</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
        <AssemblyVersion>10.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <Parameters>
        <Parameter Name="synonymMaps" Type="System.String[]">
          <Attributes>
            <Attribute>
              <AttributeName Language="C#">[System.ParamArray]</AttributeName>
              <AttributeName Language="F#">[&lt;System.ParamArray&gt;]</AttributeName>
            </Attribute>
          </Attributes>
        </Parameter>
      </Parameters>
      <Docs>
        <param name="synonymMaps">A list of synonym map names that associates synonym maps with the field.
            This option can be used only with searchable fields. Currently only one synonym map per field is
            supported. Assigning a synonym map to a field ensures that query terms targeting that field are
            expanded at query-time using the rules in the synonym map.
            </param>
        <summary>
            Indicates that the specified synonym maps should be used for searches on the target field.
            </summary>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
    <Member MemberName="SynonymMaps">
      <MemberSignature Language="C#" Value="public System.Collections.Generic.IList&lt;string&gt; SynonymMaps { get; }" />
      <MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IList`1&lt;string&gt; SynonymMaps" />
      <MemberSignature Language="DocId" Value="P:Microsoft.Azure.Search.SynonymMapsAttribute.SynonymMaps" />
      <MemberSignature Language="VB.NET" Value="Public ReadOnly Property SynonymMaps As IList(Of String)" />
      <MemberSignature Language="F#" Value="member this.SynonymMaps : System.Collections.Generic.IList&lt;string&gt;" Usage="Microsoft.Azure.Search.SynonymMapsAttribute.SynonymMaps" />
      <MemberType>Property</MemberType>
      <AssemblyInfo>
        <AssemblyName>Microsoft.Azure.Search.Service</AssemblyName>
        <AssemblyVersion>10.1.0.0</AssemblyVersion>
      </AssemblyInfo>
      <ReturnValue>
        <ReturnType>System.Collections.Generic.IList&lt;System.String&gt;</ReturnType>
      </ReturnValue>
      <Docs>
        <summary>
            A list of synonym map names that associates synonym maps with the field.
            </summary>
        <value>To be added.</value>
        <remarks>To be added.</remarks>
      </Docs>
    </Member>
  </Members>
</Type>