Skip to main content
View as Markdown

IEDMS_CommentsServicePreferences interface

No description yet.

public interface IEDMS_CommentsServicePreferences

Namespace: DXP · Assembly: Altium.SDK.Interfaces

Methods​

MethodReturnsDescription
Export_ToInivoid
Import_FromInivoid
PCBCommentThreadMaskAreaDetailsvoid
PCBCommentThreadReferenceDetailsvoid
PCBCommentThreadTextColorint
PCBShowCommentThreadsbool
SchCommentThreadColorSetCountint
SchCommentThreadColorSetDetailsbool
SchCommentThreadFontDetailsvoid
SchCommentThreadReferenceDetailsvoid
SchCommentThreadTextAlignmentTAlignment
SchCommentThreadTextColorint
SchCommentThreadTextMarginint
SchShowCommentThreadsbool
SetPCBShowCommentThreadsvoid
SetSchShowCommentThreadsvoid

Export_ToIni​

No description yet.

void Export_ToIni();

Returns: nothing (void)

Import_FromIni​

No description yet.

void Import_FromIni();

Returns: nothing (void)

PCBCommentThreadMaskAreaDetails​

No description yet.

void PCBCommentThreadMaskAreaDetails(out int argAreaColor, out float argAreaAlpha);
ParameterTypePassing
argAreaColorintout
argAreaAlphafloatout

Returns: nothing (void)

PCBCommentThreadReferenceDetails​

No description yet.

void PCBCommentThreadReferenceDetails(out int argLineColor, out int argLineWidth);
ParameterTypePassing
argLineColorintout
argLineWidthintout

Returns: nothing (void)

PCBCommentThreadTextColor​

No description yet.

int PCBCommentThreadTextColor();

Returns: int

Extension method of IEDMS_CommentsServicePreferencesHelper (using DXP;).

PCBShowCommentThreads​

No description yet.

bool PCBShowCommentThreads();

Returns: bool

SchCommentThreadColorSetCount​

No description yet.

int SchCommentThreadColorSetCount();

Returns: int

SchCommentThreadColorSetDetails​

No description yet.

bool SchCommentThreadColorSetDetails(int argIndex, out int argColor, out int argColorGradient1, out int argColorGradient2);
ParameterTypePassing
argIndexintvalue
argColorintout
argColorGradient1intout
argColorGradient2intout

Returns: bool

SchCommentThreadFontDetails​

No description yet.

void SchCommentThreadFontDetails(out string argFontName, out int argSize, out TFontStyleSet argStyle);
void SchCommentThreadFontDetails(out string argFontName, out int argSize, out ITransportSet argStyle);
ParameterTypePassing
argFontNamestringout
argSizeintout
argStyleTFontStyleSetout

Returns: nothing (void)

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

SchCommentThreadReferenceDetails​

No description yet.

void SchCommentThreadReferenceDetails(out int argLineColor, out int argLineWidth, out TPenStyle argLineStyle);
void SchCommentThreadReferenceDetails(out int argLineColor, out int argLineWidth, out int argLineStyle);
ParameterTypePassing
argLineColorintout
argLineWidthintout
argLineStyleTPenStyleout

Returns: nothing (void)

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

SchCommentThreadTextAlignment​

No description yet.

TAlignment SchCommentThreadTextAlignment();

Returns: TAlignment

Extension method of IEDMS_CommentsServicePreferencesHelper (using DXP;).

SchCommentThreadTextColor​

No description yet.

int SchCommentThreadTextColor();

Returns: int

Extension method of IEDMS_CommentsServicePreferencesHelper (using DXP;).

SchCommentThreadTextMargin​

No description yet.

int SchCommentThreadTextMargin();

Returns: int

SchShowCommentThreads​

No description yet.

bool SchShowCommentThreads();

Returns: bool

SetPCBShowCommentThreads​

No description yet.

void SetPCBShowCommentThreads(bool argValue);
ParameterTypePassing
argValueboolvalue

Returns: nothing (void)

SetSchShowCommentThreads​

No description yet.

void SetSchShowCommentThreads(bool argValue);
ParameterTypePassing
argValueboolvalue

Returns: nothing (void)

Returned by​

IEDMS_CommentsService.Preferences