CogOCVMaxFont.GetLineSpacingX Method

CogOCVMaxFont GetLineSpacingX Method

Cognex VisionPro 9.7

This is the (horizontal) spacing between adjacent line origins in this font, as interpreted using the supplied CogOCVMaxFontRenderParams object. Generally this will be the same as the value returned by the LineSpacingX property getter. If, however, SpotSpacingUsed is true for this font, then the value returned by this method will be the value returned by the LineSpacingX getter multiplied by the supplied render params object's SpotSpacingScaleX property.

Namespace: Cognex.VisionPro.OCVMax
Assembly: Cognex.VisionPro.OCVMax (in Cognex.VisionPro.OCVMax.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public double GetLineSpacingX(
	CogOCVMaxFontRenderParams renderParams
)

public double GetLineSpacingX(
	CogOCVMaxFontRenderParams renderParams
)

Public Function GetLineSpacingX ( 
	renderParams As CogOCVMaxFontRenderParams
) As Double

Public Function GetLineSpacingX ( 
	renderParams As CogOCVMaxFontRenderParams
) As Double

public:
double GetLineSpacingX(
	CogOCVMaxFontRenderParams^ renderParams
)

public:
double GetLineSpacingX(
	CogOCVMaxFontRenderParams^ renderParams
)

Parameters

renderParams: Type: Cognex.VisionPro.OCVMax CogOCVMaxFontRenderParams
A CogOCVMaxFontRenderParams object that will be used to interpret the cached LineSpacingX value.

Return Value

Type: Double
A System::Double, this is typically zero. A non-zero value means that a line will be staggered with respect to the next line.

Exceptions

Exception	Condition
InvalidOperationException	If a font has not yet been imported, or if an internal error occurs.
ObjectDisposedException	If this CogOCVMaxFont object has already been disposed.
ArgumentNullException	If the renderParams argument is NULL.