IDatabaseLibDocument interface

The IDatabaseLibDocument interface represents a database library document.

public interface IDatabaseLibDocument

Namespace: EDP · Assembly: Altium.SDK.Interfaces

Derived: ISVNDatabaseLibDocument

Properties

Property	Type	Access	Description
ConnectionString	string	get; set

ConnectionString

No description yet.

string GetConnectionString();
void SetConnectionString(string argConnectionString);

Type: string · Access: read/write

Methods

Method	Returns	Description
ClearDatabaseTypeFields	void
CreateTableInDatabase	void
DisposeIfNotShowing	void
ExportNewRecordFromIntLib	string
FinaliseExportFromDatabase	void
GetAllComponentKeys	void
GetCommandString	string
GetDatafilePath	string
GetFieldCount	int
GetFieldNameAt	string
GetFileName	string
GetFilterText	string
GetItemCount	int
GetKeyField	string
GetKeyFieldCount	int
GetLibraryPathFieldName	string
GetLibraryRefFieldName	string
GetLibrarySearchPath	string
GetModelFieldNamesAt	void
GetOrcadLibraryDetails	void
GetParameterNameAt	string
GetParametersForComponent	string
GetSchLibPathForComponent	string
GetSchLibRefForComponent	string
GetSearchSubDirectories	bool
GetTableCount	int
GetTableIndex	int
GetTableNameAt	string
InitialiseExportFromIntLib	string
InitialiseExportToDatabase	void
IsParameterDatabaseKey	bool
IsValidSQLStatementForTable	bool
LoadAllRecordsLimit	int
OrcadDelimiter	char
TableContainsColumn	bool
TableEnabled	bool
ValidateSQLQuery	string

ClearDatabaseTypeFields

No description yet.

void ClearDatabaseTypeFields();

Returns: nothing (void)

CreateTableInDatabase

No description yet.

void CreateTableInDatabase(string argTableName, string argPrimaryKeyColumnName);

Parameter	Type	Passing
argTableName	string	value
argPrimaryKeyColumnName	string	value

Returns: nothing (void)

DisposeIfNotShowing

No description yet.

void DisposeIfNotShowing();

Returns: nothing (void)

ExportNewRecordFromIntLib

No description yet.

string ExportNewRecordFromIntLib(string argTableName, string argFieldParameters);

Parameter	Type	Passing
argTableName	string	value
argFieldParameters	string	value

Returns: string

FinaliseExportFromDatabase

No description yet.

void FinaliseExportFromDatabase();

Returns: nothing (void)

GetAllComponentKeys

No description yet.

void GetAllComponentKeys(int argTableIndex, IStrings argResults);
void GetAllComponentKeys(int argTableIndex, object argResults);

Parameter	Type	Passing
argTableIndex	int	value
argResults	IStrings	value

Returns: nothing (void)

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

GetCommandString

No description yet.

string GetCommandString(int argTableIndex, string argFilterText, string argSQLWhereClause);

Parameter	Type	Passing
argTableIndex	int	value
argFilterText	string	value
argSQLWhereClause	string	value

Returns: string

GetDatafilePath

No description yet.

string GetDatafilePath(string argName, string argType, string argTableName, string argComponentKeys);

Parameter	Type	Passing
argName	string	value
argType	string	value
argTableName	string	value
argComponentKeys	string	value

Returns: string

GetFieldCount

No description yet.

int GetFieldCount(int argTableIndex);

Parameter	Type	Passing
argTableIndex	int	value

Returns: int

GetFieldNameAt

No description yet.

string GetFieldNameAt(int argTableIndex, int argFieldIndex);

Parameter	Type	Passing
argTableIndex	int	value
argFieldIndex	int	value

Returns: string

GetFileName

No description yet.

string GetFileName();

Returns: string

GetFilterText

No description yet.

string GetFilterText(int argTableIndex, string argFilterColumnNames, string argFilterValue);

Parameter	Type	Passing
argTableIndex	int	value
argFilterColumnNames	string	value
argFilterValue	string	value

Returns: string

GetItemCount

No description yet.

int GetItemCount(string argCommand, ref string argnError);

Parameter	Type	Passing
argCommand	string	value
argnError	string	ref

Returns: int

GetKeyField

No description yet.

string GetKeyField(bool argParameterName, int argTableIndex, int argKeyIndex);

Parameter	Type	Passing
argParameterName	bool	value
argTableIndex	int	value
argKeyIndex	int	value

Returns: string

GetKeyFieldCount

