Inheritance diagram for xtd::forms::create_params:

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
auto	caption () const noexcept -> const xtd::string &
	Gets the control's initial text.
auto	caption (const xtd::string &value) -> create_params &
	Gets the control's initial text.
auto	class_name () const noexcept -> const xtd::string &
	Gets the name of the Windows class to derive the control from.
auto	class_name (const xtd::string &value) -> create_params &
	Sets the name of the Windows class to derive the control from.
auto	class_style () const noexcept -> xtd::usize
	Gets a bitwise combination of class style values.
auto	class_style (xtd::usize value) -> create_params &
	Gets a bitwise combination of class style values.
auto	ex_style () const noexcept -> xtd::usize
	Gets a bitwise combination of extended window style values.
auto	ex_style (xtd::usize value) -> create_params &
	Sets a bitwise combination of extended window style values.
auto	height () const noexcept -> xtd::int32
	Gets the initial height of the control.
auto	height (xtd::int32 value) -> create_params &
	Sets the initial height of the control.
auto	location () const noexcept -> xtd::drawing::point
	Gets the initial location of the control.
auto	location (const xtd::drawing::point value) -> create_params &
	Sets the initial location of the control.
auto	param () const noexcept -> xtd::intptr
	Gets additional parameter information needed to create the control.
auto	param (xtd::intptr value) -> create_params &
	Sets additional parameter information needed to create the control.
auto	parent () const noexcept -> xtd::intptr
	Gets or sets the control's parent.
auto	parent (xtd::intptr value) -> create_params &
	Sets or sets the control's parent.
auto	style () const noexcept -> xtd::usize
	Gets a bitwise combination of window style values.
auto	style (xtd::usize value) -> create_params &
	Sets a bitwise combination of window style values.
auto	size () const noexcept -> xtd::drawing::size
	Gets the initial size of the control.
auto	size (const xtd::drawing::size value) -> create_params &
	Sets the initial size of the control.
auto	width () const noexcept -> xtd::int32
	Gets the initial width of the control.
auto	width (xtd::int32 value) -> create_params &
	Sets the initial width of the control.
auto	x () const noexcept -> xtd::int32
	Gets the initial left position of the control.
auto	x (xtd::int32 value) -> create_params &
	Sets the initial left position of the control.
auto	y () const noexcept -> xtd::int32
	Gets the initial top position of the control.
auto	y (xtd::int32 value) -> create_params &
	Sets the initial top position of the control.

Public Methods
auto	equals (const xtd::object &obj) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	equals (const create_params &other) const noexcept -> bool override
	Determines whether the specified object is equal to the current object.
auto	get_hash_code () const noexcept -> xtd::usize override
	Serves as a hash function for a particular type.
auto	to_string () const noexcept -> xtd::string override
	Returns a string that represents the current object.

Additional Inherited Members
	object ()=default
	Create a new instance of the ultimate base class object.
virtual auto	get_type () const noexcept -> type_object
	Gets the type of the current instance.
template<typename object_t>
auto	memberwise_clone () const -> xtd::unique_ptr_object< object_t >
	Creates a shallow copy of the current object.
template<typename object_a_t, typename object_b_t>
static auto	equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	Determines whether the specified object instances are considered equal.
template<typename object_a_t, typename object_b_t>
static auto	reference_equals (const object_a_t &object_a, const object_b_t &object_b) noexcept -> bool
	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]

auto xtd::forms::create_params::caption ( ) const -> const xtd::string &

nodiscardnoexcept

Gets the control's initial text.

Returns: The control's initial text.

◆ caption() [2/2]

auto xtd::forms::create_params::caption ( const xtd::string & value ) -> create_params &

Gets the control's initial text.

Parameters

value The control's initial text.

Returns: Current create_params instance.

◆ class_name() [1/2]

auto xtd::forms::create_params::class_name ( ) const -> const xtd::string &

nodiscardnoexcept

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]

auto xtd::forms::create_params::class_name ( const xtd::string & value ) -> create_params &

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

Parameters

value The 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]

auto xtd::forms::create_params::class_style ( ) const -> xtd::usize

nodiscardnoexcept

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]

auto xtd::forms::create_params::class_style ( xtd::usize value ) -> create_params &

Gets a bitwise combination of class style values.

Parameters

value A bitwise combination of the class style values.

Returns: Current create_param instance.

Remarks: see class_styles.h file

◆ ex_style() [1/2]

auto xtd::forms::create_params::ex_style ( ) const -> xtd::usize

nodiscardnoexcept

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]

auto xtd::forms::create_params::ex_style ( xtd::usize value ) -> create_params &

Sets a bitwise combination of extended window style values.

Parameters

value A 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]

auto xtd::forms::create_params::height ( ) const -> xtd::int32

nodiscardnoexcept

Gets the initial height of the control.

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

◆ height() [2/2]

auto xtd::forms::create_params::height ( xtd::int32 value ) -> create_params &

