CODOrientationProperties Class

class CODOrientationProperties: public CODProperty, public CPropertyContainer< IODPropertyContainer, sfl::CPropertyAccessor< CODOrientationProperties > >

Determines the orientation of a label or component in relation to its container. The orientation is defined by an OD_CONTROL_POINT value that indicates a location in the container object. Horizontal and vertical offset values can also be specified.

This class is both a property and a container for properties. It implements the IODPropertyContainer interface for getting and setting values that it contains. Each sub-property contained by orientation property objects has a unique identifier (see Orientation Property Identifiers) for getting and setting each value. There are also methods to directly set each property.

Defined in: OdOrientationProp.h

Class Members

VIEWS_API CODOrientationProperties(int nId = OD_PROP_ORIENTATION)

Constructor.

VIEWS_API CODOrientationProperties(const CODOrientationProperties& propOrientation)

Copy constructor.

VIEWS_API virtual ~CODOrientationProperties()

Destructor.

OD_CONTROL_POINT m_ctlPoint

Position with respect to container.

int m_nHorzSpacing

Horizontal spacing between container control point and component.

int m_nVertSpacing

Vertical spacing between container control point and component.

VIEWS_API OD_CONTROL_POINT GetControlPoint() const

Gets the control point that defines the orientation value.

VIEWS_API void SetControlPoint(const OD_CONTROL_POINT ctlPoint)

Sets the control point that defines the orientation value.

VIEWS_API int GetHorizontalSpacing() const

Gets the horizontal spacing between container control point and component.

VIEWS_API void SetHorizontalSpacing(const int nHorzSpacing)

Sets the horizontal spacing between container control point and component.

VIEWS_API int GetVerticalSpacing() const

Gets the vertical spacing between container control point and component.

VIEWS_API void SetVerticalSpacing(const int nVertSpacing)

Sets the vertical spacing between container control point and component.

VIEWS_API virtual BOOL CompareId(const int nId) const

Compare the property identifier with another identifier.

VIEWS_API CODOrientationProperties& operator=(const CODOrientationProperties& propOrientation)

Assigns another property to this property.

VIEWS_API BOOL operator==(const CODOrientationProperties propOrientation) const

Compares two orientation properties.

VIEWS_API virtual CODProperty* Dup()

Makes a copy of this properties object.

VIEWS_API virtual void Merge(CODProperty* pProperty, DWORD dwChangeFlags = OD_CHANGE_ALL)

Merges another set of properties with this one.

VIEWS_API virtual BOOL IsEqual(CODProperty* pProp)

Determines if another set of properties is equal to this one.

VIEWS_API ULONG STDMETHODCALLTYPE AddRef()

Add a reference to this object.

VIEWS_API ULONG STDMETHODCALLTYPE Release()

Release a reference to this object.

VIEWS_API virtual BOOL GetValue(const int nPropId, CString& strValue) const

Gets the value of the given string property.

VIEWS_API virtual BOOL GetValue(const int nPropId, int& nValue) const

Gets the value of the given integer property.

VIEWS_API virtual BOOL GetValue(const int nPropId, UINT& nValue) const

Gets the value of the given unsigned integer property.

VIEWS_API virtual BOOL GetValue(const int nPropId, DWORD& dwValue) const

Gets the value of the given DWORD property.

VIEWS_API virtual BOOL GetValue(const int nPropId, float& fValue) const

Gets the value of the given float property.

VIEWS_API virtual BOOL SetValue(const int nPropId, LPCTSTR lpszValue)

Sets the value of the given string property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const int nValue)

Sets the value of the given integer property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const UINT nValue)

Sets the value of the given unsigned integer property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const DWORD dwValue)

Sets the value of the given unsigned DWORD property.

VIEWS_API virtual BOOL SetValue(const int nPropId, const float fValue)

Sets the value of the given float property.

VIEWS_API virtual void Serialize(CArchive& ar)

Serializes the orientation properties.