ISupplier interface

No description yet.

public interface ISupplier

Namespace: SCH · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
Enabled	bool	get; set
Hidden	bool	get; set
IsReadOnly	bool	get; set
Options	string	get; set
OrderPosition	int	get; set

Enabled

No description yet.

bool GetState_Enabled();
void SetState_Enabled(bool argValue);

Type: bool · Access: read/write

Hidden

No description yet.

bool GetState_Hidden();
void SetState_Hidden(bool argValue);

Type: bool · Access: read/write

IsReadOnly

No description yet.

bool GetState_IsReadOnly();
void SetState_IsReadOnly(bool argValue);

Type: bool · Access: read/write

Options

No description yet.

string GetState_Options();
void SetState_Options(string argValue);

Type: string · Access: read/write

OrderPosition

No description yet.

int GetState_OrderPosition();
void SetState_OrderPosition(int argValue);

Type: int · Access: read/write

Methods

Method	Returns	Description
BackgroundGetCategoryParameters	void
BackgroundSearchByKeyword	void
BackgroundSearchByManufacturerPartNumber	void
BackgroundSearchBySupplierPartNumber	void
CreateSupplierCart	ISupplierCart
GetCategoryParameters	ISupplierCategoryParameters
GetOptionsPage	IOptionsPage
GetSearchUrl	string
SearchByKeyword	ISupplierSearchResults
SearchByManufacturerPartNumber	ISupplierSearchResults
SearchBySupplierPartNumber	ISupplierSourceRelationship
SourceName	string
SupportedSearchFilters	TSupplierSearchFilterSet

BackgroundGetCategoryParameters

No description yet.

void BackgroundGetCategoryParameters(ISupplierCategory argCategory, uint argHandle);
void BackgroundGetCategoryParameters(object argCategory, uint argHandle);

Parameter	Type	Passing
argCategory	ISupplierCategory	value
argHandle	uint	value

Returns: nothing (void)

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

BackgroundSearchByKeyword

No description yet.

void BackgroundSearchByKeyword(string argKeywords, int argRecordCount, int argStartRecord, TSupplierSearchFilterSet argSearchFilters, ISupplierCategory argCategory, ISupplierParametricFilters argParametricFilters, uint argHandle);
void BackgroundSearchByKeyword(string argKeywords, int argRecordCount, int argStartRecord, ITransportSet argSearchFilters, object argCategory, object argParametricFilters, uint argHandle);

Parameter	Type	Passing
argKeywords	string	value
argRecordCount	int	value
argStartRecord	int	value
argSearchFilters	TSupplierSearchFilterSet	value
argCategory	ISupplierCategory	value
argParametricFilters	ISupplierParametricFilters	value
argHandle	uint	value

Returns: nothing (void)

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

BackgroundSearchByManufacturerPartNumber

No description yet.

void BackgroundSearchByManufacturerPartNumber(string argManufacturerPartNumber, uint argHandle);

Parameter	Type	Passing
argManufacturerPartNumber	string	value
argHandle	uint	value

Returns: nothing (void)

BackgroundSearchBySupplierPartNumber

No description yet.

void BackgroundSearchBySupplierPartNumber(string argSupplierPartNumber, TSkipOptionSet argSkipOptions, uint argHandle);
void BackgroundSearchBySupplierPartNumber(string argSupplierPartNumber, ITransportSet argSkipOptions, uint argHandle);

Parameter	Type	Passing
argSupplierPartNumber	string	value
argSkipOptions	TSkipOptionSet	value
argHandle	uint	value

Returns: nothing (void)

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

CreateSupplierCart

No description yet.

ISupplierCart CreateSupplierCart();

Returns: ISupplierCart

Extension method of ISupplierHelper (using SCH;).

GetCategoryParameters

No description yet.

ISupplierCategoryParameters GetCategoryParameters(ISupplierCategory argCategory);

Parameter	Type	Passing
argCategory	ISupplierCategory	value

Returns: ISupplierCategoryParameters

Extension method of ISupplierHelper (using SCH;).

GetOptionsPage

No description yet.

IOptionsPage GetOptionsPage();

Returns: IOptionsPage

Extension method of ISupplierHelper (using SCH;).

GetSearchUrl

No description yet.

string GetSearchUrl(string argPartNumber);

Parameter	Type	Passing
argPartNumber	string	value

Returns: string

SearchByKeyword

No description yet.

ISupplierSearchResults SearchByKeyword(string argKeywords, int argRecordCount, int argStartRecord, TSupplierSearchFilterSet argSearchFilters, ISupplierCategory argCategory, ISupplierParametricFilters argParametricFilters);

Parameter	Type	Passing
argKeywords	string	value
argRecordCount	int	value
argStartRecord	int	value
argSearchFilters	TSupplierSearchFilterSet	value
argCategory	ISupplierCategory	value
argParametricFilters	ISupplierParametricFilters	value

Returns: ISupplierSearchResults

Extension method of ISupplierHelper (using SCH;).

SearchByManufacturerPartNumber

No description yet.

ISupplierSearchResults SearchByManufacturerPartNumber(string argManufacturerPartNumber);

Parameter	Type	Passing
argManufacturerPartNumber	string	value

Returns: ISupplierSearchResults

Extension method of ISupplierHelper (using SCH;).

SearchBySupplierPartNumber

No description yet.

ISupplierSourceRelationship SearchBySupplierPartNumber(string argSupplierPartNumber, TSkipOptionSet argSkipOptions);

Parameter	Type	Passing
argSupplierPartNumber	string	value
argSkipOptions	TSkipOptionSet	value

Returns: ISupplierSourceRelationship

Extension method of ISupplierHelper (using SCH;).

SourceName

No description yet.

string SourceName();

Returns: string

Examples: Extension_TestCS

SupportedSearchFilters

No description yet.

TSupplierSearchFilterSet SupportedSearchFilters();

Returns: TSupplierSearchFilterSet

Extension method of ISupplierHelper (using SCH;).

Returned by

ISupplierManager.GetSourceByName, ISupplierManager.GetSupplierSource

Examples

Used in the SDK examples: Extension_TestCS.