Interface IImagingProfileService

Represents the ImagingProfile API service.

Namespace: Relativity.Testing.Framework.Api.Services

Assembly: Relativity.Testing.Framework.Api.dll

Syntax

public interface IImagingProfileService

Examples

_imagingProfileService = relativityFacade.Resolve<IImagingProfileService>();

Methods

CreateBasic(Int32, CreateBasicImagingProfileDTO)

Creates a new Imaging Profile instance, specifying only Basic Profile options. Native Profile options will be set to default values, as occurs when creating a Basic Profile in the UI.

Declaration

ImagingProfile CreateBasic(int workspaceId, CreateBasicImagingProfileDTO dto)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
CreateBasicImagingProfileDTO	dto	A CreateBasicImagingProfileDTO object corresponding to the desired Imaging Profile object.

Returns

Type	Description
ImagingProfile	Returns an ImagingProfile instance.

Examples

var workspaceId = 1015427;
var dto = new CreateBasicImagingProfileDTO
{
	Name = Randomizer.GetString(),
	Notes = string.Empty,
	Keywords = string.Empty,
	BasicOptions = new BasicImagingEngineOptions
	{
		ImageOutputDpi = 300,
		BasicImageFormat = ImageFormatType.Jpeg,
		ImageSize = ImageSizeType.Custom,
		MaximumImageHeight = 6.0m,
		MaximumImageWidth = 6.0m
	}
};
var imagingProfile = _imagingService.CreateBasic(workspaceId, dto);

CreateNative(Int32, CreateNativeImagingProfileDTO)

Creates a new Imaging Profile instance, specifying both Basic and Native Profile options.

Declaration

ImagingProfile CreateNative(int workspaceId, CreateNativeImagingProfileDTO dto)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
CreateNativeImagingProfileDTO	dto	A CreateNativeImagingProfileDTO object corresponding to the desired Imaging Profile object.

Returns

Type	Description
ImagingProfile	Returns an ImagingProfile instance.

Examples

var workspaceId = 1015427;
var dto = new CreateNativeImagingProfileDTO
{
	Name = Randomizer.GetString(),
	Notes = string.Empty,
	Keywords = string.Empty,
	BasicOptions = new BasicImagingEngineOptions
	{
		ImageOutputDpi = 300,
		BasicImageFormat = ImageFormatType.Jpeg,
		ImageSize = ImageSizeType.Custom,
		MaximumImageHeight = 6.0m,
		MaximumImageWidth = 6.0m
	},
	NativeOptions = new NativeImagingEngineOptions
	{
		NativeImageFormat = ImageFormatType.Tiff,
	},
	HtmlOptions = new ImagingHtmlOptions
	{
		RemoveNonBreakingSpaceCodes = true
	},
	PresentationOptions = new ImagingPresentationOptions
	{
		ShowSpeakerNotes = true,
		SlideOrientation = ImagingElementOrientation.OriginalSetting
	},
	SpreadsheetOptions = new ImagingSpreadsheetOptions
	{
		HideAndPageBreakAfterConsecutiveBlankRowCol = 10,
		IncludeBorders = true,
		IncludeComments = true,
		IncludeGridlines = ImagingIncludeElement.OriginalSetting,
		IncludeHeadersAndFooters = ImagingIncludeElement.OriginalSetting,
		IncludeRowAndColumnHeadings = ImagingIncludeElement.OriginalSetting,
		PageOrder = ImagingSpreadsheetPageOrder.OriginalSetting,
		PaperSizeOrientation = ImagingSpreadsheetPaperSizeOrientation.OriginalSetting,
		PrintArea = ImagingSpreadsheetPrintArea.OriginalSetting,
		ShowTrackChanges = true,
		UnhideHiddenWorksheets = true
	},
	WordProcessingOptions = new ImagingWordOptions
	{
		PageOrientation = ImagingElementOrientation.OriginalSetting,
		ShowTrackChanges = true
	},
	EmailOptions = new ImagingEmailOptions
	{
		ClearIndentations = true,
		DetectCharacterEncoding = true,
		DisplaySmtpAddresses = true,
		DownloadImagesFromInternet = true,
		Orientation = ImagingEmailOrientation.Landscape,
		ResizeImagesToFitPage = true,
		ResizeTablesToFitPage = true,
		ShowMessageTypeInHeader = true,
		SplitTablesToFitPageWidth = true
	}
};
var imagingProfile = _imagingProfileService.CreateNative(workspaceId, dto);

Delete(Int32, Int32)

Deletes an Imaging Profile instance.

Declaration

void Delete(int workspaceId, int imagingProfileId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	imagingProfileId	The Artifact ID of the ImagingProfile instance to delete.

Examples

var workspaceId = 1015427;
var imagingProfileId = 1018877;
_imagingProfileService.Delete(workspaceId, imagingProfileId);

Get(Int32, Int32)

Retrieves the ImagingProfile with the specified Artifact ID.

Declaration

ImagingProfile Get(int workspaceId, int imagingProfileId)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
System.Int32	imagingProfileId	The Artifact ID of the ImagingProfile instance to read.

Returns

Type	Description
ImagingProfile	Returns an ImagingProfile instance.

Examples

var workspaceId = 1015427;
var imagingProfileId = 1018877;
var imagingProfile = _imagingProfileService.Get(workspaceId, imagingProfileId);

Update(Int32, ImagingProfile)

Updates an existing Imaging Profile instance.

Declaration

void Update(int workspaceId, ImagingProfile imagingProfile)

Parameters

Type	Name	Description
System.Int32	workspaceId	The workspace ID.
ImagingProfile	imagingProfile	An ImagingProfile object with updated fields, reflecting the desired final state of the Imaging Profile.

Examples

var workspaceId = 1015427;
someImagingProfile.Name = Randomizer.GetString();
var updatedImagingProfile = _imagingProfileService.Update(workspaceId, someImagingProfile);