ASPxFileManager - How to get a file's SettingsDataSource.KeyFieldName field value

Max Mendel

created 12 years ago

I have an ASPxFileManager that I bind to a datatable

<dx:ASPxFileManager AllowResize="true" ID="filemanager" runat="server" Theme="DevEx" EnableTheming="True" Width="100%" SettingsUpload-Enabled="false" OnCustomThumbnail="fileManager_CustomThumbnail" OnFileDownloading="filemanager_FileDownloading" >
<SettingsDataSource KeyFieldName="admin:id" ParentKeyFieldName="admin:parentid" NameFieldName="NameAndAttachment" IsFolderFieldName="IsFolder" />
</dx:ASPxFileManager>

Both in my code-behind and on the client-side I want to access the KeyFieldName of the file or folder. In the event I can find the filename e.File.Name alright and some other fields, but I can't identify the KeyFieldName. On the client-side I'm even more hopelessly lost to find this
Can you please help me?

Answers approved by DevExpress Support

Vasily (DevExpress Support)

created 12 years ago (modified 12 years ago)

Hi Max,
The SettingsDataSource.KeyFieldName and SettingsDataSource.ParentKeyFieldName properties are used only to generate a File structure using the DataSource control. After the file structure is generated, the Key field is no longer used in APSxFileManager to identify files.
To accomplish your task, you can find the corresponding Key value in your data source manually by using the e.File.Name and e.File.RelativeName properties.
UPDATED:
I suggest you use ASPxFileManager.JSProperties to send the necessary properties value from the server to the client.
See Also:
- ASPxFileManager - How to implement custom thumbnails

Show previous comments (5)

Max Mendel 12 years ago

I ended up doing that in the code-behind, but can you give me some advice on how to accomplish this on the client side? For instance, I assign a custom thumbnail that contains the id, so that would be a good candidate to snag on the client but I can't seem to find the thumbnail url.

DevExpress Support Team 12 years ago

Hi Max,
I suggest you use ASPxFileManager.JSProperties to send the necessary properties value from the server to the client.
See Also:
- ASPxFileManager - How to implement custom thumbnails

Max Mendel 12 years ago

Thank you Demetrius; I can see that this is the solution.
I'm a beginner programmer so please help me along a little bit more to implement it. Do you suggest that during the custom thumbnail event I execute something like this for every file:
ASPxFileManager1.JSProperties(e.File.name)= GetIDbyName(e.File.name)
But then how do I execute
var id = fileManager.cpLabelText
on the client? I mean, what do I substitute for cpLabelText from your example? I only have the filename string and that may not even look pretty.

Vasily (DevExpress Support) 12 years ago

Hi Max,
To accomplish your task, use the "cpLabelText" key when saving your ID to the JSProperties collection. Note that the key you used to save the value to the JSProperies collection will be used to access this value on the client side. Please also note that this key always should be started with "cp":
Server-side:

Visual Basic
ASPxFileManager1.JSProperties("cpSomeName") =  GetIDbyName(e.File.name)

Client-side:

JavaScript
var id = fileManager.cpSomeName

Please refer to the How to Access Server Data on the Client Side help topic for more information regarding this.

Max Mendel 12 years ago

I still don't understand; please bear with me.
But how do I choose the cpSomeName string? If a file gets clicked I have the e.File.name and this will depend on the file that is clicked so it can't be fixed to cpSomeName. I want to snag the id of the file based on it's name and then navigate like this:
<ClientSideEvents
SelectedFileChanged="function(s, e) { var id = filemanager.__e.File.Name__; window.open( '/ResourcesX/NewDocument.aspxID=' + id ); } />
So what do I put in lieu of __e.File.name__ ?
Thank you for your patience.

Vasily (DevExpress Support) 12 years ago

Hi Max,
If I understand you correctly you want to store all your file IDs in the JSProperties collection, and then get the ID of the corresponded file by its name on the client side. In this case I suggest you pass the dictionary with the file names and corresponding ID fields to the client side by using the JSProperties collection:

Visual Basic
Protected Sub filemanager_CustomJSProperties(sender As Object, e As DevExpress.Web.ASPxClasses.CustomJSPropertiesEventArgs) Handles filemanager.CustomJSProperties  
    Dim fileNames As Dictionary(Of String, String) = New Dictionary(Of String, String)  'Key="FileName" Value="ID"  

    ...  

    e.Properties("cpFileNames") = fileNames  
End Sub

JavaScript
function GetFileID(fileName) {  
    return fileManager.cpFileNames[fileName];  
}

Max Mendel 12 years ago

That was the break I needed. Thank you Vasily. It works.

Vasily (DevExpress Support) 12 years ago

Hi Max,
Please do not hesitate to contact us in case of any difficulty. We will be happy to help you!

Created: May 14, 2013 7:25 PM

Modified: May 20, 2013 3:27 PM

Platform: ASP.NET Web Forms

Product: Navigation, Layout & Multi-Purpose Controls

Disclaimer: The information provided on DevExpress.com and affiliated web properties (including the DevExpress Support Center) is provided "as is" without warranty of any kind. Developer Express Inc disclaims all warranties, either express or implied, including the warranties of merchantability and fitness for a particular purpose. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.

Confidential Information: Developer Express Inc does not wish to receive, will not act to procure, nor will it solicit, confidential or proprietary materials and information from you through the DevExpress Support Center or its web properties. Any and all materials or information divulged during chats, email communications, online discussions, Support Center tickets, or made available to Developer Express Inc in any manner will be deemed NOT to be confidential by Developer Express Inc. Please refer to the DevExpress.com Website Terms of Use for more information in this regard.

ASPxFileManager - How to get a file's SettingsDataSource.KeyFieldName field value

Answers approved by DevExpress Support

Recently viewed tickets