Interface ISharedObjectsAware

Implemented by any file type components (native or bilingual) that require access to shared objects used during processing. The framework will call the SetSharedObjects(ISharedObjects) method before the component is used for the first time.

Namespace: Sdl.FileTypeSupport.Framework.NativeApi

Assembly: Sdl.FileTypeSupport.Framework.Core.dll

Syntax

public interface ISharedObjectsAware

Remarks

This interface can be used to establish communication across components or between components and the host application during conversion.

Communication between components during conversion is normally handled by embedding information in the actual content, e.g. by calling CustomInfo(ICustomInfoProperties), by setting custom properties on tags or contexts, or by adding actual content such as tags or contexts to the output. That is often the preferred method for content processing components to communicate, since the information will travel with the data it relates to, and is therefore not affected by buffering, etc. However, it is sometimes useful to establish communication of unrelated properties or to communicate 'upstream', in which case shared objects constitute the preferred mechanism.

An example of the use of shared objects are verification settings, which are passed from SDL Trados Studio to the verifier components.

Methods

SetSharedObjects(ISharedObjects)

The framework calls this method before the component is used for content processing in order to communicate with the interface used for accessing shared objects.

Declaration

void SetSharedObjects(ISharedObjects sharedObjects)

Parameters

Type	Name	Description
ISharedObjects	sharedObjects

Remarks

Note that not all shared objects may have been published at the time of this call. Handle the SharedObjectPublished event to get notifications when new object instances are shared.