Auf Ordner in einer Bibliothek zugreifen - TIAPortal

TIA Portal Openness: API für die Automatisierung von Engineering-Workflows

ft:publication_title
TIA Portal Openness: API für die Automatisierung von Engineering-Workflows
Product
TIAPortal
Version
V20
Publication date
01/2025
Language
de-DE
Auf Ordner in einer Bibliothek zugreifen

Voraussetzung

Einleitung

Über die Schnittstelle TIA Portal Openness API können Sie auf die Systemordner für Typen und Masterkopien in einer Bibliothek zugreifen. Dabei können Sie auf Typen, Typversionen, Masterkopien und benutzerdefinierte Ordner im Systemordner zugreifen.

Mit der Methode Find, z. B. libTypeUserFolder.Folders.Find("SomeUserFolder");, können Sie jederzeit auf einen benutzerdefinierten Ordner zugreifen.

Programmcode: Auf Systemordner zugreifen

Um auf die Systemordner für Typen in einer Bibliothek zuzugreifen, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

public static void AccessTypeSystemFolder(ILibrary library)

{

    LibraryTypeSystemFolder libTypeSystemFolder = library.TypeFolder;

}

Um auf die Systemordner für Masterkopien in einer Bibliothek zuzugreifen, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

public static void AccessMasterCopySystemFolder(ILibrary library)

{

    MasterCopySystemFolder libMasterCopySystemFolder = library.MasterCopyFolder;

}

Programmcode: Über die Methode Find() auf benutzerdefinierte Ordner zugreifen

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

...

LibraryTypeUserFolderComposition userFolderComposition = ...

LibraryTypeUserFolder userFolder = userFolderComposition.Find("Name of user folder");

...

Programmcode: Benutzerdefinierte Ordner enumerieren

Um benutzerdefinierte Unterordner in einem Systemordner für Typen zu enumerieren, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

public static void EnumerateUserFoldersInTypeSystemFolder(ILibrary library)

{

    // Enumerating user folders in type system folder:

    LibraryTypeSystemFolder libTypeSystemFolder = library.TypeFolder;

    foreach (LibraryTypeUserFolder libTypeUserFolder in libTypeSystemFolder.Folders)

    {

        //...

    } 

}

Um benutzerdefinierte Unterordner in einem Systemordner für Masterkopien zu enumerieren, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

public static void EnumerateUserFoldersInMasterCopySystemFolder(ILibrary library)

{

    // Enumerating user folders in master copy system folder:

    MasterCopySystemFolder libMasterCopySystemFolder = library.MasterCopyFolder;

    foreach (MasterCopyUserFolder libMasterCopyUserFolder in libMasterCopySystemFolder.Folders)

    {

        //..

    }

}

Um benutzerdefinierte Unterordner in einem benutzerdefinierten Ordner für Typen zu enumerieren, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

public static void EnumerateAllUserFolders(LibraryTypeUserFolder libUserFolder)

{

    foreach (LibraryTypeUserFolder libSubUserFolder in libUserFolder.Folders)

    {

       EnumerateAllUserFolders(libSubUserFolder);

    }

}

Um benutzerdefinierte Unterordner in einem benutzerdefinierten Ordner für Masterkopien zu enumerieren, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

public static void EnumerateAllUserFolders(MasterCopyUserFolder libUserFolder)

{

    foreach (MasterCopyUserFolder libSubUserFolder in libUserFolder.Folders)

    {

       EnumerateAllUserFolders(libSubUserFolder);

    }

}

Programmcode: Benutzerdefinierte Ordner erstellen

Um einen benutzerdefinierten Ordner für Typen zu erstellen, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

var typeFolderComposition = ProjectLibrary.TypeFolder.Folders;

var newTypeUserFolder = typeFolderComposition.Create("NewTypeUserFolder");

Um einen benutzerdefinierten Ordner für Masterkopien zu erstellen, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

var masterCopyFolderComposition = projectProjectLibrary.MasterCopyFolder.Folders;

MasterCopyUserFolder newMasterCopyUserFolder = masterCopyFolderComposition.Create("NewMasterCopyUserFolder);

Programmcode: Benutzerdefinierte Ordner umbenennen

Um einen benutzerdefinierten Ordner für Typen zu erstellen, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

var typeUserFolder = project.ProjectLibrary.TypeFolder.Folders.Find("SampleTypeUserFolderName");

typeUserFolder.Name = "NewTypeUserFolderName";

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

var typeUserFolder = ProjectLibrary.TypeFolder.Folders.Find("SampleTypeUserFolderName");

typeUserFolder.SetAttributes(new[] {new KeyValuePair<string,object>("Name", "NewTypeUserFolderName")});

Um einen benutzerdefinierten Ordner für Masterkopien zu erstellen, ändern Sie folgenden Programmcode:

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

var masterCopyUserFolder = project.ProjectLibrary.MasterCopyFolder.Folders.Find("SampleMasterCopyUserFolderName");

masterCopyUserFolder.Name = "NewMasterCopyUserFolderName";

Kopiert den nachfolgenden Programmcode in die Zwischenablage.

var masterCopyUserFolder = ProjectLibrary.MasterCopyFolder.Folders.Find("SampleMasterCopyUserFolderName");

masterCopyUserFolder.SetAttributes(new[] {new KeyValuePair<string,object>("Name", "NewMasterCopyUserFolderName")});