xtd 0.2.0
Loading...
Searching...
No Matches
xtd::forms::create_params Class Reference
Inheritance diagram for xtd::forms::create_params:
xtd::object

Definition

Encapsulates the information needed when creating a control.

Header
#include <xtd/forms/create_params>
Namespace
xtd::forms
Library
xtd.forms
Remarks
The information in a create_params can be used to pass information about the initial state and appearance of a control. Most control derived controls override the create_params property to pass in the appropriate values or include additional information in the create_params.
Note
The constants used to set the style, ex_style, and class_style properties are defined in the xtd.forms.native library as constants.

Public Constructors

 create_params ()
 Initializes a new instance of the create_params class.
 

Public Properties

const xtd::stringcaption () const noexcept
 Gets the control's initial text.
 
create_paramscaption (const xtd::string &caption)
 Gets the control's initial text.
 
const xtd::stringclass_name () const noexcept
 Gets the name of the Windows class to derive the control from.
 
create_paramsclass_name (const xtd::string &class_name)
 Sets the name of the Windows class to derive the control from.
 
size_t class_style () const noexcept
 Gets a bitwise combination of class style values.
 
create_paramsclass_style (size_t class_style)
 Gets a bitwise combination of class style values.
 
size_t ex_style () const noexcept
 Gets a bitwise combination of extended window style values.
 
create_paramsex_style (size_t ex_style)
 Sets a bitwise combination of extended window style values.
 
int32 height () const noexcept
 Gets the initial height of the control.
 
create_paramsheight (int32 height)
 Sets the initial height of the control.
 
drawing::point location () const noexcept
 Gets the initial location of the control.
 
create_paramslocation (const drawing::point location)
 Sets the initial location of the control.
 
intptr param () const noexcept
 Gets additional parameter information needed to create the control.
 
create_paramsparam (intptr param)
 Sets additional parameter information needed to create the control.
 
intptr parent () const noexcept
 Gets or sets the control's parent.
 
create_paramsparent (intptr parent)
 Sets or sets the control's parent.
 
size_t style () const noexcept
 Gets a bitwise combination of window style values.
 
create_paramsstyle (size_t style)
 Sets a bitwise combination of window style values.
 
drawing::size size () const noexcept
 Gets the initial size of the control.
 
create_paramssize (const drawing::size size)
 Sets the initial size of the control.
 
int32 width () const noexcept
 Gets the initial width of the control.
 
create_paramswidth (int32 width)
 Sets the initial width of the control.
 
int32 x () const noexcept
 Gets the initial left position of the control.
 
create_paramsx (int32 x)
 Sets the initial left position of the control.
 
int32 y () const noexcept
 Gets the initial top position of the control.
 
create_paramsy (int32 y)
 Sets the initial top position of the control.
 

Public Methods

xtd::string to_string () const noexcept override
 Returns a string that represents the current object.
 

Additional Inherited Members

- Public Member Functions inherited from xtd::object
 object ()=default
 Create a new instance of the ultimate base class object.
 
virtual bool equals (const object &obj) const noexcept
 Determines whether the specified object is equal to the current object.
 
virtual size_t get_hash_code () const noexcept
 Serves as a hash function for a particular type.
 
virtual type_object get_type () const noexcept
 Gets the type of the current instance.
 
template<typename object_t >
xtd::uptr< object_t > memberwise_clone () const
 Creates a shallow copy of the current object.
 
- Static Public Member Functions inherited from xtd::object
template<typename object_a_t , typename object_b_t >
static bool equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are considered equal.
 
template<typename object_a_t , typename object_b_t >
static bool reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept
 Determines whether the specified object instances are the same instance.
 

Constructor & Destructor Documentation

◆ create_params()

xtd::forms::create_params::create_params ( )

Initializes a new instance of the create_params class.

Member Function Documentation

◆ caption() [1/2]

const xtd::string & xtd::forms::create_params::caption ( ) const
noexcept

Gets the control's initial text.

Returns
The control's initial text.

◆ caption() [2/2]

create_params & xtd::forms::create_params::caption ( const xtd::string caption)

Gets the control's initial text.

Parameters
captionThe control's initial text.
Returns
Current create_params instance.

◆ class_name() [1/2]

const xtd::string & xtd::forms::create_params::class_name ( ) const
noexcept

Gets the name of the Windows class to derive the control from.

Returns
The name of the Windows class to derive the control from.
Remarks
The default value for this property is empty (""), indicating that the control is not derived from an existing control class. To derive from an existing control class, store the system class name in this property. For example, to derive from the standard Button control, set this property to "button".

◆ class_name() [2/2]

create_params & xtd::forms::create_params::class_name ( const xtd::string class_name)

Sets the name of the Windows class to derive the control from.

Parameters
class_nameThe name of the Windows class to derive the control from.
Returns
Current create_param instance.
Remarks
The default value for this property is empty (""), indicating that the control is not derived from an existing control class. To derive from an existing control class, store the system class name in this property. For example, to derive from the standard Button control, set this property to "button".

◆ class_style() [1/2]

size_t xtd::forms::create_params::class_style ( ) const
noexcept

