public static void Run(ViewOptions.ViewFormatEnum format)
{
var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
var apiInstance = new ViewApi(configuration);
try
{
var viewOptions = new ViewOptions()
{
FileInfo = new FileInfo()
{
FilePath = "viewerdocs/one-page.docx",
Password = "",
StorageName = Common.MyStorage
},
ViewFormat = format
};
var request = new CreateViewRequest(viewOptions);
var response = apiInstance.CreateView(request);
Console.WriteLine("Expected response type is ViewResult: " + response.Pages.Count.ToString());
}
catch (Exception e)
{
Console.WriteLine("Exception while calling ViewApi: " + e.Message);
}
}
public void TestCreateViewWithHtmlViewOptions()
{
// Arrange
var testFile = TestFiles.OnePageDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
RenderOptions = new HtmlOptions {
ExternalResources = true
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(1, viewResult.Pages.Count);
Assert.AreEqual(0, viewResult.Attachments.Count);
var page = viewResult.Pages[0];
Assert.AreEqual(1, page.Number);
Assert.Greater(page.Resources.Count, 0);
}
/// <summary>
/// Render document pages
/// </summary>
/// <param name="request">Request. <see cref="CreateViewRequest" /></param>
/// <returns><see cref="ViewResult"/></returns>
public ViewResult CreateView(CreateViewRequest request)
{
// verify the required parameter 'viewOptions' is set
if (request.viewOptions == null)
{
throw new ApiException(400, "Missing required parameter 'viewOptions' when calling CreateView");
}
// create path and map variables
var resourcePath = this.configuration.GetServerUrl() + "/viewer/view";
resourcePath = Regex
.Replace(resourcePath, "\\*", string.Empty)
.Replace("&", "&")
.Replace("/?", "?");
var postBody = SerializationHelper.Serialize(request.viewOptions); // http body (model) parameter
var response = this.apiInvoker.InvokeApi(
resourcePath,
"POST",
postBody,
null,
null);
if (response != null)
{
return((ViewResult)SerializationHelper.Deserialize(response, typeof(ViewResult)));
}
return(null);
}
public static void Run()
{
var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
var apiInstance = new ViewApi(configuration);
try
{
var viewOptions = new ViewOptions()
{
FileInfo = new FileInfo()
{
FilePath = "viewerdocs/three-layouts.dwf",
Password = "",
StorageName = Common.MyStorage
},
RenderOptions = new HtmlOptions()
{
IsResponsive = true
}
};
var request = new CreateViewRequest(viewOptions);
var response = apiInstance.CreateView(request);
Console.WriteLine("Expected response type is ViewResult: " + response.Pages.Count.ToString());
}
catch (Exception e)
{
Console.WriteLine("Exception while calling ViewApi: " + e.Message);
}
}
public static void Run()
{
var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
var apiInstance = new ViewApi(configuration);
try
{
var viewOptions = new ViewOptions()
{
FileInfo = new FileInfo()
{
FilePath = "viewerdocs/with-hidden-rows-and-columns.xlsx",
Password = "",
StorageName = Common.MyStorage
},
RenderOptions = new RenderOptions()
{
SpreadsheetOptions = new SpreadsheetOptions()
{
PaginateSheets = true,
CountRowsPerPage = 5
}
}
};
var request = new CreateViewRequest(viewOptions);
var response = apiInstance.CreateView(request);
Console.WriteLine("Expected response type is ViewResult: " + response.Pages.Count.ToString());
}
catch (Exception e)
{
Console.WriteLine("Exception while calling ViewApi: " + e.Message);
}
}
public void TestCreateViewWithProjectOptions()
{
// Arrange
var testFile = TestFiles.ProjectMpp;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
RenderOptions = new RenderOptions
{
ProjectManagementOptions = new ProjectManagementOptions
{
PageSize = ProjectManagementOptions.PageSizeEnum.Unspecified,
TimeUnit = ProjectManagementOptions.TimeUnitEnum.Months,
StartDate = new DateTime(2008, 7, 1),
EndDate = new DateTime(2008, 7, 31)
}
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.IsTrue(viewResult.Pages.Count == 1 || viewResult.Pages.Count == 2);
}
public void TestCreateViewReturnsMissingFileInfo()
{
// Arrange
var viewOptions = new ViewOptions();
var request = new CreateViewRequest(viewOptions);
// Act & Assert
Assert.Throws <ApiException>(() => {
ViewApi.CreateView(request);
});
}
public void TestCreateViewReturnsFileNotFound()
{
// Arrange
var viewOptions = new ViewOptions
{
FileInfo = TestFiles.NotExist.ToFileInfo()
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
Assert.Throws <ApiException>(() => {
ViewApi.CreateView(request);
});
}
public void TestCreateViewWithFontsPathOption()
{
// Arrange
var testFile = TestFiles.UsesCustomFontPptx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
ViewFormat = ViewOptions.ViewFormatEnum.PNG,
FontsPath = "font/ttf"
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(1, viewResult.Pages.Count);
}
public void TestCreateViewPdfWithOutputPath()
{
// Arrange
var testFile = TestFiles.OnePageDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
ViewFormat = ViewOptions.ViewFormatEnum.PDF,
OutputPath = OutputPath
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.IsTrue(viewResult.File.Path.StartsWith(OutputPath));
}
public void TestCreateViewWithRenderHiddenPages()
{
// Arrange
var testFile = TestFiles.TwoHiddenPagesVsd;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
RenderOptions = new RenderOptions
{
RenderHiddenPages = true
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(3, viewResult.Pages.Count);
}
public void TestCreateViewWithDefaultOutputPath()
{
// Arrange
var testFile = TestFiles.OnePageDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo()
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(1, viewResult.Pages.Count);
var page = viewResult.Pages[0];
Assert.IsTrue(page.Path.StartsWith(DefaultOutputPath));
}
public void TestCreateViewWithDefaultViewFormat()
{
// Arrange
var testFile = TestFiles.OnePageDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(1, viewResult.Pages.Count);
Assert.AreEqual(0, viewResult.Attachments.Count);
var page = viewResult.Pages[0];
Assert.AreEqual(1, page.Number);
}
public void TestDeleteViewWithDefaultViewFormat()
{
// Create view
var testFile = TestFiles.OnePageDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
};
var request = new CreateViewRequest(viewOptions);
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(1, viewResult.Pages.Count);
// Delete view
var deleteOptions = new DeleteViewOptions
{
FileInfo = testFile.ToFileInfo()
};
var deleteRequest = new DeleteViewRequest(deleteOptions);
ViewApi.DeleteView(deleteRequest);
}
public void TestCreateViewWithCadOptions()
{
// Arrange
var testFile = TestFiles.ThreeLayoutsDwf;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
RenderOptions = new RenderOptions
{
CadOptions = new CadOptions
{
Width = 800
}
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(3, viewResult.Pages.Count);
}
public void TestCreateViewWithStartPageAndCountPages()
{
// Arrange
var testFile = TestFiles.FourPagesDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
RenderOptions = new RenderOptions
{
StartPageNumber = 2,
CountPagesToRender = 2
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(2, viewResult.Pages.Count);
var page = viewResult.Pages[0];
Assert.AreEqual(2, page.Number);
}
public void TestCreateViewWithMinimalViewOptions()
{
// Arrange
var viewOptions = new ViewOptions
{
FileInfo = TestFiles.PasswordProtectedDocx.ToFileInfo()
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(4, viewResult.Pages.Count);
Assert.AreEqual(0, viewResult.Attachments.Count);
// Download result
var dlRequest = new DownloadFileRequest {
path = viewResult.Pages[0].Path
};
var response = FileApi.DownloadFile(dlRequest);
Assert.Greater(response.Length, 0);
}
public void TestCreateViewWithSpreadsheetPaginateSheetsOption()
{
// Arrange
var testFile = TestFiles.WithHiddenRowsAndColumns;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
RenderOptions = new RenderOptions
{
SpreadsheetOptions = new SpreadsheetOptions
{
PaginateSheets = true,
CountRowsPerPage = 5
}
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.AreEqual(3, viewResult.Pages.Count);
}
public static void Run()
{
var configuration = new Configuration(Common.MyAppSid, Common.MyAppKey);
var apiInstance = new ViewApi(configuration);
try
{
var viewOptions = new ViewOptions()
{
FileInfo = new FileInfo()
{
FilePath = "viewerdocs/sample.mpp",
Password = "",
StorageName = Common.MyStorage
},
RenderOptions = new RenderOptions()
{
ProjectManagementOptions = new ProjectManagementOptions()
{
PageSize = "Unknown",
TimeUnit = "Months",
StartDate = new DateTime(2008, 7, 1),
EndDate = new DateTime(2008, 7, 31)
}
}
};
var request = new CreateViewRequest(viewOptions);
var response = apiInstance.CreateView(request);
Console.WriteLine("Expected response type is ViewResult: " + response.Pages.Count.ToString());
}
catch (Exception e)
{
Console.WriteLine("Exception while calling ViewApi: " + e.Message);
}
}
protected override void ProcessRecord()
{
base.ProcessRecord();
CreateViewRequest request;
try
{
request = new CreateViewRequest
{
CreateViewDetails = CreateViewDetails,
OpcRetryToken = OpcRetryToken,
OpcRequestId = OpcRequestId,
Scope = Scope
};
response = client.CreateView(request).GetAwaiter().GetResult();
WriteOutput(response, response.View);
FinishProcessing(response);
}
catch (Exception ex)
{
TerminatingErrorDuringExecution(ex);
}
}
public void TestCreateViewWithPdfViewOptions()
{
// Arrange
var testFile = TestFiles.OnePageDocx;
var viewOptions = new ViewOptions
{
FileInfo = testFile.ToFileInfo(),
ViewFormat = ViewOptions.ViewFormatEnum.PDF,
RenderOptions = new PdfOptions
{
PermissionsPassword = "******",
Permissions = new List <string> {
"DenyPrinting"
}
}
};
var request = new CreateViewRequest(viewOptions);
// Act & Assert
var viewResult = ViewApi.CreateView(request);
Assert.NotNull(viewResult.File.DownloadUrl);
}
