L_AnnTextEdit

#include "l_bitmap.h"

L_LTANN_API L_INT L_AnnTextEdit (hObject);

HANNOBJECT hObject;

handle to the text-based annotation object

This function causes a text-based annotation to enter edit mode.

Parameter

Description

hObject

Handle to the text-based annotation object.

Returns

SUCCESS

The function was successful.

< 1

An error occurred. Refer to Return Codes.

Comments

This function causes a text-based annotation to enter edit mode, which displays an edit window for direct entry of text. Calling this function allows a user to programmatically force an object into edit modean action that is normally available in automation mode when creating or double-clicking text-based annotations.

It can be used with any of the text-based annotations including:

A successful call to L_AnnSetText() affects hObject in the following way:

Only one object can be in text edit mode. Therefore, if another text object is in text edit mode (hObject2), calling L_AnnTextEdit(), will get hObject2 out of the text edit mode, and put hObject into the text edit mode.

This function will fail with ERROR_AUTOMATION_INV_HANDLE if hObject is not contained in the root container and if it is not in the automated mode.

This function works only with the following objects:

If you pass an object that is not one of these types, the function will return ERROR_INV_PARAMETER.

Required DLLs and Libraries

LTANN

For a listing of the exact DLLs and Libraries needed, based on the toolkit version, refer to Files To Be Included With Your Application.

Platforms

Win32, x64.

See Also

Functions:

L_AnnGetText, L_AnnGetTextLen, L_AnnGetAutoText, L_AnnGetAutoTextLen, L_AnnSetAutoText, L_AnnSetTextRTF, L_AnnGetTextRTF, L_AnnGetTextAlign, L_AnnSetTextAlign

Topics:

Annotation Objects - Automated Features

 

Annotation Functions (Document/Medical only): Getting and Setting Text Properties

Example

This example programmatically makes an annotation text object hObject go into edit mode. Note that hObject must be a annotation.

L_INT AnnTextEditExample(HANNOBJECT hObject)  
{ 
   L_INT    nRet     = SUCCESS; 
   L_TCHAR* pszError = NULL; 
 
   nRet = L_AnnTextEdit(hObject); 
   switch(nRet) 
   { 
   case SUCCESS: 
      pszError = NULL; 
      break; 
   case ERROR_AUTOMATION_INV_HANDLE: 
      pszError = TEXT("L_AnnTextEdit failed because you are not in automated mode"); 
      break;  
   case ERROR_INV_PARAMETER: 
      pszError = TEXT("L_AnnTextEdit failed because hObject was not text-based"); 
      break; 
   default: 
      pszError = TEXT("L_AnnTextEdit failed"); 
      break; 
   } 
 
   if (pszError) 
      MessageBox(NULL, pszError, TEXT("Error"), MB_OK); 
   return nRet; 
} 

Help Version 20.0.2018.1.19
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.
LEADTOOLS Raster Imaging C API Help