.NET Framework Class Library
Database Members

<< Click to Display Table of Contents >>

Navigation:  Programming Mechworks PDM > .NET API > MwPDMApi Namespace > Database Class >

.NET Framework Class Library
Database Members

The Database type exposes the following members.

Methods

 

Name

Description

Public method

AddToParent

Adds a child relationship between a parent document and a child document. The child index value is meaningful for the ordering in the bill of materials of the parent, and may be omitted ( in which case a 0 value will be used as default )

Public method

ComposedOf

Returns component documents of a specified one.

Public method

DeleteParentChild

Deletes only the parent-child relationships of the document with the assigned unique identifier.

Public method

Equals

(Inherited from Object.)

Public method

ExecSQL

Executes an SQL command passed by a string

Public method

ExecuteQuery(String)

Executes a query against the database. The query must be a valid SQL command that can be executed against the database. It does not return any result, it is used for commands like INSERT, UPDATE, DELETE, etc.

Public method

ExecuteQuery(String, SqlParameter[])


Public method

Filter

It makes available from the command shell interface the Filter functionality available in the browser Document and Query pages.

Protected method

Finalize

(Inherited from Object.)

Public method

GetChildren

Retrieves a list of current document first level children.

Public method

GetChildrenList

Retrieves a list of current document first level children.

Public method

GetDataset


Public method

GetDocumentData

Retrieves an object with all the data in the Document table for the specified document unique id.

Public method

GetHashCode

(Inherited from Object.)

Public method

GetInsertCmdValue

Gets the value from an DBWorks-generated sql INSERT command, given the name of a field.

Public method

GetLinks

Retrieves unique id of parents/children documents related to the current one.

Public method

GetListFromQuery(String)

Given a query, returns a list of dynamic objects with the query results.

Public method

GetListFromQuery(String, Int32)


Public method

GetListFromQueryCOM

The behavior is the same as the GetListFromQuery method, but it is exposed to COM clients for use for example in vbscript.

Public method

GetParents

Retrieves a list of current document parents.

Public method

GetParentsList

Retrieves a list of current document parents.

Public method

GetSortedUIDListForProcessing

Returns input uid list values sorted by approval hierarchy.

Public method

GetSqlStringFieldData


Public method

GetStringFieldData

Queries a given table from a datasource for a string field through a key field and key value

Public method

GetStringFieldData2

Queries a given table from a datasource for a string field through a key field and key value

Public method

GetType

(Inherited from Object.)

Protected method

MemberwiseClone

(Inherited from Object.)

Public method

Query

Given the identifier of a DBWorks document, it fetches from the DOCUMENT table of the DBWorks database the value of the assigned field.

Public method

QueryByUid

Given the identifier of a DBworks document, it fetches from the DOCUMENT table of the MW database the value of an assigned field

Public method

QueryRevisionByUid

Given the identifier of a DBWorks document, it fetches from the REVISION table of the DBWorks database the value of an assigned field.

Public method

QueryTableFieldByKey

Given a keyName/KeyValue, it fetches from the required table the value of an assigned field

Public method

RemoveFromParent

Deletes the child relationship of the document with unique identifier child_unique_id from the document with unique identifier parent_unique_id.

Public method

Requery

Refreshes all the grids and the tree view by re-querying the database

Public method

SetDbworksStringFieldData

Sets a field of the DOCUMENT table in DBWORKS

Public method

SetNullFieldData

Sets, in a given table of a datasource, a string field using a key field and key value

Public method

SetRevisionStringFieldData

Sets, in the REVISION table of DBWorks database, a string field using revision name and document

Public method

SetStringFieldData

Sets, in a given table of a datasource, a string field using a key field and key value

Public method

ToString

(Inherited from Object.)

Public method

UpdateDatabaseActiveDoc

This command has the primary goal to register document in the database without performing a save on the file. More, it updates the database with the structure/data of the active opened document. It works also with checked-out documents and it is equivalent, from a database point of view, to a _shift_ REFRESH operation.

Public method

UpdateReleasedDatabaseDocument

Update the Released Database record of a document, if existing.

Public method

UpdateReleasedDatabaseParentChild

Updates the parent-child structure of the Released Database for the assigned document unique id

Public method

WhereUsed

Returns the documents where the current one is used.

Public method

WhereUsedByString

Returns the documents where the current one is used.

See Also

Database Class

MwPDMApi Namespace