SPSolutionExporter.ExportWorkFlowTemplate - Méthode

Exporte le modèle de flux de travail spécifiée sous la forme d'un fichier de solution.

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Shared Sub ExportWorkFlowTemplate ( _
    web As SPWeb, _
    solutionFilePath As String, _
    title As String, _
    description As String, _
    workflowTemplateName As String _
)
'Utilisation
Dim web As SPWeb
Dim solutionFilePath As String
Dim title As String
Dim description As String
Dim workflowTemplateName As StringSPSolutionExporter.ExportWorkFlowTemplate(web, _
    solutionFilePath, title, description, _
    workflowTemplateName)

public static void ExportWorkFlowTemplate(
    SPWeb web,
    string solutionFilePath,
    string title,
    string description,
    string workflowTemplateName
)

Paramètres

• web
  Type : Microsoft.SharePoint.SPWeb

  Le site Web qui contient le modèle de flux de travail.

• solutionFilePath
  Type : System.String

  Le chemin d'accès, nom de fichier et l'extension du fichier solution qui sera créé. Lorsque la méthode s'exécute, les espaces sont supprimés du nom de fichier, comme les autres caractères non autorisés. Si un fichier de solution (.wsp) portant le même nom existe déjà sur le chemin d'accès spécifié, il est remplacé.

• title
  Type : System.String

  Titre du modèle de flux de travail.

• description
  Type : System.String

  Obtenir des informations détaillées décrivant le modèle.

• workflowTemplateName
  Type : System.String

  Le nom du modèle de flux de travail à exporter. Le modèle doit exister sur le site Web.

Exemples

L'exemple suivant est une application console qui exporte un modèle de flux de travail sous la forme d'un fichier de solution dans le répertoire de l'application. Le modèle de flux de travail utilisé dans l'exemple de code est « Tâche de flux de travail ». Vous devez remplacer le nom d'un modèle de flux de travail qui existe sur votre site avant d'exécuter le code.

using System;
using System.IO;
using Microsoft.SharePoint;
namespace ConsoleApp
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("https://localhost"))
            {
                using (SPWeb web = site.RootWeb)
                {
                    string solutionFile = "TaskWorkflow.wsp";
                    string solutionPath = AppDomain.CurrentDomain.BaseDirectory;
                    string solutionFilePath = SPSolutionExporter.PathCombine(solutionPath, solutionFile);

                    string solutionTitle = "Task";
                    string solutionDesc = "This template was saved programmatically.";
                    string templateName = "Task Workflow";

                    try
                    {
                        // Save the workflow in a solution file.
                        SPSolutionExporter.ExportWorkFlowTemplate(
                            web,
                            solutionFilePath,
                            solutionTitle,
                            solutionDesc,
                            templateName);
                    }
                    catch (SPException spx)
                    {
                        Console.WriteLine(spx.Message);
                    }


                    // Print information about the file.
                    FileInfo solutionFileInfo = new FileInfo(solutionFilePath);
                    if (solutionFileInfo.Exists)
                    {
                        Console.WriteLine("File name: {0}", solutionFileInfo.Name);
                        Console.WriteLine("File size: {0:n0} KB", solutionFileInfo.Length / 1024);
                    }
                }
            }
            Console.Write("\nPress ENTER to continue....");
            Console.ReadLine();
        }
    }
}

Imports System
Imports System.IO
Imports Microsoft.SharePoint

Module ConsoleApp

    Sub Main()

        Using site As New SPSite("https://localhost")
            Using web As SPWeb = site.RootWeb

                Dim solutionFile As String = "TaskWorkflow.wsp"
                Dim solutionPath As String = AppDomain.CurrentDomain.BaseDirectory
                Dim solutionFilePath As String = SPSolutionExporter.PathCombine(solutionPath, solutionFile)

                Dim solutionTitle As String = "Task"
                Dim solutionDesc As String = "This template was saved programmatically."
                Dim templateName As String = "Task Workflow"

                Try
                    ' Save the workflow in a solution file.
                    SPSolutionExporter.ExportWorkFlowTemplate(web, solutionFilePath, solutionTitle, solutionDesc, templateName)
                Catch spx As SPException
                    Console.WriteLine(spx.Message)
                End Try

                ' Print information about the file.
                Dim solutionFileInfo As New FileInfo(solutionFilePath)
                If solutionFileInfo.Exists Then
                    Console.WriteLine("File name: {0}", solutionFileInfo.Name)
                    Console.WriteLine("File size: {0:n0} KB", solutionFileInfo.Length / 1024)
                End If

            End Using
        End Using

        Console.Write(vbCrLf & "Press ENTER to continue....")
        Console.Read()
    End Sub

End Module

Voir aussi

Référence

SPSolutionExporter classe

SPSolutionExporter - Membres

Microsoft.SharePoint - Espace de noms

Autres ressources

Site Types: WebTemplates and Site Definitions