No description yet.

int GetKeyFieldCount(int argTableIndex);

Parameter	Type	Passing
argTableIndex	int	value

Returns: int

GetLibraryPathFieldName

No description yet.

string GetLibraryPathFieldName(int argTableIndex);

Parameter	Type	Passing
argTableIndex	int	value

Returns: string

GetLibraryRefFieldName

No description yet.

string GetLibraryRefFieldName(int argTableIndex, ref bool argOrcadLibrary);

Parameter	Type	Passing
argTableIndex	int	value
argOrcadLibrary	bool	ref

Returns: string

GetLibrarySearchPath

No description yet.

string GetLibrarySearchPath();

Returns: string

GetModelFieldNamesAt

No description yet.

void GetModelFieldNamesAt(int argnIndex, int argTableIndex, string argModelType, ref string argModelPathName, ref string argModelRefName, ref bool argOrcadModel);

Parameter	Type	Passing
argnIndex	int	value
argTableIndex	int	value
argModelType	string	value
argModelPathName	string	ref
argModelRefName	string	ref
argOrcadModel	bool	ref

Returns: nothing (void)

GetOrcadLibraryDetails

No description yet.

void GetOrcadLibraryDetails(string argParseString, ref string argLibRef, ref string argLibPath);

Parameter	Type	Passing
argParseString	string	value
argLibRef	string	ref
argLibPath	string	ref

Returns: nothing (void)

GetParameterNameAt

No description yet.

string GetParameterNameAt(int argTableIndex, int argFieldIndex);

Parameter	Type	Passing
argTableIndex	int	value
argFieldIndex	int	value

Returns: string

GetParametersForComponent

No description yet.

string GetParametersForComponent(int argTableIndex, string argComponentKeys);

Parameter	Type	Passing
argTableIndex	int	value
argComponentKeys	string	value

Returns: string

GetSchLibPathForComponent

No description yet.

string GetSchLibPathForComponent(int argTableIndex, string argComponentKeys);

Parameter	Type	Passing
argTableIndex	int	value
argComponentKeys	string	value

Returns: string

GetSchLibRefForComponent

No description yet.

string GetSchLibRefForComponent(int argTableIndex, string argComponentKeys);

Parameter	Type	Passing
argTableIndex	int	value
argComponentKeys	string	value

Returns: string

GetSearchSubDirectories

No description yet.

bool GetSearchSubDirectories();

Returns: bool

GetTableCount

No description yet.

int GetTableCount();

Returns: int

GetTableIndex

No description yet.

int GetTableIndex(string argTableName);

Parameter	Type	Passing
argTableName	string	value

Returns: int

GetTableNameAt

No description yet.

string GetTableNameAt(int argnIndex);

Parameter	Type	Passing
argnIndex	int	value

Returns: string

InitialiseExportFromIntLib

No description yet.

string InitialiseExportFromIntLib(string argTableName);

Parameter	Type	Passing
argTableName	string	value

Returns: string

InitialiseExportToDatabase

No description yet.

void InitialiseExportToDatabase(string argDatabaseFileName);

Parameter	Type	Passing
argDatabaseFileName	string	value

Returns: nothing (void)

IsParameterDatabaseKey

No description yet.

bool IsParameterDatabaseKey(int argTableIndex, string argParameterName);

Parameter	Type	Passing
argTableIndex	int	value
argParameterName	string	value

Returns: bool

IsValidSQLStatementForTable

No description yet.

bool IsValidSQLStatementForTable(string argTableName, string argQuery);

Parameter	Type	Passing
argTableName	string	value
argQuery	string	value

Returns: bool

LoadAllRecordsLimit

No description yet.

int LoadAllRecordsLimit();

Returns: int

OrcadDelimiter

No description yet.

char OrcadDelimiter();

Returns: char

TableContainsColumn

No description yet.

bool TableContainsColumn(int argTableIndex, string argColumnName);

Parameter	Type	Passing
argTableIndex	int	value
argColumnName	string	value

Returns: bool

TableEnabled

No description yet.

bool TableEnabled(int argnIndex);

Parameter	Type	Passing
argnIndex	int	value

Returns: bool

ValidateSQLQuery

No description yet.

string ValidateSQLQuery(string argSqlQuery);

Parameter	Type	Passing
argSqlQuery	string	value

Returns: string

Returned by

IIntegratedLibraryManager.GetAvailableDBLibDocAtPath

Accepted by

IIntegratedLibraryManager.ExtractSourcesToDatabaseLib