SftTree/DLL 7.5 - Tree Control

RowColFooterText

Defines the row/column footer text.

C

int SftTree_GetRowColFooterText(HWND hwndCtl, LPTSTR lpszBuffer, int cbMax);
int WINAPI SftTree_GetRowColFooterText_A(HWND hwndCtl, LPSTR lpszBuffer, int cbMax);
int WINAPI SftTree_GetRowColFooterText_W(HWND hwndCtl, LPWSTR lpszBuffer, int cbMax);
BOOL SftTree_SetRowColFooterText(HWND hwndCtl, LPCTSTR lpszBuffer);
BOOL WINAPI SftTree_SetRowColFooterText_A(HWND hwndCtl, LPCSTR lpszBuffer);
BOOL WINAPI SftTree_SetRowColFooterText_W(HWND hwndCtl, LPCWSTR lpszBuffer);
int WINAPI SftTreeSplit_GetRowColFooterText(HWND hwndCtl, LPTSTR lpszBuffer, int cbMax);
int WINAPI SftTreeSplit_GetRowColFooterText_A(HWND hwndCtl, LPSTR lpszBuffer, int cbMax);
int WINAPI SftTreeSplit_GetRowColFooterText_W(HWND hwndCtl, LPWSTR lpszBuffer, int cbMax);
BOOL WINAPI SftTreeSplit_SetRowColFooterText(HWND hwndCtl, LPCTSTR lpszBuffer);
BOOL WINAPI SftTreeSplit_SetRowColFooterText_A(HWND hwndCtl, LPCSTR lpszBuffer);
BOOL WINAPI SftTreeSplit_SetRowColFooterText_W(HWND hwndCtl, LPCWSTR lpszBuffer);

C++

void CSftTree::GetRowColFooterText(CString& string) const;
int CSftTree::GetRowColFooterText(LPTSTR lpszBuffer, int cbMax) const;
BOOL CSftTree::SetRowColFooterText(LPCTSTR lpszBuffer);
void CSftTreeSplit::GetRowColFooterText(CString& string) const;
int CSftTreeSplit::GetRowColFooterText(LPTSTR lpszBuffer, int cbMax) const;
BOOL CSftTreeSplit::SetRowColFooterText(LPCTSTR lpszBuffer);

Parameters

hwndCtl

The window handle of the tree control.

lpszBuffer

A pointer to a buffer where the row/column footer text will be returned (GetRowColFooterText) or a buffer containing the new row/column footer text (SetRowColFooterText).

string

A reference to a CString object, where the row/column footer text will be returned.

cbMax

The maximum number of characters to be returned in the buffer pointed to by lpszBuffer, including the terminating '\0'.

Returns

GetRowColFooterText returns the number of characters returned in the buffer, not including the terminating '\0'. If the buffer is too small to receive the complete header text, the text is truncated. -1 is returned if an error occurred.

SetRowColFooterText returns TRUE if the function was successful, otherwise FALSE is returned.

Comments

The GetRowColFooterText and SetRowColFooterText functions define the row/column footer text.

GetRowColFooterTextLen can be used to determine the required lpszBuffer size.

Row/column footer text may contain multiple lines of text, delimited using cr-lf (\r\n), based on the settings defined using MultilineFooter and it must contain the same or fewer lines of text as defined for all column footers.

The row/column footer area is only shown if row headers and column footers are both shown (see SetShowRowHeader and SetShowFooter).

See Also C/C++ API | Categories | Notifications