ApexComponent

Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as <apex:relatedList> and <apex:dataTable>. For information, see the Visualforce Developers Guide.

Supported Calls

create(), delete(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Fields

Field Details
ApiVersion
Type
double
Properties
Create, Filter, Sort, Update
Description
The API version for this custom component. Every custom component has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0.
ControllerKey
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The identifier for the controller associated with this custom component:
  • If the ControllerType parameter is set to Standard or StandardSet, this value is the name of the sObject that defines the controller.
  • If the ControllerType parameter is set to Custom, this value is the name of the Apex class that defines the controller.
ControllerType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The type of controller associated with this Visualforce custom component. Possible values include:
  • Not Specified, for custom components defined without a value for the controller attribute on the <apex:component> tag
  • Standard, a value that can't be used with custom components or errors may occur
  • StandardSet, a value that can't be used with custom components or errors may occur
  • Custom, for components that have a value for the controller attribute on the <apex:component> tag
Description
Type
textarea
Properties
Create, Filter, Nillable, Sort, Update
Description
Description of the Visualforce custom component.
Markup
Type
textarea
Properties
Create, Update
Description
The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the content of the custom component.
MasterLabel
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
The text used to identify the Visualforce custom component in the Setup area of Salesforce. The Label for this field is Label.
Name
Type
string
Properties
Create, Filter, Group, Sort, Update
Description
Required. Name of this Visualforce custom component.
NamespacePrefix
Type
string
Properties
Filter, Group, Nillable, Sort
Description
The namespace prefix associated with this object. Each Developer Edition organization that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation.

The namespace prefix can have one of the following values:

  • In Developer Edition organizations, the namespace prefix is set to the namespace prefix of the organization for all objects that support it. There is an exception if an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This is the namespace prefix of the Developer Edition organization of the package developer.
  • In organizations that are not Developer Edition organizations, NamespacePrefix is only set for objects that are part of an installed managed package. There is no namespace prefix for all other objects.

Usage

Use custom components to encapsulate a common design pattern and then reuse that pattern several times in one or more Visualforce pages. All users who can view Visualforce pages can view custom components, but the “Customize Application” permission is required to create or update custom components.

© Copyright 2000–2014 salesforce.com, inc. All rights reserved.
Various trademarks held by their respective owners.