Hide

YetaWF.Core Package Documentation

YetaWF.Core.Components.YetaWFComponentBase Class

The base class for all components used in YetaWF.

Namespace: YetaWF.Core.Components
Assembly: YetaWF.Core

Inheritance

System.Object

YetaWF.Core.Components.YetaWFComponentBase

Syntax

public abstract class YetaWFComponentBase;

Constructors

YetaWFComponentBase

Constructor.

Properties

	Container	The container model for which this component is used/rendered.
	ControlId	The HTML id of this component.
	DivId	The HTML id used for a <div> tag.
	FieldName	The HTML field name of the components.
	FieldNamePrefix	Defines the prefix used when generating an HTML field name for the component. A prefix is typically present with nested components.
	HtmlAttributes	HTML attributes that were provided to render the component.
	HtmlHelper	Returns the HtmlHelper instance.
	IsContainerComponent	Returns whether the component is a container component, i.e., can contain other components.
	PropData	Defines the YetaWF.Core.Models.PropertyData instance of the property in the container that this components represents.
	PropertyName	Defines the name of the property in the container that this components represents.
	Validation	Defines whether the component requires client-side validation.
	Manager	The YetaWF.Core.Support.Manager instance of current HTTP request.

Fields

Package

Defines the package implementing this component.

Methods

	Equals	Determines whether the specified object is equal to the current object.
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
	GetComponentType	Returns the component type (edit/display).
	GetHashCode	Serves as the default hash function.
	GetPackage	Returns the package implementing the component.
	GetSiblingProperty	Retrieves a sibling property. Used to extract related properties from a container, which typically are used for additional component customization.
	GetTemplateName	Returns the component name.
	GetType	Gets the Type of the current instance.
	HAE	Encodes the provided text suitable for use as an HTML attribute data value.
	HE	Encodes the provided text suitable for use as HTML.
	IncludeStandardDisplayAsync	Include required JavaScript, Css files when displaying a component, for all components in this package.
	IncludeStandardEditAsync	Include required JavaScript, Css files when editing a component, for all components in this package.
	JE	Encodes the provided text suitable for use as a JavaScript string.
	MemberwiseClone	Creates a shallow copy of the current Object.
	ReferenceEquals	Determines whether the specified Object instances are the same instance.
	ToString	Returns a string that represents the current object.
	TryGetSiblingProperty	Retrieves a sibling property. Used to extract related properties from container, which typically are used for additional component customization.
	UniqueId	Returns a unique HTML id.

Enums

ComponentType

The component type. YetaWF supports edit components which are used to input data and are modifiable and display components which are used to display data and cannot be modified.

An open source
web framework/CMS

.NET 6.0 - MVC