Gets a bitwise combination of class style values.

Returns
A bitwise combination of the class style values.
Remarks
see class_styles.h file

◆ class_style() [2/2]

create_params & xtd::forms::create_params::class_style ( size_t  class_style)

Gets a bitwise combination of class style values.

Parameters
class_styleA bitwise combination of the class style values.
Returns
Current create_param instance.
Remarks
see class_styles.h file

◆ ex_style() [1/2]

size_t xtd::forms::create_params::ex_style ( ) const
noexcept

Gets a bitwise combination of extended window style values.

Returns
A bitwise combination of the extended window style values.
Remarks
The ex_style property supports extended appearance and initial state values to apply to the control.
see window_styles.h file

◆ ex_style() [2/2]

create_params & xtd::forms::create_params::ex_style ( size_t  ex_style)

Sets a bitwise combination of extended window style values.

Parameters
ex_styleA bitwise combination of the extended window style values.
Returns
Current create_param instance.
Remarks
The ex_style property supports extended appearance and initial state values to apply to the control.
see window_styles.h file

◆ height() [1/2]

int32 xtd::forms::create_params::height ( ) const
noexcept

Gets the initial height of the control.

Returns
The numeric value that represents the initial height of the control.

◆ height() [2/2]

create_params & xtd::forms::create_params::height ( int32  height)

Sets the initial height of the control.

Parameters
heightThe numeric value that represents the initial height of the control.
Returns
Current create_param instance.

◆ location() [1/2]

drawing::point xtd::forms::create_params::location ( ) const
noexcept

Gets the initial location of the control.

Returns
The xtd::drawing::point that represents the initial location of the control.

◆ location() [2/2]

create_params & xtd::forms::create_params::location ( const drawing::point  location)

Sets the initial location of the control.

Parameters
locationThe xtd::drawing::point that represents the initial location of the control.
Returns
Current create_param instance.

◆ param() [1/2]

intptr xtd::forms::create_params::param ( ) const
noexcept

Gets additional parameter information needed to create the control.

Returns
An intptr that holds additional parameter information needed to create the control.

◆ param() [2/2]

create_params & xtd::forms::create_params::param ( intptr  param)

Sets additional parameter information needed to create the control.

Parameters
paramAn intptr that holds additional parameter information needed to create the control.
Returns
Current create_param instance.

◆ parent() [1/2]

intptr xtd::forms::create_params::parent ( ) const
noexcept

Gets or sets the control's parent.

Returns
An intptr that contains the window handle of the control's parent.

◆ parent() [2/2]

create_params & xtd::forms::create_params::parent ( intptr  parent)

Sets or sets the control's parent.

Parameters
parentAn intptr that contains the window handle of the control's parent.
Returns
Current create_param instance.

◆ style() [1/2]

size_t xtd::forms::create_params::style ( ) const
noexcept

Gets a bitwise combination of window style values.

Returns
A bitwise combination of the window style values.
Remarks
The Style property controls the appearance of the control and its initial state.

◆ style() [2/2]

create_params & xtd::forms::create_params::style ( size_t  style)

Sets a bitwise combination of window style values.

Parameters
styleA bitwise combination of the window style values.
Returns
Current create_param instance.
Remarks
The Style property controls the appearance of the control and its initial state.

◆ size() [1/2]

drawing::size xtd::forms::create_params::size ( ) const
noexcept

Gets the initial size of the control.

Returns
The xtd::drawing::size that represents the initial size of the control.

◆ size() [2/2]

create_params & xtd::forms::create_params::size ( const drawing::size  size)

Sets the initial size of the control.

Parameters
locationThe xtd::drawing::size that represents the initial size of the control.
Returns
Current create_param instance.

◆ width() [1/2]

int32 xtd::forms::create_params::width ( ) const
noexcept

Gets the initial width of the control.

Returns
The numeric value that represents the initial width of the control.

◆ width() [2/2]

create_params & xtd::forms::create_params::width ( int32  width)

Sets the initial width of the control.

Parameters
heightThe numeric value that represents the initial width of the control.
Returns
Current create_param instance.

◆ x() [1/2]

int32 xtd::forms::create_params::x ( ) const
noexcept

Gets the initial left position of the control.

Returns
The numeric value that represents the initial left position of the control.

◆ x() [2/2]

create_params & xtd::forms::create_params::x ( int32  x)

Sets the initial left position of the control.

Parameters
xThe numeric value that represents the initial left position of the control.
Returns
Current create_param instance.

◆ y() [1/2]

int32 xtd::forms::create_params::y ( ) const
noexcept

Gets the initial top position of the control.

Returns
The numeric value that represents the initial top position of the control.

◆ y() [2/2]

create_params & xtd::forms::create_params::y ( int32  y)

Sets the initial top position of the control.

Parameters
xThe numeric value that represents the initial top position of the control.
Returns
Current create_param instance.

◆ to_string()

xtd::string xtd::forms::create_params::to_string ( ) const
overridevirtualnoexcept

Returns a string that represents the current object.

Returns
A string that represents the current object.

Reimplemented from xtd::object.


The documentation for this class was generated from the following file: