Skip to content

Commit 4f6ac34

Browse files
author
Kendo Bot
committed
Sync with Kendo UI Professional
1 parent f813d74 commit 4f6ac34

File tree

1 file changed

+79
-34
lines changed

1 file changed

+79
-34
lines changed

docs/api/javascript/ui/filemanager.md

Lines changed: 79 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Enables or disables the drag and drop features of the FileManager.
129129

130130
### dataSource `Object | Array | kendo.data.FileManagerDataSource`
131131

132-
Sets the [FileManagerDataSource](/api/javascript/data/filemanagerdatasource) of the FileManager. Can be bound to a remote service or local data.
132+
Sets the [FileManagerDataSource](/api/javascript/data/filemanagerdatasource) of the FileManager. Can be bound to a remote service or local data.
133133

134134
#### Example
135135

@@ -189,17 +189,17 @@ Sets the [FileManagerDataSource](/api/javascript/data/filemanagerdatasource) of
189189
isDirectory: false,
190190
hasDirectories: false,
191191
path: "folder/Image2.jpg",
192-
extension: ".jpg",
192+
extension: ".jpg",
193193
size: 20,
194194
createdUtc: new Date(),
195195
}
196-
]
196+
]
197197
}
198198
];
199199

200-
$("#fileManager").kendoFileManager({
200+
$("#fileManager").kendoFileManager({
201201
dataSource: myData
202-
});
202+
});
203203
</script>
204204

205205
### upload `Object`
@@ -229,6 +229,51 @@ Sets the upload url for the Upload widget.
229229
});
230230
</script>
231231

232+
### upload.cancel `Function`
233+
234+
Fires when the upload was cancelled while in progress. [Upload Events](/api/javascript/ui/upload#events).
235+
236+
### upload.clear `Function`
237+
238+
Fires when the files are cleared by clicking on the **Clear** button. [Upload Events](/api/javascript/ui/upload#events).
239+
240+
### upload.complete `Function`
241+
242+
Fires when all active uploads complete&mdash;either successfully or with errors. [Upload Events](/api/javascript/ui/upload#events).
243+
244+
### upload.error `Function`
245+
246+
Fires when an `upload` or `remove` operation fails. [Upload Events](/api/javascript/ui/upload#events).
247+
248+
### upload.pause `Function`
249+
250+
Fires when the files are cleared by clicking the **Pause** button. The button is visible if `chunksize` is set. [Upload Events](/api/javascript/ui/upload#events).
251+
252+
### upload.progress `Function`
253+
254+
Fires when the data about the progress of the upload is available. [Upload Events](/api/javascript/ui/upload#events).
255+
256+
### upload.resume `Function`
257+
258+
Fires when the files are resumed through clicking the **Resume** button. The button is visible if `chunksize` is set and the file upload is paused. [Upload Events](/api/javascript/ui/upload#events).
259+
260+
### upload.remove `Function`
261+
262+
Fires when an uploaded file is about to be removed. If the event is canceled, the `remove` operation is prevented. [Upload Events](/api/javascript/ui/upload#events).
263+
264+
### upload.select `Function`
265+
266+
Fires when a file is selected. [Upload Events](/api/javascript/ui/upload#events).
267+
268+
### upload.success `Function`
269+
270+
Fires when an `upload` or `remove` operation is completed successfully. [Upload Events](/api/javascript/ui/upload#events).
271+
272+
### upload.upload `Function`
273+
274+
Fires when one or more files are about to be uploaded. The canceling of the event prevents the upload. [Upload Events](/api/javascript/ui/upload#events).
275+
276+
232277
### toolbar `Boolean | Object` *(default: true)*
233278

234279
Configures the Toolbar of the FileManager
@@ -542,7 +587,7 @@ Configures every view registered for the FileManager.
542587

543588
### views.grid `Object`
544589

545-
Configures the built-in grid view - accepts [kendoGrid options](/api/javascript/ui/grid)
590+
Configures the built-in grid view - accepts [kendoGrid options](/api/javascript/ui/grid)
546591

547592
#### Example
548593

@@ -569,7 +614,7 @@ Configures the built-in grid view - accepts [kendoGrid options](/api/javascript/
569614

570615
### views.list `Object`
571616

572-
Configures the built-in list view (thumbnails) - accepts [kendoListView options](/api/javascript/ui/listview)
617+
Configures the built-in list view (thumbnails) - accepts [kendoListView options](/api/javascript/ui/listview)
573618

574619
#### Example
575620

@@ -596,7 +641,7 @@ Configures the built-in list view (thumbnails) - accepts [kendoListView options]
596641

597642
### views.tree `Object`
598643

599-
Configures the built-in tree view - accepts [kendoTreeView options](/api/javascript/ui/treeview)
644+
Configures the built-in tree view - accepts [kendoTreeView options](/api/javascript/ui/treeview)
600645

601646
#### Example
602647

@@ -814,7 +859,7 @@ Defines the localization messages for the toolbar.
814859
### messages.toolbar.delete `String`
815860

816861
### messages.toolbar.rename `String`
817-
862+
818863
### messages.views `Object`
819864
Defines the localization messages for the views.
820865

@@ -839,7 +884,7 @@ Defines the localization messages for the dialogs.
839884

840885
### messages.dialogs.upload.clear `String`
841886

842-
### messages.dialogs.upload.done `String`
887+
### messages.dialogs.upload.done `String`
843888

844889
### messages.dialogs.moveConfirm `Object`
845890

@@ -925,21 +970,21 @@ Gets the path that teh FileManager is navigated to
925970
isDirectory: false,
926971
hasDirectories: false,
927972
path: "folder/Image2.jpg",
928-
extension: ".jpg",
973+
extension: ".jpg",
929974
size: 20,
930975
createdUtc: new Date(),
931976
}
932977
]}
933978
];
934979

935-
$("#fileManager").kendoFileManager({
980+
$("#fileManager").kendoFileManager({
936981
dataSource: myData
937-
});
982+
});
938983

939984
var fileManager = $("#fileManager").data("kendoFileManager");
940-
985+
941986
fileManager.navigate("folder");
942-
987+
943988
var path = fileManager.path();
944989

945990
console.log(path);
@@ -982,19 +1027,19 @@ The name of the view.
9821027
isDirectory: false,
9831028
hasDirectories: false,
9841029
path: "folder/Image2.jpg",
985-
extension: ".jpg",
1030+
extension: ".jpg",
9861031
size: 20,
9871032
createdUtc: new Date(),
9881033
}
9891034
]}
9901035
];
9911036

992-
$("#fileManager").kendoFileManager({
1037+
$("#fileManager").kendoFileManager({
9931038
dataSource: myData
994-
});
1039+
});
9951040

9961041
var fileManager = $("#fileManager").data("kendoFileManager");
997-
1042+
9981043
fileManager.view("grid");
9991044
</script>
10001045

@@ -1039,19 +1084,19 @@ The path to navigate.
10391084
isDirectory: false,
10401085
hasDirectories: false,
10411086
path: "folder/Image2.jpg",
1042-
extension: ".jpg",
1087+
extension: ".jpg",
10431088
size: 20,
10441089
createdUtc: new Date(),
10451090
}
10461091
]}
10471092
];
10481093

