### Strong-Named Assemblies for Plugins

Source: https://developers.rws.com/studio-api-docs/articles/gettingstarted/setting_up_a_developer_machine

Highlights the requirement to sign assemblies with a strong name for Trados Studio plugins to load correctly. Provides a link to a community key for signing.

```plaintext
Sign and use Strong-Named Assemblies to enable the loading of your plug-ins inside Trados Studio.
Download SdlCommunity.snk key from public AppStore repository.
```

--------------------------------

### Get Locations From Specific Location

Source: https://developers.rws.com/studio-api-docs/api/filetypesupport/Sdl.FileTypeSupport.Framework.BilingualApi.IAbstractMarkupDataContainer

Provides an enumerator for locations starting from a specific location within the collection. The 'startingFrom' parameter must be a location that exists within this collection.

```APIDOC
IEnumerable<Location> GetLocationsFrom(Location startingFrom)
  Parameters:
    startingFrom: Must be a location inside this collection.
  Returns:
    IEnumerable<Location>: Iterator that can be used to iterate over the remainder of the collection.
```

--------------------------------

### Get Translation Memory by ID or Path

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.TranslationProviderServer

Retrieves a translation memory by its unique identifier (GUID) or its path. Supports fetching additional related objects. Includes exception handling for invalid IDs.

```APIDOC
GetTranslationMemory(Guid id, TranslationMemoryProperties additionalProperties)
  - Gets the translation memory with the corresponding unique id.
  - Parameters:
    - id: Guid - The translation memory's unique id.
    - additionalProperties: TranslationMemoryProperties - The additional related objects to retrieve.
  - Returns:
    - ServerBasedTranslationMemory - The translation memory, or null if no translation memory with given id exists.
  - Exceptions:
    - System.ArgumentNullException: Thrown when `id` is empty.

GetTranslationMemory(String path, TranslationMemoryProperties additionalProperties)
  - Gets the translation memory with the corresponding unique path.
  - Gets a translation memory through its path.
  - Parameters:
    - path: string - The language resources template path.
    - additionalProperties: TranslationMemoryProperties - The additional related objects to retrieve.
  - Returns:
    - ServerBasedTranslationMemory - The language resource group template, or `null` if it does not exist.
  - Exceptions:
    - System.ArgumentNullException: Thrown when `path` is null or empty.
```

--------------------------------

### WelcomeViewController API

Source: https://developers.rws.com/studio-api-docs/api/integration/Sdl.TranslationStudioAutomation.IntegrationApi.WelcomeViewController

Comprehensive API documentation for the WelcomeViewController class, covering its constructor and key methods.

```APIDOC
WelcomeViewController:
  Namespace: Sdl.TranslationStudioAutomation.IntegrationApi
  Assembly: Sdl.TranslationStudioAutomation.IntegrationApi.dll

  Constructors:
    WelcomeViewController(IStudioWindow studioWindow)
      Parameters:
        studioWindow: IStudioWindow - The studio window context.
      Description: Initializes a new instance of the WelcomeViewController class.

  Methods:
    Initialize(IViewContext context)
      Parameters:
        context: IViewContext - The view context for initialization.
      Overrides:
        AbstractViewController.Initialize(IViewContext)
      Description: Initializes the controller with the provided view context. This method is called by the framework to set up the controller's state and dependencies.
```

--------------------------------

### Trados Studio Plugin Build Output Path

Source: https://developers.rws.com/studio-api-docs/articles/gettingstarted/setting_up_a_developer_machine

Specifies the recommended build output path for Trados Studio plugin implementations to ensure proper loading. It also advises on checking library references.

```plaintext
Build output path: %AppData%\Trados\Trados Studio\18\Plugins\Packages\
Library references example: C:\Program Files (x86)\Trados\Trados Studio\Studio18
```

--------------------------------

### Get ServerNameToolTip C# Property

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.StringResources

Retrieves the localized string for the tooltip associated with 'Server Name'. It guides users to enter an existing server name, typically a URL or instance name.

```C#
public static string ServerNameToolTip { get; }
```

--------------------------------

### GenericExteralPreviewApplication.Launch() Method

Source: https://developers.rws.com/studio-api-docs/api/filetypesupport/Sdl.FileTypeSupport.Framework.PreviewControls.GenericExteralPreviewApplication

