IDocumentPainterView interface

The IDocumentPainterView interface is an internal interface for the Schematic Editor and it represents the Mini Viewer facility. This is for internal use.

public interface IDocumentPainterView

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
DocumentToPaint	ISch_Document	set	This is for internal use.

DocumentToPaint

This is for internal use.

void SetState_DocumentToPaint(ISch_Document argDocument);

Type: ISch_Document · Access: write-only

The accessors are extension methods of IDocumentPainterViewHelper (using SCH;).

Methods

Method	Returns	Description
DrawCurrentZoomRectangle_Invert	void	This is for internal use.
GetStringMaxMin	void
Invalidate	void
PaintSingleObject	void	This is for internal use.
Redraw	void	This is for internal use.
Refresh	void	This is for internal use.
RefreshCurrentZoomWindow	void	This is for internal use.

DrawCurrentZoomRectangle_Invert

This is for internal use.

void DrawCurrentZoomRectangle_Invert();

Returns: nothing (void)

GetStringMaxMin

No description yet.

void GetStringMaxMin(Point argLocation, string argText, int argFontId, out CoordRect argBoundingRect);
void GetStringMaxMin(IPoint argLocation, string argText, int argFontId, out ICoordRect argBoundingRect);

Parameter	Type	Passing
argLocation	Point	value
argText	string	value
argFontId	int	value
argBoundingRect	CoordRect	out

Returns: nothing (void)

The first overload is an extension method of IDocumentPainterViewHelper (using SCH;) with typed parameters; the second is declared by the interface.

Invalidate

No description yet.

void Invalidate();

Returns: nothing (void)

PaintSingleObject

This is for internal use.

void PaintSingleObject(ISch_GraphicalObject argGraphicalObject);
void PaintSingleObject(object argGraphicalObject);

Parameter	Type	Passing
argGraphicalObject	ISch_GraphicalObject	value

Returns: nothing (void)

The first overload is an extension method of IDocumentPainterViewHelper (using SCH;) with typed parameters; the second is declared by the interface.

Redraw

This is for internal use.

void Redraw(ISch_GraphicalObject argGraphicalObject);
void Redraw(object argGraphicalObject);

Parameter	Type	Passing
argGraphicalObject	ISch_GraphicalObject	value

Returns: nothing (void)

The first overload is an extension method of IDocumentPainterViewHelper (using SCH;) with typed parameters; the second is declared by the interface.

Refresh

This is for internal use.

void Refresh();

Returns: nothing (void)

RefreshCurrentZoomWindow

This is for internal use.

void RefreshCurrentZoomWindow();

Returns: nothing (void)

Returned by

ISch_ServerInterface.CreateDocumentPainter