Skip to content

SharedText

jdubs edited this page Oct 21, 2016 · 1 revision

Table of Contents

Overview

Retrieves an exported text resource stored in the Shared folder of the project.

Parameters

SpecName (constant) The variable for assignment of the shared resource. Variable must be a Formatted Text type.

Name (multiple) The name of the resource to retrieve.

SharedPath (multiple) The shared path id provided by Four51. It must contain the shared resource unique ID, and the project sub folder of the resources you are retrieving.

ErrorMessage (multiple | optional) The error message to return when any error occurs.

Synopsis

This method allows an easier method of shared Variable Document usage.

Special Note

Four51 designates a variable named four51sharedpath that contains the location of the shared resources in the application environment. This path differs between environments such as the demo, beta and production environment. You can override this value locally for testing. Define the variable and in the job preview set the local file path value.

Source Code

public static void SharedText(object SpecName, object Source, object SharedPath, object ErrorMessage)
{
	Break();
	try
	{
		Variable((string)SpecName).Value = SharedResource((string)SharedPath, (string)Source);
	}
	catch (Exception ex)
	{
		throw new Four51ActionsException(ex.Message, (string)ErrorMessage);
	}
}

Referenced Methods

Clone this wiki locally