Database.CreateProperty Method

  • Article
Access Developer Reference

Creates a new user-defined Property object (Microsoft Access workspaces only). .

Syntax

expression.CreateProperty(Name, Type, Value, DDL)

expression   A variable that represents a Database object.

Parameters

Name Required/Optional Data Type Description
Name Optional Variant A String that uniquely names the new Property object. See the Name property for details on valid Property names.
Type Optional Variant A constant that defines the data type of the new Property object. See the Type property for valid data types.
Value Optional Variant A Variant containing the initial property value. See the Value property for details.
DDL Optional Variant A Variant (Boolean subtype) that indicates whether or not the Property is a DDL object. The default is False. If DDL is True, users can't change or delete this Property object unless they have dbSecWriteDef permission.

Return Value
Property

Remarks

You can create a user-defined Property object only in the Properties collection of an object that is persistent.

If you omit one or more of the optional parts when you use CreateProperty, you can use an appropriate assignment statement to set or reset the corresponding property before you append the new object to a collection. After you append the object, you can alter some but not all of its property settings. See the Name, Type, and Value property topics for more details.

If name refers to an object that is already a member of the collection, a run-time error occurs when you use the Append method.

To remove a user-defined Property object from the collection, use the Delete method on the Properties collection. You can't delete built-in properties.

Bb221004.vs_note(en-us,office.12).gif  Note
If you omit the DDL argument, it defaults to False (non-DDL). Because no corresponding DDL property is exposed, you must delete and re-create a Property object you want to change from DDL to non-DDL.

Example

This example tries to set the value of a user-defined property. If the property doesn't exist, it uses the CreateProperty method to create and set the value of the new property. The SetProperty procedure is required for this procedure to run.

Visual Basic for Applications 
  Sub CreatePropertyX()

Dim dbsNorthwind As Database
Dim prpLoop As Property


Set dbsNorthwind = OpenDatabase("Northwind.mdb")


' Set the Archive property to True.
SetProperty dbsNorthwind, "Archive", True


With dbsNorthwind
Debug.Print "Properties of " & .Name


  ' Enumerate Properties collection of the Northwind 
  ' database.
  For Each prpLoop In .Properties
     If prpLoop <> "" Then Debug.Print "  " & _
        prpLoop.Name & " = " & prpLoop
  Next prpLoop

  ' Delete the new property since this is a 
  ' demonstration.
  .Properties.Delete "Archive"

  .Close



End With


End Sub


Sub SetProperty(dbsTemp As Database, strName As String, _
booTemp As Boolean)


Dim prpNew As Property
Dim errLoop As Error


' Attempt to set the specified property.
On Error GoTo Err_Property
dbsTemp.Properties("strName") = booTemp
On Error GoTo 0


Exit Sub


Err_Property:


' Error 3270 means that the property was not found.
If DBEngine.Errors(0).Number = 3270 Then
' Create property, set its value, and append it to the
' Properties collection.
Set prpNew = dbsTemp.CreateProperty(strName, _
dbBoolean, booTemp)
dbsTemp.Properties.Append prpNew
Resume Next
Else
' If different error has occurred, display message.
For Each errLoop In DBEngine.Errors
MsgBox "Error number: " & errLoop.Number & vbCr & _
errLoop.Description
Next errLoop
End
End If


End Sub

See Also