IPainter interface

No description yet.

public interface IPainter

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
BrushColor	int	get; set
CanvasHeight_Mils	int	get
CanvasWidth_Mils	int	get
ClipRect	Rect	get; set
DoingRedraw	bool	get; set
PenColor	int	get; set
PenWidth	int	get; set
ViewRect	Rect	get; set
XScaleFactor	double	get; set
YScaleFactor	double	get; set

BrushColor

No description yet.

int GetBrushColor();
int SetBrushColor(int argColor);

Type: int · Access: read/write

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

CanvasHeight_Mils

No description yet.

int GetProperty_CanvasHeight_Mils();

Type: int · Access: read-only

CanvasWidth_Mils

No description yet.

int GetProperty_CanvasWidth_Mils();

Type: int · Access: read-only

ClipRect

No description yet.

Rect GetClipRect();
Rect SetClipRect(Rect argRect);

Type: Rect · Access: read/write

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

DoingRedraw

No description yet.

bool GetProperty_DoingRedraw();
void SetProperty_DoingRedraw(bool argValue);

Type: bool · Access: read/write

PenColor

No description yet.

int GetPenColor();
int SetPenColor(int argColor);

Type: int · Access: read/write

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

PenWidth

No description yet.

int GetPenWidth();
int SetPenWidth(int argWidth);

Type: int · Access: read/write

ViewRect

No description yet.

Rect GetViewRect();
Rect SetViewRect(Rect argRect);

Type: Rect · Access: read/write

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

XScaleFactor

No description yet.

double GetProperty_XScaleFactor();
void SetProperty_XScaleFactor(double argValue);

Type: double · Access: read/write

YScaleFactor

No description yet.

double GetProperty_YScaleFactor();
void SetProperty_YScaleFactor(double argValue);

Type: double · Access: read/write

Methods

Method	Returns	Description
ClearExternalDisplayContext	void
ClearViewRect	void
DoCircle	void
DoEllipse	void
DoFillRect	void
DoLineTo	void
DoMoveTo	void
DoPole	void
DoTextOut	void
DoZero	void
DrawCursorTab	void
DrawDesignationSymbol	void
DrawHorizontalCursorLine	void
DrawLinearXMinorDivisions	void
DrawRect	void
DrawSelectionButton	void
DrawVerticalCursorLine	void
DrawWaveScrollArrow	void
Export_ToScreen_HighLight	void
Export_ToScreen_Paint	void
Export_ToScreen_Update	void
GetTextHeight	int
GetTextWidth	int
SetFontAngle	int
SetFontColor	int
SetFontSize	int
SetFontStyle	TFontStyleSet
SetPenMode	TPenMode
SetPenStyle	ushort
SetScaling	void
SetupExternalDisplayContext	void
SetWindowHandle	void
WriteStringWithinWidth	void

ClearExternalDisplayContext

No description yet.

void ClearExternalDisplayContext();

Returns: nothing (void)

ClearViewRect

No description yet.

void ClearViewRect();

Returns: nothing (void)

DoCircle

No description yet.

void DoCircle(Point argTopLeft, int argDiameter);
void DoCircle(IPoint argTopLeft, int argDiameter);

Parameter	Type	Passing
argTopLeft	Point	value
argDiameter	int	value

Returns: nothing (void)

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

DoEllipse

No description yet.

void DoEllipse(int argX1, int argY1, int argX2, int argY2);

Parameter	Type	Passing
argX1	int	value
argY1	int	value
argX2	int	value
argY2	int	value

Returns: nothing (void)

DoFillRect

No description yet.

void DoFillRect(Rect argRect);
void DoFillRect(IRect argRect);

Parameter	Type	Passing
argRect	Rect	value

Returns: nothing (void)

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

DoLineTo

No description yet.

void DoLineTo(int argX, int argY);

Parameter	Type	Passing
argX	int	value
argY	int	value

Returns: nothing (void)

DoMoveTo

No description yet.

void DoMoveTo(int argX, int argY);

Parameter	Type	Passing
argX	int	value
argY	int	value

Returns: nothing (void)

DoPole

No description yet.

void DoPole(int argX1, int argY1, int argX2, int argY2);

Parameter	Type	Passing
argX1	int	value
argY1	int	value
argX2	int	value
argY2	int	value

Returns: nothing (void)

DoTextOut

No description yet.

void DoTextOut(int argX, int argY, string argString);

Parameter	Type	Passing
argX	int	value
argY	int	value
argString	string	value

Returns: nothing (void)

DoZero

No description yet.

void DoZero(int argX1, int argY1, int argX2, int argY2);

Parameter	Type	Passing
argX1	int	value
argY1	int	value
argX2	int	value
argY2	int	value

Returns: nothing (void)

DrawCursorTab

No description yet.

void DrawCursorTab(int argX, int argY, char argLabelChar);

Parameter	Type	Passing
argX	int	value
argY	int	value
argLabelChar	char	value

Returns: nothing (void)

DrawDesignationSymbol

No description yet.

void DrawDesignationSymbol(int argnX, int argY, int argWaveIndex);

