IWSM_OutputJobDocument interface
The IWSM_OutputJobDocument interface represents the output jobs document in Altium Designer.
public interface IWSM_OutputJobDocument
Namespace: EDP · Assembly: Altium.SDK.Interfaces
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| MediumOutputer | IOutputer | get | |
| MediumOutputersCount | int | get | |
| Outputer | IOutputer | get | |
| OutputerCount | int | get | |
| OutputMedium | IOutputMedium | get | |
| OutputMediumCount | int | get | |
| VariantName | string | get; set | |
| VariantScope | TOutputJobVariantScope | get; set |
MediumOutputer
No description yet.
IOutputer GetState_MediumOutputer(IOutputMedium argOutputMedium, int argi);
Type: IOutputer · Access: read-only · Index: argOutputMedium (IOutputMedium), argi (int)
The accessors are extension methods of IWSM_OutputJobDocumentHelper (using EDP;).
MediumOutputersCount
No description yet.
int GetState_MediumOutputersCount(IOutputMedium argOutputMedium);
Type: int · Access: read-only · Index: argOutputMedium (IOutputMedium)
The accessors are extension methods of IWSM_OutputJobDocumentHelper (using EDP;).
Outputer
No description yet.
IOutputer GetState_Outputer(int argIndex);
Type: IOutputer · Access: read-only · Index: argIndex (int)
The accessors are extension methods of IWSM_OutputJobDocumentHelper (using EDP;).
Examples: Extension_ChangeOutputJobFile, Extension_GenerateGerber
OutputerCount
No description yet.
int GetState_OutputerCount();
Type: int · Access: read-only
Examples: Extension_ChangeOutputJobFile, Extension_GenerateGerber
OutputMedium
No description yet.
IOutputMedium GetState_OutputMedium(int argIndex);
Type: IOutputMedium · Access: read-only · Index: argIndex (int)
The accessors are extension methods of IWSM_OutputJobDocumentHelper (using EDP;).
OutputMediumCount
No description yet.
int GetState_OutputMediumCount();
Type: int · Access: read-only
VariantName
No description yet.
string GetState_VariantName();
void SetState_VariantName(string argName);
Type: string · Access: read/write
Examples: Extension_GenerateGerber
VariantScope
No description yet.
TOutputJobVariantScope GetState_VariantScope();
void SetState_VariantScope(TOutputJobVariantScope argValue);
Type: TOutputJobVariantScope · Access: read/write
The accessors are extension methods of IWSM_OutputJobDocumentHelper (using EDP;).
Methods
| Method | Returns | Description |
|---|---|---|
| BeginModifyOutputer | bool | |
| CreateOutputer | IOutputer | |
| EndModifyOutputer | void |
BeginModifyOutputer
No description yet.
bool BeginModifyOutputer(IOutputer argOutputer);
bool BeginModifyOutputer(object argOutputer);
| Parameter | Type | Passing |
|---|---|---|
argOutputer | IOutputer | value |
Returns: bool
The first overload is an extension method of IWSM_OutputJobDocumentHelper (using EDP;) with typed parameters; the second is declared by the interface.
CreateOutputer
No description yet.
IOutputer CreateOutputer(string argOutputCategoryName, string argPredefinedOutputName, string argOutputerName);
| Parameter | Type | Passing |
|---|---|---|
argOutputCategoryName | string | value |
argPredefinedOutputName | string | value |
argOutputerName | string | value |
Returns: IOutputer
Extension method of IWSM_OutputJobDocumentHelper (using EDP;).
EndModifyOutputer
No description yet.
void EndModifyOutputer();
Returns: nothing (void)
Returned by
IWorkspace.DM_GetOutputJobDocumentByPath
Examples
Used in the SDK examples: Extension_ChangeOutputJobFile, Extension_GenerateGerber.