Skip to main content
View as Markdown

ComponentLink class

No description yet.

public class ComponentLink

Namespace: DXP · Assembly: Altium.SDK

Fields​

NameTypeValue
InvalidIndexint0
ComponentLinkPrefixstring"ComponentLink"
DescriptionSuffixstring"Description"
UrlSuffixstring"URL"

Methods​

MethodReturnsDescription
BuildParameterNamestring
DescriptionParameterNamestring
IsComponentLinkbool
IsDescriptionbool
IsUrlbool
UrlParameterNamestring

BuildParameterName​

No description yet.

static string BuildParameterName(int index, string suffix);
ParameterTypePassing
indexintvalue
suffixstringvalue

Returns: string

DescriptionParameterName​

No description yet.

static string DescriptionParameterName(int index);
ParameterTypePassing
indexintvalue

Returns: string

No description yet.

static bool IsComponentLink(string parameterName);
static bool IsComponentLink(string parameterName, out int index);

Overload 1: static bool IsComponentLink(string parameterName)

ParameterTypePassing
parameterNamestringvalue

Returns bool.

Overload 2: static bool IsComponentLink(string parameterName, out int index)

ParameterTypePassing
parameterNamestringvalue
indexintout

Returns bool.

IsDescription​

No description yet.

static bool IsDescription(string parameterName);
static bool IsDescription(string parameterName, out int index);

Overload 1: static bool IsDescription(string parameterName)

ParameterTypePassing
parameterNamestringvalue

Returns bool.

Overload 2: static bool IsDescription(string parameterName, out int index)

ParameterTypePassing
parameterNamestringvalue
indexintout

Returns bool.

IsUrl​

No description yet.

static bool IsUrl(string parameterName);
static bool IsUrl(string parameterName, out int index);

Overload 1: static bool IsUrl(string parameterName)

ParameterTypePassing
parameterNamestringvalue

Returns bool.

Overload 2: static bool IsUrl(string parameterName, out int index)

ParameterTypePassing
parameterNamestringvalue
indexintout

Returns bool.

UrlParameterName​

No description yet.

static string UrlParameterName(int index);
ParameterTypePassing
indexintvalue

Returns: string