Displays the preview file in the external application. This method initiates the preview process.

```C#
public virtual void Launch()
```

--------------------------------

### Get ParentResourceGroupPath Property

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.DatabaseServer

Gets the parent resource group path. This property is read-only.

```APIDOC
ParentResourceGroupPath:
  public string ParentResourceGroupPath { get; set; }
```

--------------------------------

### StudioAutomationIntegrationAPIModule Methods

Source: https://developers.rws.com/studio-api-docs/api/integration/Sdl.TranslationStudioAutomation.IntegrationApi.StudioAutomationIntegrationAPIModule

Provides documentation for the core methods of the StudioAutomationIntegrationAPIModule class, including Initialize, MinimumAPIFunctionality, and StartServices. These methods are crucial for setting up and managing services within the integration module.

```APIDOC
Initialize(IContainer container)
  - Initializes the module with a given container.
  - Parameters:
    - container: An instance of IContainer used for dependency injection.

MinimumAPIFunctionality(IContainer container)
  - Sets up the minimum required API functionality.
  - Parameters:
    - container: An instance of IContainer.

StartServices(IContainer container)
  - Starts the necessary services for the module.
  - Parameters:
    - container: An instance of IContainer.
```

```csharp
public void Initialize(IContainer container)
public void MinimumAPIFunctionality(IContainer container)
public void StartServices(IContainer container)
```

--------------------------------

### Get ParentResourceGroupDescription Property

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.DatabaseServer

Gets the parent resource group description. This property is read-only.

```APIDOC
ParentResourceGroupDescription:
  public string ParentResourceGroupDescription { get; set; }
```

--------------------------------

### ProjectServer Class and Constructor

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.FileBased.ProjectServer

Defines the ProjectServer class and its constructor for establishing a connection to a project server. The constructor allows for specifying server URI, authentication method, and credentials.

```APIDOC
Class ProjectServer
  Namespace: Sdl.ProjectAutomation.FileBased
  Assembly: Sdl.ProjectAutomation.FileBased.dll
  Syntax:
    public class ProjectServer

  Constructors:
    ProjectServer(Uri serverUri, bool useWindowsAuthentication, string userName, string password)
      Description: Creates a new project server.
      Parameters:
        Uri serverUri: The URI of the server.
        Boolean useWindowsAuthentication: Whether to use Windows authentication. If false, userName and password must be specified. If true, null can be passed for userName and password to log on as the current Windows user, or userName and password can be set for basic Windows authentication.
        String userName: The user name for custom or basic Windows authentication. Pass null to use integrated Windows authentication.
        String password: The password for custom or basic Windows authentication. Pass null to use integrated Windows authentication.
```

--------------------------------

### Get IsDirty Property

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.DatabaseServer

Gets a value indicating whether the instance has been modified. This property is read-only.

```APIDOC
IsDirty:
  public bool IsDirty { get; }
```

--------------------------------

### RWS Studio Class Methods

Source: https://developers.rws.com/studio-api-docs/api/filetypesupport/Sdl.FileTypeSupport.Framework.Core.Settings.QuickInserts.TextPairMarkup

Documentation for various methods within RWS Studio classes, including settings management, cloning, comparison, and data persistence.