Sets the initial height of the control.

Parameters

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

Returns: Current create_param instance.

◆ location() [1/2]

auto xtd::forms::create_params::location ( ) const -> xtd::drawing::point

nodiscardnoexcept

Gets the initial location of the control.

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

◆ location() [2/2]

auto xtd::forms::create_params::location ( const xtd::drawing::point value ) -> create_params &

Sets the initial location of the control.

Parameters

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

Returns: Current create_param instance.

◆ param() [1/2]

auto xtd::forms::create_params::param ( ) const -> xtd::intptr

nodiscardnoexcept

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]

auto xtd::forms::create_params::param ( xtd::intptr value ) -> create_params &

Sets additional parameter information needed to create the control.

Parameters

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

Returns: Current create_param instance.

◆ parent() [1/2]

auto xtd::forms::create_params::parent ( ) const -> xtd::intptr

nodiscardnoexcept

Gets or sets the control's parent.

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

◆ parent() [2/2]

auto xtd::forms::create_params::parent ( xtd::intptr value ) -> create_params &

Sets or sets the control's parent.

Parameters

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

Returns: Current create_param instance.

◆ style() [1/2]

auto xtd::forms::create_params::style ( ) const -> xtd::usize

nodiscardnoexcept

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]

auto xtd::forms::create_params::style ( xtd::usize value ) -> create_params &

Sets a bitwise combination of window style values.

Parameters

value A 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]

auto xtd::forms::create_params::size ( ) const -> xtd::drawing::size

nodiscardnoexcept

Gets the initial size of the control.

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

◆ size() [2/2]

auto xtd::forms::create_params::size ( const xtd::drawing::size value ) -> create_params &

Sets the initial size of the control.

Parameters

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

Returns: Current create_param instance.

◆ width() [1/2]

auto xtd::forms::create_params::width ( ) const -> xtd::int32

nodiscardnoexcept

Gets the initial width of the control.

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

◆ width() [2/2]

auto xtd::forms::create_params::width ( xtd::int32 value ) -> create_params &

Sets the initial width of the control.

Parameters

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

Returns: Current create_param instance.

◆ x() [1/2]

auto xtd::forms::create_params::x ( ) const -> xtd::int32

nodiscardnoexcept

Gets the initial left position of the control.

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

◆ x() [2/2]

auto xtd::forms::create_params::x ( xtd::int32 value ) -> create_params &

Sets the initial left position of the control.

Parameters

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

Returns: Current create_param instance.

◆ y() [1/2]

auto xtd::forms::create_params::y ( ) const -> xtd::int32

nodiscardnoexcept

Gets the initial top position of the control.

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

◆ y() [2/2]

auto xtd::forms::create_params::y ( xtd::int32 value ) -> create_params &

Sets the initial top position of the control.

Parameters

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

Returns: Current create_param instance.

◆ equals() [1/2]

auto xtd::forms::create_params::equals ( const xtd::object & obj ) const -> bool

nodiscardoverridevirtualnoexcept

Determines whether the specified object is equal to the current object.

Parameters

obj	The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

Reimplemented from xtd::object.

◆ equals() [2/2]

auto xtd::forms::create_params::equals ( const create_params & other ) const -> bool

nodiscardoverridenoexcept

Determines whether the specified object is equal to the current object.

Parameters

other The object to compare with the current object.

Returns: true if the specified object is equal to the current object. otherwise, false.

◆ get_hash_code()

auto xtd::forms::create_params::get_hash_code ( ) const -> xtd::usize

nodiscardoverridevirtualnoexcept

Serves as a hash function for a particular type.

Returns: A hash code for the current object.

Reimplemented from xtd::object.

◆ to_string()

auto xtd::forms::create_params::to_string ( ) const -> xtd::string

nodiscardoverridevirtualnoexcept

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:

xtd.forms/include/xtd/forms/create_params.hpp

Definition

Public Constructors

Public Properties

Public Methods

Additional Inherited Members

Constructor & Destructor Documentation

◆ create_params()

Member Function Documentation

◆ caption() [1/2]

◆ caption() [2/2]

◆ class_name() [1/2]

◆ class_name() [2/2]

◆ class_style() [1/2]

◆ class_style() [2/2]

◆ ex_style() [1/2]

◆ ex_style() [2/2]

◆ height() [1/2]

◆ height() [2/2]

◆ location() [1/2]

◆ location() [2/2]

◆ param() [1/2]

◆ param() [2/2]

◆ parent() [1/2]

◆ parent() [2/2]

◆ style() [1/2]

◆ style() [2/2]

◆ size() [1/2]

◆ size() [2/2]

◆ width() [1/2]

◆ width() [2/2]

◆ x() [1/2]

◆ x() [2/2]

◆ y() [1/2]

◆ y() [2/2]

◆ equals() [1/2]

◆ equals() [2/2]

◆ get_hash_code()

◆ to_string()