ITextRow::GetCellShading method (tom.h)
Gets the shading of the active cell.
Syntax
HRESULT GetCellShading(
[out, retval] long *pValue
);
Parameters
[out, retval] pValue
Type: long*
The shading of the active cell. See Remarks.
Return value
Type: HRESULT
If the method succeeds, it returns NOERROR. Otherwise, it returns an HRESULT error code.
Remarks
The shading is given in hundredths of a percent, so full shading is given by the value 10000. The shading percentage determines the mix of the cell foreground and background colors to be used for the cell background. A shading of 0 uses the cell background color alone. A shading of 10000 (100%) uses the foreground color alone. Values in between mix the foreground and background colors, weighting the background with (10000 – CellShading)/1000 and the foreground with CellShading/1000. These ratios are applied to the red, green, and blue channels independently of one another.
Requirements
Requirement | Value |
---|---|
Minimum supported client | Windows 8 [desktop apps only] |
Minimum supported server | Windows Server 2012 [desktop apps only] |
Target Platform | Windows |
Header | tom.h |
DLL | Msftedit.dll |