Introduction:
The Properties Manager can be called in 2 different ways. The first is if you have a Propertiesmanager type module. If this is the case, then the only thing that the module does is output a series of tabs to the user. Usually, this type of module is used for updating properties or to perform an action that has nothing to do with datamanager managed data. The second way that the Properties Manager is called is if you create a datamanager action that is formatted as a propertiesmanager action file. These types of files are used to manage datamanager managed data. (Click here for more information on datamanager actions.) Either way, everything pretty much works the same whether you use it as a module or as a datamanager action except for the part where you have to output your results to the browser after the propertiesmanager() function returns. (Don't worry, there are code files that you can download that contain the code that is needed.) OK, that being said, let's explain more about what the Properties Manager does.
What does the Properties Manager do?
The Properties Manager allows you to output a series of properties tabs (eash with their own set of fields) to the user that collects input from them and then returns that input to you. The input that is returned to you is fully validated according to the validation parameters that you set. You then take that input and do something with it. Usually, you would update a record in your database or maybe create a file based on the users input. The user can actually quickly switch between tabs and the propertiesmanager remembers their input. The Properties Manager consists of 3 main elements.
- A data structure
- The propertiesmanager() function
- And the return where you actually do something with the input.
How does the Properties Manager work?
You simply create a data structure and hand that data structure off to the propertiesmanager() function. When the function returns, you get an array of all the input values from the user. You should then take those values and do something with them like update your database, create a file, send an email, etc.... Whatever you do with the input data from the user is up to you. However, it is good practice to let the user know what you are going to do with the data that they are entering. OK, so let's take a look at the skeleton files. The files listed below are the default files that you should use to build your properties manager modules and action files from. The files are heavily commented so you should just be able to copy the code, then modify the file to meet your needs. Also, if you have the VConsole Developers Toolkit for Dreamweaver® installed, then you don't have to copy the code in the files below. All you need to do is select "New Propertiesmanager Module" or "New Propertiesmanager Action File" from the VConsole drop down menu and the files are created for you.
OK, so let's take a look at the components of the Properties Manager from a user's perspective. Here is an illustration of all the different components.

- This is the title of the properties manager. This is shown in every tab.
- This is the image that is displayed in the properties title area. Remember, it is a visual world. Icons like this give the user an idea of what they are doing. This is also shown at every tab.
- This is also the title of the properties manager. It is duplicated for clarification to the user. This is also shown at every tab. (You can get rid of this by modifying the propertiesmanager.html template file. (See Customizing Look and Feel for more info)
- This is the properties information text and should describe what the user is doing. This is also shown at every tab.
- This is the tab instructions area. (Nothing is displayed in this illustation but it works just like the wizardmanager) This changes from tab to tab and should describe what to do in this tab.
- This area contains all the input fields. You can create a variety of feature rich fields that can do everything from collecting plain text to uploading files. (See below)
- This area contains the save, and cancel buttons. These buttons are pretty self explanatory.
- This area contains the tabs. You can create as many tabs as you want. Each tab can contain 1 or more fields.
So how do you create all these components? You don't, the propertiesmanager() function handles all this for you. You simply create a data structure (which is a multi-dimensional array) and hand it off to the propertiesmanager() function. The rest is taken care of for you including GUI output to the user and field validation. Let's start with the skeleton files. Use these files to build your Properties Manager module files or action files.
See the next section for a full reference of all the parameters that the propertiesmanager takes.
There are no comments at this time.