ObjectProxy

GeneralProxy<1>References
public class ObjectProxy : GeneralProxy<IDocumentObject>
A proxy holding all required information about a certain type of Document object.

Constructors

ObjectProxy

#
public ObjectProxy(IDocumentObject instance, Plugin plugin)
Create a proxy from an instance.
Parameters:
instance (IDocumentObject)
plugin (Plugin)

ObjectProxy

#
protected ObjectProxy(Type type, Guid ioId, Nomen nomen, Plugin plugin)
Constructor for derived types. Why are you deriving from this class if you're not Thibault Schwartz?
Parameters:
type (Type)Type underlying this proxy.
ioId (Guid)Id of this type.
nomen (Nomen)Nomen of this type.
plugin (Plugin)Plugin which owns this type.

Properties

Icon

public virtual IIcon Icon { get; }
Gets the icon associated with this object.
inherited fromGeneralProxy<T>

Id

public Guid Id { get; }
Gets the ID for this object.
inherited fromGeneralProxy<T>

Nomen

public Nomen Nomen { get; }
Gets the nomen describing this object.
inherited fromGeneralProxy<T>

Obsolete

public bool Obsolete { get; }
Gets whether this proxy represents an obsolete (or otherwise hidden) object.
inherited fromGeneralProxy<T>

Plugin

public Plugin Plugin { get; }
Gets the plugin to which is object belongs.
inherited fromGeneralProxy<T>

SearchableNomen

public Nomen SearchableNomen { get; }
Gets the searchable version of the nomen.
inherited fromGeneralProxy<T>

Type

public Type Type { get; }
Gets the Type of this object.
inherited fromGeneralProxy<T>

Methods

Draw

#
public Bitmap Draw(float scale = 1, int padding = 10, Skin skin = null)
Try and render a preview of the object to a bitmap.
Parameters:
scale (float = 1)Zoom level for preview.
padding (int = 10)Padding. Again, this is a suggestion and not guaranteed to be obeyed.
skin (Skin = null)Skin to lay out and draw with; null means the current skin.
Returns: Preview of object or null.

Draw

#
public static Bitmap Draw(IDocumentObject obj, float scale = 1, int padding = 10, Skin skin = null)
Try and render a preview of an existing object to a bitmap.
Parameters:
obj (IDocumentObject)Object to draw.
scale (float = 1)Zoom level for preview.
padding (int = 10)Padding. Again, this is a suggestion and not guaranteed to be obeyed.
skin (Skin = null)Skin to lay out and draw with; null means the current skin.
Returns: Preview of object or null.

Emit

public virtual T Emit(string initCode = null)
Emit a new instance of this object.
inherited fromGeneralProxy<T>
Parameters:
initCode (string = null)If provided, this initialisation string will be passed to the object. Not all objects support init codes, but if it doesn't, and you supply one anyway, the code will just be ignored.

ExtractIconFromInstance

#
protected override IIcon ExtractIconFromInstance(IDocumentObject instance)
Parameters:
instance (IDocumentObject)
Overrides: GeneralProxy<T>.ExtractIconFromInstance