IOutputGenerator interface

No description yet.

public interface IOutputGenerator

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
AddToProject	bool	get; set
CurrentOutputjobFileFullPath	string	get; set
DocumentPath	string	get; set
ExplicitTargetFileName	string	get; set
OpenOutputs	bool	get; set
TargetPrefix	string	get; set

AddToProject

No description yet.

bool GetAddToProject();
void SetAddToProject(bool argAddToProject);

Type: bool · Access: read/write

CurrentOutputjobFileFullPath

No description yet.

string GetCurrentOutputjobFileFullPath();
void SetCurrentOutputjobFileFullPath(string argFullPath);

Type: string · Access: read/write

DocumentPath

No description yet.

string GetDocumentPath();
void SetDocumentPath(string argDocumentPath);

Type: string · Access: read/write

ExplicitTargetFileName

No description yet.

string GetExplicitTargetFileName();
void SetExplicitTargetFileName(string argExplicitTargetFileName);

Type: string · Access: read/write

OpenOutputs

No description yet.

bool GetOpenOutputs();
void SetOpenOutputs(bool argOpenOutputs);

Type: bool · Access: read/write

TargetPrefix

No description yet.

string GetTargetPrefix();
void SetTargetPrefix(string argTargetPrefix);

Type: string · Access: read/write

Methods

Method	Returns	Description
AddParameter	void
ClearParameters	void
CreateAndLoadPCB	void
GeneratePageSet	int
GetBoardHandle	UIntPtr
GetName	string
GetPageHandle	UIntPtr
GetPageInterface	IGeneratedPage
GetParameterCount	int
GetParameterValue	string
GetProject	IProject
Initialize	void
Notify_BeginGeneratingOutputFile	void
Notify_BeginPrintingDocument	void
Notify_FinishGeneratingOutputFile	void
Notify_FinishPrintingDocument	void
ParameterTransferBegin	void
ParameterTransferEnd	void
PredictOutputFileNames	void
RunGenerator	bool
RunPreferencesForm	bool
RunPropertiesForm	bool
RunWizard	TDialogResult
SetGenerateCallbacks	void
SetOutputMediumType	void
SetOutputPath	void
SetPageOptionsToDefault	void

AddParameter

No description yet.

void AddParameter(string argValue);

Parameter	Type	Passing
argValue	string	value

Returns: nothing (void)

ClearParameters

No description yet.

void ClearParameters();

Returns: nothing (void)

CreateAndLoadPCB

No description yet.

void CreateAndLoadPCB();

Returns: nothing (void)

GeneratePageSet

No description yet.

int GeneratePageSet(InputValues argInputValues, PageOptionsRecord argPageOptions, PrinterOptionsRecord argPrinterOptions, uint argOutputValues, IPublisher argPublisher);
int GeneratePageSet(IInputValues argInputValues, IPageOptionsRecord argPageOptions, IPrinterOptionsRecord argPrinterOptions, uint argOutputValues, object argPublisher);

Parameter	Type	Passing
argInputValues	InputValues	value
argPageOptions	PageOptionsRecord	value
argPrinterOptions	PrinterOptionsRecord	value
argOutputValues	uint	value
argPublisher	IPublisher	value

Returns: int

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

GetBoardHandle

No description yet.

UIntPtr GetBoardHandle();

Returns: UIntPtr

Extension method of IOutputGeneratorHelper (using EDP;).

GetName

No description yet.

string GetName();

Returns: string

GetPageHandle

No description yet.

UIntPtr GetPageHandle(int argPageIndex);

Parameter	Type	Passing
argPageIndex	int	value

Returns: UIntPtr

Extension method of IOutputGeneratorHelper (using EDP;).

GetPageInterface

No description yet.

IGeneratedPage GetPageInterface(int argPageIndex);

Parameter	Type	Passing
argPageIndex	int	value

Returns: IGeneratedPage

Extension method of IOutputGeneratorHelper (using EDP;).