```APIDOC
StartText Property:
  Represents the start text for this markup.
  Declaration:
    public string StartText { get; set; }
  Property Value:
    Type: String

ClearListItemSettings Method:
  Clears the settings related to this object in settings group.
  Declaration:
    public override void ClearListItemSettings(ISettingsGroup settingsGroup, string listItemSetting)
  Parameters:
    settingsGroup: The settings group object.
    listItemSetting: The name of the list item setting to clear.
  Overrides:
    BaseMarkupDataType.ClearListItemSettings(ISettingsGroup, String)

Clone Method:
  Performs deep copy of the object.
  Declaration:
    public override object Clone()
  Returns:
    Object: Reference to the newly created object.
  Overrides:
    AbstractSettingsClass.Clone()

Equals Method:
  Compares this object with another ISettingsClass object for equality.
  Declaration:
    public override bool Equals(ISettingsClass other)
  Parameters:
    other: The ISettingsClass object to compare with.
  Returns:
    Boolean: True if the objects are equal, false otherwise.
  Overrides:
    AbstractSettingsClass.Equals(ISettingsClass)

PopulateFromSettingsGroup Method:
  Gets the settings for this markup from settings group.
  Declaration:
    public override void PopulateFromSettingsGroup(ISettingsGroup settingsGroup, string listItemSetting)
  Parameters:
    settingsGroup: The settings group object.
    listItemSetting: The name of the list item setting to populate from.
  Overrides:
    BaseMarkupDataType.PopulateFromSettingsGroup(ISettingsGroup, String)

Read Method:
  Reads data from a value getter.
  Declaration:
    public override void Read(IValueGetter valueGetter)
  Parameters:
    valueGetter: The IValueGetter to read data from.
  Overrides:
    AbstractSettingsClass.Read(IValueGetter)

ResetToDefaults Method:
  Resets the object's settings to their default values.
  Declaration:
    public override void ResetToDefaults()
  Overrides:
    FileTypeSettingsBase.ResetToDefaults()

Save Method:
  Saves the object's data using a value processor.
  Declaration:
    public override void Save(IValueProcessor valueProcessor)
  Parameters:
    valueProcessor: The IValueProcessor to use for saving.
  Overrides:
    AbstractSettingsClass.Save(IValueProcessor)

SaveToSettingsGroup Method:
  Saves this markup to a settings group.
  Declaration:
    public override void SaveToSettingsGroup(ISettingsGroup settingsGroup, string listItemSetting)
  Parameters:
    settingsGroup: The settings group object.
    listItemSetting: The name of the list item setting to save to.
  Overrides:
    BaseMarkupDataType.SaveToSettingsGroup(ISettingsGroup, String)
```

--------------------------------

### Get TranslationProviderServer Property

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.DatabaseServer

Gets the translation provider server on which this database server is registered. This property is read-only.

```APIDOC
TranslationProviderServer:
  public TranslationProviderServer TranslationProviderServer { get; }
```

--------------------------------

### Return Package Creation and Import

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.Core

APIs for managing return packages. CreateReturnPackage is used to generate a return package from selected project files, while ImportReturnPackage handles the import of an existing return package into a project.

```APIDOC
Sdl.ProjectAutomation.Core.IProject.CreateReturnPackage Method:
  Creates a return package from specified project files.
  Signature: CreateReturnPackage(Guid[] projectFileGuids, String returnPackagePath, String comment)
  Parameters:
    - projectFileGuids: An array of GUIDs identifying the project files to include in the return package.
    - returnPackagePath: The file path where the return package will be created.
    - comment: An optional comment to be associated with the return package.

Sdl.ProjectAutomation.Core.IProject.ImportReturnPackage Method:
  Imports a return package into the current project.
  Signature: ImportReturnPackage(String returnPackagePath)
  Parameters:
    - returnPackagePath: The file path of the return package to import.
```

--------------------------------

### Get IsNewObject Property

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.DatabaseServer

Gets a value indicating whether this instance is a new object. This property is read-only.

```APIDOC
IsNewObject:
  public bool IsNewObject { get; }
```

--------------------------------

### IsAll String Predicate C# API

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.Core.CharacterProperties

Evaluates a predicate on all characters in a string, optionally starting from a specified position. Returns true if all characters fulfill the predicate, or if the string is empty or the start position is invalid. Includes overloads for strings with and without a starting index.

```C#
public static bool IsAll(string s, int start, Predicate<char> predicate)
    - Evaluates the predicate on all characters in the string, starting from position `start`, and returns true if all characters fulfill the predicate, and false otherwise.
    - Note that the method will always return `true` for the empty string or if the start position exceeds the string length.
    - Parameters:
      - s: String - The input string.
      - start: Int32 - The starting position in the string.
      - predicate: Predicate<Char> - The predicate to evaluate.
    - Returns:
      - Boolean - true if all characters fulfill the predicate, or `s` is the empty string, or `start` exceeds the string length, and false otherwise.

public static bool IsAll(string s, Predicate<char> predicate)
    - Evaluates the predicate on all characters in the string and returns true if all characters fulfill the predicate, and false otherwise.
    - Note that the method will always return `true` for the empty string.
    - Parameters:
      - s: String - The input string.
      - predicate: Predicate<Char> - The predicate to evaluate.
    - Returns:
      - Boolean - true if all characters fulfill the predicate or `s` is the empty string, and false otherwise.
```