1049-
$("#fileManager").kendoFileManager({
1094+
$("#fileManager").kendoFileManager({
10501095
dataSource: myData
1051-
});
1096+
});
10521097

10531098
var fileManager = $("#fileManager").data("kendoFileManager");
1054-
1099+
10551100
fileManager.navigate("folder");
10561101
</script>
10571102

@@ -1086,19 +1131,19 @@ Refreshes the current view of the FileManager. Rebinds the data.
10861131
isDirectory: false,
10871132
hasDirectories: false,
10881133
path: "folder/Image2.jpg",
1089-
extension: ".jpg",
1134+
extension: ".jpg",
10901135
size: 20,
10911136
createdUtc: new Date(),
10921137
}
10931138
]}
10941139
];
10951140

1096-
$("#fileManager").kendoFileManager({
1141+
$("#fileManager").kendoFileManager({
10971142
dataSource: myData
1098-
});
1143+
});
10991144

11001145
var fileManager = $("#fileManager").data("kendoFileManager");
1101-
1146+
11021147
fileManager.refresh();
11031148
</script>
11041149

@@ -1137,9 +1182,9 @@ The command arguments.
11371182
}
11381183
}
11391184
});
1140-
1185+
11411186
var fileManager = $("#fileManager").data("kendoFileManager");
1142-
1187+
11431188
fileManager.executeCommand("CreateFolderCommand");
11441189
</script>
11451190

@@ -1185,7 +1230,7 @@ Sets the dataSource of an existing FileManager and rebinds it.
11851230
}
11861231
}
11871232
});
1188-
1233+
11891234
var myData = [{
11901235
name: "Folder",
11911236
isDirectory: true,
@@ -1208,7 +1253,7 @@ Sets the dataSource of an existing FileManager and rebinds it.
12081253
data: myData,
12091254
schema: kendo.data.schemas.filemanager
12101255
});
1211-
1256+
12121257
var filemanager = $("#fileManager").data("kendoFileManager");
12131258
filemanager.setDataSource(dataSource);
12141259
</script>
@@ -1340,9 +1385,9 @@ The items dragged and dropped over the target.
13401385

13411386
### command
13421387

1343-
Fired when server command is executed (copy, move, delete or rename).
1388+
Fired when server command is executed (copy, move, delete or rename).
13441389

1345-
The event is useful to get feedback when server commands has failed or succeeded and take additional actions based on the status.
1390+
The event is useful to get feedback when server commands has failed or succeeded and take additional actions based on the status.
13461391

13471392
#### Event Data
13481393

@@ -1364,7 +1409,7 @@ Retrieves contextual data that holds information about the item(s) involved in t
13641409

13651410
##### e.response `Object`
13661411

1367-
The returned response by the service.
1412+
The returned response by the service.
13681413

13691414
#### Example
13701415

0 commit comments

Comments
 (0)