Search Results for

    Show / Hide Table of Contents

    Interface ITerminologyProvider

    Provides access to a terminology provider, which in turn provides access to termbases.

    Inherited Members
    System.IDisposable.Dispose()
    Namespace: Sdl.Terminology.TerminologyProvider.Core
    Assembly: Sdl.Terminology.TerminologyProvider.Core.dll
    Syntax
    public interface ITerminologyProvider : IDisposable
    Remarks

    Implement ITerminologyProvider interface when creating a terminology provider.

    Properties

    Definition

    Get a list of terminology provider definition objects

    Declaration
    IDefinition Definition { get; }
    Property Value
    Type Description
    IDefinition

    Description

    Gets the terminology provider description

    Declaration
    string Description { get; }
    Property Value
    Type Description
    System.String

    Id

    Gets the unique ID of the terminology provider

    Declaration
    string Id { get; }
    Property Value
    Type Description
    System.String

    IsReadOnly

    Read only flag for the terminology provider.

    Declaration
    bool IsReadOnly { get; }
    Property Value
    Type Description
    System.Boolean

    Name

    Gets the display name of the terminology provider

    Declaration
    string Name { get; }
    Property Value
    Type Description
    System.String

    SearchEnabled

    Gets the terminology provider search enabled flag.

    Declaration
    bool SearchEnabled { get; }
    Property Value
    Type Description
    System.Boolean

    Type

    Gets the type of the terminology provider.

    Declaration
    TerminologyProviderType Type { get; }
    Property Value
    Type Description
    TerminologyProviderType

    Uri

    Gets the URI of this terminology provider.

    Declaration
    Uri Uri { get; }
    Property Value
    Type Description
    System.Uri

    Methods

    GetEntry(Int32)

    Get an entry definition from the terminology provider

    Declaration
    IEntry GetEntry(int id)
    Parameters
    Type Name Description
    System.Int32 id

    The entry id to get.

    Returns
    Type Description
    IEntry

    The entry object. Returns null if an entry with the specified id does not exists in the terminology provider.

    GetEntry(Int32, IEnumerable<ILanguage>)

    Get an entry from the terminology provider

    Declaration
    IEntry GetEntry(int id, IEnumerable<ILanguage> languages)
    Parameters
    Type Name Description
    System.Int32 id

    The entry id to get.

    System.Collections.Generic.IEnumerable<ILanguage> languages

    The languages to fill for the requested entry.

    Returns
    Type Description
    IEntry

    The entry object. Returns null if an entry with the specified id does not exists in the terminology provider.

    GetLanguages()

    Returns a list of the language languages available for this terminology provider

    Declaration
    IList<ILanguage> GetLanguages()
    Returns
    Type Description
    System.Collections.Generic.IList<ILanguage>

    The list of language definitions for a terms

    Search(String, ILanguage, ILanguage, Int32, SearchMode, Boolean)

    Performs a search over the current terminology provider

    Declaration
    IList<ISearchResult> Search(string text, ILanguage source, ILanguage destination, int maxResultsCount, SearchMode mode, bool targetRequired)
    Parameters
    Type Name Description
    System.String text

    The text to search for

    ILanguage source

    Source language

    ILanguage destination

    Destination language

    System.Int32 maxResultsCount

    Maximum number of result to return

    SearchMode mode

    search mode: normal, fuzzy, full text

    System.Boolean targetRequired

    True to return only term with target language term definition

    Returns
    Type Description
    System.Collections.Generic.IList<ISearchResult>

    The list of found terms

    SetDefault(Boolean)

    Set the terminology provider as default

    Declaration
    void SetDefault(bool value)
    Parameters
    Type Name Description
    System.Boolean value

    Determines if it is set as default or not

    On this page

    Back to top Generated by DocFX