--------------------------------

### Initialize Controller

Source: https://developers.rws.com/studio-api-docs/api/integration/Sdl.TranslationStudioAutomation.IntegrationApi.ProjectsController

Initializes the project controller with the provided view context.

```APIDOC
Initialize(IViewContext context)
  Parameters:
    context: IViewContext - The context in which the project controller is initialized.
  Overrides:
    AbstractViewController.Initialize(IViewContext)
```

--------------------------------

### Project Information and Configuration

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.Core

Classes for holding and updating project-specific information, configurations, and templates.

```APIDOC
ProjectFileTypeConfiguration:
  Configuration details for a specific project file type.

ProjectInfo:
  Holds information about a project.
  This class is used when accessing information about an existing project, and for updating a project with new information. It is also used when creating a new project.
  Not all properties are supported for project updating.

ProjectTemplateInfo:
  Holds information about a project template.

ProjectTemplateReference:
  Represents a reference to an existing project template.
```

--------------------------------

### Get SupportedLanguageDirections Property (C#)

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.AbstractLocalTranslationMemory

Gets the list of language directions supported by this translation memory. Returns a ReadOnlyCollection of LanguagePair objects.

```csharp
public ReadOnlyCollection<LanguagePair> SupportedLanguageDirections { get; }
```

--------------------------------

### Project Package Creation Options

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.Core

Defines options for creating project packages, specifying what content to include.

```APIDOC
ProjectPackageCreationOptions:
  Represents options that can be passed to CreateProjectPackage to control what will be included in a project package.
```

--------------------------------

### Get FuzzyIndexStatisticsSize Property (C#)

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.AbstractLocalTranslationMemory

Gets the size of the TM at the point of the last fuzzy index statistics recomputation. This value is nullable.

```csharp
public int? FuzzyIndexStatisticsSize { get; set; }
```

--------------------------------

### PerfectMatchTaskSettings Class Documentation

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.Settings.PerfectMatchTaskSettings

Provides detailed documentation for the PerfectMatchTaskSettings class, including its constructors, properties, namespace, and assembly information. This entry covers the core API definition for managing Perfect Match task settings.

```APIDOC
PerfectMatchTaskSettings Class Documentation
  Namespace: Sdl.ProjectAutomation.Settings
  Assembly: Sdl.ProjectAutomation.Settings.dll
  Inheritance: Object -> PerfectMatchTaskSettings

  Syntax:
    public class PerfectMatchTaskSettings : SettingsGroup

  Constructors:
    PerfectMatchTaskSettings()
      Declaration: public PerfectMatchTaskSettings()
      Description: Initializes a new instance of the PerfectMatchTaskSettings class.

  Properties:
    MarkAsPerfectMatchAndLock
      Declaration: public Setting<bool> MarkAsPerfectMatchAndLock { get; }
      Description: If true, all segments copied over from the reference files will be marked as "PerfectMatch" and will be locked. This caters for the "fully reviewed existing project" scenario. If false, the original segment properties will be preserved and the segment will not be locked. This caters for the "mid project update" scenario, where the translator is halfway through a translation project, and the client sends all the source files again with a few tweaks in them.
      Property Value:
        Type: Setting<Boolean>
        Description:  
```

--------------------------------

### Get FuzzyIndexTuningSettings Property (C#)

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.AbstractLocalTranslationMemory

Gets or sets the fuzzy index tuning settings for the translation memory. This property returns a FuzzyIndexTuningSettings object.

```csharp
public FuzzyIndexTuningSettings FuzzyIndexTuningSettings { get; set; }
```

--------------------------------

### ConvertFilesToXliff Example

Source: https://developers.rws.com/studio-api-docs/api/filetypesupport/Sdl.FileTypeSupport.Framework.IntegrationApi.IFileTypeManager

Example demonstrating how to use the RWS Studio API to convert a collection of native files into a single SDL XLIFF document.

```C#
void ConvertFilesToXliff(IFileTypeManager manager, string[] nativeFiles, CultureInfo language, Codepage suggestedCodepage, string xliffFilePath)
{
	// Assuming 'settingsBundle' is defined elsewhere and holds necessary configuration.
	// For demonstration, we'll pass null or a placeholder if not provided.
	object settingsBundle = null; // Replace with actual settings if available
	IMultiFileConverter converter = manager.GetConverterToDefaultBilingual(nativeFiles, xliffFilePath, language, suggestedCodepage, null, settingsBundle);
	converter.Parse();
}
```

