Class FileUpload

Deprecated. The UI service was deprecated on December 11, 2014. To create user interfaces, use the HTML service instead.

A widget that wraps the HTML <input type='file'> element. This widget must be used within a FormPanel.

The result of a FileUpload is a "Blob" which can we used in various other functions. Below is an example of how to use FileUpload.

 

 function doGet(e) {

 var app = UiApp.createApplication().setTitle("Upload CSV to Sheet");
   var formContent = app.createVerticalPanel();
   formContent.add(app.createFileUpload().setName('thefile'));
   formContent.add(app.createSubmitButton());
   var form = app.createFormPanel();
   form.add(formContent);
   app.add(form);
   return app;
 }

 function doPost(e) {
   // data returned is a blob for FileUpload widget
   var fileBlob = e.parameter.thefile;
   var doc = DocsList.createFile(fileBlob);
 }

Internally, UiApp widgets are built on top of the Google Web Toolkit, and it can sometimes be helpful to look at the GWT documentation directly. You can find the FileUpload documentation here.

Deprecated methods

Method	Return type	Brief description
`addChangeHandler(handler)`	`FileUpload`	Add a handler for change events.
`addStyleDependentName(styleName)`	`FileUpload`	Sets the dependent style name of this `FileUpload`.
`addStyleName(styleName)`	`FileUpload`	Adds a style name to this `FileUpload`.
`getId()`	`String`	Returns the id that has been assigned to this object.
`getTag()`	`String`	Gets the text tag of this `FileUpload`.
`getType()`	`String`	Gets the type of this object.
`setEnabled(enabled)`	`FileUpload`	Sets whether the `FileUpload` is enabled.
`setHeight(height)`	`FileUpload`	Sets the height of this `FileUpload`.
`setId(id)`	`FileUpload`	Sets the id of this `FileUpload`.
`setLayoutData(layout)`	`FileUpload`	Set the layout for this `FileUpload`.
`setName(name)`	`FileUpload`	Sets the name of the `FileUpload`, which is how it will be referred to when used in a FormPanel or as a callback element on an event handler.
`setPixelSize(width, height)`	`FileUpload`	Sets the size of this `FileUpload` in pixels.
`setSize(width, height)`	`FileUpload`	Sets the size of this `FileUpload`.
`setStyleAttribute(attribute, value)`	`FileUpload`	Sets one of this `FileUpload`'s style attributes to a new value.
`setStyleAttributes(attributes)`	`FileUpload`	Sets this `FileUpload`'s style attributes.
`setStyleName(styleName)`	`FileUpload`	Sets the style name of this `FileUpload`.
`setStylePrimaryName(styleName)`	`FileUpload`	Sets the primary style name of this `FileUpload`.
`setTag(tag)`	`FileUpload`	Sets the text tag of this `FileUpload`.
`setTitle(title)`	`FileUpload`	Sets the hover title of this `FileUpload`.
`setVisible(visible)`	`FileUpload`	Sets whether this `FileUpload` is visible.
`setWidth(width)`	`FileUpload`	Sets the width of this `FileUpload`.

Deprecated methods

`addChangeHandler(handler)`

Deprecated. This function is deprecated and should not be used in new scripts.

Add a handler for change events.

Note that you can have multiple handlers for the same event on the same widget. They will be called in the order that they were added to the widget, although ServerHandlers may appear to happen simultaneously.

The handler passes back some information to the server about what happened. This information can be accessed as follows:

 

 function doGet() {
   var app = UiApp.createApplication();
   var textBox = app.createTextBox();
   var handler = app.createServerHandler("handlerFunction");
   textBox.addChangeHandler(handler);
   app.add(textBox);
   return app;
 }

 function handlerFunction(eventInfo) {
   var parameter = eventInfo.parameter;
   // the type of event, in this case "change".
   var eventType = parameter.eventType;
   // the id of the widget that fired this event.
   var source = parameter.source;
 }

In addition, the values of certain widgets can be sent up with the event as well, as "callback elements." See the documentation of ServerHandler for more information.

Parameters

Name	Type	Description
`handler`	`Handler`	the handler to execute when the event occurs. This can be a `ClientHandler` or a `ServerHandler`.

Return

FileUpload — the FileUpload itself, useful for chaining.

`addStyleDependentName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the dependent style name of this FileUpload.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

FileUpload — the FileUpload itself, useful for chaining.

`addStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Adds a style name to this FileUpload.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

