LAnnotation::SetAutoDefaults

#include "ltwrappr.h"

virtual L_INT LAnnotation::SetAutoDefaults(hAutoObject, uFlags=0)

virtual L_INT LAnnotation::SetAutoDefaults(AnnAuto, uFlags=0)

HANNOBJECT hAutoObject;	/* handle to the automation object.*/
LAnnAutomation &AnnAuto;	/* automation object.*/
L_UINT uFlags;	/* flags that determine which objects to process */

Assigns the default properties of the specified automation object to an annotation object.

Parameter	Description
hAutoObject	Handle to an automation object.
AnnAuto	The automation object.
uFlags	Flags that determine which objects to process. Most of the flags apply only to container objects. You can combine values when appropriate by using a bitwise OR ( \| ). The following are valid values:
	Value	Meaning
	0	Process only the specified object.
	ANNFLAG_SELECTED	[0x0001] Process only objects that have the selected property set to TRUE. For getting and setting the selected property, use the LAnnContainer::GetSelectItems and LAnnotation::SetSelected functions.
	ANNFLAG_NOTTHIS	[0x0004] Process only one level of objects within the specified container, not the container itself. If there are containers within the container, they are modified, but the objects within them are not.
	ANNFLAG_RECURSE	[0x0008] Process objects within a container, and within any subcontainers, down to any level.
	ANNFLAG_NOTCONTAINER	[0x0002] (Used with ANNFLAG_RECURSE) Process objects within containers, not the containers themselves.
	ANNFLAG_NOINVALIDATE	[0x0010] Do not invalidate the affected rectangle in the window. Use this to avoid generating unwanted paint messages.

Returns

SUCCESS	The function was successful.
< 1	An error occurred. Refer to Return Codes.

Comments

This function simulates the action that takes place when an annotation object is created using the automated mode. An annotation object created in automated mode receives the same default properties as the automation object, such as foreground color, line width, etc. This lets you assign the same default properties in an automation object to the specified annotation object.

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:	LAnnotation::SetAutoSnapCursor, LAnnotation::GetAutoSnapCursor
Topics:	Annotation Functions: Working with the Toolbar

Example

This is an example, for both:

LAnnotation::SetAutoDefaults( HANNOBJECT hAutoObject, L_UINT uFlags=0)

LAnnotation::SetAutoDefaults( LAnnAutomation &AnnAuto, L_UINT uFlags=0)

L_INT LAnnotation_SetAutoDefaultsExample()
{
   LSettings::UnlockSupport(L_SUPPORT_DOCUMENT, L_KEY_DOCUMENT);
   L_TCHAR szFontName[100];
   L_UINT  uLen = 0;
   LAnnAutomation AnnAutomation;
   AnnAutomation.AddUndoNode();
   AnnAutomation.SetFontName(TEXT("Courier"));
   LAnnNote MyNote;
   //Automation default font is set to Courier
   //MyNote.SetAutoDefaults(AnnAutomation.GetHandle());
   //Another way
   MyNote.SetAutoDefaults(AnnAutomation);
   MyNote.GetFontName(szFontName, &uLen);
   //Note font name is same as Automation (Courier)
   AfxMessageBox(szFontName);
   return SUCCESS;
}