--------------------------------

### ProjectsController Constructor

Source: https://developers.rws.com/studio-api-docs/api/integration/Sdl.TranslationStudioAutomation.IntegrationApi.ProjectsController

Initializes a new instance of the ProjectsController class with the specified studio window, project management service, and projects view service.

```APIDOC
ProjectsController(IStudioWindow studioWindow, IProjectManagementService projectManagementService, IProjectsViewService projectsViewService)
  - Parameters:
    - studioWindow: IStudioWindow - The main studio window.
    - projectManagementService: IProjectManagementService - Service for managing projects.
    - projectsViewService: IProjectsViewService - Service for the projects view.
```

--------------------------------

### API: LanguageGroupInstallationStatus Enum

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.Core.CultureInfoExtensions.LanguageGroupInstallationStatus

Defines the installation status for language group information, referencing definitions from the Platform SDK and WinNls.h. It specifies the states a language group can be in regarding its installation.

```APIDOC
Namespace: Sdl.LanguagePlatform.Core
Assembly: Sdl.LanguagePlatform.Core.dll

Syntax:
public enum LanguageGroupInstallationStatus

Fields:
- Installed: Indicates that the language group is installed
- Supported: Indicates that the language group is installed
```

--------------------------------

### ProjectServer Methods

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.FileBased.ProjectServer

Provides API documentation for various methods of the ProjectServer class, including deleting projects, retrieving project details, listing projects, and opening projects.

```APIDOC
Methods:
  DeleteProject(Guid projectId)
    Description: Delete a project from the remote server.
    Parameters:
      Guid projectId: The unique id to identify the project to delete.
    Returns: void

  GetServerProject(string qualifiedName)
    Description: Given the qualified (organisationPath/projectName) name of a server project, returns the project details if present on the server, otherwise null.
    Parameters:
      string qualifiedName: A name in the form organizationPath/ProjectName (e.g., /MyCompany/Project1).
    Returns:
      ServerProjectInfo: Details of the project.

  GetServerProjects(string organizationPath, bool includeProjectsInSubOrganizations, bool includeCompletedProjects)
    Description: Returns the project list from the remote server.
    Parameters:
      string organizationPath: The path to the organization.
      bool includeProjectsInSubOrganizations: Whether to include projects in sub-organizations.
      bool includeCompletedProjects: Whether to include completed projects.
    Returns:
      ServerProjectInfo[]: An array of ServerProjectInfo objects.

  OpenProject(Guid projectId, string localProjectFolder)
    Description: The method opens the project with the specified id.
    Parameters:
      Guid projectId: The project unique id.
      string localProjectFolder: The local project folder.
    Returns:
      FileBasedProject: The opened project.
```

--------------------------------

### StartWithAny: Check if String Starts with Any Character in a List (C#)

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.Core.StringUtilities

Returns true if the string `s` starts with any of the characters provided in the `characterList`, and false otherwise. It takes the string and an array of characters to check against.

```csharp
APIDOC
StartWithAny(string s, char[] characterList)
  - Returns `true` if the string `s` starts with any of the characters in `characterList`.
  - Parameters:
    - s (String): The input string.
    - characterList (Char[]): The list of characters to check against.
  - Returns:
    - Boolean: True if the string starts with any of the specified characters, false otherwise.
```

--------------------------------

### ReturningPackageSettings Class

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.Settings.ReturningPackageSettings

Provides detailed documentation for the ReturningPackageSettings class, including its constructors, properties, and inheritance hierarchy.

```APIDOC
ReturningPackageSettings Class
  Description: Settings that relate to the return package when the create project package is created.
  Namespace: Sdl.ProjectAutomation.Settings
  Assembly: Sdl.ProjectAutomation.Settings.dll
  Inheritance: Object -> ReturningPackageSettings

  Constructors:
    ReturningPackageSettings()
      Description: Initializes a new instance of the ReturningPackageSettings class.
      Declaration: public ReturningPackageSettings()

  Properties:
    RunVerificationBeforeReturningPackage:
      Description: Setting that specifies whether the return package should run a verification before creation.
      Declaration: public bool RunVerificationBeforeReturningPackage { get; set; }
      Property Value:
        Type: Boolean
        Description: Indicates if verification is run before package creation.
```