FileUpload — the FileUpload itself, useful for chaining.

`getId()`

Deprecated. This function is deprecated and should not be used in new scripts.

Returns the id that has been assigned to this object.

This can be used in conjunction with app.getElementById() to retrieve a reference to this object.

Return

String — the id that has been assigned to this object

`getTag()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the text tag of this FileUpload.

Return

String — the text tag.

`getType()`

Deprecated. This function is deprecated and should not be used in new scripts.

Gets the type of this object.

Return

String — the object type

`setEnabled(enabled)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether the FileUpload is enabled.

Parameters

Name	Type	Description
`enabled`	`Boolean`	whether the `FileUpload` should be enabled or disabled.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setHeight(height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the height of this FileUpload.

Parameters

Name	Type	Description
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

FileUpload — the FileUpload itself, useful for chaining.

`setId(id)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the id of this FileUpload.

Parameters

Name	Type	Description
`id`	`String`	the new id, which can be used to retrieve the `FileUpload` from app.getElementById(id).

Return

FileUpload — the FileUpload itself, useful for chaining.

`setLayoutData(layout)`

Deprecated. This function is deprecated and should not be used in new scripts.

Set the layout for this FileUpload.

This is not currently functional.

Parameters

Name	Type	Description
`layout`	`Object`

Return

FileUpload — the FileUpload itself, useful for chaining.

`setName(name)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the name of the FileUpload, which is how it will be referred to when used in a FormPanel or as a callback element on an event handler.

Parameters

Name	Type	Description
`name`	`String`	the new name.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setPixelSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this FileUpload in pixels.

Parameters

Name	Type	Description
`width`	`Integer`	the new width in pixels.
`height`	`Integer`	the new height in pixels.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setSize(width, height)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the size of this FileUpload.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".
`height`	`String`	the new height in any CSS unit such as "10px" or "50%".

Return

FileUpload — the FileUpload itself, useful for chaining.

`setStyleAttribute(attribute, value)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets one of this FileUpload's style attributes to a new value. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 

 // Change the widget's background to black and text color to green.
 widget.setStyleAttribute("background", "black")
     .setStyleAttribute("color", "green");

Parameters

Name	Type	Description
`attribute`	`String`	the CSS attribute, in camel-case ("fontSize", not "font-size"), as listed here
`value`	`String`	the CSS value

Return

FileUpload — the FileUpload itself, useful for chaining.

`setStyleAttributes(attributes)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets this FileUpload's style attributes. This is a convenience method that is equivalent to calling setStyleAttribute with every key/value pair in the attributes object. Valid attributes are listed here; the values for each attribute are the same as those available in CSS style sheets.

 

 // Change the widget's background to black and text color to green.
 widget.setStyleAttributes({background: "black", color: "green"});

Parameters

Name	Type	Description
`attributes`	`Object`	an object of key/value pairs for the CSS attributes and values to set; valid attributes are listed here

Return

FileUpload — the FileUpload itself, useful for chaining.

`setStyleName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the style name of this FileUpload.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setStylePrimaryName(styleName)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the primary style name of this FileUpload.

This is useful for debugging but is otherwise of minimal use since there is no way to use custom stylesheets in UiApp.

Parameters

Name	Type	Description
`styleName`	`String`	the new style name.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setTag(tag)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the text tag of this FileUpload.

Parameters

Name	Type	Description
`tag`	`String`	the new text tag, which can be anything you wish to store with the widget.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setTitle(title)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the hover title of this FileUpload.

Not all browsers will show this.

Parameters

Name	Type	Description
`title`	`String`	the hover title.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setVisible(visible)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets whether this FileUpload is visible.

Parameters

Name	Type	Description
`visible`	`Boolean`	whether this `FileUpload` should be visible or not.

Return

FileUpload — the FileUpload itself, useful for chaining.

`setWidth(width)`

Deprecated. This function is deprecated and should not be used in new scripts.

Sets the width of this FileUpload.

Parameters

Name	Type	Description
`width`	`String`	the new width in any CSS unit such as "10px" or "50%".

Return

FileUpload — the FileUpload itself, useful for chaining.

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 3.0 License, and code samples are licensed under the Apache 2.0 License. For details, see our Site Policies.

Last updated February 26, 2015.