GetParameterCount

No description yet.

int GetParameterCount();

Returns: int

GetParameterValue

No description yet.

string GetParameterValue(int argIndex);

Parameter	Type	Passing
argIndex	int	value

Returns: string

GetProject

No description yet.

IProject GetProject();

Returns: IProject

Extension method of IOutputGeneratorHelper (using EDP;).

Initialize

No description yet.

void Initialize(UIntPtr argddress, UIntPtr argCallBackHandle, IProject argProject, string argPredefinedOutput, string argDocumentPath);
void Initialize(object argddress, object argCallBackHandle, object argProject, string argPredefinedOutput, string argDocumentPath);

Parameter	Type	Passing
argddress	UIntPtr	value
argCallBackHandle	UIntPtr	value
argProject	IProject	value
argPredefinedOutput	string	value
argDocumentPath	string	value

Returns: nothing (void)

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

Notify_BeginGeneratingOutputFile

No description yet.

void Notify_BeginGeneratingOutputFile(string argGeneratedFileName);

Parameter	Type	Passing
argGeneratedFileName	string	value

Returns: nothing (void)

Notify_BeginPrintingDocument

No description yet.

void Notify_BeginPrintingDocument(string argGeneratedFileName);

Parameter	Type	Passing
argGeneratedFileName	string	value

Returns: nothing (void)

Notify_FinishGeneratingOutputFile

No description yet.

void Notify_FinishGeneratingOutputFile(string argGeneratedFileName);

Parameter	Type	Passing
argGeneratedFileName	string	value

Returns: nothing (void)

Notify_FinishPrintingDocument

No description yet.

void Notify_FinishPrintingDocument(string argGeneratedFileName);

Parameter	Type	Passing
argGeneratedFileName	string	value

Returns: nothing (void)

ParameterTransferBegin

No description yet.

void ParameterTransferBegin();

Returns: nothing (void)

ParameterTransferEnd

No description yet.

void ParameterTransferEnd();

Returns: nothing (void)

PredictOutputFileNames

No description yet.

void PredictOutputFileNames(IStrings argFiles);
void PredictOutputFileNames(object argFiles);

Parameter	Type	Passing
argFiles	IStrings	value

Returns: nothing (void)

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

RunGenerator

No description yet.

bool RunGenerator();

Returns: bool

RunPreferencesForm

No description yet.

bool RunPreferencesForm();

Returns: bool

RunPropertiesForm

No description yet.

bool RunPropertiesForm();

Returns: bool

RunWizard

No description yet.

TDialogResult RunWizard(int argX, int argY);

Parameter	Type	Passing
argX	int	value
argY	int	value

Returns: TDialogResult

Extension method of IOutputGeneratorHelper (using EDP;).

SetGenerateCallbacks

No description yet.

void SetGenerateCallbacks(UIntPtr argnAllowProc, UIntPtr argCheckCancelFn);
void SetGenerateCallbacks(object argnAllowProc, object argCheckCancelFn);

Parameter	Type	Passing
argnAllowProc	UIntPtr	value
argCheckCancelFn	UIntPtr	value

Returns: nothing (void)

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

SetOutputMediumType

No description yet.

void SetOutputMediumType(string argOutputMediumType);

Parameter	Type	Passing
argOutputMediumType	string	value

Returns: nothing (void)

SetOutputPath

No description yet.

void SetOutputPath(string argTargetFolder);

Parameter	Type	Passing
argTargetFolder	string	value

Returns: nothing (void)

SetPageOptionsToDefault

No description yet.

void SetPageOptionsToDefault(ref PageOptionsRecord argPageOptions);
void SetPageOptionsToDefault(ref IPageOptionsRecord argPageOptions);

Parameter	Type	Passing
argPageOptions	PageOptionsRecord	ref

Returns: nothing (void)

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

Accepted by

IOutputGeneratorUtils.SaveGeneratedPages