Dokumentationsformat eines PLC-Projekts setzen

Das Dokumentationsformat eines PLC-Projekts bestimmt, welches Ausgabeformat beim Generieren der Projektdokumentation verwendet wird. Der einzige unterstützte Wert ist TcDocGen. Das Format wird per ConsumeXml auf dem PLC-Projekt-Tree-Item gesetzt. Dieses Feature steht ab TwinCAT Build 4026.7 zur Verfügung.

Voraussetzungen

TwinCAT XAE ist installiert und gestartet.
Eine DTE-Verbindung zur Zielinstanz ist aktiv.
ITcSysManager ist in einem STA-Thread initialisiert.
Ein PLC-Projekt ist in der Solution vorhanden.
TwinCAT Build 4026.7 oder neuer.

Dokumentationsformat setzen

Der folgende Aufruf setzt das Format auf TcDocGen. Ein leerer <DocFormat>-Tag setzt das Format auf den Standardwert zurück.

ITcSmTreeItem plcProject = sysManager.LookupTreeItem(@"TIPC^PLC1^PLC1 Project");

// Set TcDocGen documentation format
plcProject.ConsumeXml(@"
<TreeItem>
  <IECProjectDef>
    <ProjectInfo>
      <DocFormat>TcDocGen</DocFormat>
    </ProjectInfo>
  </IECProjectDef>
</TreeItem>");

// Reset to default (empty string sets format to "Default")
plcProject.ConsumeXml(@"
<TreeItem>
  <IECProjectDef>
    <ProjectInfo>
      <DocFormat></DocFormat>
    </ProjectInfo>
  </IECProjectDef>
</TreeItem>");

Gültige Werte

Wert	Bedeutung
`TcDocGen`	TcDocGen-Dokumentationsgenerator
`""` (leer)	Setzt das Format auf "Default" zurück