FileUploaderComponent Class

Represents a file uploader form component. The component is designed for use in Forms application only.

Inheritance Hierarchy

System.Object
  Kentico.Forms.Web.Mvc.FormComponent
    Kentico.Forms.Web.Mvc.FormComponent<FileUploaderProperties, BizFormUploadFile>
      Kentico.Forms.Web.Mvc.FileUploaderComponent

Namespace: Kentico.Forms.Web.Mvc
Assembly: Kentico.Content.Web.Mvc (in Kentico.Content.Web.Mvc.dll) Version: 12.0.0

Syntax

public class FileUploaderComponent : FormComponent<FileUploaderProperties, BizFormUploadFile>

The FileUploaderComponent type exposes the following members.

Constructors

	Name	Description
Public method	FileUploaderComponent	Initializes a new instance of the FileUploaderComponent class.

Fields

	Name	Description
Public field Static member	IDENTIFIER	Represents the FileUploaderComponent identifier.

Properties

	Name	Description
Public property	BaseProperties	Gets the form component's properties as its base type. (Inherited from FormComponent<TProperties, TValue>.)
Public property	CustomAutopostHandling	If true, prevents built-in visibility condition handling for this component. (Inherited from FormComponent.)
Public property	Definition	Gets or sets the definition under which the form component is registered in the system. (Inherited from FormComponent.)
Public property	DeleteOrReplaceFile	Gets or sets a value indicating whether to delete or replace the current form file.
Public property	FileInputClientId	Represents the identifier of the file uploader.
Public property	FormSite	Gets the site of the form this component is being used for. The site is determined from the bound context.
Public property	HasDependingFields	Gets or sets a value indicating whether there are another form components whose visibility condition depends on this component's value. (Inherited from FormComponent.)
Public property	LabelForPropertyName	Gets the name of the FileInputClientId property. (Overrides FormComponent.LabelForPropertyName.)
Public property	MaxAllowedFileSize	Gets the maximal size of the file that can be uploaded in kilobytes.
Public property	Name	Gets or sets the name of the corresponding form field. The name is used as a prefix when naming the HTML input. (Inherited from FormComponent.)
Public property	OriginalFileName	Gets or sets the original file name of the form file.
Public property	PlainOriginalFileName	Gets or sets the original file name of the form file.
Public property	PlainSystemFileName	Represents the identifier of the permanent file that is already stored in the database and file system.
Public property	PlainTempFileIdentifier	Represents the identifier of the newly uploaded file in the unprotected format.
Public property	Properties	Gets the form component's properties. (Inherited from FormComponent<TProperties, TValue>.)
Public property	PropertiesType	Gets the properties type of the form component. (Inherited from FormComponent.)
Public property	ShowPartialValidationMessages	Also shows validation errors of partial values of the component. If false, each individual component should contain validation message in its partial view. (Inherited from FormComponent.)
Public property	ShowViewFileLink	Gets a value indicating whether to display a view file link after a file has previously been uploaded.
Public property	SystemFileName	Gets or sets the permanent file name of the form file.
Public property	TempFileIdentifier	Gets or sets the identifier of the newly uploaded file.
Public property	TempFileOriginalName	Gets or sets the original name of the newly uploaded file.

Methods

	Name	Description
Public method	BindContext	Binds contextual information to the form component. (Overrides FormComponent.BindContext(FormComponentContext).)
Public method	GetDisplayName	Returns non-localized string representing component name. Component Name is returned in case of empty Label. (Inherited from FormComponent.)
Public method	GetFileUploadParameters	Returns parameters to PostFile(Int32, String, String) endpoint for file upload from this form component.
Public method	GetModelPropertyCustomAttributes<T>	Gets a collection of custom attributes applied to the model's property this form component represents. (Inherited from FormComponent.)
Public method	GetObjectValue	Gets the value of the form component. The GetValue() method can be used directly to obtain the typed value. (Inherited from FormComponent<TProperties, TValue>.)
Public method	GetValue	Gets the identification string of the form file. Gets the TempFileIdentifier. (Overrides FormComponent<TProperties, TValue>.GetValue().)
Public method	LoadProperties	Loads properties of the form component. The actual properties type must match the PropertiesType. (Inherited from FormComponent<TProperties, TValue>.)
Public method	ModifyMetadata	Modifies modelMetadata according to the current object. (Inherited from FormComponent.)
Public method	SetObjectValue	Sets the value of the form component. The value must be of proper type or an exception is thrown. The SetValue(TValue) method can be used directly to set the typed default value. (Inherited from FormComponent<TProperties, TValue>.)
Public method	SetValue	Sets the identification string of the form file. (Overrides FormComponent<TProperties, TValue>.SetValue(TValue).)
Public method	Validate	Validates whether the submitted temp file still exists. (Overrides FormComponent.Validate(ValidationContext).)

Extension Methods

	Name	Description
Public Extension Method	GetBizFormComponentContext	Gets BizFormComponentContext of a form component, if such a context was bound to the component. (Defined by FormComponentExtensions.)