Class FileBasedPluginDescriptor

Plug-in descriptor which loads the plug-in manifest and the plug-in's resources from files on the local file system.

Inheritance

object

FileBasedPluginDescriptor

Implements

IPluginDescriptor

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: SdlSdl.CorePluginFramework

Assembly: Sdl.Core.PluginFramework.dll

Syntax

public class FileBasedPluginDescriptor : IPluginDescriptor

Constructors

FileBasedPluginDescriptor(string)

Constructs a FileBasedPluginDescriptor using the specified path of a plug-in manifest path.

Declaration

public FileBasedPluginDescriptor(string pluginManifestFilePath)

Parameters

Type	Name	Description
string	pluginManifestFilePath	The full path to the plug-in manifest.

Properties

Name

Returns the file name of the plug-in manifest file.

Declaration

public string Name { get; }

Property Value

Type	Description
string

PluginManifestFilePath

Gets the full plug-in manifest file path.

Declaration

public string PluginManifestFilePath { get; }

Property Value

Type	Description
string

Methods

GetPluginManifestStream()

Returns a file stream for reading the plug-in manifest file.

Declaration

public Stream GetPluginManifestStream()

Returns

Type	Description
Stream	A file stream for reading the plug-in manifest file.

GetPluginResource(string)

Gets a plug-in resource by name. This only includes resources that are referred to in the plug-in manifest, such as strings and images.

Declaration

public object GetPluginResource(string name)

Parameters

Type	Name	Description
string	name	The resource name.

Returns

Type	Description
object

Remarks

When a property of an extsion attribnute or auxiliary extension attribute is merked with the PluginResourceAttribute attribute, any value assigned to it is assumed to be the name of a plug-in resource and can therefore be retrieved using this method.

Implements

IPluginDescriptor