2.2.1.7.1 PidLidBusinessCardDisplayDefinition Property
Type: PtypBinary ([MS-OXCDATA] section 2.11.1)
The PidLidBusinessCardDisplayDefinition ([MS-OXPROPS] section 2.46) property specifies user-customization details for displaying a contact as a business card. This property is optional.
The layout of a business card can be represented as an image and a number of text fields. The image can be either a contact photo, specified in section 2.2.1.8, or a card picture, specified in section 2.2.1.7.2. Text fields consist of a value from another PtypString property set on the Contact object and an optional customized label string provided by the user.
The following diagram specifies the format of the PidLidBusinessCardDisplayDefinition property. Note that multiple-byte values are stored in little-endian format in the buffer.
|
|
|
|
|
|
|
|
|
|
1 |
|
|
|
|
|
|
|
|
|
2 |
|
|
|
|
|
|
|
|
|
3 |
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
MajorVersion |
MinorVersion |
TemplateID |
CountOfFields |
||||||||||||||||||||||||||||
|
FieldInfoSize |
ExtraInfoSize |
ImageAlignment |
ImageSource |
||||||||||||||||||||||||||||
|
BackgroundColor |
|||||||||||||||||||||||||||||||
|
ImageArea |
Reserved |
||||||||||||||||||||||||||||||
|
... |
FieldInfoN (variable) |
||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
|
ExtraInfo (variable) |
|||||||||||||||||||||||||||||||
|
... |
|||||||||||||||||||||||||||||||
MajorVersion (1 byte): An 8-bit value that specifies the major version number. This field MUST be set to 0x03 or greater.
MinorVersion (1 byte): An 8-bit value that specifies the minor version number. This field SHOULD be set to 0x00.
TemplateID (1 byte): An 8-bit value that specifies the layout of the business card. The valid values for this field are specified in the following table.
|
Value |
Meaning |
|---|---|
|
0x00 |
The image area will be left aligned, stretching the full height of the card vertically; text fields will appear to the right of the image area. |
|
0x01 |
The image area will be right aligned, stretching the full height of the card vertically; text fields will appear to the left of the image area. |
|
0x02 |
The image area will be aligned to the top, stretching the full width of the card horizontally; text fields will appear under the image area. |
|
0x03 |
The image area will be aligned to the bottom, stretching the full width of the card horizontally; text fields will appear above the image area. |
|
0x04 |
No image area is included in the card, only text fields are included. In this case, the PidLidBusinessCardCardPicture property (section 2.2.1.7.2) SHOULD NOT be set on the Contact object. |
|
0x05 |
The image area will be used as a background for the card, stretching the full height and width of the card. Text fields are displayed on top of the image area. |
CountOfFields (1 byte): An integer that specifies the number of FieldInfo structures, as specified in section 2.2.1.7.1.1, contained in the FieldInfoN field.
FieldInfoSize (1 byte): An integer that specifies the size, in bytes, of each FieldInfo structure that is contained in the FieldInfoN field. This field MUST be set to 16.
ExtraInfoSize (1 byte): An integer that specifies the size, in bytes, of the ExtraInfo field.
ImageAlignment (1 byte): An 8-bit value that specifies the alignment of the image within the image area. If the value of the TemplateID field is 0x04, indicating a text-only card, this field is ignored. The valid values for this field are specified in the following table.
|
Value |
Meaning |
|---|---|
|
0x00 |
Image is stretched to fit. |
|
0x01 |
Align top left. |
|
0x02 |
Align top center. |
|
0x03 |
Align top right. |
|
0x04 |
Align middle left. |
|
0x05 |
Align middle center. |
|
0x06 |
Align middle right. |
|
0x07 |
Align bottom left. |
|
0x08 |
Align bottom center. |
|
0x09 |
Align bottom right. |
ImageSource (1 byte): An 8-bit value that specifies the source of the image that is used for the business card. The business card can display up to one image on the card. That image can be obtained from either the contact photo, as specified in section 2.2.1.8.1, or the card picture, as specified in section 2.2.1.7.2. If the value of the ImageSource field is 0x00, the contact photo SHOULD be used; otherwise, the card picture SHOULD be used.
-
If the value of this field is 0x00, the PidLidBusinessCardCardPicture property ([MS-OXPROPS] section 2.45) SHOULD NOT exist on the Contact object. This field MUST NOT be set to 0x00 when the value of the PidLidHasPicture property (section 2.2.1.8.1) is zero (FALSE). If the value of the TemplateID field is 0x04, indicating a text-only card, this field is ignored.
BackgroundColor (4 bytes): A 32-bit value that specifies the background color of the business card. This field has the format 0x00BBGGRR, where the high byte is 0x00 and the three lower bytes, represented by BBGGRR, specify blue, green, and red intensities, respectively.
ImageArea (1 byte): An integer that specifies the percent of space that the image will occupy on the business card. The value of this field SHOULD be between 4 and 50. The value of this field is ignored for text-only cards (TemplateID field is set to 0x04) and background image cards (TemplateID field is set to 0x05).
Reserved (4 bytes): This field MUST be set to zero when sent and MUST be ignored when received.
FieldInfoN (variable): An array of zero or more FieldInfo structures (section 2.2.1.7.1.1), each of which contains details about the text field of a business card. Each text field is associated with a user-customized label that is listed in the ExtraInfo field. The number of FieldInfo structures contained in this field is specified by the CountOfFields field.
ExtraInfo (variable): An array of null-terminated Unicode strings, each of which specifies a business card label that has been provided by the user. Each business card label SHOULD be limited to 16 Unicode characters, including the terminating null character. Each business card label is associated with a text field of the business card and is referenced by the LabelOffset field of one of the FieldInfo structures contained in the FieldInfoN field. The total size, in bytes, of the ExtraInfo field is specified by the ExtraInfoSize field.