Click or drag to resize

IExportManagerUpdate Method

Updates the properties for an export

Namespace:  EdaIntegrationContract.Exports
Assembly:  EdaIntegration.Contract (in EdaIntegration.Contract.dll) Version: 7.6
Syntax
C#
Copy
void Update(
	IExport export
)

Parameters

export
Type: EdaIntegrationContract.ExportsIExport
The export containing updated data to save
Exceptions
ExceptionCondition
EdaApiExceptionThrown if an export with the provided id does not exist
ArgumentExceptionThrown if the export configuration parameters are invalid
Examples
This example demonstrates updating the properties of an export.
C#
Copy
using EdaIntegrationContract;
using EdaIntegrationContract.Case;
using EdaIntegrationContract.Exports;

class Sample
{
    public static void Main()
    {
        var edaIntegration = new EdaIntegration().ConnectToExplore();
        ICase edaCase = edaIntegration.Cases.OpenCaseByName("Case 1");

        // Retrieve an existing export
        IExport export = edaCase.Exports.ByName("Export-001");
        Console.WriteLine("Name: {0}", export.Name);
        Console.WriteLine("Next Number: {0}", export.Config.NumberingSeed);
        Console.WriteLine("Use Alpha Numbering?: {0}", export.Config.Scope);

        // Change its document numbering properties
        export.Config.AlphaNumericNumbering = true;
        export.Config.NumberingSeed = "100a";
        edaCase.Exports.Update(export);

        // Re-retrieve the export and verify the property changes
        export = edaCase.Exports.ByName("Export-001");
        Console.WriteLine("Name: {0}", export.Name);
        Console.WriteLine("Next Number: {0}", export.Config.NumberingSeed);
        Console.WriteLine("Use Alpha Numbering?: {0}", export.Config.Scope);
    }
}
/*
This example produces the following results:

Name: Export-001
Next Number: 00000001
Use Alpha Numbering: False

Name: Export-001
Next Number: 100a
Use Alpha Numbering: True
 */
See Also