Previous: gotoPage	Up: Dixie2.0	Next: HighlightText
HighlightHyperlink (from DixieCtl.cpp)

Set a region to be a hyperlink area.

long CDixieCtrl HighlightHyperlink ( long FAR *rectList, long FAR *colorList, long rectCount, long pageNum, LPCTSTR linkString, BOOL dispUpdate );

Summary

Parameters

rectList A list of rectangle region for the text string to be highlighted as hyperlink.

colorList A list of color value (COLORREF) for each rectangle, specifing the text color in that rectangle.

rectCount Number of rectangles.

pageNum The page number where this hyperlink is on.

textString The hyperlink text.

dispUpdate Boolean value determines if the display will be updated following this function. Set this value to true if you want to see this hyperlink rightaway. If you are adding multiple hyperlinks, it's more efficient to set this value true for the last item.

Return Value

0 fail
1 success

rectList		A list of rectangle region for the text string to be highlighted as hyperlink.
colorList		A list of color value (`COLORREF`) for each rectangle, specifing the text color in that rectangle.
rectCount		Number of rectangles.
pageNum		The page number where this hyperlink is on.
textString		The hyperlink text.
dispUpdate		Boolean value determines if the display will be updated following this function. Set this value to true if you want to see this hyperlink rightaway. If you are adding multiple hyperlinks, it's more efficient to set this value true for the last item.