CustomFields Class

This section describes the Web Service methods used with Ektron's Custom Fields. The Custom Fields Web service is a wrapper for the Custom Fields API: Ektron.Cms.API.CustomFields. These methods can be accessed through the CustomFields.asmx file located in:

~/Workarea/webservices/WebServiceAPI/CustomFields.asmx

IMPORTANT: If you are accessing these Web Services remotely, you will need to set the authentication header.

Class Hierarchy

[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)]
public class CustomFields : EktronBaseService;

Visual Basic

<WebService(Namespace = "http://tempuri.org/")>
<WebServiceBinding(ConformsTo = WsiProfiles.BasicProfile1_1)>
Public Class CustomFields
Inherits EktronBaseService

CustomFields.cs

Name	Description
CustomFields Methods	The methods of the CustomFields class are listed here.

CustomFields Methods

	Name	Description
	AddNewEditableCustomFieldAssignments	Returns the HTML string for the add/edit custom fields. This method can be accessed through the CustomFields.asmx file located in:
	BoolToYesNo	Returns labels for yes or no based on locale. This method can be accessed through the CustomFields.asmx file located in:
	GetEditableCustomFieldAssignments	Returns the editable custom fields. Break Inheritance check box: Visible if not at root. Checked if any fields assigned without inheritance. If unchecked & form saved, removes all assignments. If checked & form saved and no assignments chosen, creates NULL assignment (CustomFieldID -1). When checked, enables all assignment check boxes (iterate through all of this tables elements). When unchecked, disables all assignment check boxes (iterate through all of this tables elements). Assignment Check boxes: When clicked: if 'Assignment' button is unchecked, then ensure required us unchecked. When clicked: if 'Required' button, don't accept checks if assigned is unchecked. When form... more
	GetEnhancedMetadataArea	Returns the HTML needed to render the EnhancedMetadata selection area. This method can be accessed through the CustomFields.asmx file located in:
	GetEnhancedMetadataScript	Returns support Javascript code for enhanced metadata. This method can be accessed through the CustomFields.asmx file located in:
	GetFieldsByFolder	Gets the custom fields associated with a folder by supplying the Folder ID and Language ID. This method can be accessed through the CustomFields.asmx file located in:
	GetSearchProperties	Returns an HTML string for the search properties display. This method can be accessed through the CustomFields.asmx file located in:
	ProcessCustomFields	Process Folders' Custom-Field (and metadata) assignments: When form submitted, copy checked items to hidden field. Form processor: If break inheritance checked, and any items in hidden field, send contents to db. If break inheritance checked, and hidden field empty, create dummy assignment fieldID = -1. If break inheritance NOT checked, remove all assignments for this folder. This method can be accessed through the CustomFields.asmx file located in:
	SearchAllAssets	Returns the search result based on assets. This method can be accessed through the CustomFields.asmx file located in:
	WriteFilteredMetadataForEdit	Returns an HTML string for filtered metadata. This method can be accessed through the CustomFields.asmx file located in:
	WriteFilteredMetadataForView	Returns an HTML string for metadata view. This method can be accessed through the CustomFields.asmx file located in:
	WriteLibrarySearchExtended	Returns an HTML string for the library search custom metadata properties. This method can be accessed through the CustomFields.asmx file located in:
	WriteMetadataDefaultForEdit	Returns an HTML string for the default metadata. This method can be accessed through the CustomFields.asmx file located in:
	WriteMetadataTypeForView	Returns a metadata type for view. This method can be accessed through the CustomFields.asmx file located in:
	WritePublicSearch	Returns WritepublicsearchEx. This method can be accessed through the CustomFields.asmx file located in:

Links

CustomFields Methods, Classes, Legend, Members, Topics, CustomFields Methods

Created with a commercial version of

Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at

[email protected].

Contents | Index | Home

What do you think about this topic? Send feedback!