/// <summary>
/// Returns an object that contains the css page dimensions comparing the BoxModel to the LayoutMetrics
/// </summary>
/// <remarks>
/// This forces a layout and node ids obtained before this may not be valid.
/// </remarks>
/// <returns></returns>
public static async Task <PageDimensions> GetPageDimensions(this Page.PageAdapter pageAdapter, Dom.GetBoxModelCommandResponse documentBoxModel = null, Page.GetLayoutMetricsCommandResponse layoutMetrics = null, long?documentNodeId = null)
{
if (documentBoxModel == null || layoutMetrics == null)
{
if (documentNodeId.HasValue == false)
{
var documentNode = await pageAdapter.Session.DOM.GetDocument(1);
documentNodeId = documentNode.NodeId;
}
if (documentBoxModel == null)
{
documentBoxModel = await pageAdapter.Session.DOM.GetBoxModel(new Dom.GetBoxModelCommand
{
NodeId = documentNodeId.Value
});
}
if (layoutMetrics == null)
{
layoutMetrics = await pageAdapter.Session.Page.GetLayoutMetrics();
}
}
double scaleX = layoutMetrics.LayoutViewport.ClientWidth / documentBoxModel.Model.Width;
double scaleY = layoutMetrics.LayoutViewport.ClientHeight / documentBoxModel.Model.Height;
if (scaleX != scaleY)
{
throw new InvalidOperationException($"Did not expect a non-proportional scale factor: scaleX:{scaleX} scaleY: {scaleY}");
}
return(new PageDimensions
{
DevicePixelRatio = scaleX,
FullHeight = (long)Math.Round((layoutMetrics.LayoutViewport.PageY / scaleY) + (layoutMetrics.LayoutViewport.ClientHeight / scaleY)),
FullWidth = (long)Math.Round((layoutMetrics.LayoutViewport.PageX / scaleX) + (layoutMetrics.LayoutViewport.ClientWidth / scaleX)),
OriginalOverflowStyle = "",
ScrollX = (long)layoutMetrics.VisualViewport.PageX,
ScrollY = (long)layoutMetrics.VisualViewport.PageY,
WindowHeight = (long)(layoutMetrics.VisualViewport.ClientHeight / scaleY),
WindowWidth = (long)(layoutMetrics.VisualViewport.ClientWidth / scaleY)
});
}
/// <summary>
/// Saves an image of the entire contents of the current page.
/// </summary>
/// <returns></returns>
public static async Task TakeFullPageScreenshot(this Page.PageAdapter pageAdapter, string outputFileName, CancellationToken cancellationToken = default(CancellationToken), int millisecondsTimeout = 60000)
{
if (String.IsNullOrWhiteSpace(outputFileName))
{
throw new ArgumentNullException(nameof(outputFileName));
}
var dimensions = await pageAdapter.Session.Page.GetPageDimensions();
//m_logger.LogDebug("{functionName} taking full page screenshot ({width}x{height})", nameof(TakeFullPageScreenshot), dimensions.FullWidth, dimensions.FullHeight);
//TODO: This needs to be improved -- it appears that the max visible size in any dimension
//is around 8192px - pages greater than 8192px will be clipped. This method should limit size
// to 8192 (or the actual max) take multiple shots of this size and stich the resulting images
// together.
//Set the visible size to the full page size.
await pageAdapter.Session.Emulation.SetVisibleSize(new Emulation.SetVisibleSizeCommand
{
Width = (long)dimensions.FullWidth,
Height = (long)dimensions.FullHeight
}, cancellationToken : cancellationToken);
var result = await pageAdapter.Session.SendCommand <Page.CaptureScreenshotCommand, Page.CaptureScreenshotCommandResponse>(new Page.CaptureScreenshotCommand
{
Format = "png"
}, cancellationToken : cancellationToken, millisecondsTimeout : millisecondsTimeout);
var imageBytes = Convert.FromBase64String(result.Data);
//m_logger.LogDebug("{functionName} Saving screenshot to {fileName}", nameof(TakeFullPageScreenshot), outputFileName);
File.WriteAllBytes(outputFileName, imageBytes);
//m_logger.LogDebug("{functionName} wrote {bytes} bytes to {fileName}", nameof(TakeFullPageScreenshot), imageBytes.LongCount(), outputFileName);
imageBytes = null;
result = null;
//Set the visible size back to the original size.
await pageAdapter.Session.Emulation.SetVisibleSize(new Emulation.SetVisibleSizeCommand
{
Width = (long)dimensions.WindowWidth,
Height = (long)dimensions.WindowHeight
}, cancellationToken : cancellationToken);
}
public static async Task <Page.GetLayoutMetricsCommandResponse> GetLayoutMetrics(this Page.PageAdapter pageAdapter)
{
return(await pageAdapter.Session.Page.GetLayoutMetrics(new Page.GetLayoutMetricsCommand
{
}));
}
/// <summary>
/// Returns the present frame / resource tree structure.
/// </summary>
/// <returns></returns>
public static async Task <Page.FrameResourceTree> GetResourceTree(this Page.PageAdapter pageAdapter)
{
var getFramesResponse = await pageAdapter.Session.SendCommand <Page.GetResourceTreeCommand, Page.GetResourceTreeCommandResponse>(new Page.GetResourceTreeCommand());
return(getFramesResponse.FrameTree);
}