--------------------------------

### AbstractApplication Class API

Source: https://developers.rws.com/studio-api-docs/api/integration/Sdl.Desktop.IntegrationApi.AbstractApplication

API documentation for the AbstractApplication class, detailing its constructors, methods, events, and inheritance hierarchy.

```APIDOC
AbstractApplication
  Namespace: Sdl.Desktop.IntegrationApi
  Assembly: Sdl.Desktop.IntegrationApi.dll
  Inheritance:
    Object
    AbstractApplication
    [SdlTradosStudioApplication](Sdl.TranslationStudioAutomation.IntegrationApi.Internal.SdlTradosStudioApplication.html)
  Inherited Members:
    Object.ToString()
    Object.Equals(Object)
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetHashCode()
    Object.GetType()
    Object.MemberwiseClone()

  Syntax:
    public abstract class AbstractApplication

  Constructors:
    AbstractApplication()
      protected AbstractApplication()
      Description: Initialize the instance of this class

  Methods:
    ExecuteAction<TAction>()
      Declaration: public virtual void ExecuteAction<TAction>()
        where TAction : AbstractAction
      Type Parameters:
        TAction: The requested action by type.
      Description: Execute the requested action

    GetAction<TAction>()
      Declaration: public virtual TAction GetAction<TAction>()
        where TAction : AbstractAction
      Returns:
        TAction: The action requested or null if none was found.
      Type Parameters:
        TAction: The requested action by type.
      Description: Gets the requested action.

    GetController<TController>()
      Declaration: public virtual TController GetController<TController>()
        where TController : AbstractController
      Returns:
        TController: The controller of type T requested.
      Type Parameters:
        TController: the type of the requested controller
      Description: Gets the requested controller. This supports getting view or view part controllers.

    GetService<T>()
      Declaration: public T GetService<T>()
      Returns:
        T: The service requested or null if none was found.
      Type Parameters:
        T: The requested service by type.
      Description: Gets the requested service.

    RegisterRelay(IStudioWindow)
      Declaration: protected virtual void RegisterRelay(IStudioWindow window)
      Parameters:
        window: IStudioWindow
      Description: Initializes services when the window is created

  Events:
    Closing
      Declaration: public event EventHandler<CancelEventArgs> Closing
      Event Type:
        EventHandler<CancelEventArgs>
      Description: Triggered when the application is closing

  Extension Methods:
    WindowsControlUtils.ForWindowFromFrameworkElement(Object, Action<Window>)
      Link: Sdl.Desktop.Platform.Controls.Controls.WindowsControlUtils.html#Sdl_Desktop_Platform_Controls_Controls_WindowsControlUtils_ForWindowFromFrameworkElement_System_Object_System_Action_System_Windows_Window__
```

--------------------------------

### Field Retrieval by Name or GUID

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemory.FieldDefinitions

Methods for looking up fields using either their unique GUID or their case-insensitive name. Returns the field object or null if not found.

```APIDOC
Lookup(Guid guid)
  - Retrieves a field by its GUID.
  - Parameters:
    - guid: Guid The GUID to look up.
  - Returns:
    - [Field]: The field with the specified GUID, or `null` if no such field exists.

Lookup(string name)
  - Retrieves the field declaration with the specified name. Field names are case-insensitive.
  - Parameters:
    - name: String The field name.
  - Returns:
    - [Field]: The field declaration or null if it does not exist.
```

--------------------------------

### Get UserName Static Property in C#

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.StringResources

Retrieves the static string value for the UserName property. This property is read-only and typically used to get a localized string for 'User Name'.

```csharp
public static string UserName { get; }
```

--------------------------------

### DatabaseServer Class API Documentation

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemoryApi.DatabaseServer

Provides detailed information about the DatabaseServer class, including its constructor, properties, inheritance, and namespace. This documentation covers how to create, manage, and interact with database server objects within the Sdl.LanguagePlatform.TranslationMemoryApi.

