IWorkspacePreferences interface

The IWorkspacePreferences interface represents the Preferences object in Altium Designer This interface details with file ownership - that is the rights of access to a design document.

public interface IWorkspacePreferences

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Properties

Property	Type	Access	Description
DefaultTemplateFile	string	get; set
FileOwnership_Enabled	bool	get; set
FileOwnership_EnabledOutputDirectory	bool	get; set
FileOwnership_WarningLevelOpen	TFileOwnershipWarningLevel	get; set
FileOwnership_WarningLevelSave	TFileOwnershipWarningLevel	get; set
ReleasesTemporaryFolder	string	get; set
ReleasesTemporaryFolderCleanUp	bool	get; set
TemplateSource	TTemplateSource	get; set
UseLeftRightSelection	bool	get; set

DefaultTemplateFile

No description yet.

string GetDefaultTemplateFile(string argDocKind);
void SetDefaultTemplateFile(string argDocKind, string argFileName);

Type: string · Access: read/write · Index: argDocKind (string)

FileOwnership_Enabled

No description yet.

bool GetFileOwnership_Enabled();
void SetFileOwnership_Enabled(bool argValue);

Type: bool · Access: read/write

FileOwnership_EnabledOutputDirectory

No description yet.

bool GetFileOwnership_EnabledOutputDirectory();
void SetFileOwnership_EnabledOutputDirectory(bool argValue);

Type: bool · Access: read/write

FileOwnership_WarningLevelOpen

No description yet.

TFileOwnershipWarningLevel GetFileOwnership_WarningLevelOpen();
void SetFileOwnership_WarningLevelOpen(TFileOwnershipWarningLevel argValue);

Type: TFileOwnershipWarningLevel · Access: read/write

The accessors are extension methods of IWorkspacePreferencesHelper (using EDP;).

FileOwnership_WarningLevelSave

No description yet.

TFileOwnershipWarningLevel GetFileOwnership_WarningLevelSave();
void SetFileOwnership_WarningLevelSave(TFileOwnershipWarningLevel argValue);

Type: TFileOwnershipWarningLevel · Access: read/write

The accessors are extension methods of IWorkspacePreferencesHelper (using EDP;).

ReleasesTemporaryFolder

No description yet.

string GetReleasesTemporaryFolder();
void SetReleasesTemporaryFolder(string argValue);

Type: string · Access: read/write

ReleasesTemporaryFolderCleanUp

No description yet.

bool GetReleasesTemporaryFolderCleanUp();
void SetReleasesTemporaryFolderCleanUp(bool argValue);

Type: bool · Access: read/write

TemplateSource

No description yet.

TTemplateSource GetTemplateSource();
void SetTemplateSource(TTemplateSource argValue);

Type: TTemplateSource · Access: read/write

The accessors are extension methods of IWorkspacePreferencesHelper (using EDP;).

UseLeftRightSelection

No description yet.

bool GetUseLeftRightSelection();
void SetUseLeftRightSelection(bool argValue);

Type: bool · Access: read/write

Methods

Method	Returns	Description
GetCrossSelectZoomOption	TCrossSelectZoomOption
GetDefaultDocumentPath	string
GetDefaultLibraryPath	string
GetDefaultTemplateFile_NotExpanded	string
GetHighlightConnectedPowerParts	bool
GetHighlightMethodSet	THighlightMethodSet
GetObjectsToDisplay	TWorkspaceObjectIdSet
GetTemplatePath_Sch	string
GetVariantOption	IVariantOption

GetCrossSelectZoomOption

No description yet.

TCrossSelectZoomOption GetCrossSelectZoomOption();

Returns: TCrossSelectZoomOption

Extension method of IWorkspacePreferencesHelper (using EDP;).

GetDefaultDocumentPath

No description yet.

string GetDefaultDocumentPath();

Returns: string

GetDefaultLibraryPath

No description yet.

string GetDefaultLibraryPath();

Returns: string

GetDefaultTemplateFile_NotExpanded

No description yet.

string GetDefaultTemplateFile_NotExpanded(string argDocKind);

Parameter	Type	Passing
argDocKind	string	value

Returns: string

GetHighlightConnectedPowerParts

No description yet.

bool GetHighlightConnectedPowerParts();

Returns: bool

GetHighlightMethodSet

No description yet.

THighlightMethodSet GetHighlightMethodSet();

Returns: THighlightMethodSet

Extension method of IWorkspacePreferencesHelper (using EDP;).

GetObjectsToDisplay

No description yet.

TWorkspaceObjectIdSet GetObjectsToDisplay();

Returns: TWorkspaceObjectIdSet

Extension method of IWorkspacePreferencesHelper (using EDP;).

GetTemplatePath_Sch

No description yet.

string GetTemplatePath_Sch();

Returns: string

GetVariantOption

No description yet.

IVariantOption GetVariantOption();

Returns: IVariantOption

Extension method of IWorkspacePreferencesHelper (using EDP;).

Examples: Extension_VariantOptions

Returned by

IWorkspace.DM_Preferences

Examples

Used in the SDK examples: Extension_VariantOptions.