ApexComponent

Represents a Visualforce component.

For more information, see Visualforce in Salesforce Help and StaticResource: MetadataWithContent

Parent Type 

This type extends MetadataWithContent and inherits its fields.

File Suffix and Directory Location 

The file suffix is .component for the page file. The accompanying metadata file is named ComponentName-meta.xml.

Visualforce components are stored in the components folder in the corresponding package directory.

Version 

Visualforce components are available in API version 12.0 and later.

Fields 

apiVersion 

  • Type: double
  • Required: No
  • Introduced: API version 16.0
  • Description: The API version for this Visualforce component. Every component has an API version specified at creation.

content 

  • Type: base64Binary
  • Required: No
  • Description: The component content. Base 64-encoded binary data. Before making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is handled for you by a SOAP client. This field is inherited from the MetadataWithContent component.

description 

  • Type: string
  • Required: No
  • Description: A description of what the component does.

fullName 

  • Type: string
  • Required: No
  • Description: The component developer name used as a unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the Metadata component.

label 

  • Type: string
  • Required: Yes
  • Description: Required. The label for this component.

packageVersions 

  • Type: PackageVersion[]

  • Required: No

  • Introduced: API version 16.0

  • Description: The list of installed managed package versions that are referenced by this Visualforce component.

    Package components and Visualforce custom component are distinct concepts. A package is comprised of many elements, such as custom objects, Apex classes and triggers, and custom pages and components.

    For more information about managed packages, see Second-Generation Managed Packages in the Salesforce DX Developer Guide.

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.