ISIAPIProject Interface¶

Namespace: SIDRASolutions.SI.API
Assembly: SIDRASolutions.SI.API.dll COM CLSID: 92FE4623-165F-4767-B5DD-0C803422C9DD

SIDRA INTERSECTION Project wrapper interface

Declaration¶

[Guid("92FE4623-165F-4767-B5DD-0C803422C9DD")]
public interface ISIAPIProject

Get an instance¶

C#VB.NETPythonPowerShell

// Navigate to the ISIAPIProject you need via the ISIAPI tree.
// See ISIAPI for the activation root.
var project = /* ... */;

' Navigate to the ISIAPIProject you need via the ISIAPI tree.
' See ISIAPI for the activation root.
Dim project As ISIAPIProject = Nothing

# Navigate to the ISIAPIProject you need via the ISIAPI tree.
# See ISIAPI for the activation root.
project = ...

# Navigate to the ISIAPIProject you need via the ISIAPI tree.
# See ISIAPI for the activation root.
$project = $null

Properties¶

Name¶

Project name

string Name { get; }

Type string

Value

Project name

Code samples

C#VB.NETPythonPowerShell

string name = project.Name;

Dim name As String = project.Name

name = project.Name

$name = $project.Name

LastErrorMessage¶

string LastErrorMessage { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string lastErrorMessage = project.LastErrorMessage;

Dim lastErrorMessage As String = project.LastErrorMessage

last_error_message = project.LastErrorMessage

$lastErrorMessage = $project.LastErrorMessage

SiteFolders¶

Collection of SiteFolders in the current Project

ISIAPISiteFolders SiteFolders { get; }

Type ISIAPISiteFolders

Value

SiteFolders collection

Code samples

C#VB.NETPythonPowerShell

var siteFolders = project.SiteFolders;

Dim siteFolders As ISIAPISiteFolders = project.SiteFolders

site_folders = project.SiteFolders

$siteFolders = $project.SiteFolders

NetworkFolders¶

Collection of NetworkFolders in the current Project

ISIAPINetworkFolders NetworkFolders { get; }

Type ISIAPINetworkFolders

Value

NetworkFolders collection

Code samples

C#VB.NETPythonPowerShell

var networkFolders = project.NetworkFolders;

Dim networkFolders As ISIAPINetworkFolders = project.NetworkFolders

network_folders = project.NetworkFolders

$networkFolders = $project.NetworkFolders

Description¶

string Description { get; set; }

Type string

Code samples

C#VB.NETPythonPowerShell

string description = project.Description;
project.Description = @"value";

Dim description As String = project.Description
project.Description = "value"

description = project.Description
project.Description = r"value"

$description = $project.Description
$project.Description = "value"

MinViableVersion¶

string MinViableVersion { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string minViableVersion = project.MinViableVersion;

Dim minViableVersion As String = project.MinViableVersion

min_viable_version = project.MinViableVersion

$minViableVersion = $project.MinViableVersion

Created_date¶

DateTime Created_date { get; }

Type DateTime

Code samples

C#VB.NETPythonPowerShell

var created_date = project.Created_date;

Dim created_date As DateTime = project.Created_date

created_date = project.Created_date

$created_date = $project.Created_date

Created_by¶

string Created_by { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string created_by = project.Created_by;

Dim created_by As String = project.Created_by

created_by = project.Created_by

$created_by = $project.Created_by

Created_by_company¶

string Created_by_company { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string created_by_company = project.Created_by_company;

Dim created_by_company As String = project.Created_by_company

created_by_company = project.Created_by_company

$created_by_company = $project.Created_by_company

Created_version¶

string Created_version { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string created_version = project.Created_version;

Dim created_version As String = project.Created_version

created_version = project.Created_version

$created_version = $project.Created_version

Modified_date¶

DateTime Modified_date { get; }

Type DateTime

Code samples

C#VB.NETPythonPowerShell

var modified_date = project.Modified_date;

Dim modified_date As DateTime = project.Modified_date

modified_date = project.Modified_date

$modified_date = $project.Modified_date

Modified_by¶

string Modified_by { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string modified_by = project.Modified_by;

Dim modified_by As String = project.Modified_by

modified_by = project.Modified_by

$modified_by = $project.Modified_by

Modified_by_company¶

string Modified_by_company { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string modified_by_company = project.Modified_by_company;

Dim modified_by_company As String = project.Modified_by_company

modified_by_company = project.Modified_by_company

$modified_by_company = $project.Modified_by_company

Modified_version¶

string Modified_version { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string modified_version = project.Modified_version;

Dim modified_version As String = project.Modified_version

modified_version = project.Modified_version

$modified_version = $project.Modified_version

EarliestModifiedVersion¶

string EarliestModifiedVersion { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string earliestModifiedVersion = project.EarliestModifiedVersion;

Dim earliestModifiedVersion As String = project.EarliestModifiedVersion

earliest_modified_version = project.EarliestModifiedVersion

$earliestModifiedVersion = $project.EarliestModifiedVersion

LatestModifiedVersion¶

string LatestModifiedVersion { get; }

Type string

Code samples

C#VB.NETPythonPowerShell

string latestModifiedVersion = project.LatestModifiedVersion;

Dim latestModifiedVersion As String = project.LatestModifiedVersion

latest_modified_version = project.LatestModifiedVersion

$latestModifiedVersion = $project.LatestModifiedVersion

SiteVolumeBinFolders¶

Collection of SiteVolumeBinFolders in the current Project

ISIAPISiteVolumeBinFolders SiteVolumeBinFolders { get; }

Type ISIAPISiteVolumeBinFolders

Value

SiteVolumeBinFolders collection

Code samples

C#VB.NETPythonPowerShell

var siteVolumeBinFolders = project.SiteVolumeBinFolders;

Dim siteVolumeBinFolders As ISIAPISiteVolumeBinFolders = project.SiteVolumeBinFolders

site_volume_bin_folders = project.SiteVolumeBinFolders

$siteVolumeBinFolders = $project.SiteVolumeBinFolders

Methods¶

UpdateModifiedInfo()¶

Update the Last Modified Information, such as Date, User Name, Organisation Name, Software Version Number

bool UpdateModifiedInfo()

Returns bool

Code samples

C#VB.NETPythonPowerShell

bool result = project.UpdateModifiedInfo();

Dim result As Boolean = project.UpdateModifiedInfo()

result = project.UpdateModifiedInfo()

$result = $project.UpdateModifiedInfo()

ImportSitesFromProject(string, string)¶

Import Site(s) from another Project file into this Project file.

int ImportSitesFromProject(string projectFilePath, string siteNames)

Parameters

Name	Type	Description
`projectFilePath`	`string`	The file path of the other Project file.
`siteNames`	`string`	The name(s) of the Site(s) to import. Use semicolon ";" to separate the names. If a name already has ";", replace each ";" with ";;". For examples:

Returns int - The number of successfully imported Sites

Code samples

C#VB.NETPythonPowerShell

int result = project.ImportSitesFromProject(@"C:\path\to\project.sip", @"Main Intersection");

Dim result As Integer = project.ImportSitesFromProject("C:\path\to\project.sip", "Main Intersection")

result = project.ImportSitesFromProject(r"C:\path\to\project.sip", r"Main Intersection")

$result = $project.ImportSitesFromProject("C:\path\to\project.sip", "Main Intersection")

ImportNetworksFromProject(string, string)¶

Import Network(s) from another Project file into this Project file. This function will import the Sites in the Network(s) too.

int ImportNetworksFromProject(string projectFilePath, string networkNames)

Parameters

Name	Type	Description
`projectFilePath`	`string`	The file path of the other Project file.
`networkNames`	`string`	The name(s) of the Network(s) to import. Use semicolon ";" to separate the names. If a name already has ";", replace each ";" with ";;". For examples:

Returns int - The number of successfully imported Networks

Code samples

C#VB.NETPythonPowerShell

int result = project.ImportNetworksFromProject(@"C:\path\to\project.sip", @"City Network");

Dim result As Integer = project.ImportNetworksFromProject("C:\path\to\project.sip", "City Network")

result = project.ImportNetworksFromProject(r"C:\path\to\project.sip", r"City Network")

$result = $project.ImportNetworksFromProject("C:\path\to\project.sip", "City Network")

AddSiteFolder(string)¶

Add a new SiteFolder into the Project.

ISIAPISiteFolder AddSiteFolder(string name)

Parameters

Name	Type	Description
`name`	`string`

Returns ISIAPISiteFolder

Code samples

C#VB.NETPythonPowerShell

var result = project.AddSiteFolder(@"Example");

Dim result As ISIAPISiteFolder = project.AddSiteFolder("Example")

result = project.AddSiteFolder(r"Example")

$result = $project.AddSiteFolder("Example")

RemoveSiteFolder(ISIAPISiteFolder)¶

Remove a SiteFolder from the Project. All Sites in the SiteFolder will be removed. This method fails if any Site in the SiteFolder is used in a Network.

bool RemoveSiteFolder(ISIAPISiteFolder siteFolder)

Parameters

Name	Type	Description
`siteFolder`	`ISIAPISiteFolder`	The SiteFolder to remove.

Returns bool - true if the SiteFolder is successfully removed; otherwise, false. This method also returns false if the SiteFolder does not exist in this Project.

Code samples

C#VB.NETPythonPowerShell

bool result = project.RemoveSiteFolder(null);

Dim result As Boolean = project.RemoveSiteFolder(Nothing)

result = project.RemoveSiteFolder(None)

$result = $project.RemoveSiteFolder($null)

MoveSiteFolderTo(ISIAPISiteFolder, int)¶

Move a SiteFolder to a new position.

bool MoveSiteFolderTo(ISIAPISiteFolder siteFolder, int newPosition)

Parameters

Name	Type	Description
`siteFolder`	`ISIAPISiteFolder`	The SiteFolder to move.
`newPosition`	`int`	The zero-based position that the SiteFolder should be moved to.

Returns bool - true if the SiteFolder is successfully moved; otherwise, false. This method also returns false if the SiteFolder does not exist in this Project.

Code samples

C#VB.NETPythonPowerShell

bool result = project.MoveSiteFolderTo(null, 0);

Dim result As Boolean = project.MoveSiteFolderTo(Nothing, 0)

result = project.MoveSiteFolderTo(None, 0)

$result = $project.MoveSiteFolderTo($null, 0)

AddNetworkFolder(string)¶

Add a new NetworkFolder into the Project.

ISIAPINetworkFolder AddNetworkFolder(string name)

Parameters

Name	Type	Description
`name`	`string`

Returns ISIAPINetworkFolder

Code samples

C#VB.NETPythonPowerShell

var result = project.AddNetworkFolder(@"Example");

Dim result As ISIAPINetworkFolder = project.AddNetworkFolder("Example")

result = project.AddNetworkFolder(r"Example")

$result = $project.AddNetworkFolder("Example")

RemoveNetworkFolder(ISIAPINetworkFolder)¶

Remove a NetworkFolder from the Project. All Networks in the NetworkFolder will be removed.

bool RemoveNetworkFolder(ISIAPINetworkFolder networkFolder)

Parameters

Name	Type	Description
`networkFolder`	`ISIAPINetworkFolder`	The NetworkFolder to remove.

Returns bool - true if the NetworkFolder is successfully removed; otherwise, false. This method also returns false if the NetworkFolder does not exist in this Project.

Code samples

C#VB.NETPythonPowerShell

bool result = project.RemoveNetworkFolder(null);

Dim result As Boolean = project.RemoveNetworkFolder(Nothing)

result = project.RemoveNetworkFolder(None)

$result = $project.RemoveNetworkFolder($null)

MoveNetworkFolderTo(ISIAPINetworkFolder, int)¶

Move a NetworkFolder to a new position.

bool MoveNetworkFolderTo(ISIAPINetworkFolder networkFolder, int newPosition)

Parameters

Name	Type	Description
`networkFolder`	`ISIAPINetworkFolder`	The NetworkFolder to move.
`newPosition`	`int`	The zero-based position that the NetworkFolder should be moved to.

Returns bool - true if the NetworkFolder is successfully moved; otherwise, false. This method also returns false if the NetworkFolder does not exist in this Project.

Code samples

C#VB.NETPythonPowerShell

bool result = project.MoveNetworkFolderTo(null, 0);

Dim result As Boolean = project.MoveNetworkFolderTo(Nothing, 0)

result = project.MoveNetworkFolderTo(None, 0)

$result = $project.MoveNetworkFolderTo($null, 0)

AddSiteVolumeBinFolder(string)¶

Add a new SiteVolumeBinFolder into the Project.

ISIAPISiteVolumeBinFolder AddSiteVolumeBinFolder(string name)

Parameters

Name	Type	Description
`name`	`string`

Returns ISIAPISiteVolumeBinFolder

Code samples

C#VB.NETPythonPowerShell

var result = project.AddSiteVolumeBinFolder(@"Example");

Dim result As ISIAPISiteVolumeBinFolder = project.AddSiteVolumeBinFolder("Example")

result = project.AddSiteVolumeBinFolder(r"Example")

$result = $project.AddSiteVolumeBinFolder("Example")

RemoveSiteVolumeBinFolder(ISIAPISiteVolumeBinFolder)¶

Remove a SiteVolumeBinFolder from the Project. All SiteVolumeBins in the SiteVolumeBinFolder will be removed. This method fails if any SiteVolumeBin in the Folder is used by Site.

bool RemoveSiteVolumeBinFolder(ISIAPISiteVolumeBinFolder siteVolumeBinFolder)

Parameters

Name	Type	Description
`siteVolumeBinFolder`	`ISIAPISiteVolumeBinFolder`	The SiteVolumeBinFolder to remove.

Returns bool - true if the SiteVolumeBinFolder is successfully removed; otherwise, false. This method also returns false if the SiteVolumeBinFolder does not exist in this Project.

Code samples

C#VB.NETPythonPowerShell

bool result = project.RemoveSiteVolumeBinFolder(null);

Dim result As Boolean = project.RemoveSiteVolumeBinFolder(Nothing)

result = project.RemoveSiteVolumeBinFolder(None)

$result = $project.RemoveSiteVolumeBinFolder($null)

MoveSiteVolumeBinFolderTo(ISIAPISiteVolumeBinFolder, int)¶

Move a SiteVolumeBinFolder to a new position.

bool MoveSiteVolumeBinFolderTo(ISIAPISiteVolumeBinFolder siteVolumeBinFolder, int newPosition)

Parameters

Name	Type	Description
`siteVolumeBinFolder`	`ISIAPISiteVolumeBinFolder`	The SiteVolumeBinFolder to move.
`newPosition`	`int`	The zero-based position that the SiteVolumeBinFolder should be moved to.

Returns bool - true if the SiteVolumeBinFolder is successfully moved; otherwise, false. This method also returns false if the SiteVolumeBinFolder does not exist in this Project.

Code samples

C#VB.NETPythonPowerShell

bool result = project.MoveSiteVolumeBinFolderTo(null, 0);

Dim result As Boolean = project.MoveSiteVolumeBinFolderTo(Nothing, 0)

result = project.MoveSiteVolumeBinFolderTo(None, 0)

$result = $project.MoveSiteVolumeBinFolderTo($null, 0)