Class Job

An SDS2 job, or project.

Inheritance

object

Job

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: DesignData.SDS2.Database

Assembly: DesignData.SDS2.Database.dll

Syntax

public class Job

Properties

CustomPropertyMapHandle

A handle to the custom properties for this job.

Declaration

public CustomPropertyMapHandle CustomPropertyMapHandle { get; }

Property Value

Type	Description
CustomPropertyMapHandle

Exceptions

Type	Condition
JobNotOpenException	If Open() hasn't been called on this job, or if that call returned false, or if another job has been Opened since this one was.

Default

The identifier for the currently selected job for the user running your software. This is the job they would see by just opening SDS2.

Declaration

public static Identifier Default { get; }

Property Value

Type	Description
Identifier

Remarks

You need to have opened a DataDirectory before calling this.

MajorVersion

Returns the human readable major data version of the Job. This can be used to prevent opening an unconverted Job. It checks the Job's data version without needing to open the job.

Declaration

public int MajorVersion { get; }

Property Value

Type	Description
int	The major data version of the job.

Members

Get a list of all members in the job.

Declaration

public MemberHandleList Members { get; }

Property Value

Type	Description
MemberHandleList	A list of member objects representing every active member in the job.

Remarks

This can be slow in large jobs, especially if it's called repeatedly.

Exceptions

Type	Condition
JobNotOpenException	If Open() hasn't been called on this job, or if that call returned false, or if another job has been Opened since this one was.

MinorVersion

Returns the human readable minor data version of the Job. This can be used to prevent opening an unconverted Job. It checks the Job's data version without needing to open the job.

Declaration

public int MinorVersion { get; }

Property Value

Type	Description
int	The minor data version of the job.

UserDefinedConnections

Get a list of all UDC (user defined connection) handles in this job.

You can get real DesignData.SDS2.Model.UserDefinedConnection objects by using the static Get method on that object, passing one UserDefinedConnectionHandle to it.

Declaration

public UserDefinedConnectionHandleList UserDefinedConnections { get; }

Property Value

Type	Description
UserDefinedConnectionHandleList

Methods

Dispose(bool)

An SDS2 job, or project.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing

~Job()

An SDS2 job, or project.

Declaration

protected ~Job()

FindJob(Identifier)

Find a job on the system based on a job identifier.

Declaration

public static Job FindJob(Identifier id)

Parameters

Type	Name	Description
Identifier	id	The job identifier used to find a job on the system. This includes the name of the job and the repository this job should be found in.

Returns

Type	Description
Job

GetDrawingHandles(TableWithDrawings)

Get all drawing handles for a particular table

Declaration

public DrawingHandleList GetDrawingHandles(TableWithDrawings table)

Parameters

Type	Name	Description
TableWithDrawings	table

Returns

Type	Description
DrawingHandleList

GetGridLineHandles()

Get a list of all grid lines in the job.

Declaration

public GridLineHandleList GetGridLineHandles()

Returns

Type	Description
GridLineHandleList	A list of grid line handles representing every active grid line in the job.

Exceptions

Type	Condition
JobNotOpenException	If Open() hasn't been called on this job, or if that call returned false, or if another job has been Opened since this one was.

GetGroupMemberHandles()

Get a list of all group members in the job.

Declaration

public GroupMemberHandleList GetGroupMemberHandles()

Returns

Type	Description
GroupMemberHandleList	A list of group member handles representing every active group member in the job.

Exceptions

Type	Condition
JobNotOpenException	If Open() hasn't been called on this job, or if that call returned false, or if another job has been Opened since this one was.

GetNoteHandles()

Get a list of all note handles in the job.

Declaration

public NoteHandleList GetNoteHandles()

Returns

Type	Description
NoteHandleList	A list of note handles representing every active note in the job.

Exceptions

Type	Condition
JobNotOpenException	If Open() hasn't been called on this job, or if that call returned false, or if another job has been Opened since this one was.

GroupsForMember(MemberHandle)

All the GroupMemberHandles where a member is a submember

Declaration

public GroupMemberHandleList GroupsForMember(MemberHandle arg0)

Parameters

Type	Name	Description
MemberHandle	arg0

Returns

Type	Description
GroupMemberHandleList

Open()

Open this job and make it the current Job. This is required before you can begin accessing data inside this job. SDS2 can only have one job open at a time, so calling this on one job necessarily closed any already opened job. There is no need to explicitly close the job later.

Declaration

public bool Open()

Returns

Type	Description
bool	true if the job has been successfully opened and is ready for access, or false if something went wrong and the job is not ready for access.