```APIDOC
Namespace: Sdl.LanguagePlatform.TranslationMemoryApi
Assembly: Sdl.LanguagePlatform.TranslationMemoryApi.dll

Class DatabaseServer
  Represents a database server known in the system, which can serve as the host for one or more translation memory containers.

Inheritance:
  Object
  DatabaseServer

Implements:
  IEditableObject
  INotifyPropertyChanged
  IEquatable<DatabaseServer>
  IPermissionCheck

Syntax:
  public class DatabaseServer : IEquatable<DatabaseServer>, IPermissionCheck

Constructors:
  DatabaseServer(TranslationProviderServer server)
    Creates a new database server. Note that you have to call Save() to persist the database server object, after setting all the required properties.
    Parameters:
      server: [TranslationProviderServer] The translation provider server with which the database server should be registered.
    Exceptions:
      System.ArgumentNullException: Thrown when `server` is null.

Properties:
  AuthenticationType
    Gets or sets the type of authentication that is used when the application server communicates with this database server.
    Declaration:
      public DatabaseServerAuthenticationType AuthenticationType { get; set; }
    Property Value:
      [DatabaseServerAuthenticationType]: 
    Exceptions:
      [ObjectDeletedException]: Thrown when trying to set AuthenticationType of an entity that no longer exists.

  Containers
    Gets all the translation memory containers that are hosted on this database server.
    Declaration:
      public ReadOnlyCollection<TranslationMemoryContainer> Containers { get; }
    Property Value:
      ReadOnlyCollection<[TranslationMemoryContainer]>: 
    Remarks:
      If the list of containers has been pre-loaded, the in-memory collection of containers is returned, otherwise the list of containers is retrieved from the server on-demand.
    Exceptions:
      [ObjectDeletedException]: Thrown when this object has already been deleted.

  Description
    Gets or sets the description of the database server.
    Declaration:
      public string Description { get; set; }
    Property Value:
      String: 
    Remarks:
      Note that you have to call Save() to persists the change after setting this property.
    Exceptions:
      [ObjectDeletedException]: Thrown when trying to get/set description of an entity that no longer exists.

  Id
    Gets the unique Id for this database server.
    Declaration:
      public Guid Id { get; }
    Property Value:
      Guid: 
    Remarks:
      This is auto-generated by the system when the database server is created.
    Exceptions:
      [ObjectDeletedException]: Thrown when trying to get the unique ID of an entity that no longer exists.

  IsDeleted
    Returns true if this translation memory has been deleted.
    Declaration:
      public bool IsDeleted { get; }
    Property Value:
      Boolean: 

  IsDirty
    Returns true if this database server has unsaved changes.
    Declaration:
      public bool IsDirty { get; }
    Property Value:
      Boolean: 

```

--------------------------------

### GetTranslationProviderConfiguration

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.FileBased.FileBasedProject

Retrieves the translation provider configuration for the project. This method can be called without arguments to get the default configuration or with a target language to get a language-specific override. It never returns null.

```APIDOC
GetTranslationProviderConfiguration()
  Returns:
    TranslationProviderConfiguration - The default translation provider configuration for the project. This never returns null.

GetTranslationProviderConfiguration(Language targetLanguage)
  Parameters:
    targetLanguage: Language - The target language for which to get the translation provider configuration.
  Returns:
    TranslationProviderConfiguration - The translation provider configuration for the specified target language. If no specific configuration is set, an empty configuration is returned.
```

--------------------------------

### FileBasedProject Constructors

Source: https://developers.rws.com/studio-api-docs/api/projectautomation/Sdl.ProjectAutomation.FileBased.FileBasedProject

Details the different ways to create a FileBasedProject instance, including using default templates, existing projects, or project templates, along with their specific requirements and potential exceptions.

