# ISupplier interface

*No description yet.*

```csharp
public interface ISupplier
```

**Namespace:** SCH · **Assembly:** Altium.SDK.Interfaces

## Properties

| Property | Type | Access | Description |
| --- | --- | --- | --- |
| [Enabled](#enabled) | `bool` | get; set |  |
| [Hidden](#hidden) | `bool` | get; set |  |
| [IsReadOnly](#isreadonly) | `bool` | get; set |  |
| [Options](#options) | `string` | get; set |  |
| [OrderPosition](#orderposition) | `int` | get; set |  |

### Enabled

*No description yet.*

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

**Type:** `bool` · **Access:** read/write

### Hidden

*No description yet.*

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

**Type:** `bool` · **Access:** read/write

### IsReadOnly

*No description yet.*

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

**Type:** `bool` · **Access:** read/write

### Options

*No description yet.*

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

**Type:** `string` · **Access:** read/write

### OrderPosition

*No description yet.*

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

**Type:** `int` · **Access:** read/write

## Methods

| Method | Returns | Description |
| --- | --- | --- |
| [BackgroundGetCategoryParameters](#backgroundgetcategoryparameters) | `void` |  |
| [BackgroundSearchByKeyword](#backgroundsearchbykeyword) | `void` |  |
| [BackgroundSearchByManufacturerPartNumber](#backgroundsearchbymanufacturerpartnumber) | `void` |  |
| [BackgroundSearchBySupplierPartNumber](#backgroundsearchbysupplierpartnumber) | `void` |  |
| [CreateSupplierCart](#createsuppliercart) | [ISupplierCart](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCart.md) |  |
| [GetCategoryParameters](#getcategoryparameters) | [ISupplierCategoryParameters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCategoryParameters.md) |  |
| [GetOptionsPage](#getoptionspage) | [IOptionsPage](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsPage.md) |  |
| [GetSearchUrl](#getsearchurl) | `string` |  |
| [SearchByKeyword](#searchbykeyword) | [ISupplierSearchResults](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierSearchResults.md) |  |
| [SearchByManufacturerPartNumber](#searchbymanufacturerpartnumber) | [ISupplierSearchResults](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierSearchResults.md) |  |
| [SearchBySupplierPartNumber](#searchbysupplierpartnumber) | [ISupplierSourceRelationship](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierSourceRelationship.md) |  |
| [SourceName](#sourcename) | `string` |  |
| [SupportedSearchFilters](#supportedsearchfilters) | [TSupplierSearchFilterSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSupplierSearchFilterSet.md) |  |

### BackgroundGetCategoryParameters

*No description yet.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCategory` | [ISupplierCategory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCategory.md) | 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.*

```csharp
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](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSupplierSearchFilterSet.md) | value |
| `argCategory` | [ISupplierCategory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCategory.md) | value |
| `argParametricFilters` | [ISupplierParametricFilters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierParametricFilters.md) | 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.*

```csharp
void BackgroundSearchByManufacturerPartNumber(string argManufacturerPartNumber, uint argHandle);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManufacturerPartNumber` | `string` | value |
| `argHandle` | `uint` | value |

**Returns:** nothing (`void`)

### BackgroundSearchBySupplierPartNumber

*No description yet.*

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

| Parameter | Type | Passing |
| --- | --- | --- |
| `argSupplierPartNumber` | `string` | value |
| `argSkipOptions` | [TSkipOptionSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSkipOptionSet.md) | 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.*

```csharp
ISupplierCart CreateSupplierCart();
```

**Returns:** [ISupplierCart](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCart.md)

Extension method of `ISupplierHelper` (`using SCH;`).

### GetCategoryParameters

*No description yet.*

```csharp
ISupplierCategoryParameters GetCategoryParameters(ISupplierCategory argCategory);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argCategory` | [ISupplierCategory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCategory.md) | value |

**Returns:** [ISupplierCategoryParameters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCategoryParameters.md)

Extension method of `ISupplierHelper` (`using SCH;`).

### GetOptionsPage

*No description yet.*

```csharp
IOptionsPage GetOptionsPage();
```

**Returns:** [IOptionsPage](https://altiumdeveloper.github.io/ad-sdk-docs/reference/dxp/IOptionsPage.md)

Extension method of `ISupplierHelper` (`using SCH;`).

### GetSearchUrl

*No description yet.*

```csharp
string GetSearchUrl(string argPartNumber);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argPartNumber` | `string` | value |

**Returns:** `string`

### SearchByKeyword

*No description yet.*

```csharp
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](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSupplierSearchFilterSet.md) | value |
| `argCategory` | [ISupplierCategory](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierCategory.md) | value |
| `argParametricFilters` | [ISupplierParametricFilters](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierParametricFilters.md) | value |

**Returns:** [ISupplierSearchResults](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierSearchResults.md)

Extension method of `ISupplierHelper` (`using SCH;`).

### SearchByManufacturerPartNumber

*No description yet.*

```csharp
ISupplierSearchResults SearchByManufacturerPartNumber(string argManufacturerPartNumber);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argManufacturerPartNumber` | `string` | value |

**Returns:** [ISupplierSearchResults](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierSearchResults.md)

Extension method of `ISupplierHelper` (`using SCH;`).

### SearchBySupplierPartNumber

*No description yet.*

```csharp
ISupplierSourceRelationship SearchBySupplierPartNumber(string argSupplierPartNumber, TSkipOptionSet argSkipOptions);
```

| Parameter | Type | Passing |
| --- | --- | --- |
| `argSupplierPartNumber` | `string` | value |
| `argSkipOptions` | [TSkipOptionSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSkipOptionSet.md) | value |

**Returns:** [ISupplierSourceRelationship](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierSourceRelationship.md)

Extension method of `ISupplierHelper` (`using SCH;`).

### SourceName

*No description yet.*

```csharp
string SourceName();
```

**Returns:** `string`

**Examples:** [Extension_TestCS](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_TestCS/Source%20Code/Commands.cs#L40)

### SupportedSearchFilters

*No description yet.*

```csharp
TSupplierSearchFilterSet SupportedSearchFilters();
```

**Returns:** [TSupplierSearchFilterSet](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/TSupplierSearchFilterSet.md)

Extension method of `ISupplierHelper` (`using SCH;`).

## Returned by

[ISupplierManager.GetSourceByName](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierManager.md#getsourcebyname), [ISupplierManager.GetSupplierSource](https://altiumdeveloper.github.io/ad-sdk-docs/reference/sch/ISupplierManager.md#getsuppliersource)

## Examples

Used in the SDK examples: [Extension_TestCS](https://github.com/AltiumDeveloper/ad-sdk-examples/blob/5b144f54740a53ec578b3b6c3f902b831e0b1144/Extension_TestCS/Source%20Code/Commands.cs#L39).