Parameter	Type	Passing
argnX	int	value
argY	int	value
argWaveIndex	int	value

Returns: nothing (void)

DrawHorizontalCursorLine

No description yet.

void DrawHorizontalCursorLine(int argnX1, int argnX2, int argY, int argYMin, int argYMax);

Parameter	Type	Passing
argnX1	int	value
argnX2	int	value
argY	int	value
argYMin	int	value
argYMax	int	value

Returns: nothing (void)

DrawLinearXMinorDivisions

No description yet.

void DrawLinearXMinorDivisions(int argnX, int argTop, int argBottom, int argDivWidth);

Parameter	Type	Passing
argnX	int	value
argTop	int	value
argBottom	int	value
argDivWidth	int	value

Returns: nothing (void)

DrawRect

No description yet.

void DrawRect(Rect argRect, ushort argPenStyle);
void DrawRect(IRect argRect, ushort argPenStyle);

Parameter	Type	Passing
argRect	Rect	value
argPenStyle	ushort	value

Returns: nothing (void)

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

DrawSelectionButton

No description yet.

void DrawSelectionButton(Rect argRect, bool argSelected);
void DrawSelectionButton(IRect argRect, bool argSelected);

Parameter	Type	Passing
argRect	Rect	value
argSelected	bool	value

Returns: nothing (void)

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

DrawVerticalCursorLine

No description yet.

void DrawVerticalCursorLine(int argY1, int argY2, int argnX);

Parameter	Type	Passing
argY1	int	value
argY2	int	value
argnX	int	value

Returns: nothing (void)

DrawWaveScrollArrow

No description yet.

void DrawWaveScrollArrow(Rect argR, TScrollArrowDirection argDir, bool argHiLight);
void DrawWaveScrollArrow(IRect argR, int argDir, bool argHiLight);

Parameter	Type	Passing
argR	Rect	value
argDir	TScrollArrowDirection	value
argHiLight	bool	value

Returns: nothing (void)

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

Export_ToScreen_HighLight

No description yet.

void Export_ToScreen_HighLight(IPrimitive argPrimitive, bool argHide);
void Export_ToScreen_HighLight(object argPrimitive, bool argHide);

Parameter	Type	Passing
argPrimitive	IPrimitive	value
argHide	bool	value

Returns: nothing (void)

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

Export_ToScreen_Paint

No description yet.

void Export_ToScreen_Paint(IPrimitive argPrimitive);
void Export_ToScreen_Paint(object argPrimitive);

Parameter	Type	Passing
argPrimitive	IPrimitive	value

Returns: nothing (void)

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

Export_ToScreen_Update

No description yet.

void Export_ToScreen_Update(IPrimitive argPrimitive, double argNewXPlotValue);
void Export_ToScreen_Update(object argPrimitive, double argNewXPlotValue);

Parameter	Type	Passing
argPrimitive	IPrimitive	value
argNewXPlotValue	double	value

Returns: nothing (void)

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

GetTextHeight

No description yet.

int GetTextHeight(string argString);

Parameter	Type	Passing
argString	string	value

Returns: int

GetTextWidth

No description yet.

int GetTextWidth(string argString);

Parameter	Type	Passing
argString	string	value

Returns: int

SetFontAngle

No description yet.

int SetFontAngle(int argngle_Degrees);

Parameter	Type	Passing
argngle_Degrees	int	value

Returns: int

SetFontColor

No description yet.

int SetFontColor(int argColor);

Parameter	Type	Passing
argColor	int	value

Returns: int

Extension method of IPainterHelper (using SCH;).

SetFontSize

No description yet.

int SetFontSize(int argSize);

Parameter	Type	Passing
argSize	int	value

Returns: int

SetFontStyle

No description yet.

TFontStyleSet SetFontStyle(TFontStyleSet argStyle);

Parameter	Type	Passing
argStyle	TFontStyleSet	value

Returns: TFontStyleSet

Extension method of IPainterHelper (using SCH;).

SetPenMode

No description yet.

TPenMode SetPenMode(TPenMode argMode);

Parameter	Type	Passing
argMode	TPenMode	value

Returns: TPenMode

Extension method of IPainterHelper (using SCH;).

SetPenStyle

No description yet.

ushort SetPenStyle(ushort argStyle);

Parameter	Type	Passing
argStyle	ushort	value

Returns: ushort

SetScaling

No description yet.

void SetScaling();

Returns: nothing (void)

SetupExternalDisplayContext

No description yet.

void SetupExternalDisplayContext(uint argDC);

Parameter	Type	Passing
argDC	uint	value

Returns: nothing (void)

SetWindowHandle

No description yet.

void SetWindowHandle(uint argHandle);

Parameter	Type	Passing
argHandle	uint	value

Returns: nothing (void)

WriteStringWithinWidth

No description yet.

void WriteStringWithinWidth(string argString, int argnX, int argY, int argMaxWidth);

Parameter	Type	Passing
argString	string	value
argnX	int	value
argY	int	value
argMaxWidth	int	value

Returns: nothing (void)

Returned by

IChart.Painter, ISDFGraphicalView.Painter

Accepted by

IChart.GetClipRect