DocumentReaderGetProcessedImage Method Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Gets the virtual path to a processed, cached image given its original virtual path. This method does not running under remoting

Namespace: ContentStudio.Document
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetProcessedImage(
	ConnectionId connectionId,
	SessionId sessionId,
	string virtualPath,
	int width = 0,
	int height = 0,
	Rectangle cropInfo = null,
	long compression = 0,
	double ratio = 0,
	DocumentReaderRatioCropPosition ratioCropPosition = DocumentReaderRatioCropPosition.Center,
	bool useSmartResize = false,
	Point ratioCropPositionCenterPoint = null,
	int maxWidth = 0,
	int maxHeight = 0


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemString
The virtual path.
width (Optional)
Type: SystemInt32
The width.
height (Optional)
Type: SystemInt32
The height.
cropInfo (Optional)
Type: System.DrawingRectangle
The bounds of cropped image.
compression (Optional)
Type: SystemInt64
The compression.
ratio (Optional)
Type: SystemDouble
The ratio.
ratioCropPosition (Optional)
Type: ContentStudio.DocumentDocumentReaderRatioCropPosition
The ratio crop position.
useSmartResize (Optional)
Type: SystemBoolean
if set to true to use smart resize.
ratioCropPositionCenterPoint (Optional)
Type: System.DrawingPoint
The ratio crop position center point.
maxWidth (Optional)
Type: SystemInt32
The maximum width.
maxHeight (Optional)
Type: SystemInt32
The maximum height.

Return Value

Type: String
The virtual path to the processed image.


This method was added in Content Studio 5.7.
See Also