```APIDOC
Constructors for FileBasedProject:

1. FileBasedProject(ProjectInfo projectInfo)
   - Creates a new project based on the default project template set up in Trados Studio.
   - Parameters:
     - projectInfo: [ProjectInfo] Properties to use when creating the project.
   - Remarks:
     The default project template has to be set up before you can use this constructor. This is done automatically when Trados Studio starts for the first time after installation.
   - Exceptions:
     - System.InvalidOperationException: Thrown when trying to use this constructor before Trados Studio has initialized the default project template.
     - System.ArgumentNullException: Thrown when `projectInfo` is `null`.
     - System.ArgumentException: Thrown when `projectInfo` is invalid.

2. FileBasedProject(ProjectInfo projectInfo, ProjectReference projectReference)
   - Creates a new project based on an existing project.
   - Parameters:
     - projectInfo: [ProjectInfo] Properties to use when creating the project.
     - projectReference: [ProjectReference] The existing project to base this new project on.
   - Exceptions:
     - System.ArgumentNullException: Thrown when `projectInfo` or `projectReference` is `null`.
     - System.ArgumentException: Thrown when `projectInfo` is invalid.
     - System.IO.FileNotFoundException: Thrown when `projectReference` does not exist.
     - ProjectAutomationException: Thrown when the reference project could not be loaded.

3. FileBasedProject(ProjectInfo projectInfo, ProjectTemplateReference templateReference)
   - Creates a new project based on a project template.
   - Parameters:
     - projectInfo: [ProjectInfo] Properties to use when creating the project.
     - templateReference: [ProjectTemplateReference] The project template to base this new project on.
   - Exceptions:
     - System.ArgumentNullException: Thrown when `projectInfo` or `templateReference` is `null`.
     - System.ArgumentException: Thrown when `projectInfo` is invalid.
```

--------------------------------

### AbstractSettingsPage API

Source: https://developers.rws.com/studio-api-docs/api/core/Sdl.Core.Settings.AbstractSettingsPage

API documentation for the AbstractSettingsPage class, detailing its structure, properties, and methods.

```APIDOC
AbstractSettingsPage Class Documentation

Namespace: Sdl.Core.Settings
Assembly: Sdl.Core.Settings.dll
Inheritance: Object -> AbstractSettingsPage
Implements: ISettingsPage, IDisposable

Syntax:
public abstract class AbstractSettingsPage : ISettingsPage, IDisposable

Constructors:
- protected AbstractSettingsPage()
  - Description: Initializes a new instance of the AbstractSettingsPage class.

Properties:
- DataSource:
  - Declaration: public object DataSource { get; set; }
  - Type: object
  - Description: Gets or sets the data source for the settings page.
- HasDefaultSettings:
  - Declaration: public virtual bool HasDefaultSettings { get; }
  - Type: boolean
  - Description: Gets a value indicating whether the settings page has default settings.

Methods:
- AfterCancel():
  - Declaration: public virtual void AfterCancel()
  - Description: Called after the cancel operation is performed.
- AfterSave():
  - Declaration: public virtual void AfterSave()
  - Description: Called after the save operation is performed.
- Cancel():
  - Declaration: public virtual void Cancel()
  - Description: Cancels the current settings changes.
- Dispose():
  - Declaration: public abstract void Dispose()
  - Description: Releases all resources used by the AbstractSettingsPage.
- GetControl():
  - Declaration: public abstract object GetControl()
  - Returns: Object - The UI control associated with the settings page.
  - Description: Gets the UI control for the settings page.
- OnActivate():
  - Declaration: public virtual void OnActivate()
  - Description: Called when the settings page is activated.
- OnDeactivate():
  - Declaration: public virtual void OnDeactivate()
  - Description: Called when the settings page is deactivated.
- Refresh():
  - Declaration: public virtual void Refresh()
  - Description: Refreshes the settings page content.
- ResetToDefaults():
  - Declaration: public virtual void ResetToDefaults()
  - Description: Resets the settings page to its default values.
- Save():
  - Declaration: public virtual void Save()
  - Description: Saves the current settings.
- ValidateInput():
  - Declaration: public virtual bool ValidateInput()
  - Returns: Boolean - True if the input is valid, false otherwise.
  - Description: Validates the user input on the settings page.
```

--------------------------------

### IField Retrieval by Name or GUID

Source: https://developers.rws.com/studio-api-docs/api/translationmemory/Sdl.LanguagePlatform.TranslationMemory.FieldDefinitions

Methods for looking up fields as IField objects using either their unique GUID or their name. Returns the IField object or null if not found.

```APIDOC
LookupIField(Guid guid)
  - Returns the field with the specified GUID.
  - Parameters:
    - guid: Guid The GUID to look up.
  - Returns:
    - [IField]: The field with the specified GUID, or `null` if there is no field with that GUID.

LookupIField(string name)
  - Returns the field with the specified name.
  - Parameters:
    - name: String The field name.
  - Returns:
    - [IField]: The field with the specified name, or `null` if there is no field with that name.
```