From abfa673b854c5e97977d49064473bb3b2a2cdf84 Mon Sep 17 00:00:00 2001 From: Pjandro Date: Thu, 29 Oct 2026 21:00:03 +0000 Subject: [PATCH] =?UTF-8?q?=D0=94=D0=BE=D0=BA=D0=B8:=20=D0=BE=D0=BA=D1=80?= =?UTF-8?q?=D1=83=D0=B6=D0=B5=D0=BD=D0=B8=D0=B5=20[MS-DOC]=20=D0=B2=20docs?= =?UTF-8?q?/standards/doc=20(CFB/OSHARED/ODRAW/OLEPS/OFFCRYPTO/OVBA/WMF/EM?= =?UTF-8?q?F)=20+=20README=20=D0=BF=D0=BE=20=D0=BA=D0=B0=D1=82=D0=B5=D0=B3?= =?UTF-8?q?=D0=BE=D1=80=D0=B8=D1=8F=D0=BC?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- AGENTS.md | 2 +- docs/standards/doc/README.md | 67 + docs/standards/doc/ms-cfb.md | 1618 +++ docs/standards/doc/ms-emf.md | 12559 ++++++++++++++++ docs/standards/doc/ms-odraw.md | 19834 ++++++++++++++++++++++++++ docs/standards/doc/ms-offcrypto.md | 5733 ++++++++ docs/standards/doc/ms-oleps.md | 2149 +++ docs/standards/doc/ms-oshared.md | 7627 ++++++++++ docs/standards/doc/ms-ovba.md | 5402 +++++++ docs/standards/doc/ms-wmf.md | 9329 ++++++++++++ docs/standards/{ => docx}/README.md | 25 +- 11 files changed, 64320 insertions(+), 25 deletions(-) create mode 100644 docs/standards/doc/README.md create mode 100644 docs/standards/doc/ms-cfb.md create mode 100644 docs/standards/doc/ms-emf.md create mode 100644 docs/standards/doc/ms-odraw.md create mode 100644 docs/standards/doc/ms-offcrypto.md create mode 100644 docs/standards/doc/ms-oleps.md create mode 100644 docs/standards/doc/ms-oshared.md create mode 100644 docs/standards/doc/ms-ovba.md create mode 100644 docs/standards/doc/ms-wmf.md rename docs/standards/{ => docx}/README.md (78%) diff --git a/AGENTS.md b/AGENTS.md index 28c693b..cc32160 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -121,7 +121,7 @@ Java2D → PNG 300 dpi (`ChartRenderer.DPI = 300`, `PADDING = 4.0`, растр | `.gitea/workflows/` | Gitea Actions: `pr.yml` (`PR checks`), `main.yml` (тесты + coverage-сводка и комментарий в PR → `images-app`/`images-web` (build+push в Nexus) → deploy (рендер прод-конфигов + pull) → autotests → rollback) | | `GITEA-vars.md` | Инструкция владельца: Secrets/Variables, защита ветки, перезапуск — только имена переменных, без значений | | `prod-autotests/` | Прод-автотесты API (pytest + requests, 21 проверка): конфигурация стенда **только env** (`WORDPDF_BASE_URL` обязателен, `WORDPDF_API_KEY`/`WORDPDF_MAX_PAGES`/`WORDPDF_MAX_MB`/`WORDPDF_SAMPLES_DIR` факультативны) — прод-хостов/ключей в коде нет | -| `docs/standards/` | Нормативная документация форматов Word, две категории: `docx/` — OOXML: PDF+md ECMA-376 Part 1 (5-е изд.), md [MS-OI29500]/[MS-ODRAWXML], полные наборы XSD `docx/schema/strict/` (21) + `docx/schema/transitional/` (26), `docx/validate-fixtures.py` — XSD-валидация `samples/*.docx` (lxml, ставится отдельно); `doc/` — бинарный .doc: md [MS-DOC]; регенерация — `docs/standards/README.md` | +| `docs/standards/` | Нормативная документация форматов Word, две категории: `docx/` — OOXML: PDF+md ECMA-376 Part 1 (5-е изд.), md [MS-OI29500]/[MS-ODRAWXML], полные наборы XSD `docx/schema/strict/` (21) + `docx/schema/transitional/` (26), `docx/validate-fixtures.py` — XSD-валидация `samples/*.docx` (lxml, ставится отдельно); `doc/` — бинарный .doc: md [MS-DOC] + окружение [MS-CFB]/[MS-OSHARED]/[MS-ODRAW]/[MS-OLEPS]/[MS-OFFCRYPTO]/[MS-OVBA]/[MS-WMF]/[MS-EMF]; регенерация — README в каждой категории: `docx/README.md`, `doc/README.md` | | `develop/` (вне git, gitignored) | Рабочие материалы и эталоны сравнения рендера — **не фикстуры**, в тесты/jar не подключать; пиксельные замеры зашиты числами в chart-тестах | ## Development Commands diff --git a/docs/standards/doc/README.md b/docs/standards/doc/README.md new file mode 100644 index 0000000..53c2928 --- /dev/null +++ b/docs/standards/doc/README.md @@ -0,0 +1,67 @@ +# Нормативная документация бинарного .doc (Word 97–2003) + +Справочный комплект форматов бинарного .doc: источник истины по структуре контейнера и его потоков (CFB, FIB, CHPX/PAPX, piece table, OfficeArt, property sets, шифрование, VBA) — правки по документам ниже, а не по догадкам. Конвертер принимает только .docx — всё здесь справочное. Документация OOXML — `../docx/README.md`. + +SHA-256 `.md`-файлов — справочные: они производные от инструментов извлечения (poppler/pandoc), при регенерации другим инструментом могут измениться; первичен PDF/docx в таблице «Источники». + +Метка `[TABLE]` в `.md` — таблицы битовых макетов (packet diagram) со span-ячейками: конверсионная команда `-t gfm-raw_html` отключает HTML-fallback pandoc, и такие таблицы не выразимы в GFM; все поля описаны текстом сразу за плейсхолдером (одинаково во всех файлах, включая `ms-doc.md`). + +### Источники + +|Файл|Документ|Редакция/дата|URL|SHA-256| +|---|---|---|---|---| +|`ms-doc.md`|[MS-DOC] «Word (.doc) Binary File Format» — бинарный формат .doc Word 97–2003 (WordDocument/1Table-потоки, FIB, CHPX/PAPX, Clx/PlcPcd/Pcd — «piece table»)|12.5 (260217, февраль 2026)|https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-DOC/%5bMS-DOC%5d-260217.docx|`c2886120e92aa2790a5603156fb0ca8b23151d58476592fef3ede7fb6841ee7d`| +|`ms-cfb.md`|[MS-CFB] «Compound File Binary File Format» — OLE2-контейнер .doc (заголовок, FAT/MiniFAT, directory entries, потоки)|13.0 (261026, октябрь 2026)|https://winprotocoldocs-bhdugrdyduf5h2e4.b02.azurefd.net/MS-CFB/%5bMS-CFB%5d-261026.docx|`84d0f9f282aa00dac631a575514264b6bc1f3cec1b9c8fed095e12f7cc042913`| +|`ms-oshared.md`|[MS-OSHARED] «Office Common Data Types and Objects Structures» — общие типы MS-DOC/MS-PPT/MS-XLS (MSONFC/FilePointer/FixedPoint, тулбары TBC, property sets, RefEdit, VBA-подпись)|11.1 (251113, ноябрь 2025)|https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-OSHARED/%5bMS-OSHARED%5d-251113.docx|`ccac510af0266a0804f6a242b08bc4df2f6d1f5b27935c113609b4faf198cb57`| +|`ms-odraw.md`|[MS-ODRAW] «Office Drawing Binary File Format» — бинарные рисунки OfficeArt (картинки/фигуры внутри .doc)|12.4 (250819, август 2025)|https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-ODRAW/%5bMS-ODRAW%5d-250819.docx|`f7b9b19222ca8b22ab773846a0c7ff4fa1898e391fff1b3ce41ca3b528f36cf6`| +|`ms-oleps.md`|[MS-OLEPS] «Object Linking and Embedding (OLE) Property Set Data Structures» — метаданные-потоки `\x05SummaryInformation`/`\x05DocumentSummaryInformation`|9.0 (240423, апрель 2024)|https://winprotocoldocs-bhdugrdyduf5h2e4.b02.azurefd.net/MS-OLEPS/%5bMS-OLEPS%5d-240423.docx|`ff255baa60ef6002a62f632ffc71e7c0cb0d7a72273d844e85efb97557c0e107`| +|`ms-offcrypto.md`|[MS-OFFCRYPTO] «Office Document Cryptography Structure» — шифрование документов (CryptoAPI-обёртка .doc, agile .docx)|14.0 (260217, февраль 2026)|https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-OFFCRYPTO/%5bMS-OFFCRYPTO%5d-260217.docx|`70836fa126b785efcc4e223480bd938e57c45799129d47ef6c8c3524a5a1dfdf`| +|`ms-ovba.md`|[MS-OVBA] «Office VBA File Format Structure» — VBA-проект (макросы) в CFB-потоках|15.0 (260519, май 2026)|https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-OVBA/%5bMS-OVBA%5d-260519.docx|`a9c32389ff0f03341f73a141f14269f7aae71c35af8c375e37be0cb013e706af`| +|`ms-wmf.md`|[MS-WMF] «Windows Metafile Format» — записи метафайла (встраиваемые картинки .doc)|18.0 (240423, апрель 2024)|https://winprotocoldocs-bhdugrdyduf5h2e4.b02.azurefd.net/MS-WMF/%5bMS-WMF%5d-240423.docx|`f7fc5dfb2ffa671c81badea2a983b62c215bb10aad4fc1d04d6d9ff3df00a262`| +|`ms-emf.md`|[MS-EMF] «Enhanced Metafile Format» — записи расширенного метафайла|18.0 (240423, апрель 2024)|https://winprotocoldocs-bhdugrdyduf5h2e4.b02.azurefd.net/MS-EMF/%5bMS-EMF%5d-240423.docx|`dcb97229d0201556c3f21b07f32388363a80348f0ce87fbe308e4b3048a29c3f`| + +### Что где искать + +- **Бинарный .doc (Word 97–2003)** — `ms-doc.md`: §2.1 File Structure (WordDocument-, 1Table/0Table-, Data-потоки), §2.5 FIB (FibBase, флага), §2.8–2.9 структуры данных (Chpx §2.9.32, PapxFkp, Grpprl, Clx §2.9.38, PlcPcd §2.8.35, Pcd), §3 Structure Examples, §6 Change Tracking; поиск по номерам секций — по строкам оглавления вида `[2.9.38 Clx …]` (заголовки в теле без номеров — автонумерация Word потерялась при извлечении). Конвертер принимает только .docx — документ справочный. +- **Контейнер .doc (OLE2/CFB)** — `ms-cfb.md`: §2.2 Compound File Header, §2.3–2.5 FAT/Mini FAT/DIFAT-секторы, §2.6 Directory Sectors — где лежат потоки `WordDocument`/`1Table`/`Data` из MS-DOC §2.1. +- **Общие типы Office** — `ms-oshared.md`: §2.2 Data Types (MSONFC §2.2.1.3, FilePointer, FixedPoint), §2.3 Common Objects (Toolbar Customization §2.3.1, VBA Digital Signature §2.3.2 — `WordSignBlob`, Property Set Storage §2.3.3, RefEdit Control §2.3.5) — за этим, а не за форматом .doc, MS-DOC и цитирует MS-OSHARED. +- **Рисунки .doc (OfficeArt)** — `ms-odraw.md`: §2.2 записи OfficeArt: корень файла `OfficeArtDggContainer` §2.2.12, `OfficeArtSpContainer` §2.2.14, BLIP-картинки §2.2.23–2.2.30; MS-DOC отсылает сюда за содержимым `Data`-потока рисунков. +- **Метаданные .doc** — `ms-oleps.md`: §2.20 PropertySet, §2.21 PropertySetStream, §2.23 имена потоков/хранилищ, §2.25 Well-Known Property Set Formats — аналог `docProps/core|app.xml` для OOXML (заголовок, автор, счётчики страниц). +- **Шифрование** — `ms-offcrypto.md`: §2.3.5 Office Binary Document RC4 CryptoAPI (обёртка .doc), §2.3.4 ECMA-376 Document Encryption (Standard/Extensible = agile, `EncryptedPackage` §2.3.4.4); шифрованный вход нечитаем — распознавание по CFB-потокам `EncryptedStream`/`EncryptedPackage`. +- **Макросы (VBA)** — `ms-ovba.md`: §2.2 File Structure (корневое хранилище `_VBA_PROJECT_CUR` §2.2.1, `_VBA_PROJECT`-поток §2.2.3, `dir`-поток §2.2.4, модули §2.2.5), §2.4.1 сжатие, §2.4.3 Data Encryption (обфускация модулей) — что пропускать при разборе .doc. +- **Метафайлы-картинки** — `ms-wmf.md` / `ms-emf.md`: §2.3 записи (WMF/EMF — один и тот же набор типов записей, EMF расширенный); частый формат inline-изображений в .doc (BLIP-типы `OfficeArtBlipWMF`/`OfficeArtBlipEMF` §2.2.24–2.2.25 MS-ODRAW). + +### Регенерация + +```bash +# ms-doc.md — свежий dated-.docx [MS-DOC] с лендинга +# https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-doc/ccd7b486-7881-484c-a137-51170af7cc22 +curl -sSL -o /tmp/msdoc.docx "https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-DOC/%5bMS-DOC%5d-260217.docx" +pandoc /tmp/msdoc.docx -t gfm-raw_html --wrap=none -o docs/standards/doc/ms-doc.md + +# Окружение MS-DOC — те же dated-.docx (при 404 — самый свежий с лендингов ниже). +# Два CDN: у windows_protocols-документов (CFB, OLEPS, WMF, EMF) путь БЕЗ сегмента /files/. +O="https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files" +W="https://winprotocoldocs-bhdugrdyduf5h2e4.b02.azurefd.net" +curl -sSL -o /tmp/ms-cfb.docx "$W/MS-CFB/%5bMS-CFB%5d-261026.docx" +curl -sSL -o /tmp/ms-oshared.docx "$O/MS-OSHARED/%5bMS-OSHARED%5d-251113.docx" +curl -sSL -o /tmp/ms-odraw.docx "$O/MS-ODRAW/%5bMS-ODRAW%5d-250819.docx" +curl -sSL -o /tmp/ms-oleps.docx "$W/MS-OLEPS/%5bMS-OLEPS%5d-240423.docx" +curl -sSL -o /tmp/ms-offcrypto.docx "$O/MS-OFFCRYPTO/%5bMS-OFFCRYPTO%5d-260217.docx" +curl -sSL -o /tmp/ms-ovba.docx "$O/MS-OVBA/%5bMS-OVBA%5d-260519.docx" +curl -sSL -o /tmp/ms-wmf.docx "$W/MS-WMF/%5bMS-WMF%5d-240423.docx" +curl -sSL -o /tmp/ms-emf.docx "$W/MS-EMF/%5bMS-EMF%5d-240423.docx" +for n in ms-cfb ms-oshared ms-odraw ms-oleps ms-offcrypto ms-ovba ms-wmf ms-emf; do + pandoc "/tmp/$n.docx" -t gfm-raw_html --wrap=none -o "docs/standards/doc/$n.md" +done + +# Лендинги (свежий dated .docx — в таблице «Published Version»): +# MS-CFB https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-cfb/53989ce4-7b05-4f8d-829b-d08d6148375b +# MS-OSHARED https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-oshared/d93502fa-5b8f-4f47-a3fe-5574046f4b8d +# MS-ODRAW https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-odraw/8560795e-7759-4745-838f-f7f2ef2f1872 +# MS-OLEPS https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-oleps/bf7aeae8-c47a-4939-9f45-700158dac3bc +# MS-OFFCRYPTO https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-offcrypto/3c34d72a-1a61-4b52-a893-196f9157f083 +# MS-OVBA https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-ovba/575462ba-bf67-4190-9fac-c275523c75fc +# MS-WMF https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-wmf/4813e7fd-52d0-4f42-965f-228c8b7488d2 +# MS-EMF https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-emf/91c257d7-c39d-4a36-9b1f-63e3f73d30ca +``` diff --git a/docs/standards/doc/ms-cfb.md b/docs/standards/doc/ms-cfb.md new file mode 100644 index 0000000..9ba345f --- /dev/null +++ b/docs/standards/doc/ms-cfb.md @@ -0,0 +1,1618 @@ +**\[MS-CFB\]:** + +**Compound File Binary File Format** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 7/16/2010 | 1.0 | New | First Release. | +| 8/27/2010 | 1.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/8/2010 | 2.0 | Major | Updated and revised the technical content. | +| 11/19/2010 | 2.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/7/2011 | 2.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/11/2011 | 2.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/25/2011 | 2.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/6/2011 | 2.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/17/2011 | 2.1 | Minor | Clarified the meaning of the technical content. | +| 9/23/2011 | 2.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/16/2011 | 2.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/30/2012 | 2.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/12/2012 | 2.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/25/2012 | 2.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/31/2013 | 2.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 8/8/2013 | 3.0 | Major | Updated and revised the technical content. | +| 11/14/2013 | 4.0 | Major | Updated and revised the technical content. | +| 2/13/2014 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/15/2014 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/30/2015 | 5.0 | Major | Significantly changed the technical content. | +| 10/16/2015 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/14/2016 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/1/2017 | 6.0 | Major | Significantly changed the technical content. | +| 9/15/2017 | 7.0 | Major | Significantly changed the technical content. | +| 12/1/2017 | 7.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/16/2018 | 8.0 | Major | Significantly changed the technical content. | +| 9/12/2018 | 9.0 | Major | Significantly changed the technical content. | +| 4/7/2021 | 10.0 | Major | Significantly changed the technical content. | +| 6/25/2021 | 11.0 | Major | Significantly changed the technical content. | +| 4/23/2024 | 12.0 | Major | Significantly changed the technical content. | +| 10/26/2026 | 13.0 | Major | Significantly changed the technical content. | + +Table of Contents + +[1 Introduction [5](#introduction)](#introduction) + +[1.1 Glossary [6](#glossary)](#glossary) + +[1.2 References [9](#references)](#references) + +[1.2.1 Normative References [9](#normative-references)](#normative-references) + +[1.2.2 Informative References [9](#informative-references)](#informative-references) + +[1.3 Overview [9](#overview)](#overview) + +[1.4 Relationship to Protocols and Other Structures [11](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [12](#applicability-statement)](#applicability-statement) + +[1.6 Versioning and Localization [12](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [12](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [13](#structures)](#structures) + +[2.1 Compound File Sector Numbers and Types [15](#compound-file-sector-numbers-and-types)](#compound-file-sector-numbers-and-types) + +[2.2 Compound File Header [17](#compound-file-header)](#compound-file-header) + +[2.3 Compound File FAT Sectors [20](#compound-file-fat-sectors)](#compound-file-fat-sectors) + +[2.4 Compound File Mini FAT Sectors [21](#compound-file-mini-fat-sectors)](#compound-file-mini-fat-sectors) + +[2.5 Compound File DIFAT Sectors [22](#compound-file-difat-sectors)](#compound-file-difat-sectors) + +[2.6 Compound File Directory Sectors [23](#compound-file-directory-sectors)](#compound-file-directory-sectors) + +[2.6.1 Compound File Directory Entry [23](#compound-file-directory-entry)](#compound-file-directory-entry) + +[2.6.2 Root Directory Entry [27](#root-directory-entry)](#root-directory-entry) + +[2.6.3 Other Directory Entries [27](#other-directory-entries)](#other-directory-entries) + +[2.6.4 Red-Black Tree [28](#red-black-tree)](#red-black-tree) + +[2.7 Compound File User-Defined Data Sectors [29](#compound-file-user-defined-data-sectors)](#compound-file-user-defined-data-sectors) + +[2.8 Compound File Range Lock Sector [29](#compound-file-range-lock-sector)](#compound-file-range-lock-sector) + +[2.9 Compound File Size Limits [29](#compound-file-size-limits)](#compound-file-size-limits) + +[3 Structure Examples [31](#structure-examples)](#structure-examples) + +[3.1 The Header [31](#the-header)](#the-header) + +[3.2 Sector \#0: FAT Sector [32](#sector-0-fat-sector)](#sector-0-fat-sector) + +[3.3 Sector \#1: Directory Sector [33](#sector-1-directory-sector)](#sector-1-directory-sector) + +[3.3.1 Stream ID 0: Root Directory Entry [33](#stream-id-0-root-directory-entry)](#stream-id-0-root-directory-entry) + +[3.3.2 Stream ID 1: Storage 1 [34](#stream-id-1-storage-1)](#stream-id-1-storage-1) + +[3.3.3 Stream ID 2: Stream 1 [35](#stream-id-2-stream-1)](#stream-id-2-stream-1) + +[3.3.4 Stream ID 3: Unused, Free [35](#stream-id-3-unused-free)](#stream-id-3-unused-free) + +[3.4 Sector \#2: MiniFAT Sector [36](#sector-2-minifat-sector)](#sector-2-minifat-sector) + +[3.5 Sector \#3: Mini Stream Sector [37](#sector-3-mini-stream-sector)](#sector-3-mini-stream-sector) + +[4 Security Considerations [39](#security-considerations)](#security-considerations) + +[4.1 Validation and Corruption [39](#validation-and-corruption)](#validation-and-corruption) + +[4.2 File Security [39](#file-security)](#file-security) + +[4.3 Unallocated Ranges [39](#unallocated-ranges)](#unallocated-ranges) + +[5 Appendix A: Product Behavior [40](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [44](#change-tracking)](#change-tracking) + +[7 Index [45](#index)](#index) + +# Introduction + +This document specifies a new structure that is called the Microsoft Compound File Binary (CFB) file format, also known as the Object Linking and Embedding (OLE) or Component Object Model (COM) structured storage compound file implementation binary file format. This structure name can be shortened to [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). + +Traditional [**file systems**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d) encounter challenges when they attempt to store efficiently multiple kinds of [**objects**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) in one document. A compound file provides a solution by implementing a simplified file system within a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25). Structured storage defines how to treat a single file as a hierarchical collection of two types of objects--[**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) and [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5)--that behave as [**directories**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9) and files, respectively. This scheme is called structured storage. The purpose of structured storage is to reduce the performance penalties and overhead that is associated with storing separate objects in a flat file. The standard Windows COM implementation of OLE structured storage is called compound files. For more information about structured storage, see [\[MSDN-SS\]](https://go.microsoft.com/fwlink/?LinkId=90136). + +Structured storage solves performance problems by eliminating the need to totally rewrite a file whenever a new object is added or an existing object increases in size. The new data is written to the next available free location in the file, and the storage object updates an internal structure that maintains the locations of its storage objects and stream objects. At the same time, structured storage enables end users to interact and manage a compound file as if it were a single file rather than a nested hierarchy of separate objects. For example, a compound file can be copied, backed up, and emailed like a normal single file. + +The following figure shows a simplified file system that has multiple directories and files nested in a hierarchy. Similarly, a compound file is a single file that contains a nested hierarchy of [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) and stream objects, with storage objects analogous to directories, and stream objects analogous to files. + +![Simplified file system hierarchy with multiple nested directories and files](media/image1.bin "Simplified file system hierarchy with multiple nested directories and files") + +Figure 1: Simplified file system hierarchy with multiple nested directories and files + +![Structured storage compound file hierarchy that contains nested storage objects and stream objects](media/image2.bin "Structured storage compound file hierarchy that contains nested storage objects and stream objects") + +Figure 2: Structured storage compound file hierarchy that contains nested storage objects and stream objects + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **access control list (ACL)**: A list of access control entries (ACEs) that collectively describe the security rules for authorizing access to some resource; for example, an object or set of objects. +> +> **application**: A participant that is responsible for beginning, propagating, and completing an atomic transaction. An application communicates with a transaction manager in order to begin and complete transactions. An application communicates with a transaction manager in order to marshal transactions to and from other applications. An application also communicates in application-specific ways with a resource manager in order to submit requests for work on resources. +> +> **child object, children**: An [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) that is not the root of its tree. The children of an [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) o are the set of all [**objects**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) whose parent is o. See section 1 of \[MS-ADTS\] and section 1 of \[MS-DRSR\]. +> +> **class identifier (CLSID)**: A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that identifies a software component; for instance, a DCOM object class or a COM class. +> +> **compound file**: A structure for storing a file system, similar to a simplified FAT file system inside a single file, by dividing the single file into sectors. +> +> **Coordinated Universal Time (UTC)**: A high-precision atomic time standard that approximately tracks Universal Time (UT). It is the basis for legal, civil time all over the Earth. Time zones around the world are expressed as positive and negative offsets from UTC. In this role, it is also referred to as Zulu time (Z) and Greenwich Mean Time (GMT). In these specifications, all references to UTC refer to the time at UTC-0 (or GMT). +> +> **creation time**: The time, in [**UTC**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7), when a [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) was created. +> +> **directory**: The database that stores information about objects such as users, groups, computers, printers, and the directory service that makes this information available to users and applications. +> +> **directory entry**: A structure that contains a [**storage object's**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) or [**stream object's**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) FileInformation. +> +> **directory stream**: An array of [**directory entries**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) that are grouped into [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2). +> +> **double-indirect file allocation table (DIFAT)**: A structure that is used to locate [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). +> +> **file**: An entity of data in the [**file system**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d) that a user can access and manage. A file has to have a unique name in its directory. It consists of one or more streams of bytes that hold a set of related data, plus a set of attributes also called properties that describe the file or the data within the file. The creation time of a file is an example of a file attribute. +> +> **file allocation table (FAT)**: A data structure that the operating system creates when a volume is formatted by using [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) or FAT32 [**file systems**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d). The operating system stores information about each [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) in the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) so that it can retrieve the [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) later. +> +> **file system**: A system that enables applications to store and retrieve [**files**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) on storage devices. Files are placed in a hierarchical structure. The file system specifies naming conventions for files and the format for specifying the path to a file in the tree structure. Each file system consists of one or more drivers and DLLs that define the data formats and features of the file system. File systems can exist on the following storage devices: diskettes, hard disks, jukeboxes, removable optical disks, and tape backup units. +> +> **globally unique identifier (GUID)**: A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [\[RFC4122\]](https://go.microsoft.com/fwlink/?LinkId=90460) or [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824) have to be used for generating the GUID. See also universally unique identifier (UUID). +> +> **header**: The structure at the beginning of a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **mini FAT**: A [**file allocation table (FAT)**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) structure for the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff) that is used to allocate space in a small [**sector size**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0). +> +> **mini stream**: A structure that contains all [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) for [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) less than a predefined size limit. +> +> **modification time**: The time, in [**UTC**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7), when a [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) was last modified. +> +> **object**: A set of attributes, each with its associated values. Two attributes of an object have special significance: an identifying attribute and a parent-identifying attribute. An identifying attribute is a designated single-valued attribute that appears on every object; the value of this attribute identifies the object. For the set of objects in a replica, the values of the identifying attribute are distinct. A parent-identifying attribute is a designated single-valued attribute that appears on every object; the value of this attribute identifies the object's parent. That is, this attribute contains the value of the parent's identifying attribute, or a reserved value identifying no object. For the set of objects in a replica, the values of this parent-identifying attribute define a tree with objects as vertices and child-parent references as directed edges with the child as an edge's tail and the parent as an edge's head. Note that an object is a value, not a variable; a replica is a variable. The process of adding, modifying, or deleting an object in a replica replaces the entire value of the replica with a new value. As the word replica suggests, it is often the case that two replicas contain "the same objects". In this usage, objects in two replicas are considered the same if they have the same value of the identifying attribute and if there is a process in place (replication) to converge the values of the remaining attributes. When the members of a set of replicas are considered to be the same, it is common to say "an object" as shorthand referring to the set of corresponding objects in the replicas. +> +> **object class**: In COM, a category of objects identified by a [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99), members of which can be obtained through activation of the [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99). +> +> **parent object**: An object is either the root of a tree of objects or has a parent. If two objects have the same parent, they have to have different values in their relative distinguished names (RDNs). See also, [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) in section 1 of \[MS-ADTS\] and section 1 of \[MS-DRSR\]. +> +> **root storage object**: A storage object in a compound file that has to be accessed before any other storage objects and stream objects are referenced. It is the uppermost [**parent object**](#gt_0d41951a-62f0-4fbd-bb23-22f645ae3bf5) in the storage object and stream object hierarchy. +> +> **sector**: The smallest addressable unit of a disk. +> +> **sector chain**: A linked list of [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2), where each [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) can be located in a different location inside a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). +> +> **sector number**: A nonnegative integer identifying a particular [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) that is located in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). +> +> **sector size**: The size, in bytes, of a [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7), typically 512 bytes. +> +> **storage**: A storage object, as defined in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). +> +> **storage object**: An [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) that is analogous to a [**file system**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d) [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9). The [**parent object**](#gt_0d41951a-62f0-4fbd-bb23-22f645ae3bf5) of a storage object has to be another storage object or the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4). +> +> **stream**: An element of a compound file, as described in \[MS-CFB\]. A stream contains a sequence of bytes that can be read from or written to by an application, and they can exist only in storages. +> +> **stream object**: An [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) that is analogous to a [**file system**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d) [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25). The [**parent object**](#gt_0d41951a-62f0-4fbd-bb23-22f645ae3bf5) of a stream object has to be a [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) or the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4). +> +> **Stream object**: A Server object that is used to read and write large string and binary properties. +> +> **unallocated free sector**: An empty [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) that can be allocated to hold data. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **user-defined data**: The main stream portion of a [**stream object**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5). +> +> **UTF-16**: A standard for encoding Unicode characters, defined in the Unicode standard, in which the most commonly used characters are defined as double-byte characters. Unless specified otherwise, this term refers to the UTF-16 encoding form specified in \[UNICODE5.0.0/2007\] section 3.9. +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[MS-DTYP\] Microsoft Corporation, "[Windows Data Types](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2)". + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[UNICODE3.0.1\] The Unicode Consortium, "Unicode Default Case Conversion Algorithm 3.0.1", August 2001, [http://www.unicode.org/Public/3.1-Update1/CaseFolding-4.txt](https://go.microsoft.com/fwlink/?LinkId=119562) + +\[UNICODE5.0.0\] The Unicode Consortium, "Unicode Default Case Conversion Algorithm 5.0.0", March 2006, [http://www.unicode.org/Public/5.0.0/ucd/CaseFolding.txt](https://go.microsoft.com/fwlink/?LinkId=119564) + +### Informative References + +\[MS-OLEDS\] Microsoft Corporation, "[Object Linking and Embedding (OLE) Data Structures](%5bMS-OLEDS%5d.pdf#Section_85583d21c1cf4afea35fd6701c5fbb6f)". + +\[MS-OLEPS\] Microsoft Corporation, "[Object Linking and Embedding (OLE) Property Set Data Structures](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc)". + +\[MSDN-SS\] Microsoft Corporation, "Structured Storage", [http://msdn.microsoft.com/en-us/library/aa380369.aspx](https://go.microsoft.com/fwlink/?LinkId=90136) + +\[MSDN-STGMC\] Microsoft Corporation, "STGM Constants", [http://msdn.microsoft.com/en-us/library/aa380337.aspx](https://go.microsoft.com/fwlink/?LinkId=90140) + +## Overview + +A [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) is a structure that is used to store a hierarchy of [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) and [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) into a single file or memory buffer. + +A storage object is analogous to a [**file system**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d) [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9). Just as a directory can contain other directories and files, a storage object can contain other storage objects and stream objects. Also like a directory, a storage object tracks the locations and sizes of the child storage object and stream objects that are nested beneath it. + +A stream object is analogous to the traditional notion of a file. Like a file, a [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) that is stored as a consecutive sequence of bytes. + +The hierarchy is defined by a [**parent object**](#gt_0d41951a-62f0-4fbd-bb23-22f645ae3bf5)/[**child object**](#gt_9b04b599-9dca-48f1-aa9e-08e254d20553) relationship. [**Stream objects**](#gt_3de414eb-819f-44ff-8cb9-366d6ae67aa3) cannot contain child objects. Storage objects can contain stream objects and/or other storage objects, each of which has a name that uniquely identifies it among the child objects of its parent storage object. + +The [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4) has no parent object. The root storage object also has no name. Because names are used to identify child objects, a name for the root storage object is unnecessary and the file format does not provide a representation for it. + +![Example of a structured storage compound file](media/image3.bin "Example of a structured storage compound file") + +Figure 3: Example of a structured storage compound file + +A compound file consists of the root storage object with optional child storage objects and stream objects in a nested hierarchy. Stream objects can contain user-defined data that is stored as an array of bytes. Storage objects can contain an [**object class**](#gt_a224e395-3fea-48bd-b141-3dd9bee2136a) [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that is called a class identifier ([**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99)), which can identify an [**application**](#gt_15dae0ae-da4d-4984-9c8f-4f337e8e42d2) that can read/write stream objects under that storage object. + +The benefits of compound files include the following: + +- Because the compound file implementation provides a file system-like abstraction within a file, independent of the details of the underlying file system, compound files can be accessed by different applications on different platform operating systems. The compound file can be a generic container file format that holds data for multiple applications. + +- Because the separate objects in a compound file are saved in a standard format, any browser utility that is reading the standard format can list the storage objects and stream objects in the compound file, even though data within a particular [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) can be in a proprietary format. + +- Standardized data structures exist for writing certain types of stream objects--for example, summary information property sets (for more information about property sets, see [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc)). Applications can read these stream objects by using parsers for these data structures, even when the rest of the stream objects cannot be understood. + +The compound file implementation constructs a level of indirection by supporting a file system within a file. A single flat file requires a large contiguous sequence of bytes on the disk. By contrast, compound files define how to treat a single file as a structured collection of storage objects and stream objects that act as file system directories and files, respectively. + +![Example of a compound file showing equal-length sector divisions](media/image4.bin "Example of a compound file showing equal-length sector divisions") + +Figure 4: Example of a compound file showing equal-length sector divisions + +A compound file is divided into equal-length [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2). The first sector contains the [compound file header](#Section_05060311bfce4b12874d71fd4ce63aea). Subsequent sectors are identified by a 32-bit nonnegative integer number, called the sector number. + +A group of sectors can form a [**sector chain**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82), which is a linked list of sectors forming a logical byte array, even though the sectors can be in non-consecutive locations in the compound file. For example, the following figure shows two sector chains. A sector chain starts at sector \#0, continues to sector \#2, and ends at sector \#4. Another sector chain starts at sector \#1 and ends at sector \#3. + +![Example of a compound file sector chain](media/image5.bin "Example of a compound file sector chain") + +Figure 5: Example of a compound file sector chain + +A sector can be unallocated or free, in which case it is not part of a sector chain. A [**sector number**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119) is used for the following purposes: + +1. A sector number is used to identify the file offset of that sector in a compound file. + +2. In a sector chain, a sector number is used to identify the next sector in the chain. + +3. Special sector numbers are used to represent chain termination and free sectors. + +## Relationship to Protocols and Other Structures + +[\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2), "Windows Data Types", Revision 3.0, September 2007, MS-DTYP-v1.02.doc + +The compound file internal structures use the following Windows data types: + +- FILETIME for [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) timestamps + +- GUID for [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) [**object class**](#gt_a224e395-3fea-48bd-b141-3dd9bee2136a) ID + +- ULONGLONG for [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) sizes + +- DWORD for [**sector numbers**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119) and various size fields + +- USHORT for [**header**](#gt_84a82291-9444-481e-97e3-4ff69a88e932) and directory fields + +- BYTE for header and directory fields + +- WCHAR for storage and stream names + +[\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) Microsoft OLE Property Set Data Structures + +OLE property sets are a standard set of stream formats that are typically implemented as compound file [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5). Most [**applications**](#gt_15dae0ae-da4d-4984-9c8f-4f337e8e42d2) that save their data in compound files also write out summary information property set data in the OLE property sets stream formats. + +[\[MS-OLEDS\]](%5bMS-OLEDS%5d.pdf#Section_85583d21c1cf4afea35fd6701c5fbb6f) Microsoft OLE Data Structures + +OLE linking and embedding streams and storages are used to contain data that is used by outside applications that implement the OLE interfaces and APIs. + +[\[UNICODE3.0.1\]](https://go.microsoft.com/fwlink/?LinkId=119562) The Unicode Consortium, "Unicode Default Case Conversion Algorithm", Version 3.0.1, August 2001, http://www.unicode.org/Public/3.1-Update1/CaseFolding-4.txt + +[\[UNICODE5.0.0\]](https://go.microsoft.com/fwlink/?LinkId=119564) The Unicode Consortium, "Unicode Default Case Conversion Algorithm", Version 5.0.0, March 2006, http://www.unicode.org/Public/5.0.0/ucd/CaseFolding.txt + +The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) Default Case Conversion Algorithm, simple case conversion variant, is used to compare storage object and stream object names. + +## Applicability Statement + +This protocol structure is recommended for persisting objects in a random access file system or random access memory system. + +This protocol is not recommended for real-time streaming, progressive rendering, or open-ended data protocols where the size of streams is unknown when the compound file is transmitted. The known size of all structures within a compound file needs to be specified when the compound file is transmitted or retrieved. + +## Versioning and Localization + +This document covers versioning issues in the following areas: + +- **Structure Versions:** There are two versions of the compound file structure, version 3 and version 4. These versions are defined in section [2.2](#Section_05060311bfce4b12874d71fd4ce63aea). In a version 4 compound file, all features of version 3 need to be implemented. + +Implementations need to return an error when encountering a higher version than supported. For example, if only a version 3 compound file is supported, the implementation needs to return an error if a version 4 compound file is being opened. + +- **Localization:** There is no localization-dependent structure content in the compound file structure. In the implementation, all [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character comparisons need to be locale-invariant and all timestamps need to be stored in the Coordinated Universal Time ([**UTC**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7)) time zone. + +## Vendor-Extensible Fields + +A compound file does not contain any vendor-extensible fields. However, a compound file does contain ways to store [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) in [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) and [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5). The vendor can store vendor-specific data in user-defined data. + +# Structures + +This document references commonly used data types as defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2). + +Unless otherwise qualified, instances of **GUID** in this section refer to \[MS-DTYP\] section 2.3.4. + +![Sectors of a compound file with FAT array at sector \#0](media/image6.bin "Sectors of a compound file with FAT array at sector #0") + +Figure 6: Sectors of a compound file with FAT array at sector \#0 + +The main structure that is used to manage [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) allocation and [**sector chains**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82) is the [**file allocation table (FAT)**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0). The FAT contains an array of 32-bit [**sector numbers**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119), where the index represents a sector number, and its value represents the next sector in the chain or a special value. + +- FAT\[0\] contains sector \#0's next sector in the chain. + +- FAT\[1\] contains sector \#1's next sector in the chain. + +- ... + +- FAT\[N\] contains sector \#N's next sector in the chain. + +This allows a compound file to contain many sector chains in a single file. Many compound file structures, including [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839), are implemented as sector chains that are represented in the FAT. + +Even the FAT array itself is represented as a sector chain. The sector chain holds both internal and user-defined data streams. Because the FAT array is stored in a sector chain, the double-indirect file allocation table ([**DIFAT**](#gt_d6586971-0729-47b3-86cb-5c56af8df989)) array is used to find the [FAT sector](#Section_30e1013aa0ff44049ccfd75d835ff404) locations. Each DIFAT array entry contains a 32-bit sector number. + +- DIFAT\[0\] contains FAT sector \#0's location. + +- DIFAT\[1\] contains FAT sector \#1's location. + +- ... + +- DIFAT\[N\] contains FAT sector \#N's location. + +Because space for streams is always allocated in [**sector-sized**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0) blocks, storing objects that are much smaller than the normal sector size (either 512 bytes or 4,096 bytes) can cause considerable waste. As a solution to this problem, the concept of the [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33) is introduced. + +![Mini sectors of a mini stream](media/image7.bin "Mini sectors of a mini stream") + +Figure 7: Mini sectors of a mini stream + +The mini FAT is structurally equivalent to the FAT, but it is used in a different way. The sector size for objects that are represented in mini FAT is 64 bytes, instead of the 512 bytes or 4,096 bytes for normal sectors. The space for these objects comes from a special [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that is called the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff). The mini stream is an internal [**stream object**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) that is divided into equal-length mini sectors. Each mini FAT array entry contains a 32-bit sector number for the mini stream, not the file. + +- MiniFAT\[0\] contains mini stream sector \#0's next sector in the chain. + +- MiniFAT\[1\] contains mini stream sector \#1's next sector in the chain. + +- ... + +- MiniFAT\[N\] contains mini stream sector \#N's next sector in the chain. + +[**Stream objects**](#gt_3de414eb-819f-44ff-8cb9-366d6ae67aa3) that have a user-defined data length less than a cutoff (4,096 bytes) are allocated with the mini FAT from the mini stream. Larger stream objects are allocated with the FAT from [**unallocated free sectors**](#gt_73cf56af-df1c-45e2-87a1-2de3f703e07f) in the file. + +The names of all [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) and stream objects, along with other [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) metadata like stream size and [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) [**CLSIDs**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99), are found in the [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) array. The space for the directory entry array is allocated with the FAT like other sector chains. + +- DirectoryEntry\[0\] contains information about the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4). + +- DirectoryEntry\[1\] contains information about a storage object, stream object, or unallocated object. + +- ... + +- DirectoryEntry\[N\] contains information about a storage object, stream object, or unallocated object. + +![Entries of a directory entry array](media/image8.bin "Entries of a directory entry array") + +Figure 8: Entries of a directory entry array + +![Summary of compound file internal streams and connections to user-defined data streams](media/image9.bin "Summary of compound file internal streams and connections to user-defined data streams") + +Figure 9: Summary of compound file internal streams and connections to user-defined data streams + +This diagram summarizes the compound file main internal streams and how they are linked to user-defined data streams. The DIFAT, FAT, mini FAT, directory entry arrays, and mini stream are internal streams, whereas the user-defined data streams link directly to their stream objects. + +In a compound file, all integer fields, including [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that are encoded in [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb), MUST be stored in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) byte order. The only exception is in user-defined data streams, where the compound file structure does not impose any restrictions. + +## Compound File Sector Numbers and Types + +Each [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2), except for the header, is identified by a nonnegative, 32-bit [**sector number**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119). The following sector numbers above 0xFFFFFFFA are reserved and MUST NOT be used to identify the location of a sector in a compound file. + +| Sector name | Integer value | Description | +|----|----|----| +| REGSECT | 0x00000000 - 0xFFFFFFF9 | Regular sector number. | +| MAXREGSECT | 0xFFFFFFFA | Maximum regular sector number. | +| Not applicable | 0xFFFFFFFB | Reserved for future use. | +| DIFSECT | 0xFFFFFFFC | Specifies a [DIFAT sector](#Section_0afa4e43b18f432a99174f276eca7a73) in the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0). | +| FATSECT | 0xFFFFFFFD | Specifies a [FAT sector](#Section_30e1013aa0ff44049ccfd75d835ff404) in the FAT. | +| ENDOFCHAIN | 0xFFFFFFFE | End of a linked chain of sectors. | +| FREESECT | 0xFFFFFFFF | Specifies an unallocated sector in the FAT, [**Mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33), or [**DIFAT**](#gt_d6586971-0729-47b3-86cb-5c56af8df989). | + +The following list contains the types of sectors that are allowed in a compound file. Their structures are described in sections [2.2](#Section_05060311bfce4b12874d71fd4ce63aea) through [2.8](#Section_947df1281f4a4c02b6ed6d1d0c04c02f). + +| Sector type | Array entry length | Purpose | +|----|----|----| +| Header | Not applicable | A single sector with fields that are needed to read the other structures of the compound file. This sector must be at file offset 0. | +| FAT | 4 bytes | Main allocator of space within the compound file. | +| DIFAT | 4 bytes | Used to locate FAT sectors in the compound file. | +| Mini FAT | 4 bytes | Allocator for [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff) [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839). | +| Directory | 128 bytes | Contains [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) and [**stream object**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) metadata. | +| User-defined Data | Not applicable | User-defined data for stream objects. | +| Range Lock | Not applicable | A single sector that is used to manage concurrent access to the compound file. This sector must cover file offset 0x7FFFFFFF. | +| Unallocated Free | Not applicable | Empty space in the compound file. | + +Compound file sectors can contain unallocated free space, user-defined data for stream objects, directory sectors containing [**directory entries**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d), FAT sectors containing the FAT entries, DIFAT sectors containing the DIFAT entries, and [mini FAT sectors](#Section_c5d235f7b73c4ec5bf8d5c08306cd023) containing the mini FAT entries. Compound file sectors can be located at any sector-sized offset in the file, with the exception of the header and range lock sector. + +![Example of the hierarchy of compound file sectors](media/image10.bin "Example of the hierarchy of compound file sectors") + +Figure 10: Example of the hierarchy of compound file sectors + +All the sector types are eventually linked back to the header sector, except for the range lock sector and [**unallocated free sectors**](#gt_73cf56af-df1c-45e2-87a1-2de3f703e07f). Unallocated free sectors are marked in the FAT as FREESECT (0xFFFFFFFF). Unallocated free sectors can be in the middle of the file, and they can be created by extending the file size and allocating additional FAT sectors to cover the increased length. The range lock sector is identified by a fixed file offset (0x7FFFFFFF) in the compound file. + +In a compound file, all [**sector chains**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82) MUST contain valid sector numbers, less than or equal to MAXREGSECT (0xFFFFFFFA). In a sector chain, the last sector's next pointer MUST be ENDOFCHAIN (0xFFFFFFFE). All sectors in a sector chain MUST NOT be part of any other sector chain in the same file. A sector chain MUST NOT link to a sector appearing earlier in the same chain, which would result in a cycle. Finally, the actual sector count MUST match the size that is specified for a sector chain. + +## Compound File Header + +The **Compound File Header** structure MUST be at the beginning of the file (offset 0). + +[TABLE] + +**Header Signature (8 bytes):** Identification signature for the compound file structure, and MUST be set to the value 0xD0, 0xCF, 0x11, 0xE0, 0xA1, 0xB1, 0x1A, 0xE1. + +**Header CLSID (16 bytes):** Reserved and unused class ID that MUST be set to all zeroes (CLSID_NULL). + +**Minor Version (2 bytes):** Version number for nonbreaking changes. This field SHOULD be set to 0x003E if the major version field is either 0x0003 or 0x0004. + +| Value | Meaning | +|--------|----------------------------------------------------| +| 0x003E | If major version field is either 0x0003 or 0x0004. | + +**Major Version (2 bytes):** Version number for breaking changes. This field MUST be set to either 0x0003 (version 3) or 0x0004 (version 4). + +| Name | Value | +|-----------|--------| +| version 3 | 0x0003 | +| version 4 | 0x0004 | + +**Byte Order (2 bytes):** This field MUST be set to 0xFFFE. This field is a byte order mark for all integer fields, specifying [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) byte order. + +**Sector Shift (2 bytes):** This field MUST be set to 0x0009, or 0x000c, depending on the Major Version field. This field specifies the [**sector size**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0) of the compound file as a power of 2. + +- If Major Version is 3, the Sector Shift MUST be 0x0009, specifying a sector size of 512 bytes. + +- If Major Version is 4, the Sector Shift MUST be 0x000C, specifying a sector size of 4096 bytes. + +[TABLE] + +**Mini Sector Shift (2 bytes):** This field MUST be set to 0x0006. This field specifies the sector size of the Mini Stream as a power of 2. The sector size of the Mini Stream MUST be 64 bytes. + +**Reserved (6 bytes):** This field MUST be set to all zeroes. + +**Number of Directory Sectors (4 bytes):** This integer field contains the count of the number of directory sectors in the compound file. + +- If Major Version is 3, the Number of Directory Sectors MUST be zero. This field is not supported for version 3 compound files. + +| Value | Meaning | +|----|----| +| 0x00000000 | If Major Version is 3, the Number of Directory Sectors MUST be zero. | + +**Number of FAT Sectors (4 bytes):** This integer field contains the count of the number of [FAT sectors](#Section_30e1013aa0ff44049ccfd75d835ff404) in the compound file. + +**First Directory Sector Location (4 bytes):** This integer field contains the starting sector number for the [**directory stream**](#gt_aa28a205-7032-4fe8-b5ee-d3078e0eafa3). + +**Transaction Signature Number (4 bytes):** This integer field MAY contain a sequence number that is incremented every time the compound file is saved by an implementation that supports file transactions. This is the field that MUST be set to all zeroes if file transactions are not implemented.[\<1\>](#Appendix_A_1) + +**Mini Stream Cutoff Size (4 bytes):** This integer field MUST be set to 0x00001000. This field specifies the maximum size of a user-defined data [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that is allocated from the [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33) and mini stream, and that cutoff is 4,096 bytes. Any user-defined data stream that is greater than or equal to this cutoff size must be allocated as normal sectors from the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0). + +**First Mini FAT Sector Location (4 bytes):** This integer field contains the starting sector number for the mini FAT. + +**Number of Mini FAT Sectors (4 bytes):** This integer field contains the count of the number of [mini FAT sectors](#Section_c5d235f7b73c4ec5bf8d5c08306cd023) in the compound file. + +**First DIFAT Sector Location (4 bytes):** This integer field contains the starting sector number for the [**DIFAT**](#gt_d6586971-0729-47b3-86cb-5c56af8df989). + +**Number of DIFAT Sectors (4 bytes):** This integer field contains the count of the number of [DIFAT sectors](#Section_0afa4e43b18f432a99174f276eca7a73) in the compound file. + +**DIFAT (436 bytes):** This array of 32-bit integer fields contains the first 109 FAT sector locations of the compound file. + +- For version 4 compound files, the header size (512 bytes) is less than the sector size (4,096 bytes), so the remaining part of the header (3,584 bytes) MUST be filled with all zeroes. + +[TABLE] + +## Compound File FAT Sectors + +The [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) is the main allocator for space within a compound file. Every [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) in the file is represented within the FAT in some fashion, including those sectors that are unallocated (free). The FAT is a [**sector chain**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82) that is made up of one or more FAT sectors. + +![Sectors of a FAT array](media/image11.bin "Sectors of a FAT array") + +Figure 11: Sectors of a FAT array + +The FAT is an array of [**sector numbers**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119) that represent the allocation of space within the file, grouped into FAT sectors. Each stream is represented in the FAT by a sector chain, in much the same fashion as a FAT file system. + +The set of FAT sectors can be considered together as a single array. Each entry in that array contains the sector number of the next sector in the chain, and this sector number can be used as an index into the FAT array to continue along the chain. + +Special values are reserved for chain terminators (ENDOFCHAIN = 0xFFFFFFFE), free sectors (FREESECT = 0xFFFFFFFF), and sectors that contain [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) for FAT sectors (FATSECT = 0xFFFFFFFD) or [DIFAT Sectors](#Section_0afa4e43b18f432a99174f276eca7a73) (DIFSECT = 0xFFFFFFC), which are not chained in the same way as the others. + +The locations of FAT sectors are read from the [**DIFAT**](#gt_d6586971-0729-47b3-86cb-5c56af8df989). The FAT is represented in itself, but not by a chain. A special reserved sector number (FATSECT = 0xFFFFFFFD) is used to mark sectors that are allocated to the FAT. + +A sector number can be converted into a byte offset into the file by using the following formula: (sector number + 1) x **Sector Size**. This implies that sector \#0 of the file begins at byte offset **Sector Size**, not at 0. + +The detailed FAT sector structure is specified below. + +[TABLE] + +**Next Sector in Chain (variable):** This field specifies the next sector number in a chain of sectors. + +- If Header **Major Version** is 3, there MUST be 128 fields specified to fill a 512-byte sector. + +- If Header **Major Version** is 4, there MUST be 1,024 fields specified to fill a 4,096-byte sector. + +The last FAT sector can have more entries that span past the actual size of the compound file. In this case, the entries that cover past end-of-file MUST be marked with FREESECT (0xFFFFFFFF). The size of a compound file is determined by the index of the last non-free FAT array entry. If the last FAT sector contains an entry FAT\[N\] != FREESECT (0xFFFFFFFF), the file size MUST be at least (N + 1) x (**Sector Size**) bytes in length. + +[TABLE] + +## Compound File Mini FAT Sectors + +The [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33) is used to allocate space in the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff). The mini stream is divided into smaller, equal-length [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2), and the [**sector size**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0) that is used for the mini stream is specified from the [Compound File Header](#Section_05060311bfce4b12874d71fd4ce63aea) (64 bytes). + +![Sectors of a mini FAT array](media/image12.bin "Sectors of a mini FAT array") + +Figure 12: Sectors of a mini FAT array + +The locations for mini FAT sectors are stored in a standard chain in the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0), with the beginning of the chain stored in the header (location of the first mini FAT starting sector). + +A mini FAT sector number can be converted into a byte offset into the mini stream by using the following formula: [**sector number**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119) x 64 bytes. This formula is different from the formula that is used to convert a sector number into a byte offset in the file, because no header is stored in the mini stream. + +The mini stream is chained within the FAT in exactly the same fashion as any normal stream. The mini stream's starting sector is referenced in the first [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) (root storage stream ID 0). + +If all of the user streams in the file are greater than the cutoff of 4,096 bytes, the mini FAT and mini stream are not required. In this case, the location of the header's first mini FAT starting sector can be set to ENDOFCHAIN, and the location of the root directory entry's starting sector can be set to ENDOFCHAIN. + +The detailed mini FAT sector structure is specified below. + +[TABLE] + +**Next Sector in Chain (variable):** This field specifies the next sector number in a chain of sectors. + +- If header Major Version is 3, there MUST be 128 fields specified to fill a 512-byte sector. + +- If Header Major Version is 4, there MUST be 1,024 fields specified to fill a 4,096-byte sector. + +[TABLE] + +## Compound File DIFAT Sectors + +The [**DIFAT**](#gt_d6586971-0729-47b3-86cb-5c56af8df989) array is used to represent [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) of the [FAT sectors](#Section_30e1013aa0ff44049ccfd75d835ff404). The DIFAT is represented by an array of 32-bit [**sector numbers**](#gt_dcce8f8e-8914-441d-bd16-40a6da0cd119). The DIFAT array is stored both in the header and in DIFAT sectors. In the header, the DIFAT array occupies 109 entries, and in each DIFAT sector, the DIFAT array occupies the entire [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) minus 4 bytes. (The last field is for chaining the DIFAT sector chain.) + +![Sectors of a DIFAT array](media/image13.bin "Sectors of a DIFAT array") + +Figure 13: Sectors of a DIFAT array + +The DIFAT sectors are linked together by the last field in each DIFAT sector. As an optimization, the first 109 FAT sectors are represented within the header itself. No DIFAT sectors are needed in a compound file that is smaller than 6.875 megabytes (MB) for a 512-byte sector compound file (6.875 MB = (1 header sector + 109 FAT sectors x 128 non-empty entries) × 512 bytes per sector). + +The DIFAT represents the FAT sectors in a different manner than the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) represents a [**sector chain**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82). A particular index, *n*, into the DIFAT array will contain the sector number of the (*n*+1)th FAT sector. For instance, index \#3 in the DIFAT contains the sector number for the fourth FAT sector, because the DIFAT array starts with index \#0. + +The storage for DIFAT sectors is reserved with the FAT, but it is not chained there. Space for DIFAT sectors is marked by a special sector number, DIFSECT (0xFFFFFFFC). + +The location of the first DIFAT sector is stored in the header. + +A special value of ENDOFCHAIN (0xFFFFFFFE) is stored in the "Next DIFAT Sector Location" field of the last DIFAT sector, or in the header when no DIFAT sectors are needed. + +The detailed DIFAT sector structure is specified below. + +[TABLE] + +**FAT Sector Location (variable):** This field specifies the FAT sector number in a DIFAT. + +- If Header Major Version is 3, there MUST be 127 fields specified to fill a 512-byte sector minus the "Next DIFAT Sector Location" field. + +- If Header Major Version is 4, there MUST be 1,023 fields specified to fill a 4,096-byte sector minus the "Next DIFAT Sector Location" field. + +**Next DIFAT Sector Location (4 bytes):** This field specifies the next sector number in the DIFAT chain of sectors. The first DIFAT sector is specified in the Header. The last DIFAT sector MUST set this field to ENDOFCHAIN (0xFFFFFFFE). + +| Name | Value | +|------------|------------| +| ENDOFCHAIN | 0xFFFFFFFE | + +## Compound File Directory Sectors + +The [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) array is a structure that is used to contain information about the stream and [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7), and to maintain a tree-style containment structure. The directory entry array is allocated as a standard chain of directory sectors within the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0). Each directory entry is identified by a nonnegative number that is called the stream ID. The first sector of the directory sector chain MUST contain the root [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) directory entry as the first directory entry at stream ID 0. + +![Sectors of a directory entry array](media/image14.bin "Sectors of a directory entry array") + +Figure 14: Sectors of a directory entry array + +### Compound File Directory Entry + +The [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) array is an array of directory entries that are grouped into a [directory sector](#Section_a94d7445c4be49cdb6b92f4abc663817). Each [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) or [**stream object**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) within a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) is represented by a single directory entry. The space for the directory sectors that are holding the array is allocated from the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0). + +The valid values for a stream ID, which are used in the **Child ID**, **Right Sibling ID**, and **Left Sibling ID** fields, are 0 through MAXREGSID (0xFFFFFFFA). The special value NOSTREAM (0xFFFFFFFF) is used as a terminator. + +| Stream ID name | Integer value | Description | +|----|----|----| +| REGSID | 0x00000000 through 0xFFFFFFF9 | Regular stream ID to identify the directory entry. | +| MAXREGSID | 0xFFFFFFFA | Maximum regular stream ID. | +| NOSTREAM | 0xFFFFFFFF | Terminator or empty pointer. | + +The directory entry size is fixed at 128 bytes. The name in the directory entry is limited to 32 [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) code points, including the required Unicode terminating null character. + +Directory entries are grouped into blocks to form directory sectors. There are four directory entries in a 512-byte directory sector (version 3 compound file), and there are 32 directory entries in a 4,096-byte directory sector (version 4 compound file). The number of directory entries can exceed the number of storage objects and stream objects due to unallocated directory entries. + +The detailed Directory Entry structure is specified below. + +[TABLE] + +**Directory Entry Name (64 bytes):** This field MUST contain a Unicode string for the [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) or stream name encoded in UTF-16. The name MUST be terminated with a UTF-16 terminating null character. Thus, storage and stream names are limited to 32 UTF-16 code points, including the terminating null character. When locating an [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) in the compound file except for the root storage, the directory entry name is compared by using a special case-insensitive uppercase mapping, described in [Red-Black Tree](#Section_d30e462c5f8a435b9c4ccc0b9ea89956). The following characters are illegal and MUST NOT be part of the name: '/', '\\, ':', '!'. + +**Directory Entry Name Length (2 bytes):** This field MUST match the length of the Directory Entry Name Unicode string in bytes. The length MUST be a multiple of 2 and include the terminating null character in the count. This length MUST NOT exceed 64, the maximum size of the Directory Entry Name field. + +**Object Type (1 byte):** This field MUST be 0x00, 0x01, 0x02, or 0x05, depending on the actual type of object. All other values are not valid. + +| Name | Value | +|------------------------|-------| +| Unknown or unallocated | 0x00 | +| Storage Object | 0x01 | +| Stream Object | 0x02 | +| Root Storage Object | 0x05 | + +**Color Flag (1 byte):** This field MUST be 0x00 (red) or 0x01 (black). All other values are not valid. + +| Name | Value | +|-------|-------| +| red | 0x00 | +| black | 0x01 | + +**Left Sibling ID (4 bytes):** This field contains the stream ID of the left sibling. If there is no left sibling, the field MUST be set to NOSTREAM (0xFFFFFFFF). + +[TABLE] + +**Right Sibling ID (4 bytes):** This field contains the stream ID of the right sibling. If there is no right sibling, the field MUST be set to NOSTREAM (0xFFFFFFFF). + +[TABLE] + +**Child ID (4 bytes):** This field contains the stream ID of a [**child object**](#gt_9b04b599-9dca-48f1-aa9e-08e254d20553). If there is no child object, including all entries for stream objects, the field MUST be set to NOSTREAM (0xFFFFFFFF). + +[TABLE] + +**CLSID (16 bytes):** This field contains an object class [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1), if this entry is for a storage object or root storage object. For a stream object, this field MUST be set to all zeroes. A value containing all zeroes in a storage or root storage directory entry is valid, and indicates that no object class is associated with the storage. If an implementation of the file format enables applications to create storage objects without explicitly setting an object class GUID, it MUST write all zeroes by default. If this value is not all zeroes, the [**object class**](#gt_a224e395-3fea-48bd-b141-3dd9bee2136a) GUID can be used as a parameter to start [**applications**](#gt_15dae0ae-da4d-4984-9c8f-4f337e8e42d2). + +| Value | Meaning | +|----|----| +| 0x00000000000000000000000000000000 | No object class is associated with the storage. | + +**State Bits (4 bytes):** This field contains the user-defined flags if this entry is for a storage object or [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4). For a stream object, this field SHOULD be set to all zeroes because many implementations provide no way for applications to retrieve state bits from a stream object. If an implementation of the file format enables applications to create storage objects without explicitly setting state bits, it MUST write all zeroes by default. + +| Value | Meaning | +|----|----| +| 0x00000000 | Default value when no state bits are explicitly set on the object. | + +**Creation Time (8 bytes):** This field contains the [**creation time**](#gt_f49a559a-a89c-4199-b4d0-974cac3240f9) for a storage object, or all zeroes to indicate that the creation time of the storage object was not recorded. The Windows FILETIME structure is used to represent this field in [**UTC**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7). For a stream object, this field MUST be all zeroes. For a root storage object, this field MUST be all zeroes, and the creation time is retrieved or set on the compound file itself. + +| Value | Meaning | +|--------------------|-----------------------------------------------| +| 0x0000000000000000 | No creation time was recorded for the object. | + +**Modified Time (8 bytes):** This field contains the [**modification time**](#gt_1f882c62-6a40-4b13-b624-3b200fa7b559) for a storage object, or all zeroes to indicate that the modified time of the storage object was not recorded. The Windows FILETIME structure is used to represent this field in UTC. For a stream object, this field MUST be all zeroes. For a root storage object, this field MAY[\<2\>](#Appendix_A_2) be set to all zeroes, and the modified time is retrieved or set on the compound file itself. + +| Value | Meaning | +|--------------------|-----------------------------------------------| +| 0x0000000000000000 | No modified time was recorded for the object. | + +**Starting Sector Location (4 bytes):** This field contains the first [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) location if this is a stream object. For a root storage object, this field MUST contain the first sector of the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff), if the mini stream exists. For a storage object, this field MUST be set to all zeroes. + +**Stream Size (8 bytes):** This 64-bit integer field contains the size of the [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) if this is a stream object. For a root storage object, this field contains the size of the mini stream. For a storage object, this field MUST be set to all zeroes. + +- For a version 3 compound file 512-byte [**sector size**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0), the value of this field MUST be less than or equal to 0x80000000. (Equivalently, this requirement can be stated: the size of a stream or of the mini stream in a version 3 compound file MUST be less than or equal to 2 gigabytes (GB).) Note that as a consequence of this requirement, the most significant 32 bits of this field MUST be zero in a version 3 compound file. However, implementers should be aware that some older implementations did not initialize the most significant 32 bits of this field, and these bits might therefore be nonzero in files that are otherwise valid version 3 compound files. Although this document does not normatively specify parser behavior, it is recommended that parsers ignore the most significant 32 bits of this field in version 3 compound files, treating it as if its value were zero, unless there is a specific reason to do otherwise (for example, a parser whose purpose is to verify the correctness of a compound file). + +### Root Directory Entry + +The first entry in the first [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) of the [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9) chain (also referred to as the first element of the directory array, or stream ID \#0) is known as the root [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d), and it is reserved for two purposes. First, it provides a root parent for all objects that are stationed at the root of the compound file. Second, its function is overloaded to store the size and starting sector for the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff). + +The root directory entry behaves as both a stream and a [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba). The root directory entry's Name field MUST contain the null-terminated string "**Root Entry**" in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb). + +The [**object class**](#gt_a224e395-3fea-48bd-b141-3dd9bee2136a) [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) ([**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99)) that is stored in the root directory entry can be used for COM activation of the document's [**application**](#gt_15dae0ae-da4d-4984-9c8f-4f337e8e42d2). + +The time stamps for the root storage are not maintained in the root directory entry. Rather, the root storage's creation and [**modification time**](#gt_1f882c62-6a40-4b13-b624-3b200fa7b559) stamps are normally stored on the file itself in the [**file system**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d). + +The **Creation Time** field in the root storage directory entry MUST be all zeroes. The **Modified Time** field in the root storage directory entry MAY be all zeroes. + +### Other Directory Entries + +[**Directory entries**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) other than the root storage directory entry are marked as either [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5), [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba), or unallocated objects. + +The [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99), state bits, [**creation time**](#gt_f49a559a-a89c-4199-b4d0-974cac3240f9), modified time, and Child ID values are meaningful in directory entries for storage objects but not for [**Stream objects**](#gt_3de414eb-819f-44ff-8cb9-366d6ae67aa3). + +The Starting Sector Location and Stream Size values are meaningful in directory entries for stream objects but not for storage objects. + +To determine the file location of actual stream data from a stream directory entry, it is necessary to determine whether the stream exists as normal sectors allocated in the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) or as mini sectors (from the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff)) allocated in the [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33). Streams whose size is less than the **Mini Stream Cutoff Size** value (typically 4,096 bytes) for the file exist in the mini stream. The Starting Sector Location is used as an index into the mini FAT (which starts at mini FAT Starting Location) to track the chain of [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) through the mini stream. Streams whose size is greater than or equal to the **Mini Stream Cutoff Size** value for the file exist as standard streams. Their Starting Sector Location value is used as an index into the standard FAT, which describes the chain of full sectors containing their data. + +For 512-byte sectors, the **Stream Size** upper 32-bits field MUST be set to zero when the [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) is written. However, the high DWORD of this field was not initialized in older implementations, so current implementations MUST accept uninitialized high DWORD for the **Stream Size** field. For version 4 compound files that support a 4,096-byte [**sector size**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0), the **Stream Size** must be a full 64-bit integer stream size. + +Free (unused) directory entries are marked with Object Type 0x0 (unknown or unallocated). The entire directory entry must consist of all zeroes except for the child, right sibling, and left sibling pointers, which must be initialized to NOSTREAM (0xFFFFFFFF). + +### Red-Black Tree + +Each set of sibling objects in one level of the containment hierarchy (all [**child objects**](#gt_9b04b599-9dca-48f1-aa9e-08e254d20553) under a [**storage object**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba)) is represented as a red-black tree. The [**parent object**](#gt_0d41951a-62f0-4fbd-bb23-22f645ae3bf5) of this set of siblings will have a pointer to the top of this tree. + +A red-black tree is a special type of binary search tree where each node has a color attribute of red or black. It allows efficient searching in the list of child objects under a storage object. The constraints on a red-black tree allow the binary tree to be roughly balanced, so that insertion, deletion, and searching operations are efficient. + +To be valid, the red-black tree MUST maintain the following constraints: + +1. The [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4) MUST always be black. Because the root [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9) does not have siblings, its color is irrelevant and can therefore be either red or black. + +2. Two consecutive nodes MUST NOT both be red. + +3. The left sibling MUST always be less than the right sibling. This sorting relationship is defined as follows: + + - A node that has a shorter name is less than a node that has a longer name. (Compare the length of the names from the **Directory Entry Name Length** field.) + + - For nodes that have the same name length from **Directory Entry Name Length**, iterate through each [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) code point, one at a time, from the beginning of the [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string. + + - For each UTF-16 code point, convert to uppercase by using the Unicode Default Case Conversion Algorithm, simple case conversion variant (simple case foldings), with the following notes.[\<3\>](#Appendix_A_3)Compare each uppercased UTF-16 code point binary value. + + - Unicode surrogate characters are never uppercased, because they are represented by two UTF-16 code points, while the sorting relationship uppercases a single UTF-16 code point at a time. + + - Lowercase characters that are defined in a newer, later version of the Unicode standard can be uppercased by an implementation that conforms to that later Unicode standard. + +The simplest implementation of the preceding invariants would be to mark every node as black, in which case the tree is simply a binary tree. However, keeping the red-black tree balanced will typically result in better read performance. + +All sibling objects within a storage object (all immediate child objects in one level of the hierarchy) MUST have unique names in the **Directory Entry Name** field, where uniqueness is determined by the sorting relationship. + +## Compound File User-Defined Data Sectors + +Stream [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) are simply collections of arbitrary bytes. They are the building blocks of [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) streams, and no restrictions are imposed on their contents. User-defined data sectors are represented as chains in the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) or [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33), and each chain MUST have a single [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) associated with it to hold its [**stream object**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) metadata, such as its name and size. + +![Example of a user-defined data sector chain](media/image15.bin "Example of a user-defined data sector chain") + +Figure 15: Example of a user-defined data sector chain + +In the preceding example with sector \#0 through sector \#8 shown, a user-defined data [**sector chain**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82) starts at sector \#7, continues to sector \#1, continues to sector \#3, and ends with sector \#5. The next sector location for sector \#5 points to ENDOFCHAIN (0xFFFFFFFE). + +To hold all of the user-defined data, the length of the user-defined data sector chain MUST be greater than or equal to the **stream size** that is specified in the stream object's directory entry. The unused portion of the last sector of a stream object's user-defined data SHOULD be filled with zeroes to avoid leaking unintended information. + +## Compound File Range Lock Sector + +The range lock [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) is the sector that covers file offsets 0x7FFFFF00-0x7FFFFFFF in the file, which are just before 2 GB. These offsets are reserved for byte-range locking to support concurrency, transactions, and other compound file features. The range lock sector MUST be allocated in the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) and marked with ENDOFCHAIN (0xFFFFFFFE), when the compound file grows beyond 2 GB. Because 512-byte compound files are limited to 2 GB in size for compatibility reasons, these files do not need a range lock sector allocated. If the compound file is greater than 2 GB and then shrinks to below 2 GB, the range lock sector SHOULD be marked as FREESECT (0xFFFFFFFF) in the FAT. + +The range lock sector MUST NOT contain any [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839). The [**header**](#gt_84a82291-9444-481e-97e3-4ff69a88e932), FAT, [**DIFAT**](#gt_d6586971-0729-47b3-86cb-5c56af8df989), [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33), and [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9) chains MUST NOT point to the range lock sector location. + +## Compound File Size Limits + +The minimum size of a compound file is one [**header**](#gt_84a82291-9444-481e-97e3-4ff69a88e932), one [FAT sector](#Section_30e1013aa0ff44049ccfd75d835ff404), and one [directory sector](#Section_a94d7445c4be49cdb6b92f4abc663817), which is three [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) total. Therefore, a compound file MUST be at least three sectors in length. + +A 512-byte sector compound file MUST be no greater than 2 GB in size for compatibility reasons. This means that every stream, including the [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) array and [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff), inside a 512-byte sector compound file MUST be less than 2 GB in size. + +4,096-byte sector compound files can have 64-bit file and [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) stream **sizes**, up to slightly less than 16 terabytes (4,096 bytes/sector x MAXREGSECT (0xFFFFFFFA) sectors). + +The maximum number of directory entries ([**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) and [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5)) is MAXREGSID (0xFFFFFFFA), roughly 4 billion. This corresponds to a maximum directory sector chain length of slightly less than 512 GB for a 4,096-byte sector compound file. (See section [2.6.1](#Section_60fe861166c3496bb70da504c94c9ace) for details about directory-entry size and directory-sector composition.) + +The maximum number of directory entries (storage objects, stream objects, and unallocated [**objects**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca)) in a 512-byte sector compound file is limited by the 2-GB file size, resulting in 0x00FFFFFF (slightly less than 16 million) directory entries. + +The maximum size of the mini stream is MAXREGSECT (0xFFFFFFFA) x 64 bytes, which is slightly less than 256 GB. The maximum size of the mini stream in a 512-byte sector compound file is limited by the 2-GB file size. + +# Structure Examples + +This section contains a hexadecimal dump of a structured storage compound file to clarify the binary file format. This compound file consists of the [header sector](#Section_05060311bfce4b12874d71fd4ce63aea) plus five [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) that are numbered as sector \#0 through sector \#4. The following example is a version 3 compound file that has a sector size of 512 bytes. + +![Example of a compound file](media/image16.bin "Example of a compound file") + +Figure 16: Example of a compound file + +## The Header + +[TABLE] + +000000: D0CF 11E0 A1B1 1AE1 0000 0000 0000 0000 ................ + +1. 000010: 0000 0000 0000 0000 3E00 0300 FEFF 0900 ........;....... + + 000020: 0600 0000 0000 0000 0000 0000 0100 0000 ................ + + 000030: 0100 0000 0000 0000 0010 0000 0200 0000 ................ + + 000040: 0100 0000 FEFF FFFF 0000 0000 0000 0000 ................ + + 000050: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000060: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000070: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000080: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000090: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0000A0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0000B0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0000C0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0000D0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0000E0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0000F0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000100: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000110: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000120: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000130: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000140: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000150: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000160: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000170: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000180: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000190: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0001A0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0001B0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0001C0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0001D0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0001E0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0001F0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + +## Sector \#0: FAT Sector + +This [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) is the first and only [FAT sector](#Section_30e1013aa0ff44049ccfd75d835ff404) in the file, with five non-empty entries. + +FAT\[Sector \#0\]: 0xFFFFFFFD = FATSECT: marks this sector as a FAT sector. + +FAT\[Sector \#1\]: 0xFFFFFFFE = ENDOFCHAIN: marks the end of the [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9) chain. + +FAT\[Sector \#2\]: 0xFFFFFFFE = ENDOFCHAIN: marks the end of the [mini FAT](#Section_c5d235f7b73c4ec5bf8d5c08306cd023) chain. + +FAT\[Sector \#3\]: 0x00000004 = pointer to the next sector in the "Stream 1" data. + +FAT\[Sector \#4\]: 0xFFFFFFFE = ENDOFCHAIN: marks the end of the "Stream 1" stream data. + +FAT\[Sector \#5 through \#127\] 0xFFFFFFFF = FREESECT: empty [**unallocated free sectors**](#gt_73cf56af-df1c-45e2-87a1-2de3f703e07f). + +| Byte offset | Field name | Field value | +|-------------|----------------------|---------------------------| +| 0x0200 | Next Sector in Chain | 0xFFFFFFFD (FAT sector) | +| 0x0204 | Next Sector in Chain | 0xFFFFFFFE (end of chain) | +| 0x0208 | Next Sector in Chain | 0xFFFFFFFE (end of chain) | +| 0x020C | Next Sector in Chain | 0x00000004 | +| 0x0210 | Next Sector in Chain | 0xFFFFFFFE (end of chain) | +| 0x0214 | Next Sector in Chain | 0xFFFFFFFF (empty) | + +32. 000200: FDFF FFFF FEFF FFFF FEFF FFFF 0400 0000 ................ + + 000210: FEFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000220: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000230: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000240: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000250: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000260: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000270: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000280: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000290: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0002A0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0002B0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0002C0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0002D0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0002E0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0002F0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000300: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000310: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000320: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000330: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000340: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000350: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000360: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000370: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000260: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000380: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000390: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0003A0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0003B0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0003C0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0003D0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0003E0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0003F0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + +## Sector \#1: Directory Sector + +This is the first and only [directory sector](#Section_a94d7445c4be49cdb6b92f4abc663817) in the file. This directory sector consists of four directory entries. + +Stream ID 0: Root Storage Name = "Root Entry" (section [2.6.2](#Section_026fde6e143d41bfa7dac08b2130d50e)) + +Stream ID 1: Storage Name = "Storage 1" (section [2.6.3](#Section_b37413bbf3ef4adcb18e29bddd62c26e)) + +Stream ID 2: Stream Name = "Stream 1" (section 2.6.3) + +65. Stream ID 3: Unused + +### Stream ID 0: Root Directory Entry + +[TABLE] + +66. 000400: 5200 6F00 6F00 7400 2000 4500 6E00 7400 R.o.o.t. .E.n.t. + + 000410: 7200 7900 0000 0000 0000 0000 0000 0000 r.y............. + + 000420: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000430: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000440: 1600 0501 FFFF FFFF FFFF FFFF 0100 0000 ................ + + 000450: 0067 6156 54C1 CE11 8553 00AA 00A1 F95B .gaVT....S.....\[ + + 000460: 0000 0000 0000 0000 0000 0000 801E 9213 ................ + + 000470: 4BB4 BA01 0300 0000 4002 0000 0000 0000 K.......@....... + +### Stream ID 1: Storage 1 + +[TABLE] + +74. 000480: 5300 7400 6F00 7200 6100 6700 6500 2000 S.t.o.r.a.g.e. . + + 000490: 3100 0000 0000 0000 0000 0000 0000 0000 1............... + + 0004A0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0004B0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0004C0: 1400 0101 FFFF FFFF FFFF FFFF 0200 0000 ................ + + 0004D0: 0061 6156 54C1 CE11 8553 00AA 00A1 F95B .aaVT....S.....\[ + + 0004E0: 0000 0000 0088 F912 4BB4 BA01 801E 9213 ........K....... + + 0004F0: 4BB4 BA01 0000 0000 0000 0000 0000 0000 K............... + +### Stream ID 2: Stream 1 + +[TABLE] + +82. 000500: 5300 7400 7200 6500 6100 6D00 2000 3100 S.t.r.e.a.m. .1. + + 000510: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000520: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000530: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000540: 1200 0201 FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000550: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000560: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000570: 0000 0000 0000 0000 2002 0000 0000 0000 ........ ....... + +### Stream ID 3: Unused, Free + +[TABLE] + +All fields are zeroes except for the child, right sibling, and left sibling pointers, which are set to NOSTREAM. + +90. 000580: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000590: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0005A0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0005B0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0005C0: 0000 0000 FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0005D0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0005E0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 0005F0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + +## Sector \#2: MiniFAT Sector + +The [mini FAT sector](#Section_c5d235f7b73c4ec5bf8d5c08306cd023) is identical to a [FAT sector](#Section_30e1013aa0ff44049ccfd75d835ff404) in structure, but instead of describing allocations for the file, the [**mini FAT**](#gt_2a145f15-cf64-4041-a52a-443b011e5a33) describes allocations for the [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff). The following is a chain of eight contiguous [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2). + +MiniFAT\[Sector \#0\]: 0x00000001: This sector points to the second sector of "Stream 1". + +MiniFAT\[Sector \#1\]: 0x00000002: This sector point to the third sector of "Stream 1". + +MiniFAT\[Sector \#2\]: 0x00000003: This sector points to the fourth sector of "Stream 1". + +MiniFAT\[Sector \#3\]: 0x00000004 : This sector points to the fifth sector of "Stream 1". + +MiniFAT\[Sector \#4\]: 0x00000005 : This sector points to the sixth sector of "Stream 1". + +MiniFAT\[Sector \#5\]: 0x00000006 : This sector points to the seventh sector of "Stream 1". + +MiniFAT\[Sector \#6\]: 0x00000007 : This sector points to the eighth sector of "Stream 1". + +MiniFAT\[Sector \#7\]: 0x00000008 : This sector points to the ninth sector of "Stream 1". + +MiniFAT\[Sector \#8\]: 0xFFFFFFFE = ENDOFCHAIN: marks the end of the "Stream 1" [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839). + +MiniFAT\[Sector \#9 through \#127\] 0xFFFFFFFF = FREESECT: empty [**unallocated free sectors**](#gt_73cf56af-df1c-45e2-87a1-2de3f703e07f). + +| Byte offset | Field name | Field value | +|-------------|----------------------|---------------------------| +| 0x0600 | Next Sector in Chain | 0x00000001 | +| 0x0604 | Next Sector in Chain | 0x00000002 | +| 0x0608 | Next Sector in Chain | 0x00000003 | +| 0x060C | Next Sector in Chain | 0x00000004 | +| 0x0610 | Next Sector in Chain | 0x00000005 | +| 0x0614 | Next Sector in Chain | 0x00000006 | +| 0x0618 | Next Sector in Chain | 0x00000007 | +| 0x061C | Next Sector in Chain | 0x00000008 | +| 0x0620 | Next Sector in Chain | 0xFFFFFFFE (end of chain) | +| 0x0624 | Next Sector in Chain | 0xFFFFFFFF (free) | + +98. 000600: 0100 0000 0200 0000 0300 0000 0400 0000 ................ + + 000610: 0500 0000 0600 0000 0700 0000 0800 0000 ................ + + 000620: FEFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000630: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000640: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000650: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000660: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000670: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000680: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000690: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0006A0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0006B0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0006C0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0006D0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0006E0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0006F0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000700: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000710: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000720: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000730: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000740: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000750: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000760: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000770: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000780: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 000790: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0007A0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0007B0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0007C0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0007D0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0007E0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + + 0007F0: FFFF FFFF FFFF FFFF FFFF FFFF FFFF FFFF ................ + +## Sector \#3: Mini Stream Sector + +The [**mini stream**](#gt_f6b5a467-14e9-4832-b945-f36207f66cff) contains data for all streams whose length is less than the header's [Mini Stream Cutoff Size](#Section_05060311bfce4b12874d71fd4ce63aea) (4,096 bytes). In this example, the mini stream contains the [**user-defined data**](#gt_975908f3-246b-4cbe-ad39-f63468dcd839) for Stream 1. The unused portion of the [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) is zeroed out. + +130. 000800: 4461 7461 2066 6F72 2073 7472 6561 6D20 Data for stream + + 000810: 3144 6174 6120 666F 7220 7374 7265 616D 1Data for stream + + 000820: 2031 4461 7461 2066 6F72 2073 7472 6561 1Data for strea + + ... + + 000A00: 7461 2066 6F72 2073 7472 6561 6D20 3144 ta for stream 1D + + 000A10: 6174 6120 666F 7220 7374 7265 616D 2031 ata for stream 1 + +Although the user-defined data ends at file offset 0x000A1F, the [mini stream sector](#Section_c5d235f7b73c4ec5bf8d5c08306cd023) is filled to the end with known data, such as all zeroes, to prevent random disk or memory contents from contaminating the file on-disk. + +136. 000A20: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A30: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A40: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A50: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A60: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A70: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A80: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000A90: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000AA0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000AB0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000AC0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000AD0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000AE0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000AF0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B00: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B10: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B20: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B30: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B40: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B50: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B60: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B70: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B80: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000B90: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000BA0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000BB0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000BC0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000BD0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000BE0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + + 000BF0: 0000 0000 0000 0000 0000 0000 0000 0000 ................ + +# Security Considerations + +## Validation and Corruption + +It is recommended that implementers be aware of the technical challenges of validating the CFB format and the potential security implications of insufficient validation. + +Due to the representation of [**sector chains**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82), verifying the correctness of the [**FAT**](#gt_f2bf797b-e733-4fb9-b5e5-7e122f4abbe0) [**sectors**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) of a compound file (section [2.3](#Section_30e1013aa0ff44049ccfd75d835ff404)) requires reads from the underlying storage medium (for example, disk) with total read size linear in the total file size, as well as temporary storage (for example, RAM) linear in the total file size. Similarly, verifying the correctness of the [**directory**](#gt_49ce3946-04d2-4cc9-9350-ebcd952b9ab9) sectors of a compound file (section [2.6](#Section_a94d7445c4be49cdb6b92f4abc663817)) requires read size and temporary storage linear in the total number of directory entries, that is, in the total number of [**stream objects**](#gt_9f598e1c-0d65-4845-8f06-8d50f7a32fd5) and [**storage objects**](#gt_c3ddf892-3f55-4561-8804-20325dbc8fba) in the file. The flexibility of sector allocation that is permitted by the format can increase the performance costs of validation in practice because FAT sectors, directory sectors, and so forth are often noncontiguous. + +If a parser has performance requirements, such as efficient access to small portions of a large file, it might not be possible to both satisfy the performance requirements and completely validate compound files. Parser implementers might instead choose to validate only the portions of the file that are requested by an application. + +Although details will vary between implementations, typical security concerns resulting from poorly designed or insufficient validation include: + +- References to sector numbers whose starting offset is past the end of the file, incorrect marking of free sectors in the FAT, mismatches between stream sizes in the directory and the length of the corresponding sector chains, and multiple sector chains referencing the same sectors can potentially break the assumptions of sector allocation algorithms. + +- The representations of sector chains in FAT sectors and of parent/child and sibling relationships in directory sectors make it possible for a corrupted file to represent cyclical references. Cyclical references in the FAT or directory can cause naïve parsing algorithms to get stuck in an infinite loop. + +- Corruption of the red-black tree (section [2.6.4](#Section_d30e462c5f8a435b9c4ccc0b9ea89956)) representing the [**child objects**](#gt_9b04b599-9dca-48f1-aa9e-08e254d20553) of a storage object can break the assumptions of [**directory entry**](#gt_58e4a5cf-917f-4649-92c5-ece7006c120d) allocation algorithms. Such corruption might include improper sorting of child object names, invalid red/black marking, multiple child object trees referencing the same directory entry, and the aforementioned cyclical references. + +## File Security + +Because a compound file is stored as a single file in the [**file system**](#gt_528b06a4-e67c-43b3-a02d-8738858a691d), normal file-system security mechanisms can be used to help secure the compound file. This includes read/write permissions, [**access control list (ACL)**](#gt_9f92aa05-dd0a-45f2-88d6-89f1fb654395), and encryption (NTFS EFS or BitLocker) where appropriate. + +## Unallocated Ranges + +Usually, a compound file includes ranges of bytes that are not allocated for either CFB structures or user-defined data. For instance, each stream whose length is not an exact multiple of the [**sector size**](#gt_1c7c3f33-806a-4717-8e1b-930694d521d0) requires a trailing portion of the last [**sector**](#gt_b5bbe646-aa5f-4b4e-ae9e-bdae444cbfa2) in the stream's [**sector chain**](#gt_77e9e4d3-de1b-4242-8e02-09185d4e2b82) to be unused. Implementations that fail to initialize these byte ranges to zero (as recommended in section [2.7](#Section_b089dedabe204b4aaad5fbe68bb19672)) might unintentionally leak user data. + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +The terms "earlier" and "later", when used with a product version, refer to either all preceding versions or all subsequent versions, respectively. The term "through" refers to the inclusive range of versions. Applicable Microsoft products are listed chronologically in this section. + +**Windows Client** + +- Windows NT 4.0 operating system + +- Windows 98 operating system + +- Windows 2000 Professional operating system + +- Windows Millennium Edition operating system + +- Windows XP operating system + +- Windows Vista operating system + +- Windows 7 operating system + +- Windows 8 operating system + +- Windows 8.1 operating system + +- Windows 10 operating system + +- Windows 11 operating system + +**Windows Server** + +- Windows 2000 Server operating system + +- Windows Server 2003 operating system + +- Windows Server 2008 operating system + +- Windows Server 2008 R2 operating system + +- Windows Server 2012 operating system + +- Windows Server 2012 R2 operating system + +- Windows Server 2016 operating system + +- Windows Server operating system + +- Windows Server 2019 operating system + +- Windows Server 2022 operating system + +- Windows Server 2025 operating system + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 2.2](#Appendix_A_Target_1): For all Windows versions except Windows 98 and Windows Millennium Edition, the Header Transaction Signature Number can be nonzero if a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) is opened and saved with the **STGM_TRANSACTED** flag used in one of the following APIs: **StgOpenStorage**, **StgCreateDocfile**, **StgOpenStorageEx**, **StgCreateStorageEx**. For more information about this flag and the APIs, see [\[MSDN-STGMC\]](https://go.microsoft.com/fwlink/?LinkId=90140). + +[\<2\> Section 2.6.1](#Appendix_A_Target_2): When Windows sets the modified time of a root storage, it sets the modified time of the file in the file system (as described in section [2.6.2](#Section_026fde6e143d41bfa7dac08b2130d50e)) and also sets the modified time in the root storage directory entry. When Windows retrieves the modified time of a root storage, it gets the modified time of the file in the file system but ignores the modified time in the root storage directory entry. + +[\<3\> Section 2.6.4](#Appendix_A_Target_3): For Windows XP and Windows Server 2003, the compound file implementation conforms to the [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) 3.0.1 Default Case Conversion Algorithm, simple case folding [\[UNICODE3.0.1\]](https://go.microsoft.com/fwlink/?LinkId=119562), with the following exceptions. + +| Added or subtracted from Unicode 3.0.1 | Lowercase UTF-16 code point | Uppercase UTF-16 code point | Uppercase Unicode name | +|----|----|----|----| +| Subtracted | 0x280 | 0x01A6 | LATIN LETTER YR | +| Subtracted | 0x0195 | 0x01F6 | LATIN CAPITAL LETTER HWAIR | +| Subtracted | 0x01BF | 0x01F7 | LATIN CAPITAL LETTER WYNN | +| Subtracted | 0x01F9 | 0x01F8 | LATIN CAPITAL LETTER N WITH GRAVE | +| Subtracted | 0x0219 | 0x0218 | LATIN CAPITAL LETTER S WITH COMMA BELOW | +| Subtracted | 0x021B | 0x021A | LATIN CAPITAL LETTER T WITH COMMA BELOW | +| Subtracted | 0x021D | 0x021C | LATIN CAPITAL LETTER YOGH | +| Subtracted | 0x021F | 0x021E | LATIN CAPITAL LETTER H WITH CARON | +| Subtracted | 0x0223 | 0x0222 | LATIN CAPITAL LETTER OU | +| Subtracted | 0x0225 | 0x0224 | LATIN CAPITAL LETTER Z WITH HOOK | +| Subtracted | 0x0227 | 0x0226 | LATIN CAPITAL LETTER A WITH DOT ABOVE | +| Subtracted | 0x0229 | 0x0228 | LATIN CAPITAL LETTER E WITH CEDILLA | +| Subtracted | 0x022B | 0x022A | LATIN CAPITAL LETTER O WITH DIAERESIS AND MACRON | +| Subtracted | 0x022D | 0x022C | LATIN CAPITAL LETTER O WITH TILDE AND MACRON | +| Subtracted | 0x022F | 0x022E | LATIN CAPITAL LETTER O WITH DOT ABOVE | +| Subtracted | 0x0231 | 0x0230 | LATIN CAPITAL LETTER O WITH DOT ABOVE AND MACRON | +| Subtracted | 0x0233 | 0x0232 | LATIN CAPITAL LETTER Y WITH MACRON | +| Subtracted | 0x03DB | 0x03DA | GREEK LETTER SIGMA | +| Subtracted | 0x03DD | 0x03DC | GREEK LETTER DIGAMMA | +| Subtracted | 0x03DF | 0x03DE | GREEK LETTER KOPPA | +| Subtracted | 0x03E1 | 0x03E0 | GREEK LETTER SAMPI | +| Subtracted | 0x0450 | 0x0400 | CYRILLIC CAPITAL LETTER IE WITH GRAVE | +| Subtracted | 0x045D | 0x040D | CYRILLIC CAPITAL LETTER I WITH GRAVE | +| Subtracted | 0x048D | 0x048C | CYRILLIC CAPITAL LETTER SEMISOFT SIGN | +| Subtracted | 0x048F | 0x048E | CYRILLIC CAPITAL LETTER ER WITH TICK | +| Subtracted | 0x04ED | 0x04EC | CYRILLIC CAPITAL LETTER E WITH DIAERESIS | +| Added | 0x03C2 | 0x03A3 | GREEK CAPITAL LETTER SIGMA | +| Subtracted | 0x03C2 | 0x03C2 | GREEK SMALL LETTER FINAL SIGMA | + +For Windows Vista and later and for Windows Server 2008 and later, the compound file implementation conforms to the Unicode 5.0 Default Case Conversion Algorithm, simple case folding [\[UNICODE5.0.0\]](https://go.microsoft.com/fwlink/?LinkId=119564), with the following exceptions. + +| Added or subtracted from Unicode 5.0 | Lowercase UTF-16 code point | Uppercase UTF-16 code point | Uppercase Unicode name | +|----|----|----|----| +| Added | 0x023A | 02C65 | LATIN SMALL LETTER A WITH STROKE | +| Subtracted | 0x023A | 0x023A | LATIN CAPITAL LETTER A WITH STROKE | +| Added | 0x2C65 | 0x2C65 | LATIN SMALL LETTER A WITH STROKE | +| Subtracted | 0x2C65 | 0x023A | LATIN CAPITAL LETTER A WITH STROKE | +| Added | 0x023E | 0x2C66 | LATIN SMALL LETTER T WITH DIAGONAL STROKE | +| Subtracted | 0x023E | 0x023E | LATIN CAPITAL LETTER T WITH DIAGONAL STROKE | +| Added | 0x2C66 | 0x2C66 | LATIN SMALL LETTER T WITH DIAGONAL STROKE | +| Subtracted | 0x2C66 | 0x023E | LATIN CAPITAL LETTER T WITH DIAGONAL STROKE | +| Added | 0x03C2 | 0x03A3 | GREEK CAPITAL LETTER SIGMA | +| Subtracted | 0x03C2 | 0x03C2 | GREEK SMALL LETTER FINAL SIGMA | +| Added | 0x03C3 | 0x03A3 | GREEK CAPITAL LETTER SIGMA | +| Subtracted | 0x03C3 | 0x03C2 | GREEK SMALL LETTER FINAL SIGMA | +| Added | 0x1FC3 | 0x1FC3 | GREEK SMALL LETTER ETA WITH PROSGEGRAMMENI | +| Subtracted | 0x1FC3 | 0x1FCC | GREEK CAPITAL LETTER ETA WITH PROSGEGRAMMENI | +| Added | 0x1FCC | 0x1FC3 | GREEK SMALL LETTER ETA WITH PROSGEGRAMMENI | +| Subtracted | 0x1FCC | 0x1FCC | GREEK CAPITAL LETTER ETA WITH PROSGEGRAMMENI | +| Ignored | any code point \> 0xFFFF | same value (itself) | | + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [3.1](#Section_685303249d3d44419ea966a2c8f79567) The Header | 51857 : Added memory representation for CLSID | Major | +| [3.3.1](#Section_5af03a5e66dc469c89707229a11e2a3f) Stream ID 0: Root Directory Entry | 51857 : Added memory representation for CLSID | Major | +| [3.3.2](#Section_bc7d499843754910afd0a7efd8ba0600) Stream ID 1: Storage 1 | 51857 : Added memory representation for CLSID | Major | +| [3.3.3](#Section_64a78b26997a49459c7c06fca74f85eb) Stream ID 2: Stream 1 | 51857 : Added memory representation for CLSID | Major | +| [3.3.4](#Section_a70e69b76a754349b0e075bea31e9b0e) Stream ID 3: Unused, Free | 51857 : Added memory representation for CLSID | Major | + +# Index + +A + +[Applicability](#applicability-statement) 12 + +C + +[Change tracking](#change-tracking) 44 + +[Common data types and fields](#structures) 13 + +[Compound file directory entry](#compound-file-directory-entry) 23 + +[Compound_File_DIFAT_Sectors packet](#compound-file-difat-sectors) 22 + +[Compound_File_Directory_Entry packet](#compound-file-directory-entry) 23 + +[Compound_File_FAT_Sectors packet](#compound-file-fat-sectors) 20 + +[Compound_File_Header packet](#compound-file-header) 17 + +[Compound_File_Mini_FAT_Sectors packet](#compound-file-mini-fat-sectors) 21 + +[Corruption](#validation-and-corruption) 39 + +D + +[Data types and fields - common](#structures) 13 + +Details + +[common data types and fields](#structures) 13 + +[DIFAT sectors](#compound-file-difat-sectors) 22 + +Directory sectors + +[compound file directory entry](#compound-file-directory-entry) 23 + +[other directory entries](#other-directory-entries) 27 + +[overview](#compound-file-directory-sectors) 23 + +[red-black tree](#red-black-tree) 28 + +[root directory entry](#root-directory-entry) 27 + +E + +[Examples](#structure-examples) 31 + +[header](#the-header) 31 + +[overview](#structure-examples) 31 + +[sector \#0 - FAT sector](#sector-0-fat-sector) 32 + +[Sector \#0: FAT Sector](#sector-0-fat-sector) 32 + +[sector \#1 - directory sector](#sector-1-directory-sector) 33 + +[Sector \#1: Directory Sector](#sector-1-directory-sector) 33 + +[sector \#2 - MiniFAT sector](#sector-2-minifat-sector) 36 + +[Sector \#2: MiniFAT Sector](#sector-2-minifat-sector) 36 + +[sector \#3 - mini stream sector](#sector-3-mini-stream-sector) 37 + +[Sector \#3: Mini Stream Sector](#sector-3-mini-stream-sector) 37 + +[The Header](#the-header) 31 + +F + +[FAT sectors](#compound-file-fat-sectors) 20 + +[Fields - vendor-extensible](#vendor-extensible-fields) 12 + +[File security](#file-security) 39 + +G + +[Glossary](#glossary) 6 + +H + +Header ([section 2.2](#compound-file-header) 17, [section 3.1](#the-header) 31) + +I + +[Informative references](#informative-references) 9 + +[Introduction](#introduction) 5 + +L + +[Localization](#versioning-and-localization) 12 + +M + +[Mini FAT sectors](#compound-file-mini-fat-sectors) 21 + +N + +[Normative references](#normative-references) 9 + +O + +[Overview](#structures) 13 + +[Overview (synopsis)](#overview) 9 + +P + +[Product behavior](#appendix-a-product-behavior) 40 + +R + +[Range-lock sector](#compound-file-range-lock-sector) 29 + +[Red-black tree](#red-black-tree) 28 + +[References](#references) 9 + +[informative](#informative-references) 9 + +[normative](#normative-references) 9 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 11 + +[Root directory entry](#root-directory-entry) 27 + +S + +[Sector \#0 - FAT sector](#sector-0-fat-sector) 32 + +[Sector \#0: FAT Sector example](#sector-0-fat-sector) 32 + +[Sector \#1 - directory sector](#sector-1-directory-sector) 33 + +[Sector \#1: Directory Sector example](#sector-1-directory-sector) 33 + +[Sector \#2 - MiniFAT sector](#sector-2-minifat-sector) 36 + +[Sector \#2: MiniFAT Sector example](#sector-2-minifat-sector) 36 + +[Sector \#3 - mini stream sector](#sector-3-mini-stream-sector) 37 + +[Sector \#3: Mini Stream Sector example](#sector-3-mini-stream-sector) 37 + +[Sector numbers and types](#compound-file-sector-numbers-and-types) 15 + +Security + +[file security](#file-security) 39 + +[unallocated ranges](#unallocated-ranges) 39 + +[validation and corruption](#validation-and-corruption) 39 + +Security considerations + +[file security](#file-security) 39 + +[validation and corruption](#validation-and-corruption) 39 + +[Size limits](#compound-file-size-limits) 29 + +Structures + +[overview](#structures) 13 + +T + +[The Header example](#the-header) 31 + +[Tracking changes](#change-tracking) 44 + +U + +[User-defined data sectors](#compound-file-user-defined-data-sectors) 29 + +V + +[Validation](#validation-and-corruption) 39 + +[Vendor-extensible fields](#vendor-extensible-fields) 12 + +[Versioning](#versioning-and-localization) 12 diff --git a/docs/standards/doc/ms-emf.md b/docs/standards/doc/ms-emf.md new file mode 100644 index 0000000..9d3de97 --- /dev/null +++ b/docs/standards/doc/ms-emf.md @@ -0,0 +1,12559 @@ +**\[MS-EMF\]:** + +**Enhanced Metafile Format** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 4/3/2007 | 0.01 | New | Version 0.01 release | +| 7/3/2007 | 1.0 | Major | MLonghorn+90 | +| 7/20/2007 | 2.0 | Major | Restructured record sections according to category; other updates. | +| 8/10/2007 | 2.1 | Minor | Clarified the meaning of the technical content. | +| 9/28/2007 | 2.2 | Minor | Clarified the meaning of the technical content. | +| 10/23/2007 | 3.0 | Major | Added new sections describing the EMR_COMMENT_EMFPLUS and EMR_COMMENT_EMFSPOOL records. | +| 11/30/2007 | 3.1 | Minor | Standardized art. | +| 1/25/2008 | 3.2 | Minor | Reconstructed record categories for clarity. | +| 3/14/2008 | 4.0 | Major | Abstract data model and Windows version-specific behavior added. | +| 5/16/2008 | 4.0.1 | Editorial | Changed language and formatting in the technical content. | +| 6/20/2008 | 4.1 | Minor | Clarified the meaning of the technical content. | +| 7/25/2008 | 4.1.1 | Editorial | Changed language and formatting in the technical content. | +| 8/29/2008 | 4.2 | Minor | Clarified the meaning of the technical content. | +| 10/24/2008 | 5.0 | Major | Updated and revised the technical content. | +| 12/5/2008 | 5.1 | Minor | Clarified the meaning of the technical content. | +| 1/16/2009 | 6.0 | Major | Updated and revised the technical content. | +| 2/27/2009 | 6.1 | Minor | Clarified the meaning of the technical content. | +| 4/10/2009 | 6.2 | Minor | Clarified the meaning of the technical content. | +| 5/22/2009 | 6.2.1 | Editorial | Changed language and formatting in the technical content. | +| 7/2/2009 | 6.3 | Minor | Clarified the meaning of the technical content. | +| 8/14/2009 | 6.4 | Minor | Clarified the meaning of the technical content. | +| 9/25/2009 | 6.5 | Minor | Clarified the meaning of the technical content. | +| 11/6/2009 | 6.5.1 | Editorial | Changed language and formatting in the technical content. | +| 12/18/2009 | 6.6 | Minor | Clarified the meaning of the technical content. | +| 1/29/2010 | 6.6.1 | Editorial | Changed language and formatting in the technical content. | +| 3/12/2010 | 6.7 | Minor | Clarified the meaning of the technical content. | +| 4/23/2010 | 6.7.1 | Editorial | Changed language and formatting in the technical content. | +| 6/4/2010 | 6.8 | Minor | Clarified the meaning of the technical content. | +| 7/16/2010 | 6.8 | None | No changes to the meaning, language, or formatting of the technical content. | +| 8/27/2010 | 6.8 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/8/2010 | 6.9 | Minor | Clarified the meaning of the technical content. | +| 11/19/2010 | 7.0 | Major | Updated and revised the technical content. | +| 1/7/2011 | 7.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/11/2011 | 7.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/25/2011 | 7.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/6/2011 | 7.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/17/2011 | 7.1 | Minor | Clarified the meaning of the technical content. | +| 9/23/2011 | 7.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/16/2011 | 8.0 | Major | Updated and revised the technical content. | +| 3/30/2012 | 8.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/12/2012 | 8.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/25/2012 | 8.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/31/2013 | 8.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 8/8/2013 | 9.0 | Major | Updated and revised the technical content. | +| 11/14/2013 | 9.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/13/2014 | 9.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/15/2014 | 10.0 | Major | Updated and revised the technical content. | +| 6/30/2015 | 11.0 | Major | Significantly changed the technical content. | +| 10/16/2015 | 11.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/14/2016 | 12.0 | Major | Significantly changed the technical content. | +| 6/1/2017 | 12.1 | Minor | Clarified the meaning of the technical content. | +| 9/15/2017 | 13.0 | Major | Significantly changed the technical content. | +| 12/1/2017 | 13.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/12/2018 | 14.0 | Major | Significantly changed the technical content. | +| 4/7/2021 | 15.0 | Major | Significantly changed the technical content. | +| 6/25/2021 | 16.0 | Major | Significantly changed the technical content. | +| 4/29/2022 | 17.0 | Major | Significantly changed the technical content. | +| 4/23/2024 | 18.0 | Major | Significantly changed the technical content. | + +Table of Contents + +[1 Introduction [10](#introduction)](#introduction) + +[1.1 Glossary [10](#glossary)](#glossary) + +[1.2 References [16](#references)](#references) + +[1.2.1 Normative References [16](#normative-references)](#normative-references) + +[1.2.2 Informative References [17](#informative-references)](#informative-references) + +[1.3 Overview [17](#overview)](#overview) + +[1.3.1 Metafile Structure [17](#metafile-structure)](#metafile-structure) + +[1.3.2 Graphics Objects [19](#graphics-objects)](#graphics-objects) + +[1.3.3 Byte Ordering [19](#byte-ordering)](#byte-ordering) + +[1.4 Relationship to Protocols and Other Structures [19](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [20](#applicability-statement)](#applicability-statement) + +[1.6 Versioning and Localization [20](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [20](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [21](#structures)](#structures) + +[2.1 EMF Enumerations [21](#emf-enumerations)](#emf-enumerations) + +[2.1.1 RecordType Enumeration [21](#recordtype-enumeration)](#recordtype-enumeration) + +[2.1.2 ArcDirection Enumeration [28](#arcdirection-enumeration)](#arcdirection-enumeration) + +[2.1.3 ArmStyle Enumeration [29](#armstyle-enumeration)](#armstyle-enumeration) + +[2.1.4 BackgroundMode Enumeration [29](#backgroundmode-enumeration)](#backgroundmode-enumeration) + +[2.1.5 ColorAdjustment Enumeration [30](#coloradjustment-enumeration)](#coloradjustment-enumeration) + +[2.1.6 ColorMatchToTarget Enumeration [30](#colormatchtotarget-enumeration)](#colormatchtotarget-enumeration) + +[2.1.7 ColorSpace Enumeration [30](#colorspace-enumeration)](#colorspace-enumeration) + +[2.1.8 Contrast Enumeration [31](#contrast-enumeration)](#contrast-enumeration) + +[2.1.9 DIBColors Enumeration [31](#dibcolors-enumeration)](#dibcolors-enumeration) + +[2.1.10 EmrComment Enumeration [32](#emrcomment-enumeration)](#emrcomment-enumeration) + +[2.1.11 ExtTextOutOptions Enumeration [32](#exttextoutoptions-enumeration)](#exttextoutoptions-enumeration) + +[2.1.12 FamilyType Enumeration [33](#familytype-enumeration)](#familytype-enumeration) + +[2.1.13 FloodFill Enumeration [34](#floodfill-enumeration)](#floodfill-enumeration) + +[2.1.14 FormatSignature Enumeration [34](#formatsignature-enumeration)](#formatsignature-enumeration) + +[2.1.15 GradientFill Enumeration [34](#gradientfill-enumeration)](#gradientfill-enumeration) + +[2.1.16 GraphicsMode Enumeration [35](#graphicsmode-enumeration)](#graphicsmode-enumeration) + +[2.1.17 HatchStyle Enumeration [36](#hatchstyle-enumeration)](#hatchstyle-enumeration) + +[2.1.18 ICMMode Enumeration [36](#icmmode-enumeration)](#icmmode-enumeration) + +[2.1.19 Illuminant Enumeration [36](#illuminant-enumeration)](#illuminant-enumeration) + +[2.1.20 Letterform Enumeration [37](#letterform-enumeration)](#letterform-enumeration) + +[2.1.21 MapMode Enumeration [38](#mapmode-enumeration)](#mapmode-enumeration) + +[2.1.22 MetafileVersion Enumeration [39](#metafileversion-enumeration)](#metafileversion-enumeration) + +[2.1.23 MidLine Enumeration [39](#midline-enumeration)](#midline-enumeration) + +[2.1.24 ModifyWorldTransformMode Enumeration [40](#modifyworldtransformmode-enumeration)](#modifyworldtransformmode-enumeration) + +[2.1.25 PenStyle Enumeration [40](#penstyle-enumeration)](#penstyle-enumeration) + +[2.1.26 Point Enumeration [41](#point-enumeration)](#point-enumeration) + +[2.1.27 PolygonFillMode Enumeration [42](#polygonfillmode-enumeration)](#polygonfillmode-enumeration) + +[2.1.28 Proportion Enumeration [42](#proportion-enumeration)](#proportion-enumeration) + +[2.1.29 RegionMode Enumeration [43](#regionmode-enumeration)](#regionmode-enumeration) + +[2.1.30 SerifType Enumeration [43](#seriftype-enumeration)](#seriftype-enumeration) + +[2.1.31 StockObject Enumeration [44](#stockobject-enumeration)](#stockobject-enumeration) + +[2.1.32 StretchMode Enumeration [47](#stretchmode-enumeration)](#stretchmode-enumeration) + +[2.1.33 StrokeVariation Enumeration [47](#strokevariation-enumeration)](#strokevariation-enumeration) + +[2.1.34 Weight Enumeration [48](#weight-enumeration)](#weight-enumeration) + +[2.1.35 XHeight Enumeration [48](#xheight-enumeration)](#xheight-enumeration) + +[2.2 EMF Objects [49](#emf-objects)](#emf-objects) + +[2.2.1 BitFIX28_4 Object [49](#bitfix28_4-object)](#bitfix28_4-object) + +[2.2.2 ColorAdjustment Object [49](#coloradjustment-object)](#coloradjustment-object) + +[2.2.3 DesignVector Object [51](#designvector-object)](#designvector-object) + +[2.2.4 EmrFormat Object [51](#emrformat-object)](#emrformat-object) + +[2.2.5 EmrText Object [52](#emrtext-object)](#emrtext-object) + +[2.2.6 EpsData Object [54](#epsdata-object)](#epsdata-object) + +[2.2.7 GradientRectangle Object [55](#gradientrectangle-object)](#gradientrectangle-object) + +[2.2.8 GradientTriangle Object [55](#gradienttriangle-object)](#gradienttriangle-object) + +[2.2.9 Header Object [56](#header-object)](#header-object) + +[2.2.10 HeaderExtension1 Object [57](#headerextension1-object)](#headerextension1-object) + +[2.2.11 HeaderExtension2 Object [58](#headerextension2-object)](#headerextension2-object) + +[2.2.12 LogBrushEx Object [58](#logbrushex-object)](#logbrushex-object) + +[2.2.13 LogFont Object [59](#logfont-object)](#logfont-object) + +[2.2.14 LogFontEx Object [61](#logfontex-object)](#logfontex-object) + +[2.2.15 LogFontExDv Object [62](#logfontexdv-object)](#logfontexdv-object) + +[2.2.16 LogFontPanose Object [62](#logfontpanose-object)](#logfontpanose-object) + +[2.2.17 LogPalette Object [64](#logpalette-object)](#logpalette-object) + +[2.2.18 LogPaletteEntry Object [64](#logpaletteentry-object)](#logpaletteentry-object) + +[2.2.19 LogPen Object [65](#logpen-object)](#logpen-object) + +[2.2.20 LogPenEx Object [65](#logpenex-object)](#logpenex-object) + +[2.2.21 Panose Object [67](#panose-object)](#panose-object) + +[2.2.22 PixelFormatDescriptor Object [68](#pixelformatdescriptor-object)](#pixelformatdescriptor-object) + +[2.2.23 Point28_4 Object [71](#point28_4-object)](#point28_4-object) + +[2.2.24 RegionData Object [71](#regiondata-object)](#regiondata-object) + +[2.2.25 RegionDataHeader Object [72](#regiondataheader-object)](#regiondataheader-object) + +[2.2.26 TriVertex Object [72](#trivertex-object)](#trivertex-object) + +[2.2.27 UniversalFontId Object [73](#universalfontid-object)](#universalfontid-object) + +[2.2.28 XForm Object [74](#xform-object)](#xform-object) + +[2.3 EMF Records [74](#emf-records)](#emf-records) + +[2.3.1 Bitmap Record Types [75](#bitmap-record-types)](#bitmap-record-types) + +[2.3.1.1 EMR_ALPHABLEND Record [77](#emr_alphablend-record)](#emr_alphablend-record) + +[2.3.1.2 EMR_BITBLT Record [82](#emr_bitblt-record)](#emr_bitblt-record) + +[2.3.1.3 EMR_MASKBLT Record [84](#emr_maskblt-record)](#emr_maskblt-record) + +[2.3.1.4 EMR_PLGBLT Record [88](#emr_plgblt-record)](#emr_plgblt-record) + +[2.3.1.5 EMR_SETDIBITSTODEVICE Record [92](#emr_setdibitstodevice-record)](#emr_setdibitstodevice-record) + +[2.3.1.6 EMR_STRETCHBLT Record [94](#emr_stretchblt-record)](#emr_stretchblt-record) + +[2.3.1.7 EMR_STRETCHDIBITS Record [97](#emr_stretchdibits-record)](#emr_stretchdibits-record) + +[2.3.1.8 EMR_TRANSPARENTBLT Record [100](#emr_transparentblt-record)](#emr_transparentblt-record) + +[2.3.2 Clipping Record Types [102](#clipping-record-types)](#clipping-record-types) + +[2.3.2.1 EMR_EXCLUDECLIPRECT Record [104](#emr_excludecliprect-record)](#emr_excludecliprect-record) + +[2.3.2.2 EMR_EXTSELECTCLIPRGN Record [105](#emr_extselectcliprgn-record)](#emr_extselectcliprgn-record) + +[2.3.2.3 EMR_INTERSECTCLIPRECT Record [105](#emr_intersectcliprect-record)](#emr_intersectcliprect-record) + +[2.3.2.4 EMR_OFFSETCLIPRGN Record [106](#emr_offsetcliprgn-record)](#emr_offsetcliprgn-record) + +[2.3.2.5 EMR_SELECTCLIPPATH Record [106](#emr_selectclippath-record)](#emr_selectclippath-record) + +[2.3.3 Comment Record Types [107](#comment-record-types)](#comment-record-types) + +[2.3.3.1 EMR_COMMENT Record [108](#emr_comment-record)](#emr_comment-record) + +[2.3.3.2 EMR_COMMENT_EMFPLUS Record [109](#emr_comment_emfplus-record)](#emr_comment_emfplus-record) + +[2.3.3.3 EMR_COMMENT_EMFSPOOL Record [109](#emr_comment_emfspool-record)](#emr_comment_emfspool-record) + +[2.3.3.4 EMR_COMMENT_PUBLIC Record Types [110](#emr_comment_public-record-types)](#emr_comment_public-record-types) + +[2.3.3.4.1 EMR_COMMENT_BEGINGROUP Record [111](#emr_comment_begingroup-record)](#emr_comment_begingroup-record) + +[2.3.3.4.2 EMR_COMMENT_ENDGROUP Record [112](#emr_comment_endgroup-record)](#emr_comment_endgroup-record) + +[2.3.3.4.3 EMR_COMMENT_MULTIFORMATS Record [113](#emr_comment_multiformats-record)](#emr_comment_multiformats-record) + +[2.3.3.4.4 EMR_COMMENT_WINDOWS_METAFILE Record [114](#emr_comment_windows_metafile-record)](#emr_comment_windows_metafile-record) + +[2.3.4 Control Record Types [115](#control-record-types)](#control-record-types) + +[2.3.4.1 EMR_EOF Record [116](#emr_eof-record)](#emr_eof-record) + +[2.3.4.2 EMR_HEADER Record Types [117](#emr_header-record-types)](#emr_header-record-types) + +[2.3.4.2.1 EmfMetafileHeader Record [120](#emfmetafileheader-record)](#emfmetafileheader-record) + +[2.3.4.2.2 EmfMetafileHeaderExtension1 Record [121](#emfmetafileheaderextension1-record)](#emfmetafileheaderextension1-record) + +[2.3.4.2.3 EmfMetafileHeaderExtension2 Record [122](#emfmetafileheaderextension2-record)](#emfmetafileheaderextension2-record) + +[2.3.5 Drawing Record Types [124](#drawing-record-types)](#drawing-record-types) + +[2.3.5.1 EMR_ANGLEARC Record [128](#emr_anglearc-record)](#emr_anglearc-record) + +[2.3.5.2 EMR_ARC Record [129](#emr_arc-record)](#emr_arc-record) + +[2.3.5.3 EMR_ARCTO Record [130](#emr_arcto-record)](#emr_arcto-record) + +[2.3.5.4 EMR_CHORD Record [131](#emr_chord-record)](#emr_chord-record) + +[2.3.5.5 EMR_ELLIPSE Record [132](#emr_ellipse-record)](#emr_ellipse-record) + +[2.3.5.6 EMR_EXTFLOODFILL Record [132](#emr_extfloodfill-record)](#emr_extfloodfill-record) + +[2.3.5.7 EMR_EXTTEXTOUTA Record [133](#emr_exttextouta-record)](#emr_exttextouta-record) + +[2.3.5.8 EMR_EXTTEXTOUTW Record [134](#emr_exttextoutw-record)](#emr_exttextoutw-record) + +[2.3.5.9 EMR_FILLPATH Record [135](#emr_fillpath-record)](#emr_fillpath-record) + +[2.3.5.10 EMR_FILLRGN Record [135](#emr_fillrgn-record)](#emr_fillrgn-record) + +[2.3.5.11 EMR_FRAMERGN Record [136](#emr_framergn-record)](#emr_framergn-record) + +[2.3.5.12 EMR_GRADIENTFILL Record [137](#emr_gradientfill-record)](#emr_gradientfill-record) + +[2.3.5.13 EMR_LINETO Record [139](#emr_lineto-record)](#emr_lineto-record) + +[2.3.5.14 EMR_PAINTRGN Record [140](#emr_paintrgn-record)](#emr_paintrgn-record) + +[2.3.5.15 EMR_PIE Record [140](#emr_pie-record)](#emr_pie-record) + +[2.3.5.16 EMR_POLYBEZIER Record [141](#emr_polybezier-record)](#emr_polybezier-record) + +[2.3.5.17 EMR_POLYBEZIER16 Record [142](#emr_polybezier16-record)](#emr_polybezier16-record) + +[2.3.5.18 EMR_POLYBEZIERTO Record [143](#emr_polybezierto-record)](#emr_polybezierto-record) + +[2.3.5.19 EMR_POLYBEZIERTO16 Record [144](#emr_polybezierto16-record)](#emr_polybezierto16-record) + +[2.3.5.20 EMR_POLYDRAW Record [145](#emr_polydraw-record)](#emr_polydraw-record) + +[2.3.5.21 EMR_POLYDRAW16 Record [146](#emr_polydraw16-record)](#emr_polydraw16-record) + +[2.3.5.22 EMR_POLYGON Record [147](#emr_polygon-record)](#emr_polygon-record) + +[2.3.5.23 EMR_POLYGON16 Record [148](#emr_polygon16-record)](#emr_polygon16-record) + +[2.3.5.24 EMR_POLYLINE Record [149](#emr_polyline-record)](#emr_polyline-record) + +[2.3.5.25 EMR_POLYLINE16 Record [150](#emr_polyline16-record)](#emr_polyline16-record) + +[2.3.5.26 EMR_POLYLINETO Record [150](#emr_polylineto-record)](#emr_polylineto-record) + +[2.3.5.27 EMR_POLYLINETO16 Record [151](#emr_polylineto16-record)](#emr_polylineto16-record) + +[2.3.5.28 EMR_POLYPOLYGON Record [152](#emr_polypolygon-record)](#emr_polypolygon-record) + +[2.3.5.29 EMR_POLYPOLYGON16 Record [153](#emr_polypolygon16-record)](#emr_polypolygon16-record) + +[2.3.5.30 EMR_POLYPOLYLINE Record [154](#emr_polypolyline-record)](#emr_polypolyline-record) + +[2.3.5.31 EMR_POLYPOLYLINE16 Record [156](#emr_polypolyline16-record)](#emr_polypolyline16-record) + +[2.3.5.32 EMR_POLYTEXTOUTA Record [156](#emr_polytextouta-record)](#emr_polytextouta-record) + +[2.3.5.33 EMR_POLYTEXTOUTW Record [158](#emr_polytextoutw-record)](#emr_polytextoutw-record) + +[2.3.5.34 EMR_RECTANGLE Record [159](#emr_rectangle-record)](#emr_rectangle-record) + +[2.3.5.35 EMR_ROUNDRECT Record [159](#emr_roundrect-record)](#emr_roundrect-record) + +[2.3.5.36 EMR_SETPIXELV Record [160](#emr_setpixelv-record)](#emr_setpixelv-record) + +[2.3.5.37 EMR_SMALLTEXTOUT Record [161](#emr_smalltextout-record)](#emr_smalltextout-record) + +[2.3.5.38 EMR_STROKEANDFILLPATH Record [162](#emr_strokeandfillpath-record)](#emr_strokeandfillpath-record) + +[2.3.5.39 EMR_STROKEPATH Record [163](#emr_strokepath-record)](#emr_strokepath-record) + +[2.3.6 Escape Record Types [163](#escape-record-types)](#escape-record-types) + +[2.3.6.1 EMR_DRAWESCAPE Record [164](#emr_drawescape-record)](#emr_drawescape-record) + +[2.3.6.2 EMR_EXTESCAPE Record [165](#emr_extescape-record)](#emr_extescape-record) + +[2.3.6.3 EMR_NAMEDESCAPE Record [165](#emr_namedescape-record)](#emr_namedescape-record) + +[2.3.7 Object Creation Record Types [166](#object-creation-record-types)](#object-creation-record-types) + +[2.3.7.1 EMR_CREATEBRUSHINDIRECT Record [168](#emr_createbrushindirect-record)](#emr_createbrushindirect-record) + +[2.3.7.2 EMR_CREATECOLORSPACE Record [169](#emr_createcolorspace-record)](#emr_createcolorspace-record) + +[2.3.7.3 EMR_CREATECOLORSPACEW Record [169](#emr_createcolorspacew-record)](#emr_createcolorspacew-record) + +[2.3.7.4 EMR_CREATEDIBPATTERNBRUSHPT Record [170](#emr_createdibpatternbrushpt-record)](#emr_createdibpatternbrushpt-record) + +[2.3.7.5 EMR_CREATEMONOBRUSH Record [172](#emr_createmonobrush-record)](#emr_createmonobrush-record) + +[2.3.7.6 EMR_CREATEPALETTE Record [173](#emr_createpalette-record)](#emr_createpalette-record) + +[2.3.7.7 EMR_CREATEPEN Record [174](#emr_createpen-record)](#emr_createpen-record) + +[2.3.7.8 EMR_EXTCREATEFONTINDIRECTW Record [175](#emr_extcreatefontindirectw-record)](#emr_extcreatefontindirectw-record) + +[2.3.7.9 EMR_EXTCREATEPEN Record [176](#emr_extcreatepen-record)](#emr_extcreatepen-record) + +[2.3.8 Object Manipulation Record Types [177](#object-manipulation-record-types)](#object-manipulation-record-types) + +[2.3.8.1 EMR_COLORCORRECTPALETTE Record [179](#emr_colorcorrectpalette-record)](#emr_colorcorrectpalette-record) + +[2.3.8.2 EMR_DELETECOLORSPACE Record [180](#emr_deletecolorspace-record)](#emr_deletecolorspace-record) + +[2.3.8.3 EMR_DELETEOBJECT Record [180](#emr_deleteobject-record)](#emr_deleteobject-record) + +[2.3.8.4 EMR_RESIZEPALETTE Record [181](#emr_resizepalette-record)](#emr_resizepalette-record) + +[2.3.8.5 EMR_SELECTOBJECT Record [181](#emr_selectobject-record)](#emr_selectobject-record) + +[2.3.8.6 EMR_SELECTPALETTE Record [182](#emr_selectpalette-record)](#emr_selectpalette-record) + +[2.3.8.7 EMR_SETCOLORSPACE Record [182](#emr_setcolorspace-record)](#emr_setcolorspace-record) + +[2.3.8.8 EMR_SETPALETTEENTRIES Record [183](#emr_setpaletteentries-record)](#emr_setpaletteentries-record) + +[2.3.9 OpenGL Record Types [184](#opengl-record-types)](#opengl-record-types) + +[2.3.9.1 EMR_GLSBOUNDEDRECORD Record [185](#emr_glsboundedrecord-record)](#emr_glsboundedrecord-record) + +[2.3.9.2 EMR_GLSRECORD Record [185](#emr_glsrecord-record)](#emr_glsrecord-record) + +[2.3.10 Path Bracket Record Types [186](#path-bracket-record-types)](#path-bracket-record-types) + +[2.3.11 State Record Types [187](#state-record-types)](#state-record-types) + +[2.3.11.1 EMR_COLORMATCHTOTARGETW Record [191](#emr_colormatchtotargetw-record)](#emr_colormatchtotargetw-record) + +[2.3.11.2 EMR_FORCEUFIMAPPING Record [192](#emr_forceufimapping-record)](#emr_forceufimapping-record) + +[2.3.11.3 EMR_INVERTRGN Record [192](#emr_invertrgn-record)](#emr_invertrgn-record) + +[2.3.11.4 EMR_MOVETOEX Record [193](#emr_movetoex-record)](#emr_movetoex-record) + +[2.3.11.5 EMR_PIXELFORMAT Record [194](#emr_pixelformat-record)](#emr_pixelformat-record) + +[2.3.11.6 EMR_RESTOREDC Record [194](#emr_restoredc-record)](#emr_restoredc-record) + +[2.3.11.7 EMR_SCALEVIEWPORTEXTEX Record [195](#emr_scaleviewportextex-record)](#emr_scaleviewportextex-record) + +[2.3.11.8 EMR_SCALEWINDOWEXTEX Record [195](#emr_scalewindowextex-record)](#emr_scalewindowextex-record) + +[2.3.11.9 EMR_SETARCDIRECTION Record [196](#emr_setarcdirection-record)](#emr_setarcdirection-record) + +[2.3.11.10 EMR_SETBKCOLOR Record [197](#emr_setbkcolor-record)](#emr_setbkcolor-record) + +[2.3.11.11 EMR_SETBKMODE Record [197](#emr_setbkmode-record)](#emr_setbkmode-record) + +[2.3.11.12 EMR_SETBRUSHORGEX Record [198](#emr_setbrushorgex-record)](#emr_setbrushorgex-record) + +[2.3.11.13 EMR_SETCOLORADJUSTMENT Record [198](#emr_setcoloradjustment-record)](#emr_setcoloradjustment-record) + +[2.3.11.14 EMR_SETICMMODE Record [199](#emr_seticmmode-record)](#emr_seticmmode-record) + +[2.3.11.15 EMR_SETICMPROFILEA Record [199](#emr_seticmprofilea-record)](#emr_seticmprofilea-record) + +[2.3.11.16 EMR_SETICMPROFILEW Record [200](#emr_seticmprofilew-record)](#emr_seticmprofilew-record) + +[2.3.11.17 EMR_SETLAYOUT Record [201](#emr_setlayout-record)](#emr_setlayout-record) + +[2.3.11.18 EMR_SETLINKEDUFIS Record [202](#emr_setlinkedufis-record)](#emr_setlinkedufis-record) + +[2.3.11.19 EMR_SETMAPMODE Record [202](#emr_setmapmode-record)](#emr_setmapmode-record) + +[2.3.11.20 EMR_SETMAPPERFLAGS Record [203](#emr_setmapperflags-record)](#emr_setmapperflags-record) + +[2.3.11.21 EMR_SETMITERLIMIT Record [203](#emr_setmiterlimit-record)](#emr_setmiterlimit-record) + +[2.3.11.22 EMR_SETPOLYFILLMODE Record [204](#emr_setpolyfillmode-record)](#emr_setpolyfillmode-record) + +[2.3.11.23 EMR_SETROP2 Record [204](#emr_setrop2-record)](#emr_setrop2-record) + +[2.3.11.24 EMR_SETSTRETCHBLTMODE Record [205](#emr_setstretchbltmode-record)](#emr_setstretchbltmode-record) + +[2.3.11.25 EMR_SETTEXTALIGN Record [205](#emr_settextalign-record)](#emr_settextalign-record) + +[2.3.11.26 EMR_SETTEXTCOLOR Record [206](#emr_settextcolor-record)](#emr_settextcolor-record) + +[2.3.11.27 EMR_SETTEXTJUSTIFICATION Record [206](#emr_settextjustification-record)](#emr_settextjustification-record) + +[2.3.11.28 EMR_SETVIEWPORTEXTEX Record [207](#emr_setviewportextex-record)](#emr_setviewportextex-record) + +[2.3.11.29 EMR_SETVIEWPORTORGEX Record [207](#emr_setviewportorgex-record)](#emr_setviewportorgex-record) + +[2.3.11.30 EMR_SETWINDOWEXTEX Record [208](#emr_setwindowextex-record)](#emr_setwindowextex-record) + +[2.3.11.31 EMR_SETWINDOWORGEX Record [208](#emr_setwindoworgex-record)](#emr_setwindoworgex-record) + +[2.3.12 Transform Record Types [209](#transform-record-types)](#transform-record-types) + +[2.3.12.1 EMR_MODIFYWORLDTRANSFORM Record [210](#emr_modifyworldtransform-record)](#emr_modifyworldtransform-record) + +[2.3.12.2 EMR_SETWORLDTRANSFORM Record [211](#emr_setworldtransform-record)](#emr_setworldtransform-record) + +[3 Structure Examples [212](#structure-examples)](#structure-examples) + +[3.1 EMF Metafile Playback [212](#emf-metafile-playback)](#emf-metafile-playback) + +[3.1.1 Abstract Data Model [212](#abstract-data-model)](#abstract-data-model) + +[3.1.1.1 EMF Object Table [212](#emf-object-table)](#emf-object-table) + +[3.1.1.2 Graphics Environment [214](#graphics-environment)](#graphics-environment) + +[3.1.1.2.1 Regions [214](#regions)](#regions) + +[3.1.1.2.2 Colors [215](#colors)](#colors) + +[3.1.1.2.3 Text [215](#text)](#text) + +[3.1.1.2.4 Drawing [216](#drawing)](#drawing) + +[3.1.2 Byte Ordering [217](#byte-ordering-1)](#byte-ordering-1) + +[3.2 EMF Metafile Example [218](#emf-metafile-example)](#emf-metafile-example) + +[3.2.1 EMR_HEADER Example [231](#emr_header-example)](#emr_header-example) + +[3.2.2 EMR_CREATEBRUSHINDIRECT Example [233](#emr_createbrushindirect-example)](#emr_createbrushindirect-example) + +[3.2.3 EMR_SELECTOBJECT Example 1 [234](#emr_selectobject-example-1)](#emr_selectobject-example-1) + +[3.2.4 EMR_BITBLT Example 1 [235](#emr_bitblt-example-1)](#emr_bitblt-example-1) + +[3.2.5 EMR_SELECTOBJECT Example 2 [237](#emr_selectobject-example-2)](#emr_selectobject-example-2) + +[3.2.6 EMR_BITBLT Example 2 [237](#emr_bitblt-example-2)](#emr_bitblt-example-2) + +[3.2.7 EMR_SETBKMODE Example [251](#emr_setbkmode-example)](#emr_setbkmode-example) + +[3.2.8 EMR_EXTCREATEFONTINDIRECTW Example 1 [251](#emr_extcreatefontindirectw-example-1)](#emr_extcreatefontindirectw-example-1) + +[3.2.9 EMR_SELECTOBJECT Example 3 [254](#emr_selectobject-example-3)](#emr_selectobject-example-3) + +[3.2.10 EMR_EXTTEXTOUTW Example [255](#emr_exttextoutw-example)](#emr_exttextoutw-example) + +[3.2.11 EMR_EXTCREATEFONTINDIRECTW Example 2 [256](#emr_extcreatefontindirectw-example-2)](#emr_extcreatefontindirectw-example-2) + +[3.2.12 EMR_SELECTOBJECT Example 4 [259](#emr_selectobject-example-4)](#emr_selectobject-example-4) + +[3.2.13 EMR_EXTCREATEFONTINDIRECTW Example 3 [260](#emr_extcreatefontindirectw-example-3)](#emr_extcreatefontindirectw-example-3) + +[3.2.14 EMR_SELECTOBJECT Example 5 [263](#emr_selectobject-example-5)](#emr_selectobject-example-5) + +[3.2.15 EMR_DELETEOBJECT Example 1 [263](#emr_deleteobject-example-1)](#emr_deleteobject-example-1) + +[3.2.16 EMR_EXTCREATEFONTINDIRECTW Example 4 [264](#emr_extcreatefontindirectw-example-4)](#emr_extcreatefontindirectw-example-4) + +[3.2.17 EMR_SELECTOBJECT Example 6 [267](#emr_selectobject-example-6)](#emr_selectobject-example-6) + +[3.2.18 EMR_SELECTOBJECT Example 7 [267](#emr_selectobject-example-7)](#emr_selectobject-example-7) + +[3.2.19 EMR_DELETEOBJECT Example 2 [268](#emr_deleteobject-example-2)](#emr_deleteobject-example-2) + +[3.2.20 EMR_DELETEOBJECT Example 3 [268](#emr_deleteobject-example-3)](#emr_deleteobject-example-3) + +[3.2.21 EMR_SELECTOBJECT Example 8 [268](#emr_selectobject-example-8)](#emr_selectobject-example-8) + +[3.2.22 EMR_EOF Example [269](#emr_eof-example)](#emr_eof-example) + +[4 Security Considerations [270](#security-considerations)](#security-considerations) + +[5 Appendix A: Product Behavior [271](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [278](#change-tracking)](#change-tracking) + +[7 Index [279](#index)](#index) + +# Introduction + +[**Enhanced metafile format (EMF)**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) is a file format that is used to store portable representations of graphical images. EMF [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) contain sequential records that are parsed and processed to render the stored image on any output device. + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **28.4 bit FIX notation**: A notation for representing the location of a point on a device surface to within one-sixteenth of a pixel. Each point coordinate is a 32-bit value, of which the 28 higher-order bits are the signed integral part and the 4 lower-order bits are the unsigned fractional part, in one-sixteenth units of distance. For example, the number 0x0000003C is a coordinate value of 3.75, because the fractional part is 12 sixteenths, or 0.75. +> +> **alpha transparency**: An alpha value is a transparency value represented by a number between zero and one. Each pixel has an alpha value that represents its level of transparency, which is multiplied by the color values to get the final value. Each pixel has an alpha value that represents its level of transparency. +> +> **American National Standards Institute (ANSI) character set**: A character set defined by a code page approved by the American National Standards Institute (ANSI). The term "ANSI" as used to signify Windows code pages is a historical reference and a misnomer that persists in the Windows community. The source of this misnomer stems from the fact that the Windows code page 1252 was originally based on an ANSI draft, which became International Organization for Standardization (ISO) Standard 8859-1 [\[ISO/IEC-8859-1\]](https://go.microsoft.com/fwlink/?LinkId=90689). In Windows, the ANSI character set can be any of the following code pages: 1252, 1250, 1251, 1253, 1254, 1255, 1256, 1257, 1258, 874, 932, 936, 949, or 950. For example, "ANSI application" is usually a reference to a non-[**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) or code-page-based application. Therefore, "ANSI character set" is often misused to refer to one of the character sets defined by a Windows code page that can be used as an active system code page; for example, character sets defined by code page 1252 or character sets defined by code page 950. Windows is now based on [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8), so the use of ANSI character sets is strongly discouraged unless they are used to interoperate with legacy applications or legacy data. +> +> **anisotropic**: Refers to the properties of an image, such as the scaling of logical units to device units, which are not the same regardless of the direction (x-axis versus y-axis) that is measured. Contrast with [**isotropic**](#gt_716e3252-cd28-451e-be10-bde8793f0534). +> +> **ASCII**: The American Standard Code for Information Interchange (ASCII) is an 8-bit character-encoding scheme based on the English alphabet. ASCII codes represent text in computers, communications equipment, and other devices that work with text. ASCII refers to a single 8-bit ASCII character or an array of 8-bit ASCII characters with the high bit of each character set to zero. +> +> **aspect ratio**: The ratio that is computed by dividing the width of a pixel on a given output device by its height. +> +> **baseline**: The imaginary line to which the bottom of the lowercase "x" character in a font [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) is aligned. +> +> **Bezier curve**: A type of curve, defined by a mathematical formula and a number of points greater than or equal to two, which is used in computer graphics and in the mathematical field of numeric analysis. A cubic [**Bezier curve**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5) is defined by four points: two endpoints and two control points. The curve does not pass through the control points, but the control points act like magnets, pulling the curve in certain directions and influencing the way the curve bends. With multiple [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5), the endpoint of one is the starting point of the next. +> +> **big-endian**: Multiple-byte values that are byte-ordered with the most significant byte stored in the memory location with the lowest address. +> +> **bitmap**: A collection of structures that contain a representation of a graphical image, a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3), dimensions and other information. +> +> **Boolean**: An operation or expression that can be evaluated only as either true or false. +> +> **brightness**: The relative lightness or darkness of an image, or of a particular color in an image. +> +> **cell height**: A vertical measure of font size, which is the sum of the font height and internal leading. It might not be the same as the distance between two lines of text. +> +> **Color correction**: Altering the colors in an image in order to print or display it such that the colors correctly match reality. +> +> **color gamut**: The entire range of colors that is available on a particular graphics output device such as a display or printer. +> +> **color mapping**: The process of associating integer color indices with color channel values. +> +> **color matching**: The conversion of a color, sent from its original color space, to its visually closest color in the destination color space. See also [**Image Color Management (ICM)**](#gt_fcd5ee55-57ff-45d6-b51e-2ccba47329e3). +> +> **color plane**: In [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) graphics, all pixel information for a single color. See also color channel. +> +> **color profile**: A file that contains information about how to convert colors in the color space and the color gamut of a specific device into a device-independent color space. A device-specific color profile is called a "device profile". For more information on using color and device profiles, see [\[MSDN-UDP\]](https://go.microsoft.com/fwlink/?LinkId=90151). +> +> **color proofing**: The process of previewing, or proofing colors, which were developed on one device, on a different device. +> +> **color space**: A mapping of color components to a multidimensional coordinate system. The number of dimensions is generally two, three, or four. For example, if colors are expressed as a combination of the three components red, green, and blue, a three-dimensional space is sufficient to describe all possible colors. If transparency is considered one of the components of an RGB color, four dimensions are appropriate. +> +> **color table**: An array of data that maps pixel values into a [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5). +> +> **colorfulness**: A concept referring to the perceived [**intensity**](#gt_f44dd201-e056-4467-bf8a-2dc1f4586a44) of a specific color, the difference between a color against gray. +> +> **compositing**: The process that takes place during image rendering, which combines color data from multiple graphics region. +> +> **contrast**: The relative difference between lightness and darkness in an area of an image. +> +> **coordinate space**: A space based on Cartesian coordinates, which provides a means of specifying the location of each point in the space. A two-dimensional coordinate space requires two axes that are perpendicular and equal in length. Three two-dimensional coordinate spaces are generally used to describe an output surface: world, page, and device. To scale device-independent output for a particular physical device, a rectangular area in the world or page coordinate space is mapped into the device coordinate space using a [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) +> +> **design vector**: A set of specific values for the font axes of a [**multiple master**](#gt_fef5ee7a-ad0c-4395-a1ac-f130405eec03) font. +> +> **device context**: A collection of properties and objects that defines a dynamic environment for processes on a device. For graphics output, properties include brush style, line style, text layout, foreground and background colors, and [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae); and objects include a brush, pen, font, [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5), [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), and transform matrix. Multiple device contexts can exist simultaneously, but a single device context specifies the environment for graphics output at a particular point in time. +> +> **device space**: The output space for graphics [**transforms**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). It usually refers to the client area of an application window; however, it can also include the entire desktop, a complete window, or a page of printer or plotter paper. Physical device space dimensions vary according to the dimensions set by the display, printer, or plotter technology. +> +> **device-independent bitmap (DIB)**: A container for bitmapped graphics, which specifies characteristics of the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) such that it can be created using one application and loaded and displayed in another application, while retaining an identical appearance. +> +> **dithering**: A form of digital halftoning. +> +> **ducking**: A ducking font is one that has been designed to be short enough to fit under diacritical marks or accent marks. +> +> **em size**: A measure of font size, which is the [**cell height**](#gt_b97118e3-2175-4af5-b1f9-462e57501090) minus the [**internal leading**](#gt_9efb809f-982e-4f1e-9dc8-89a65f22c732). An "em" is a term that has been used historically as a unit of typeset size. +> +> **encapsulated PostScript (EPS)**: A file of [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) raw data that describes the appearance of a single page. Although EPS data can describe text, graphics, and images; the primary purpose of an EPS file is to be encapsulated within another [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) page definition. +> +> **enhanced metafile format (EMF)**: A file format that supports the device-independent definitions of images. +> +> **enhanced metafile format plus extensions (EMF+)**: A file format that supports the device-independent definitions of images. +> +> **enhanced metafile spool format (EMFSPOOL)**: A format that specifies a structure of [**enhanced metafile format (EMF)**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) records used for defining application and device-independent printer spool files. +> +> **font axis**: A property of font design that can assume a linear range of values. In general, a font has multiple axes. For example, a font may define an axis for [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d), along which range the possible values for that property. +> +> **font hinting**: The use of mathematical operations to manipulate the appearance of an outline font so that it lines up with a [**rasterized**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c) grid. At small resolutions, with or without anti-aliasing, hinting is critical for producing clear, legible text for human readers. +> +> **font mapper**: An operating system component that maps specified font attributes to available, installed fonts on the system. +> +> **gamma correction**: In digital imaging, the process of changing the brightness, contrast, or color balance of an image by assigning new values (different colors) to gray or color tones. +> +> **Graphics Device Interface (GDI)**: An API, supported on 16-bit and 32-bit versions of the operating system, that supports graphics operations and image manipulation on logical graphics objects. +> +> **Graphics Device Interface, Extended (GDI+)**: A Windows API, supported on 32-bit and 64-bit versions of the operating system, that extends [**GDI**](#gt_6c550e84-9a9c-46ef-8716-7260fe29cae3) to include support for Bezier curves, gradient brushes, image effects, and [**EMF+**](#gt_41a5b58b-b050-4001-85ec-d6ed56379ee2) metafiles. +> +> **halftone**: A color representation consisting of a discrete gray or tone level. +> +> **Image Color Management (ICM)**: Technology that ensures that a color image, graphic, or text object is rendered as closely as possible to its original intent on any device despite differences in imaging technologies and color capabilities between devices. +> +> **inclusive-inclusive**: When referring to the bounds of a rectangle that consist of two coordinates—one coordinate for one corner and the other coordinate for the opposite corner [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) means that the coordinates are part of the rectangle. If not [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4), the coordinates are not part of the rectangle and instead are one logical unit outside the bounds of the rectangle along both coordinate axes. +> +> **intensity**: The magnitude of a component color in the color space. +> +> **internal leading**: The amount of space inside a character cell, within the bounds set by the font ascent. Accent marks can occur in this area. +> +> **isotropic**: Refers to the properties of an image, such as the scaling of logical units to device units, which are the same regardless of the direction (x-axis versus y-axis) that is measured. Contrast with [**anisotropic**](#gt_8356f4cd-ad99-4fb4-a10e-6aeeb1712c26). +> +> **Joint Photographic Experts Group (JPEG)**: A raster graphics file format for displaying high-resolution color graphics. JPEG graphics apply a user-specified compression scheme that can significantly reduce the file sizes of photo-realistic color graphics. A higher level of compression results in lower quality, whereas a lower level of compression results in higher quality. JPEG-format files have a .jpg or .jpeg file name extension. +> +> **line cap**: The shape that is used at the end of a line drawn by a graphics pen. +> +> **line join**: The shape to use at the intersection of two lines drawn by a graphics pen. +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **logical palette**: A [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) that defines colors as device-independent values. Unlike the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe), which has predefined, device-specific color definitions, a logical palette contains color values that can be defined entirely by an application. A logical palette entry is mapped to the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe) entry in order for the custom colors to appear when the application is run. +> +> **mapping mode**: The way in which logical (device-independent) coordinates are mapped to [**device space**](#gt_25d586c7-f440-45c6-b965-5c025bea9fc0) (device-specific) coordinates. It also specifies the orientation of the axes and size of the units used for drawing operations. +> +> **metafile**: A sequence of record structures that store an image in an application-independent format. Metafile records contain drawing commands, object definitions, and configuration settings. When a metafile is processed, the stored image can be rendered on a display, output to a printer or plotter, stored in memory, or saved to a file or stream. +> +> **miter length**: At the intersection of two lines, the distance from the intersection of the line walls on the inside of the [**line join**](#gt_4fd3ebb8-54f8-47e8-aded-399a08ad873e) to the intersection of the line walls on the outside of the [**line join**](#gt_4fd3ebb8-54f8-47e8-aded-399a08ad873e). The miter length can be large when the angle between two lines is small. If the miter length of the join of an intersection exceeds a specified limit, the join can be beveled to keep it within the limit of the join of the intersection. +> +> **monoscopic**: The property of an image that conveys a lack of the illusion of depth, as if the image were two-dimensional. +> +> **multiple master**: A font technology that is a variation of the [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) [**Type 1 font**](#gt_8539bd4b-4321-40c3-b4d2-aefe3c846e4e) format. Because multiple master fonts are outline fonts, changing their size does not affect the quality of their output. Multiple master technology supports the creation of an unlimited number of custom variations of a font, called instances, as well as the emulation of [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) that might not be present on the user's system. +> +> **OpenGL**: A software API for graphics hardware that supports the rendering of multidimensional graphical objects. The Microsoft implementation of OpenGL for the Windows operating system provides industry-standard graphics software for creating high-quality still and animated three-dimensional color images. See [\[OPENGL\]](https://go.microsoft.com/fwlink/?LinkId=90241) for further information. +> +> **OpenType**: A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8)-based font technology that is an extension to [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) and [**Type 1 font**](#gt_8539bd4b-4321-40c3-b4d2-aefe3c846e4e) technologies. OpenType allows [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) and [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) glyph definitions to reside in a common container format. +> +> **original equipment manufacturer (OEM) character set**: A character encoding used where the mappings between characters is dependent upon the code page configured on the machine, typically by the manufacturer. +> +> **packed DIB**: A [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) in which the bit array immediately follows the header (see [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9). +> +> **page space**: A logical coordinate system used for graphics operations. It is determined by the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae). Page space is defined with device-independent units, such as pixels. +> +> **palette**: An array of values, each element of which contains the definition of a color. The color elements in a palette are often indexed so that clients can refer to the colors, each of which can occupy 24 bits or more, by a number that requires less storage space. +> +> **PANOSE**: A classification system for font [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) that is based on certain specific visual characteristics of the font, including [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) (emphasis) and serif style. +> +> **path**: A graphics object that is a container for a series of line and curve segments, and [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in an image. +> +> **path bracket**: A series of [**paths**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613) that composes a larger figure. A path bracket specifies the current [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). +> +> **pitch**: A property of a font that describes the horizontal density of characters in a font; that is, the number of characters that can fit in a given unit of space. When all the characters in a font have the same width, the font is called "fixed-pitch"; if characters can have various widths, the font is "variable-pitch". Times New Roman is a variable-pitch font; it is easy to see that the characters in the font have different widths. For example, the width of a lowercase "i" is visibly less than the width of an uppercase "W". +> +> **playback device context**: The [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388) that defines the current graphics state during playback of the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). Although the data in a [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) can be device-independent, playback is always associated with an output device with specific properties, such as resolution, color support, and so on. +> +> **Portable Network Graphics (PNG)**: A bitmap graphics file format that uses lossless data compression and supports variable transparency of images (alpha channels) and control of image brightness on different computers (gamma correction). PNG-format files have a .png file name extension. +> +> **PostScript**: A page description language developed by Adobe Systems that is primarily used for printing documents on laser printers. It is the standard for desktop publishing. +> +> **print server**: A machine that hosts the print system and all its different components. +> +> **printer driver**: The interface component between the operating system and the printer device. It is responsible for processing the application data into a page description language (PDL) that can be interpreted by the printer device. +> +> **raster operation**: The process of combining the bits in a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) with the bits in a destination [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) and in a specified pattern, to achieve a particular graphical output. +> +> **rasterized font**: A font produced with rasterization. Such fonts are not scalable; they define glyph [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) at specific sizes. Because of this, the appearance of rasterized fonts does not improve in proportion to the resolution of an output device. When magnified, the visual quality of a rasterized font decreases significantly compared to a [**vector font**](#gt_4795d9b6-f3e9-4435-874e-bb6882ea1f0f). +> +> **rasterizer**: A program that converts geometric shapes into matrixes of discrete pixel settings on a graphics object such as a font. +> +> **red-green-blue (RGB)**: A color model that describes color information in terms of the red (R), green (G), and blue (B) intensities in a color. +> +> **red-green-blue-alpha (RGBA)**: A color model that describes color information in terms of the red (R), green (G), blue (B), and alpha (A) intensities that comprise a color. +> +> **reflection transform**: A [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that is used to create a mirror image of an object with respect to either the horizontal or vertical axis. +> +> **region**: A graphics object that is nonrectilinear in shape and is defined by an array of scanlines. +> +> **rotation**: A transform that is used to rotate an object. When rotation occurs, the points that make up the object are rotated with respect to the coordinate space origin. +> +> **rotation transform**: A [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that is used to rotate an object. When rotation occurs, the points that make up an object are rotated with respect to the [**coordinate space**](#gt_84184077-d0d9-41e0-acaf-6596aa066813) origin. +> +> **scaling transform**: A [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that is used to stretch or compress an object horizontally or vertically. +> +> **shear transform**: A [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that is used to shear or cut an object. There are two components of a shear [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b): The first alters the vertical lines in an object, and the second alters the horizontal lines. +> +> **stereoscopic**: The property of an image that gives the illusion of depth, as if the image were three-dimensional. The pixels that compose such an image can include a [**color plane**](#gt_78d62be3-d07a-447e-ab51-fa8be5560fe0) that is designed to add that illusion. +> +> **stock object**: A predefined graphics object. Stock objects are standard, commonly used objects, such as a black brush and pen. The set of predefined stock objects is specified in \[MS-EMF\] section 2.1.31. Stock objects are neither created nor deleted. +> +> **system palette**: The [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) that is actually in use to reproduce colors on a device such as a computer screen. A system palette has predefined, device-specific colors that are used by default, so that individual applications do not have to set them up. +> +> **tint**: The amount of a neutral color, such as black or white, that is mixed with another color. Changing the tint increases or decreases the lightness and saturation, and leaves the hue unchanged. +> +> **transform**: An algorithm that transforms the size, orientation, and shape of objects that are copied from one [**coordinate space**](#gt_84184077-d0d9-41e0-acaf-6596aa066813) into another. Although a transform affects an object as a whole, it is applied to each point, or to each line, in the object. +> +> **translation transform**: A [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that is used to shift each point in an object vertically, horizontally, or both, by a specified amount. +> +> **TrueType**: A scalable font technology that renders fonts for both the printer and the screen. Each TrueType font contains its own algorithms for converting printer outlines into screen [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952), which means both the outline and [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) information is [**rasterized**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c) from the same font data. The lower-level language embedded within the TrueType font allows great flexibility in its design. Both TrueType and [**Type 1 font**](#gt_8539bd4b-4321-40c3-b4d2-aefe3c846e4e) technologies are part of the [**OpenType**](#gt_5e824598-05ae-44e2-99bd-78c347279ad9) format. +> +> **Type 1 font**: A public, standard type format originally developed for use with [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) printers. Type 1 fonts contain two components—the outline font, used for printing; and the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) font set, used for screen display. +> +> **typeface**: The primary design of a set of printed characters such as Courier, Helvetica, and Times Roman. The terms typeface and font are sometimes used interchangeably. A font is the particular implementation and variation of the typeface such as normal, bold, or italics. The distinguishing characteristic of a typeface is often the presence or absence of serifs. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **UTF-16LE (Unicode Transformation Format, 16-bits, little-endian)**: The encoding scheme specified in \[UNICODE5.0.0/2007\] section 2.6 for encoding Unicode characters as a sequence of 16-bit codes, each encoded as two 8-bit bytes with the least-significant byte first. +> +> **vector font**: A font that is defined with geometrical primitives such as points, lines, curves, and polygons, which are all based on mathematical equations instead of collections of discrete pixel settings. Vector fonts can be rendered in high quality at arbitrary sizes. Outline fonts are vector fonts. Contrast with [**rasterized fonts**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c). +> +> **weight**: The property of a font that specifies the degree of emphasis or boldness of the characters. +> +> **Windows Color System (WCS)**: Color management technology that ensures a color image, graphic, or text object is rendered as closely as possible to its original intent on any device, despite differences in imaging technologies and color capabilities between devices. WCS is a superset of [**ICM**](#gt_fcd5ee55-57ff-45d6-b51e-2ccba47329e3) APIs and functionality and includes a variety of new functions that provide significant improvements in flexibility, transparency, predictability, and extensibility for vendors. Windows NT 3.1 operating system Windows NT 3.5 operating system, Windows NT 3.51 operating system, Windows 98 operating system, and Windows Millennium Edition operating system do not support [**WCS**](#gt_e4f9c4a4-c195-43d0-b189-f9727ec8a2b3) color management. +> +> **Windows metafile format (WMF)**: A file format used by Windows that supports the definition of images, including a format for clip art in word-processing documents. +> +> **world space**: The most abstract logical [**coordinate space**](#gt_84184077-d0d9-41e0-acaf-6596aa066813) for graphics [**transforms**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). It allows [**scaling**](#gt_f3f5f638-16f6-4159-a3f1-9d845b1196f5), [**translation**](#gt_4d42abda-3b31-4828-bc4c-684f2de4e2af), [**rotation**](#gt_5cdd5e5b-fe3d-46e6-9019-50483463a76a), [**shearing**](#gt_de5c1f5c-2ce7-4e79-9be9-a01b09175f5b), and [**reflection**](#gt_bbc1ce5c-0fd6-4fde-abb3-40525a95147d). +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[ISO/IEC-8859-1\] International Organization for Standardization, "Information Technology -- 8-Bit Single-Byte Coded Graphic Character Sets -- Part 1: Latin Alphabet No. 1", ISO/IEC 8859-1, 1998, [http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=28245](https://go.microsoft.com/fwlink/?LinkId=90689) + +**Note** There is a charge to download the specification. + +\[MS-DTYP\] Microsoft Corporation, "[Windows Data Types](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2)". + +\[MS-WMF\] Microsoft Corporation, "[Windows Metafile Format](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2)". + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[UNICODE\] The Unicode Consortium, "The Unicode Consortium Home Page", [http://www.unicode.org/](https://go.microsoft.com/fwlink/?LinkId=90550) + +### Informative References + +\[DEVMODE\] Microsoft Corporation, "DEVMODE structure", [http://msdn.microsoft.com/en-us/library/dd183565(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=89844) + +\[MS-EMFPLUS\] Microsoft Corporation, "[Enhanced Metafile Format Plus Extensions](%5bMS-EMFPLUS%5d.pdf#Section_5f92c78964f246b59ed415a9bb0946c6)". + +\[MS-EMFSPOOL\] Microsoft Corporation, "[Enhanced Metafile Spool Format](%5bMS-EMFSPOOL%5d.pdf#Section_3d8cd6cc528742e8925f4a53afd04534)". + +\[MSDN-GDI+\] Microsoft Corporation, "GDI+", [https://learn.microsoft.com/en-us/windows/desktop/gdiplus/-gdiplus-gdi-start](https://go.microsoft.com/fwlink/?LinkId=90013) + +\[MSDN-WindowsGDI\] Microsoft Corporation, "Windows GDI", [http://msdn.microsoft.com/en-us/library/dd145203.aspxx](https://go.microsoft.com/fwlink/?LinkId=94735) + +\[MSDN-WRLDPGSPC\] Microsoft Corporation, "World-Space to Page-Space Transformations", [http://msdn.microsoft.com/en-us/library/ms532657.aspx](https://go.microsoft.com/fwlink/?LinkId=90169) + +\[OPENGL\] Segal, M. and Akeley, K., "The OpenGL Graphics System: A Specification, Version 2.1", December 2006, [http://www.opengl.org/registry/doc/glspec21.20061201.pdf](https://go.microsoft.com/fwlink/?LinkId=90241) + +## Overview + +An [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) is a sequence of variable-length records that contain drawing commands, object definitions, and graphics properties to render a graphical image on any output device. + +When an EMF metafile is "played back" on a specific device, the resulting image maintains the same dimensions, shape, proportions, color, and so on, as the original, regardless of how the metafile was created. At any given point in the playback, the state of the graphics environment is defined by the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +### Metafile Structure + +An EMF metafile begins with a EMR_HEADER record (section [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab)), which includes the metafile version, its size, the resolution of the device on which the picture was created, and it ends with an EMR_EOF record (section [2.3.4.1](#Section_3f47fde00e6b40c187f3f4129af03aa1)). Between them are records that specify the rendering of the image. + +The following diagram depicts the structures of different versions of EMF metafiles, which are: + +- **Original**: The original version of EMF defined a file container for the device-independent specification of images.[\<1\>](#Appendix_A_1) + +- **Extension 1**: The second version and first extension added a pixel format record and support for [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) commands, enhancing the device independence and flexibility of EMF. + +- **Extension 2**: The third version and second extension added the capability to measure distances on device surfaces by using the Metric system, enhancing the accuracy and scalability of EMF. + +![EMF metafile versions](media/image1.bin "EMF metafile versions") + +Figure 1: EMF metafile versions + +EMF metafiles can be considered to have three parts: + +- **EMF header**: An EMR_HEADER record (section 2.3.4.2), possibly with extensions. It contains information concerning the structure and contents of the metafile, including an optional description string and pixel format descriptor. + +- **EMF records:** A sequence of drawing orders, property settings, and object definitions (section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba)). At least one record is present, not counting the header and end-of-file. + +- **EMF end-of-file**: The EMR_EOF record (section 2.3.4.1), which is the last record in the EMF metafile. + +EMF records are contiguous because the information that is available for traversing the metafile from record to record depends on it. From any given EMF record, except EMR_EOF, the length of that record can be used to move to the next record in the metafile. + +### Graphics Objects + +Graphics objects are used by the drawing and painting operations specified in an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). They are created by object creation records (section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18)) during the metafile playback and saved for later use. + +When needed, a graphics object is be retrieved and selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by using an EMR_SELECTOBJECT record (section [2.3.8.5](#Section_145b063d5f9641feb7ae1e615b2bc2bf)). + +The types of reusable objects include: + +- Brushes ([2.2.12](#Section_6d790f8d51654746bac33443915c2071)) + +- Color spaces ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) sections 2.2.2.11 and 2.2.2.12) + +- Fonts (sections [2.2.13](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100), [2.2.14](#Section_71516231003445f2af78c463b98db4af), [2.2.15](#Section_595fcaaebc3741489afe859e81ca7f76), and [2.2.16](#Section_c68ffff81c324398ac812cb6f0cd7a7c)) + +- Palettes (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) + +- Pens (sections [2.2.19](#Section_93ce3f4537ac4affb6e82f6db054c4c4) and [2.2.20](#Section_5b67b3eeea004f809b732959804381be)) + +[**Stock objects**](#gt_b1328cb9-acd8-47f8-9896-fe985af2d6d6) are used until graphics objects are created. + +### Byte Ordering + +Data in [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) records is stored in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) format. + +Some computer architectures number bytes in a binary word from left to right, which is referred to as [**big-endian**](#gt_6f6f9e8e-5966-4727-8527-7e02fb864e7e). The byte numbering used for bitfields in this specification is big-endian. Other architectures number the bytes in a binary word from right to left, which is referred to as little-endian. The byte numbering used for enumerations, objects, and records in this specification is little-endian. + +Using the big-endian and little-endian methods, the number 0x12345678 would be stored as shown in the following table. + +| Byte order | Byte 0 | Byte 1 | Byte 2 | Byte 3 | +|---------------|--------|--------|--------|--------| +| Big-endian | 0x12 | 0x34 | 0x56 | 0x78 | +| Little-endian | 0x78 | 0x56 | 0x34 | 0x12 | + +For an example of how the use of the big-endian and little-endian methods can affect the compatibility of applications, see section [3.1.2](#Section_26465dd0ab564321b5c96d93bc179945). + +## Relationship to Protocols and Other Structures + +Several related [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) formats can be used together for device-independent printing. Their relationships are: + +- [**Enhanced metafile spool format (EMFSPOOL)**](#gt_3bd355a2-4faa-40ab-bc79-0d158eba43b6) records ([\[MS-EMFSPOOL\]](%5bMS-EMFSPOOL%5d.pdf#Section_3d8cd6cc528742e8925f4a53afd04534) section 2.2) can contain EMF records. + +- [**Enhanced metafile format (EMF)**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) records (section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba)) can contain EMF+ records.[\<2\>](#Appendix_A_2) + +- [**Enhanced metafile format plus extensions (EMF+)**](#gt_41a5b58b-b050-4001-85ec-d6ed56379ee2) records ([\[MS-EMFPLUS\]](%5bMS-EMFPLUS%5d.pdf#Section_5f92c78964f246b59ed415a9bb0946c6) section 2.3) can contain [**Windows metafile format (WMF)**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) records ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.3). + +This is illustrated qualitatively in the following figure. + +![Relationships of metafile record types](media/image2.bin "Relationships of metafile record types") + +Figure 2: Relationships of metafile record types + +## Applicability Statement + +[**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) are portable containers for graphical output. The graphics format supported by EMF is applicable to rendering output on all devices, including displays, printers, and plotters. + +## Versioning and Localization + +This specification covers versioning issues in the following areas: + +**Versioning:** The [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) structure has been revised twice. The different versions are: + +- Original: The first version of the EMF structure, supporting records that define drawing commands and graphics objects. + +- Extension 1: Added support for [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) records and an optional internal pixel format descriptor. + +- Extension 2: Added the capability of measuring display dimensions in micrometers. + +**Localization:** This structure defines no locale-specific processes or data. + +## Vendor-Extensible Fields + +[**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) define a mechanism for the encapsulation of arbitrary vendor-defined data. The EMR_COMMENT record (section [2.3.3.1](#Section_e081b202429d4c34b21ca0ad501858a6)) can contain arbitrary private data that is unknown to EMF. This data is meaningful only to applications that can decode the format of the data. + +# Structures + +The following sections specify [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) enumerations, objects, and records. + +All character strings specified in this section are encoded in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) format [\[UNICODE\]](https://go.microsoft.com/fwlink/?LinkId=90550) unless stated otherwise. + +Unreferenced intrinsic types are defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2). + +## EMF Enumerations + +### RecordType Enumeration + +The **RecordType** enumeration defines values that uniquely identify records in an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). These values are specified in the **Type** fields of EMF records (section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba)). + +1. typedef enum + + { + +   EMR_HEADER = 0x00000001, + +   EMR_POLYBEZIER = 0x00000002, + +   EMR_POLYGON = 0x00000003, + +   EMR_POLYLINE = 0x00000004, + +   EMR_POLYBEZIERTO = 0x00000005, + +   EMR_POLYLINETO = 0x00000006, + +   EMR_POLYPOLYLINE = 0x00000007, + +   EMR_POLYPOLYGON = 0x00000008, + +   EMR_SETWINDOWEXTEX = 0x00000009, + +   EMR_SETWINDOWORGEX = 0x0000000A, + +   EMR_SETVIEWPORTEXTEX = 0x0000000B, + +   EMR_SETVIEWPORTORGEX = 0x0000000C, + +   EMR_SETBRUSHORGEX = 0x0000000D, + +   EMR_EOF = 0x0000000E, + +   EMR_SETPIXELV = 0x0000000F, + +   EMR_SETMAPPERFLAGS = 0x00000010, + +   EMR_SETMAPMODE = 0x00000011, + +   EMR_SETBKMODE = 0x00000012, + +   EMR_SETPOLYFILLMODE = 0x00000013, + +   EMR_SETROP2 = 0x00000014, + +   EMR_SETSTRETCHBLTMODE = 0x00000015, + +   EMR_SETTEXTALIGN = 0x00000016, + +   EMR_SETCOLORADJUSTMENT = 0x00000017, + +   EMR_SETTEXTCOLOR = 0x00000018, + +   EMR_SETBKCOLOR = 0x00000019, + +   EMR_OFFSETCLIPRGN = 0x0000001A, + +   EMR_MOVETOEX = 0x0000001B, + +   EMR_SETMETARGN = 0x0000001C, + +   EMR_EXCLUDECLIPRECT = 0x0000001D, + +   EMR_INTERSECTCLIPRECT = 0x0000001E, + +   EMR_SCALEVIEWPORTEXTEX = 0x0000001F, + +   EMR_SCALEWINDOWEXTEX = 0x00000020, + +   EMR_SAVEDC = 0x00000021, + +   EMR_RESTOREDC = 0x00000022, + +   EMR_SETWORLDTRANSFORM = 0x00000023, + +   EMR_MODIFYWORLDTRANSFORM = 0x00000024, + +   EMR_SELECTOBJECT = 0x00000025, + +   EMR_CREATEPEN = 0x00000026, + +   EMR_CREATEBRUSHINDIRECT = 0x00000027, + +   EMR_DELETEOBJECT = 0x00000028, + +   EMR_ANGLEARC = 0x00000029, + +   EMR_ELLIPSE = 0x0000002A, + +   EMR_RECTANGLE = 0x0000002B, + +   EMR_ROUNDRECT = 0x0000002C, + +   EMR_ARC = 0x0000002D, + +   EMR_CHORD = 0x0000002E, + +   EMR_PIE = 0x0000002F, + +   EMR_SELECTPALETTE = 0x00000030, + +   EMR_CREATEPALETTE = 0x00000031, + +   EMR_SETPALETTEENTRIES = 0x00000032, + +   EMR_RESIZEPALETTE = 0x00000033, + +   EMR_REALIZEPALETTE = 0x00000034, + +   EMR_EXTFLOODFILL = 0x00000035, + +   EMR_LINETO = 0x00000036, + +   EMR_ARCTO = 0x00000037, + +   EMR_POLYDRAW = 0x00000038, + +   EMR_SETARCDIRECTION = 0x00000039, + +   EMR_SETMITERLIMIT = 0x0000003A, + +   EMR_BEGINPATH = 0x0000003B, + +   EMR_ENDPATH = 0x0000003C, + +   EMR_CLOSEFIGURE = 0x0000003D, + +   EMR_FILLPATH = 0x0000003E, + +   EMR_STROKEANDFILLPATH = 0x0000003F, + +   EMR_STROKEPATH = 0x00000040, + +   EMR_FLATTENPATH = 0x00000041, + +   EMR_WIDENPATH = 0x00000042, + +   EMR_SELECTCLIPPATH = 0x00000043, + +   EMR_ABORTPATH = 0x00000044, + +   EMR_COMMENT = 0x00000046, + +   EMR_FILLRGN = 0x00000047, + +   EMR_FRAMERGN = 0x00000048, + +   EMR_INVERTRGN = 0x00000049, + +   EMR_PAINTRGN = 0x0000004A, + +   EMR_EXTSELECTCLIPRGN = 0x0000004B, + +   EMR_BITBLT = 0x0000004C, + +   EMR_STRETCHBLT = 0x0000004D, + +   EMR_MASKBLT = 0x0000004E, + +   EMR_PLGBLT = 0x0000004F, + +   EMR_SETDIBITSTODEVICE = 0x00000050, + +   EMR_STRETCHDIBITS = 0x00000051, + +   EMR_EXTCREATEFONTINDIRECTW = 0x00000052, + +   EMR_EXTTEXTOUTA = 0x00000053, + +   EMR_EXTTEXTOUTW = 0x00000054, + +   EMR_POLYBEZIER16 = 0x00000055, + +   EMR_POLYGON16 = 0x00000056, + +   EMR_POLYLINE16 = 0x00000057, + +   EMR_POLYBEZIERTO16 = 0x00000058, + +   EMR_POLYLINETO16 = 0x00000059, + +   EMR_POLYPOLYLINE16 = 0x0000005A, + +   EMR_POLYPOLYGON16 = 0x0000005B, + +   EMR_POLYDRAW16 = 0x0000005C, + +   EMR_CREATEMONOBRUSH = 0x0000005D, + +   EMR_CREATEDIBPATTERNBRUSHPT = 0x0000005E, + +   EMR_EXTCREATEPEN = 0x0000005F, + +   EMR_POLYTEXTOUTA = 0x00000060, + +   EMR_POLYTEXTOUTW = 0x00000061, + +   EMR_SETICMMODE = 0x00000062, + +   EMR_CREATECOLORSPACE = 0x00000063, + +   EMR_SETCOLORSPACE = 0x00000064, + +   EMR_DELETECOLORSPACE = 0x00000065, + +   EMR_GLSRECORD = 0x00000066, + +   EMR_GLSBOUNDEDRECORD = 0x00000067, + +   EMR_PIXELFORMAT = 0x00000068, + +   EMR_DRAWESCAPE = 0x00000069, + +   EMR_EXTESCAPE = 0x0000006A, + +   EMR_SMALLTEXTOUT = 0x0000006C, + +   EMR_FORCEUFIMAPPING = 0x0000006D, + +   EMR_NAMEDESCAPE = 0x0000006E, + +   EMR_COLORCORRECTPALETTE = 0x0000006F, + +   EMR_SETICMPROFILEA = 0x00000070, + +   EMR_SETICMPROFILEW = 0x00000071, + +   EMR_ALPHABLEND = 0x00000072, + +   EMR_SETLAYOUT = 0x00000073, + +   EMR_TRANSPARENTBLT = 0x00000074, + +   EMR_GRADIENTFILL = 0x00000076, + +   EMR_SETLINKEDUFIS = 0x00000077, + +   EMR_SETTEXTJUSTIFICATION = 0x00000078, + +   EMR_COLORMATCHTOTARGETW = 0x00000079, + +   EMR_CREATECOLORSPACEW = 0x0000007A + + } RecordType; + +**EMR_HEADER:** This record defines the start of the metafile and specifies its characteristics; its contents, including the dimensions of the embedded image; the number of records in the metafile; and the resolution of the device on which the embedded image was created. These values make it possible for the metafile to be device-independent. + +**EMR_POLYBEZIER:** This record defines one or more [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5). Cubic Bezier curves are defined using specified endpoints and control points, and are stroked with the current pen. + +**EMR_POLYGON:** This record defines a polygon consisting of two or more vertexes connected by straight lines. The polygon is outlined by using the current pen and filled by using the current brush and polygon fill mode. The polygon is closed automatically by drawing a line from the last vertex to the first. + +**EMR_POLYLINE:** This record defines a series of line segments by connecting the points in the specified array. + +**EMR_POLYBEZIERTO:** This record defines one or more Bezier curves based upon the current drawing position. + +**EMR_POLYLINETO:** This record defines one or more straight lines based upon the current drawing position. A line is drawn from the current drawing position to the first point specified by the points field by using the current pen. For each additional line, drawing is performed from the ending point of the previous line to the next point specified by points. + +**EMR_POLYPOLYLINE:** This record defines multiple series of connected line segments. The line segments are drawn by using the current pen. The figures formed by the segments are not filled. The current position is neither used nor updated by this record. + +**EMR_POLYPOLYGON:** This record defines a series of closed polygons. Each polygon is outlined by using the current pen and filled by using the current brush and polygon fill mode. The polygons defined by this record can overlap. + +**EMR_SETWINDOWEXTEX:** This record defines the window extent. + +**EMR_SETWINDOWORGEX:** This record defines the window origin. + +**EMR_SETVIEWPORTEXTEX:** This record defines the viewport extent. + +**EMR_SETVIEWPORTORGEX:** This record defines the viewport origin. + +**EMR_SETBRUSHORGEX:** This record defines the origin of the current brush. + +**EMR_EOF:** This record indicates the end of the metafile. + +**EMR_SETPIXELV:** This record defines the color of the pixel at the specified logical coordinates. + +**EMR_SETMAPPERFLAGS:** This record specifies parameters for the process of matching logical fonts to physical fonts, which is performed by the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1). + +**EMR_SETMAPMODE:** This record defines the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae), which defines the unit of measure used to transform [**page space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) units into [**device space**](#gt_25d586c7-f440-45c6-b965-5c025bea9fc0) units, and defines the orientation of the device's X and Y axes. + +**EMR_SETBKMODE:** This record defines the background mix mode, which is used with text, hatched brushes, and pen styles that are not solid lines. + +**EMR_SETPOLYFILLMODE:** This record defines polygon fill mode. + +**EMR_SETROP2:** This record defines binary [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) mode. + +**EMR_SETSTRETCHBLTMODE:** This record defines [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) stretch mode. + +**EMR_SETTEXTALIGN:** This record defines text alignment. + +**EMR_SETCOLORADJUSTMENT:** This record defines the color adjustment values using the specified values. + +**EMR_SETTEXTCOLOR:** This record defines the current text color. + +**EMR_SETBKCOLOR:** This record defines the background color. + +**EMR_OFFSETCLIPRGN:** This record redefines the current clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) by the specified offsets. + +**EMR_MOVETOEX:** This record defines coordinates of the new drawing position in logical units. + +**EMR_SETMETARGN:** This record intersects the current clipping region with the current metaregion and saves the combined region as the new current metaregion. + +**EMR_EXCLUDECLIPRECT:** This record defines a new clipping region that consists of the current clipping region intersected with the specified rectangle. + +**EMR_INTERSECTCLIPRECT:** This record defines a new clipping region from the intersection of the current clipping region and the specified rectangle. + +**EMR_SCALEVIEWPORTEXTEX:** This record redefines the viewport using the ratios formed by the specified multiplicands and divisors. + +**EMR_SCALEWINDOWEXTEX:** This record redefines the window using the ratios formed by the specified multiplicands and divisors. + +**EMR_SAVEDC:** This record saves the current state of the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) in an array of states saved by preceding **EMR_SAVEDC** records if any. + +**EMR_RESTOREDC:** This record restores the playback device context to the specified state, which was saved by a preceding **EMR_SAVEDC** record (section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652)). + +**EMR_SETWORLDTRANSFORM:** This record defines a two-dimensional linear [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) between [**world space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) and page space [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). + +**EMR_MODIFYWORLDTRANSFORM:** This record redefines the world transform by using the specified mode. + +**EMR_SELECTOBJECT:** This record selects an object in the playback device context, which is identified by its index in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +**EMR_CREATEPEN:** This record defines a logical pen (section [2.2.19](#Section_93ce3f4537ac4affb6e82f6db054c4c4)) that has the specified style, width, and color. + +**EMR_CREATEBRUSHINDIRECT:** This record defines a logical brush for filling figures in graphics operations. + +**EMR_DELETEOBJECT:** This record deletes a graphics object, clearing its index in the EMF object table. + +**EMR_ANGLEARC:** This record defines a line segment of an arc. The line segment is drawn from the current drawing position to the beginning of the arc. The arc is drawn along the perimeter of a circle with the given radius and center. The length of the arc is defined by the given start and sweep angles. + +**EMR_ELLIPSE:** This record defines an ellipse. The center of the ellipse is the center of the specified bounding rectangle. The ellipse is outlined by using the current pen and is filled by using the current brush. + +**EMR_RECTANGLE:** This record defines a rectangle. The rectangle is outlined by using the current pen and filled by using the current brush. + +**EMR_ROUNDRECT:** This record defines a rectangle with rounded corners. The rectangle is outlined by using the current pen and filled by using the current brush. + +**EMR_ARC:** This record defines an elliptical arc. + +**EMR_CHORD:** This record defines a chord, which is a region bounded by the intersection of an ellipse and a line segment, called a secant. The chord is outlined by using the current pen and filled by using the current brush. + +**EMR_PIE:** This record defines a pie-shaped wedge bounded by the intersection of an ellipse and two radials. The pie is outlined by using the current pen and filled by using the current brush. + +**EMR_SELECTPALETTE:** This record selects a LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) into the playback device context, identifying it by its index in the EMF object table. + +**EMR_CREATEPALETTE:** This record defines a LogPalette object. + +**EMR_SETPALETTEENTRIES:** This record defines [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color values in a range of entries in a LogPalette object. + +**EMR_RESIZEPALETTE:** This record increases or decreases the size of a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3). + +**EMR_REALIZEPALETTE:** This record maps entries from the current logical palette to the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe). + +**EMR_EXTFLOODFILL:** This record fills an area of the display surface with the current brush. + +**EMR_LINETO:** This record defines a line from the current drawing position up to, but not including, the specified point. It resets the current drawing position to the specified point. + +**EMR_ARCTO:** This record defines an elliptical arc. It resets the current position to the endpoint of the arc. + +**EMR_POLYDRAW:** This record defines a set of line segments and Bezier curves. + +**EMR_SETARCDIRECTION:** This record defines the drawing direction to be used for arc and rectangle operations. + +**EMR_SETMITERLIMIT:** This record defines the limit for the length of miter joins. + +**EMR_BEGINPATH:** This record opens a [**path bracket**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601) for specifying the current [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613). + +**EMR_ENDPATH:** This record closes an open path bracket and selects the path into the playback device context. + +**EMR_CLOSEFIGURE:** This record closes an open figure in a path. + +**EMR_FILLPATH:** This record closes any open figures in the current path bracket and fills its interior by using the current brush and polygon-filling mode. + +**EMR_STROKEANDFILLPATH:** This record closes any open figures in a path, strokes the outline of the path by using the current pen, and fills its interior by using the current brush. + +**EMR_STROKEPATH:** This record renders the specified path by using the current pen. + +**EMR_FLATTENPATH:** This record turns each curve in the path into a sequence of lines. + +**EMR_WIDENPATH:** This record redefines the current path bracket as the area that would be painted if the path were stroked using the current pen. + +**EMR_SELECTCLIPPATH:** This record specifies a clipping region as the current clipping region combined with the current path bracket, using the specified mode. + +**EMR_ABORTPATH:** This record aborts a path bracket or discards the path from a closed path bracket. + +**EMR_COMMENT:** This record specifies arbitrary private data. + +**EMR_FILLRGN:** This record fills the specified region by using the specified brush. + +**EMR_FRAMERGN:** This record draws a border around the specified region using the specified brush. + +**EMR_INVERTRGN:** This record inverts the colors in the specified region. + +**EMR_PAINTRGN:** This record paints the specified region by using the current brush. + +**EMR_EXTSELECTCLIPRGN:** This record combines the specified region with the current clipping region, using the specified mode. + +**EMR_BITBLT:** This record specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern, according to a specified raster operation. + +**EMR_STRETCHBLT:** This record specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern, according to a specified raster operation, stretching or compressing the output to fit the dimensions of the destination, if necessary. + +**EMR_MASKBLT:** This record specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern and with the application of a color mask bitmap, according to specified foreground and background raster operations. + +**EMR_PLGBLT:** This record specifies a block transfer of pixels from a source bitmap to a destination parallelogram, with the application of a color mask bitmap. + +**EMR_SETDIBITSTODEVICE:** This record specifies a block transfer of pixels from specified scanlines of a source bitmap to a destination rectangle. + +**EMR_STRETCHDIBITS:** This record specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern, according to a specified raster operation, stretching or compressing the output to fit the dimensions of the destination, if necessary. + +**EMR_EXTCREATEFONTINDIRECTW:** This record defines a logical font that has the specified characteristics. The font can subsequently be selected as the current font. + +**EMR_EXTTEXTOUTA:** This record draws an [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) text string using the current font and text colors. + +**EMR_EXTTEXTOUTW:** This record draws a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) text string using the current font and text colors. + +**EMR_POLYBEZIER16:** This record defines one or more Bezier curves. The curves are drawn using the current pen. + +**EMR_POLYGON16:** This record defines a polygon consisting of two or more vertexes connected by straight lines. The polygon is outlined by using the current pen and filled by using the current brush and polygon fill mode. The polygon is closed automatically by drawing a line from the last vertex to the first. + +**EMR_POLYLINE16:** This record defines a series of line segments by connecting the points in the specified array. + +**EMR_POLYBEZIERTO16:** This record defines one or more Bezier curves based on the current position. + +**EMR_POLYLINETO16:** This record defines one or more straight lines based upon the current position. A line is drawn from the current position to the first point specified by the **Points** field by using the current pen. For each additional line, drawing is performed from the ending point of the previous line to the next point specified by **Points**. + +**EMR_POLYPOLYLINE16:** This record defines multiple series of connected line segments. + +**EMR_POLYPOLYGON16:** This record defines a series of closed polygons. Each polygon is outlined by using the current pen and filled by using the current brush and polygon fill mode. The polygons specified by this record can overlap. + +**EMR_POLYDRAW16:** This record defines a set of line segments and Bezier curves. + +**EMR_CREATEMONOBRUSH:** This record defines a logical brush with the specified bitmap pattern. The bitmap can be a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) section bitmap or it can be a device-dependent bitmap. + +**EMR_CREATEDIBPATTERNBRUSHPT:** This record defines a logical brush that has the pattern specified by the DIB. + +**EMR_EXTCREATEPEN:** This record defines an extended logical pen (section [2.2.20](#Section_5b67b3eeea004f809b732959804381be)) that has the specified style, width, color, and brush attributes. + +**EMR_POLYTEXTOUTA:** This record draws one or more ASCII text strings using the current font and text colors. + +**Note:** [EMR_POLYTEXTOUTA](#Section_d8b7ac2176b84f9aa7cc05f9d2d5627e) SHOULD be emulated with a series of [EMR_EXTTEXTOUTW](#Section_a59a79ac328e492da34de02727af6edf) records, one per string.[\<3\>](#Appendix_A_3) + +**EMR_POLYTEXTOUTW:** This record draws one or more Unicode text strings using the current font and text colors. + +**Note:** [EMR_POLYTEXTOUTW](#Section_381015eb29a7477493ada210697f5972) SHOULD be emulated with a series of EMR_EXTTEXTOUTW records, one per string.[\<4\>](#Appendix_A_4) + +**EMR_SETICMMODE:** This record specifies the mode of [**Image Color Management (ICM)**](#gt_fcd5ee55-57ff-45d6-b51e-2ccba47329e3) for graphics operations.[\<5\>](#Appendix_A_5) + +**EMR_CREATECOLORSPACE:** This record creates a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) object from a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) with a name consisting of ASCII characters.[\<6\>](#Appendix_A_6) + +**EMR_SETCOLORSPACE:** This record defines the current logical color space object for graphics operations.[\<7\>](#Appendix_A_7) + +**EMR_DELETECOLORSPACE:** This record deletes a logical color space object.[\<8\>](#Appendix_A_8) + +**Note:** An [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record SHOULD be used instead of [EMR_DELETECOLORSPACE](#Section_5d137387d79a4bc89a4d38291320e148) to delete a logical color space object.[\<9\>](#Appendix_A_9) + +**EMR_GLSRECORD:** This record specifies an [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) function.[\<10\>](#Appendix_A_10) + +**EMR_GLSBOUNDEDRECORD:** This record specifies an OpenGL function with a bounding rectangle for output.[\<11\>](#Appendix_A_11) + +**EMR_PIXELFORMAT:** This record specifies the pixel format to use for graphics operations.[\<12\>](#Appendix_A_12) + +**EMR_DRAWESCAPE:** This record passes arbitrary information to the driver. The intent is that the information results in drawing being done. + +**EMR_EXTESCAPE:** This record passes arbitrary information to the driver. The intent is that the information does not result in drawing being done. + +**EMR_SMALLTEXTOUT:** This record outputs a string. + +**EMR_FORCEUFIMAPPING:** This record forces the font mapper to match fonts based on their **UniversalFontId** in preference to their **LogFont** information. + +**EMR_NAMEDESCAPE:** This record passes arbitrary information to the given named driver. + +**EMR_COLORCORRECTPALETTE:** This record specifies how to correct the entries of a logical palette object using [**Windows Color System (WCS)**](#gt_e4f9c4a4-c195-43d0-b189-f9727ec8a2b3) 1.0 values.[\<13\>](#Appendix_A_13) + +**EMR_SETICMPROFILEA:** This record specifies a color profile in a file with a name consisting of ASCII characters, for graphics output.[\<14\>](#Appendix_A_14) + +**EMR_SETICMPROFILEW:** This record specifies a color profile in a file with a name consisting of Unicode characters, for graphics output.[\<15\>](#Appendix_A_15) + +**EMR_ALPHABLEND:** This record specifies a block transfer of pixels from a source bitmap to a destination rectangle, including [**alpha transparency**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) data, according to a specified blending operation.[\<16\>](#Appendix_A_16) + +**EMR_SETLAYOUT:** This record specifies the order in which text and graphics are drawn.[\<17\>](#Appendix_A_17) + +**EMR_TRANSPARENTBLT:** This record specifies a block transfer of pixels from a source bitmap to a destination rectangle, treating a specified color as transparent, stretching or compressing the output to fit the dimensions of the destination, if necessary.[\<18\>](#Appendix_A_18) + +**EMR_GRADIENTFILL:** This record specifies filling rectangles or triangles with gradients of color.[\<19\>](#Appendix_A_19) + +**EMR_SETLINKEDUFIS:** This record sets the **UniversalFontIds** (section [2.2.27](#Section_34502dab22b44855b9b288f00a4a0c52)) of linked fonts to use during character lookup. + +**EMR_SETTEXTJUSTIFICATION:** This record specifies the amount of extra space to add to break characters for justification purposes.[\<20\>](#Appendix_A_20) + +**EMR_COLORMATCHTOTARGETW:** This record specifies whether to perform [**color matching**](#gt_a3322d29-7dc5-4696-b17a-55311db1cb33) with a color profile that is specified in a file with a name consisting of Unicode characters.[\<21\>](#Appendix_A_21) + +**EMR_CREATECOLORSPACEW:** This record creates a logical color space object from a color profile with a name consisting of Unicode characters.[\<22\>](#Appendix_A_22) + +### ArcDirection Enumeration + +The **ArcDirection** enumeration is used in setting the drawing direction for arcs and rectangles. + +123. typedef enum + + { + +   AD_COUNTERCLOCKWISE = 0x00000001, + +   AD_CLOCKWISE = 0x00000002 + + } ArcDirection; + +**AD_COUNTERCLOCKWISE:** Figures drawn counterclockwise. + +**AD_CLOCKWISE:** Figures drawn clockwise. + +### ArmStyle Enumeration + +The ArmStyle enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +128. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_STRAIGHT_ARMS_HORZ = 0x02, + +   PAN_STRAIGHT_ARMS_WEDGE = 0x03, + +   PAN_STRAIGHT_ARMS_VERT = 0x04, + +   PAN_STRAIGHT_ARMS_SINGLE_SERIF = 0x05, + +   PAN_STRAIGHT_ARMS_DOUBLE_SERIF = 0x06, + +   PAN_BENT_ARMS_HORZ = 0x07, + +   PAN_BENT_ARMS_WEDGE = 0x08, + +   PAN_BENT_ARMS_VERT = 0x09, + +   PAN_BENT_ARMS_SINGLE_SERIF = 0x0A, + +   PAN_BENT_ARMS_DOUBLE_SERIF = 0x0B + + } ArmStyle; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_STRAIGHT_ARMS_HORZ:** Straight arms/horizontal. + +**PAN_STRAIGHT_ARMS_WEDGE:** Straight arms/wedge. + +**PAN_STRAIGHT_ARMS_VERT:** Straight arms/vertical. + +**PAN_STRAIGHT_ARMS_SINGLE_SERIF:** Straight arms/single-serif. + +**PAN_STRAIGHT_ARMS_DOUBLE_SERIF:** Straight arms/double-serif. + +**PAN_BENT_ARMS_HORZ:** Nonstraight arms/horizontal. + +**PAN_BENT_ARMS_WEDGE:** Nonstraight arms/wedge. + +**PAN_BENT_ARMS_VERT:** Nonstraight arms/vertical. + +**PAN_BENT_ARMS_SINGLE_SERIF:** Nonstraight arms/single-serif. + +**PAN_BENT_ARMS_DOUBLE_SERIF:** Nonstraight arms/double-serif. + +### BackgroundMode Enumeration + +The **BackgroundMode** enumeration is used to specify the background mode to be used with text, hatched brushes, and pen styles that are not solid. The background mode determines how to combine the background with foreground text, hatched brushes, and pen styles that are not solid lines. + +143. typedef enum + + { + +   TRANSPARENT = 0x0001, + +   OPAQUE = 0x0002 + + } BackgroundMode; + +**TRANSPARENT:** Background remains untouched. + +**OPAQUE:** Background is filled with the current background color before the text, hatched brush, or pen is drawn. + +### ColorAdjustment Enumeration + +The ColorAdjustment enumeration is used to specify how the output image is prepared when the stretch mode is **HALFTONE**. + +148. typedef enum + + { + +   CA_NEGATIVE = 0x0001, + +   CA_LOG_FILTER = 0x0002 + + } ColorAdjustment; + +**CA_NEGATIVE:** Specifies that the negative of the original image SHOULD be displayed. + +**CA_LOG_FILTER:** Specifies that a logarithmic process SHOULD be applied to the final density of the output colors. This will increase the color contrast when the luminance is low. + +### ColorMatchToTarget Enumeration + +The **ColorMatchToTarget** enumeration is used to determine whether a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) has been embedded in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +153. typedef enum + + { + +   COLORMATCHTOTARGET_NOTEMBEDDED = 0x00000000, + +   COLORMATCHTOTARGET_EMBEDDED = 0x00000001 + + } ColorMatchToTarget; + +**COLORMATCHTOTARGET_NOTEMBEDDED:** Indicates that a color profile has not been embedded in the metafile. + +**COLORMATCHTOTARGET_EMBEDDED:** Indicates that a color profile has been embedded in the metafile. + +### ColorSpace Enumeration + +The **ColorSpace** enumeration is used to specify when to turn [**color proofing**](#gt_f00dd816-fa37-4de3-b30c-1644cbbd45a4) on and off, and when to delete [**transforms**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). + +158. typedef enum + + { + +   CS_ENABLE = 0x00000001, + +   CS_DISABLE = 0x00000002, + +   CS_DELETE_TRANSFORM = 0x00000003 + + } ColorSpace; + +**CS_ENABLE:** Maps colors to the target device's [**color gamut**](#gt_cc6ddf19-b7de-4820-8b48-ecd73c45eef2). This enables color proofing. All subsequent draw commands render colors as they would appear on the target device. + +**CS_DISABLE:** Disables color proofing. + +**CS_DELETE_TRANSFORM:** If color management is enabled for the target profile, disables it and deletes the current color transform. + +### Contrast Enumeration + +The Contrast enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +164. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_CONTRAST_NONE = 0x02, + +   PAN_CONTRAST_VERY_LOW = 0x03, + +   PAN_CONTRAST_LOW = 0x04, + +   PAN_CONTRAST_MEDIUM_LOW = 0x05, + +   PAN_CONTRAST_MEDIUM = 0x06, + +   PAN_CONTRAST_MEDIUM_HIGH = 0x07, + +   PAN_CONTRAST_HIGH = 0x08, + +   PAN_CONTRAST_VERY_HIGH = 0x09 + + } Contrast; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_CONTRAST_NONE:** None. + +**PAN_CONTRAST_VERY_LOW:** Very low. + +**PAN_CONTRAST_LOW:** Low. + +**PAN_CONTRAST_MEDIUM_LOW:** Medium low. + +**PAN_CONTRAST_MEDIUM:** Medium. + +**PAN_CONTRAST_MEDIUM_HIGH:** Medium high. + +**PAN_CONTRAST_HIGH:** High. + +**PAN_CONTRAST_VERY_HIGH:** Very high. + +### DIBColors Enumeration + +The **DIBColors** enumeration defines how to interpret the values in the color table of a [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +177. typedef enum + + { + +   DIB_RGB_COLORS = 0x00, + +   DIB_PAL_COLORS = 0x01, + +   DIB_PAL_INDICES = 0x02 + + } DIBColors; + +**DIB_RGB_COLORS:** The color table contains literal [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values. + +**DIB_PAL_COLORS:** The color table consists of an array of 16-bit indexes into the LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) that is currently defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +**DIB_PAL_INDICES:** No color table exists. The pixels in the DIB are indices into the current logical palette in the playback device context. + +DIBs are specified by DeviceIndependentBitmap objects ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9). + +### EmrComment Enumeration + +The **EmrComment** enumeration defines the types of data that a public comment record can contain, as specified in section [2.3.3.4](#Section_39c91f22e4cc4e82a6050137caa8457c). + +183. typedef enum + + { + +   EMR_COMMENT_WINDOWS_METAFILE = 0x80000001, + +   EMR_COMMENT_BEGINGROUP = 0x00000002, + +   EMR_COMMENT_ENDGROUP = 0x00000003, + +   EMR_COMMENT_MULTIFORMATS = 0x40000004, + +   EMR_COMMENT_UNICODE_STRING = 0x00000040, + +   EMR_COMMENT_UNICODE_END = 0x00000080 + + } EmrComment; + +**EMR_COMMENT_WINDOWS_METAFILE:** This comment record contains a specification of an image in [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2). + +**EMR_COMMENT_BEGINGROUP:** This comment record identifies the beginning of a group of drawing records. + +**EMR_COMMENT_ENDGROUP:** This comment record identifies the end of a group of drawing records. + +**EMR_COMMENT_MULTIFORMATS:** This comment record allows multiple definitions of an image to be included in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). Using this comment, for example, an application can include encapsulated [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) text as well as an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) definition of an image. + +**EMR_COMMENT_UNICODE_STRING:** This comment record is reserved and MUST NOT be used. + +**EMR_COMMENT_UNICODE_END:** This comment record is reserved and MUST NOT be used. + +### ExtTextOutOptions Enumeration + +The ExtTextOutOptions enumeration specifies parameters that control various aspects of the output of text by [EMR_SMALLTEXTOUT (section 2.3.5.37)](#Section_20eee81d0bd442d1a624860adfe62358) records and in [EmrText](#Section_dd585d0a5d7c4034963a1141af836972) objects. + +192. typedef enum + + { + +   ETO_OPAQUE = 0x00000002, + +   ETO_CLIPPED = 0x00000004, + +   ETO_GLYPH_INDEX = 0x00000010, + +   ETO_RTLREADING = 0x00000080, + +   ETO_NO_RECT = 0x00000100, + +   ETO_SMALL_CHARS = 0x00000200, + +   ETO_NUMERICSLOCAL = 0x00000400, + +   ETO_NUMERICSLATIN = 0x00000800, + +   ETO_IGNORELANGUAGE = 0x00001000, + +   ETO_PDY = 0x00002000, + +   ETO_REVERSE_INDEX_MAP = 0x00010000 + + } ExtTextOutOptions; + +**ETO_OPAQUE:** This bit indicates that the current background color SHOULD be used to fill the rectangle. + +**ETO_CLIPPED:** This bit indicates that the text SHOULD be clipped to the rectangle. + +**ETO_GLYPH_INDEX:** This bit indicates that the codes for characters in an output text string are indexes of the character glyphs in a [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) font. Glyph indexes are font-specific, so to display the correct characters on playback, the font that is used MUST be identical to the font used to generate the indexes.[\<23\>](#Appendix_A_23) + +**ETO_RTLREADING:** This bit indicates that the text MUST be laid out in right-to-left reading order, instead of the default left-to-right order. This SHOULD be applied only when the font selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) is either Hebrew or Arabic.[\<24\>](#Appendix_A_24) + +**ETO_NO_RECT:** This bit indicates that the record does not specify a bounding rectangle for the text output. + +**ETO_SMALL_CHARS:** This bit indicates that the codes for characters in an output text string are 8 bits, derived from the low bytes of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) character codes, in which the high byte is assumed to be 0. + +**ETO_NUMERICSLOCAL:** This bit indicates that to display numbers, digits appropriate to the locale SHOULD be used.[\<25\>](#Appendix_A_25) + +**ETO_NUMERICSLATIN:** This bit indicates that to display numbers, European digits SHOULD be used.[\<26\>](#Appendix_A_26) + +**ETO_IGNORELANGUAGE:** This bit indicates that no special operating system processing for glyph placement is performed on right-to-left strings; that is, all glyph positioning SHOULD be taken care of by drawing and state records in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7).[\<27\>](#Appendix_A_27) + +**ETO_PDY:** This bit indicates that both horizontal and vertical character displacement values SHOULD be provided.[\<28\>](#Appendix_A_28) + +**ETO_REVERSE_INDEX_MAP:** This bit is reserved and SHOULD NOT be used.[\<29\>](#Appendix_A_29) + +### FamilyType Enumeration + +The FamilyType enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +206. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_FAMILY_TEXT_DISPLAY = 0x02, + +   PAN_FAMILY_SCRIPT = 0x03, + +   PAN_FAMILY_DECORATIVE = 0x04, + +   PAN_FAMILY_PICTORIAL = 0x05 + + } FamilyType; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_FAMILY_TEXT_DISPLAY:** Text and display. + +**PAN_FAMILY_SCRIPT:** Script. + +**PAN_FAMILY_DECORATIVE:** Decorative. + +**PAN_FAMILY_PICTORIAL:** Pictorial. + +### FloodFill Enumeration + +The FloodFill enumeration defines values that specify how to determine the area for a flood fill operation. + +215. typedef enum + + { + +   FLOODFILLBORDER = 0x00000000, + +   FLOODFILLSURFACE = 0x00000001 + + } FloodFill; + +**FLOODFILLBORDER:** The fill area is bounded by a specific color. + +**FLOODFILLSURFACE:** The fill area is defined by a specific color. Filling continues outward in all directions as long as the color is encountered. This style is useful for filling areas with multicolored boundaries. + +### FormatSignature Enumeration + +The **FormatSignature** enumeration defines values that are used to identify the format of embedded data in [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +220. typedef enum + + { + +   ENHMETA_SIGNATURE = 0x464D4520, + +   EPS_SIGNATURE = 0x46535045 + + } FormatSignature; + +**ENHMETA_SIGNATURE:** The sequence of [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters "FME ", which denotes EMF data. The reverse of the string is " EMF". + +**Note:** The space character in the string is significant and MUST be present. + +This signature is used in the following structures: + +- EMR_HEADER records (section [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab)) to identify the EMF metafile + +- The EmrFormat object (section [2.2.4](#Section_1bd63563ce674528bf285a8852ff0270)) in EMR_COMMENT_MULTIFORMATS records (section [2.3.3.4.3](#Section_4bc4608eca82426dac0e5ded2ad3fc4e)), to specify embedded EMF records. + +**EPS_SIGNATURE:** The value of this member is the sequence of ASCII characters "FSPE", which denotes [**encapsulated PostScript (EPS)**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f) data. The reverse of the string is "EPSF". + +This signature is used in EmrFormat objects to specify embedded [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) data in the EpsData object (section [2.2.6](#Section_a624b402f7aa4cb6b289612c9775f37e)) in EMR_COMMENT_MULTIFORMATS records. + +### GradientFill Enumeration + +The **GradientFill** enumeration defines the modes for gradient fill operations. + +225. typedef enum + + { + +   GRADIENT_FILL_RECT_H = 0x00000000, + +   GRADIENT_FILL_RECT_V = 0x00000001, + +   GRADIENT_FILL_TRIANGLE = 0x00000002 + + } GradientFill; + +**GRADIENT_FILL_RECT_H:** Color interpolation along a gradient from the left to the right edges of a rectangle. + +**GRADIENT_FILL_RECT_V:** Color interpolation along a gradient from the top to the bottom edges of a rectangle. + +**GRADIENT_FILL_TRIANGLE:** Color interpolation between vertexes of a triangle. + +### GraphicsMode Enumeration + +The **GraphicsMode** enumeration is used to specify how to interpret shape data such as rectangle coordinates. + +231. typedef enum + + { + +   GM_COMPATIBLE = 0x00000001, + +   GM_ADVANCED = 0x00000002 + + } GraphicsMode; + +**GM_COMPATIBLE: [TrueType](#gt_855615c9-5378-459f-8d58-20f640afed6e)** text MUST be written from left to right and right side up, even if the rest of the graphics are [**rotated**](#gt_e833af67-6604-4d48-b5a2-84ea0cbbbdbb) about the x-axis or y-axis because of the current world-to-device [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). Only the height of the text SHOULD be scaled.[\<30\>](#Appendix_A_30) + +Arcs MUST be drawn using the current arc direction, but they MUST NOT reflect the current world-to-device transform, which might require a [**rotation**](#gt_5cdd5e5b-fe3d-46e6-9019-50483463a76a) along the x-axis or y-axis. + +The world-to-device transform is modified by changing the window and viewport extents and origins, using the EMR_SETWINDOWEXTEX (section [2.3.11.30](#Section_1952148360b549b8b58c4b5d1b6cf839)) and EMR_SETVIEWPORTEXTEX (section [2.3.11.28](#Section_a71486a39ebd43e3819f5318a58b70d5)) records, and the EMR_SETWINDOWORGEX (section [2.3.11.31](#Section_952803a93d5c4c83a258558bc1123bdb)) and EMR_SETVIEWPORTORGEX (section [2.3.11.29](#Section_b89489473f8d4adda4b8e572e8f90506)) records, respectively. + +The world-to-device transform can be changed by EMR_MODIFYWORLDTRANSFORM (section [2.3.12.1](#Section_c70b85e58c31418fa7b8349e417e0f76)) and EMR_SETWORLDTRANSFORM (section [2.3.12.2](#Section_985724c04db148f0b34667288b3288cb)) records. + +In **GM_COMPATIBLE** graphics mode, bottom and rightmost edges MUST be excluded when rectangles are drawn. + +**GM_ADVANCED:** TrueType text output SHOULD[\<31\>](#Appendix_A_31) fully conform to the current world-to-device transform. + +Arcs MUST be drawn in the counterclockwise direction in [**world space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7); however, both arc control points and the arcs themselves MUST reflect the current world-to-device transform. + +The world-to-device transform can be modified directly by EMR_MODIFYWORLDTRANSFORM and EMR_SETWORLDTRANSFORM records, or indirectly by changing the window and viewport extents and origins, using the EMR_SETWINDOWEXTEX and EMR_SETVIEWPORTEXTEX records, and the EMR_SETWINDOWORGEX and EMR_SETVIEWPORTORGEX records, respectively. + +In **GM_ADVANCED** graphics mode, bottom and rightmost edges MUST be included when rectangles are drawn. + +### HatchStyle Enumeration + +The **HatchStyle** enumeration is an extension to the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) **HatchStyle** enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.12). + +236. typedef enum + + { + +   HS_SOLIDCLR = 0x0006, + +   HS_DITHEREDCLR = 0x0007, + +   HS_SOLIDTEXTCLR = 0x0008, + +   HS_DITHEREDTEXTCLR = 0x0009, + +   HS_SOLIDBKCLR = 0x000A, + +   HS_DITHEREDBKCLR = 0x000B + + } HatchStyle; + +**HS_SOLIDCLR:** The hatch is not a pattern, but is a solid color. + +**HS_DITHEREDCLR:** The hatch is not a pattern, but is a dithered color. + +**HS_SOLIDTEXTCLR:** The hatch is not a pattern, but is a solid color, defined by the current text (foreground) color. + +**HS_DITHEREDTEXTCLR:** The hatch is not a pattern, but is a dithered color, defined by the current text (foreground) color. + +**HS_SOLIDBKCLR:** The hatch is not a pattern, but is a solid color, defined by the current background color. + +**HS_DITHEREDBKCLR:** The hatch is not a pattern, but is a dithered color, defined by the current background color. + +### ICMMode Enumeration + +The **ICMMode** enumeration defines values that specify when to turn on and off [**Image Color Management (ICM)**](#gt_fcd5ee55-57ff-45d6-b51e-2ccba47329e3).[\<32\>](#Appendix_A_32) + +245. typedef enum + + { + +   ICM_OFF = 0x01, + +   ICM_ON = 0x02, + +   ICM_QUERY = 0x03, + +   ICM_DONE_OUTSIDEDC = 0x04 + + } ICMMode; + +**ICM_OFF:** Turns off ICM; turns on old-style [**color correction**](#gt_0f6a2bd0-2201-4ce8-9b84-bd5a64a79931) of [**halftones**](#gt_476862c3-a702-4d6c-8f3b-a42dc49cce79). + +**ICM_ON:** Turns on ICM; turns off old-style color correction of halftones. + +**ICM_QUERY:** Queries the current state of color management. + +**ICM_DONE_OUTSIDEDC:** Turns off both ICM and old-style color correction of halftones. + +### Illuminant Enumeration + +The **Illuminant** enumeration defines values that specify the illuminant value of an image, which determines the standard light source under which the image is viewed so that the color can be adjusted appropriately. + +252. typedef enum + + { + +   ILLUMINANT_DEVICE_DEFAULT = 0x00, + +   ILLUMINANT_TUNGSTEN = 0x01, + +   ILLUMINANT_B = 0x02, + +   ILLUMINANT_DAYLIGHT = 0x03, + +   ILLUMINANT_D50 = 0x04, + +   ILLUMINANT_D55 = 0x05, + +   ILLUMINANT_D65 = 0x06, + +   ILLUMINANT_D75 = 0x07, + +   ILLUMINANT_FLUORESCENT = 0x08 + + } Illuminant; + +**ILLUMINANT_DEVICE_DEFAULT:** Device's default. Standard used by output devices. + +**ILLUMINANT_TUNGSTEN:** Tungsten lamp. + +**ILLUMINANT_B:** Noon sunlight. + +**ILLUMINANT_DAYLIGHT:** Daylight. + +**ILLUMINANT_D50:** Normal print. + +**ILLUMINANT_D55:** Bond paper print. + +**ILLUMINANT_D65:** Standard daylight. Standard for CRTs and pictures. + +**ILLUMINANT_D75:** Northern daylight. + +**ILLUMINANT_FLUORESCENT:** Cool white lamp. + +### Letterform Enumeration + +The **Letterform** enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +264. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_LETT_NORMAL_CONTACT = 0x02, + +   PAN_LETT_NORMAL_WEIGHTED = 0x03, + +   PAN_LETT_NORMAL_BOXED = 0x04, + +   PAN_LETT_NORMAL_FLATTENED = 0x05, + +   PAN_LETT_NORMAL_ROUNDED = 0x06, + +   PAN_LETT_NORMAL_OFF_CENTER = 0x07, + +   PAN_LETT_NORMAL_SQUARE = 0x08, + +   PAN_LETT_OBLIQUE_CONTACT = 0x09, + +   PAN_LETT_OBLIQUE_WEIGHTED = 0x0A, + +   PAN_LETT_OBLIQUE_BOXED = 0x0B, + +   PAN_LETT_OBLIQUE_FLATTENED = 0x0C, + +   PAN_LETT_OBLIQUE_ROUNDED = 0x0D, + +   PAN_LETT_OBLIQUE_OFF_CENTER = 0x0E, + +   PAN_LETT_OBLIQUE_SQUARE = 0x0F + + } Letterform; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_LETT_NORMAL_CONTACT:** Normal/contact. + +**PAN_LETT_NORMAL_WEIGHTED:** Normal/weighted. + +**PAN_LETT_NORMAL_BOXED:** Normal/boxed. + +**PAN_LETT_NORMAL_FLATTENED:** Normal/flattened. + +**PAN_LETT_NORMAL_ROUNDED:** Normal/rounded. + +**PAN_LETT_NORMAL_OFF_CENTER:** Normal/off center. + +**PAN_LETT_NORMAL_SQUARE:** Normal/square + +**PAN_LETT_OBLIQUE_CONTACT:** Oblique/contact. + +**PAN_LETT_OBLIQUE_WEIGHTED:** Oblique/weighted. + +**PAN_LETT_OBLIQUE_BOXED:** Oblique/boxed. + +**PAN_LETT_OBLIQUE_FLATTENED:** Oblique/flattened. + +**PAN_LETT_OBLIQUE_ROUNDED:** Oblique/rounded. + +**PAN_LETT_OBLIQUE_OFF_CENTER:** Oblique/off center. + +**PAN_LETT_OBLIQUE_SQUARE:** Oblique/square. + +### MapMode Enumeration + +The **MapMode** enumeration is used to define the unit of measure for transforming [**page space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) units into [**device space**](#gt_25d586c7-f440-45c6-b965-5c025bea9fc0) units and for defining the orientation of the drawing axes. + +283. typedef enum + + { + +   MM_TEXT = 0x01, + +   MM_LOMETRIC = 0x02, + +   MM_HIMETRIC = 0x03, + +   MM_LOENGLISH = 0x04, + +   MM_HIENGLISH = 0x05, + +   MM_TWIPS = 0x06, + +   MM_ISOTROPIC = 0x07, + +   MM_ANISOTROPIC = 0x08 + + } MapMode; + +**MM_TEXT:** Each logical unit is mapped to one device pixel. Positive x is to the right; positive y is down. + +**MM_LOMETRIC:** Each logical unit is mapped to 0.1 millimeter. Positive x is to the right; positive y is up. + +**MM_HIMETRIC:** Each logical unit is mapped to 0.01 millimeter. Positive x is to the right; positive y is up. + +**MM_LOENGLISH:** Each logical unit is mapped to 0.01 inch. Positive x is to the right; positive y is up. + +**MM_HIENGLISH:** Each logical unit is mapped to 0.001 inch. Positive x is to the right; positive y is up. + +**MM_TWIPS:** Each logical unit is mapped to one-twentieth of a printer's point (1/1440 inch, also called a "twip"). Positive x is to the right; positive y is up. + +**MM_ISOTROPIC:** Logical units are [**isotropic**](#gt_716e3252-cd28-451e-be10-bde8793f0534); that is, they are mapped to arbitrary units with equally scaled axes. Thus, one unit along the x-axis is equal to one unit along the y-axis. The EMR_SETWINDOWEXTEX (section [2.3.11.30](#Section_1952148360b549b8b58c4b5d1b6cf839)) and EMR_SETVIEWPORTEXTEX (section [2.3.11.28](#Section_a71486a39ebd43e3819f5318a58b70d5)) records are used to specify the units and the orientation of the axes. + +Adjustments MUST be made as necessary to ensure that the x and y units remain the same size. For example, when the window extent is set, the viewport MUST be adjusted to keep the units isotropic. + +**MM_ANISOTROPIC:** Logical units are [**anisotropic**](#gt_8356f4cd-ad99-4fb4-a10e-6aeeb1712c26); that is, they are mapped to arbitrary units with arbitrarily scaled axes. The EMR_SETWINDOWEXTEX and EMR_SETVIEWPORTEXTEX records are used to specify the units, orientation, and scaling of the axes. + +### MetafileVersion Enumeration + +The **MetafileVersion** enumeration defines the interoperability version for [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +294. typedef enum + + { + +   META_FORMAT_ENHANCED = 0x00010000 + + } MetafileVersion; + +**META_FORMAT_ENHANCED:** Specifies EMF metafile interoperability. + +### MidLine Enumeration + +The **MidLine** enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +298. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_MIDLINE_STANDARD_TRIMMED = 0x02, + +   PAN_MIDLINE_STANDARD_POINTED = 0x03, + +   PAN_MIDLINE_STANDARD_SERIFED = 0x04, + +   PAN_MIDLINE_HIGH_TRIMMED = 0x05, + +   PAN_MIDLINE_HIGH_POINTED = 0x06, + +   PAN_MIDLINE_HIGH_SERIFED = 0x07, + +   PAN_MIDLINE_CONSTANT_TRIMMED = 0x08, + +   PAN_MIDLINE_CONSTANT_POINTED = 0x09, + +   PAN_MIDLINE_CONSTANT_SERIFED = 0x0A, + +   PAN_MIDLINE_LOW_TRIMMED = 0x0B, + +   PAN_MIDLINE_LOW_POINTED = 0x0C, + +   PAN_MIDLINE_LOW_SERIFED = 0x0D + + } MidLine; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_MIDLINE_STANDARD_TRIMMED:** Standard/trimmed. + +**PAN_MIDLINE_STANDARD_POINTED:** Standard/pointed. + +**PAN_MIDLINE_STANDARD_SERIFED:** Standard/serifed. + +**PAN_MIDLINE_HIGH_TRIMMED:** High/trimmed. + +**PAN_MIDLINE_HIGH_POINTED:** High/pointed. + +**PAN_MIDLINE_HIGH_SERIFED:** High/serifed. + +**PAN_MIDLINE_CONSTANT_TRIMMED:** Constant/trimmed. + +**PAN_MIDLINE_CONSTANT_POINTED:** Constant/pointed. + +**PAN_MIDLINE_CONSTANT_SERIFED:** Constant/serifed. + +**PAN_MIDLINE_LOW_TRIMMED:** Low/trimmed. + +**PAN_MIDLINE_LOW_POINTED:** Low/pointed. + +**PAN_MIDLINE_LOW_SERIFED:** Low/serifed. + +### ModifyWorldTransformMode Enumeration + +The **ModifyWorldTransformMode** enumeration defines modes for changing the [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that is currently defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +315. typedef enum + + { + +   MWT_IDENTITY = 0x01, + +   MWT_LEFTMULTIPLY = 0x02, + +   MWT_RIGHTMULTIPLY = 0x03, + +   MWT_SET = 0x04 + + } ModifyWorldTransformMode; + +**MWT_IDENTITY:** Reset the current transform using the identity matrix. In this mode, the specified transform data is ignored. + +**MWT_LEFTMULTIPLY:** Multiply the current transform. In this mode, the specified transform data is the left multiplicand, and the current transform is the right multiplicand. + +**MWT_RIGHTMULTIPLY:** Multiply the current transform. In this mode, the specified transform data is the right multiplicand, and the current transform is the left multiplicand. + +**MWT_SET:** Set the current transform to the specified transform data. + +The transform data is specified as an XForm object (section [2.2.28](#Section_e84107e9bc2b4a1492345d173adc1b59)). + +For more information concerning transforms and [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). + +### PenStyle Enumeration + +The **PenStyle** enumeration defines the attributes of pens that can be used in graphics operations. A pen style is a combination of pen type, line style, [**line cap**](#gt_b0341150-ca76-4424-88fe-607e03848dbf), and [**line join**](#gt_4fd3ebb8-54f8-47e8-aded-399a08ad873e). + +322. typedef enum + + { + +   PS_COSMETIC = 0x00000000, + +   PS_ENDCAP_ROUND = 0x00000000, + +   PS_JOIN_ROUND = 0x00000000, + +   PS_SOLID = 0x00000000, + +   PS_DASH = 0x00000001, + +   PS_DOT = 0x00000002, + +   PS_DASHDOT = 0x00000003, + +   PS_DASHDOTDOT = 0x00000004, + +   PS_NULL = 0x00000005, + +   PS_INSIDEFRAME = 0x00000006, + +   PS_USERSTYLE = 0x00000007, + +   PS_ALTERNATE = 0x00000008, + +   PS_ENDCAP_SQUARE = 0x00000100, + +   PS_ENDCAP_FLAT = 0x00000200, + +   PS_JOIN_BEVEL = 0x00001000, + +   PS_JOIN_MITER = 0x00002000, + +   PS_GEOMETRIC = 0x00010000 + + } PenStyle; + +**PS_COSMETIC:** A pen type that specifies a line with a width of one logical unit and a style that is a solid color. + +**PS_ENDCAP_ROUND:** A line cap that specifies round ends. + +**PS_JOIN_ROUND:** A line join that specifies round joins. + +**PS_SOLID:** A line style that is a solid color. + +**PS_DASH:** A line style that is dashed. + +**PS_DOT:** A line style that is dotted. + +**PS_DASHDOT:** A line style that consists of alternating dashes and dots. + +**PS_DASHDOTDOT:** A line style that consists of dashes and double dots. + +**PS_NULL:** A line style that is invisible. + +**PS_INSIDEFRAME:** A line style that is a solid color. When this style is specified in a drawing record that takes a bounding rectangle, the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, considering the width of the pen. + +**PS_USERSTYLE:** A line style that is defined by a styling array, which specifies the lengths of dashes and gaps in the line. + +**PS_ALTERNATE:** A line style in which every other pixel is set. This style is applicable only to a pen type of **PS_COSMETIC**. + +**PS_ENDCAP_SQUARE:** A line cap that specifies square ends. + +**PS_ENDCAP_FLAT:** A line cap that specifies flat ends. + +**PS_JOIN_BEVEL:** A line join that specifies beveled joins. + +**PS_JOIN_MITER:** A line join that specifies mitered joins when the lengths of the joins are within the current [**miter length**](#gt_7d78ab9f-9531-4993-b140-8c2bb6e82220) limit. If the lengths of the joins exceed the miter limit, beveled joins are specified. + +The miter length limit is a [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) state property that is set by the EMR_SETMITERLIMIT record (section [2.3.11.21](#Section_2637d0d092dd48e8be5e6400b4d1fc5e)). + +**PS_GEOMETRIC:** A pen type that specifies a line with a width that is measured in logical units and a style that can contain any of the attributes of a brush. + +### Point Enumeration + +The Point enumeration is used to specify how a point is to be used in a drawing call. + +342. typedef enum + + { + +   PT_CLOSEFIGURE = 0x01, + +   PT_LINETO = 0x02, + +   PT_BEZIERTO = 0x04, + +   PT_MOVETO = 0x06 + + } Point; + +**PT_CLOSEFIGURE:** A **PT_LINETO** or **PT_BEZIERTO** type can be combined with this value by using the bitwise operator OR to indicate that the corresponding point is the last point in a figure and the figure is closed. + +The current position is set to the ending point of the closing line. + +**PT_LINETO:** Specifies that a line is to be drawn from the current position to this point, which then becomes the new current position. + +**PT_BEZIERTO:** Specifies that this point is a control point or ending point for a [**Bezier curve**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5). + +**PT_BEZIERTO** types always occur in sets of three. The current position defines the starting point for the Bezier curve. The first two **PT_BEZIERTO** points are the control points, and the third **PT_BEZIERTO** point is the ending point. The ending point becomes the new current position. If there are not three consecutive **PT_BEZIERTO** points, an error results. + +**PT_MOVETO:** Specifies that this point starts a disjoint figure. This point becomes the new current position. + +### PolygonFillMode Enumeration + +The PolygonFillMode enumeration defines values that specify how to calculate the [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) of a polygon that is to be filled. + +349. typedef enum + + { + +   ALTERNATE = 0x01, + +   WINDING = 0x02 + + } PolygonFillMode; + +**ALTERNATE:** Selects alternate mode (fills the area between odd-numbered and even-numbered polygon sides on each scan line). + +**WINDING:** Selects winding mode (fills any region with a nonzero winding value). + +### Proportion Enumeration + +The Proportion enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +354. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_PROP_OLD_STYLE = 0x02, + +   PAN_PROP_MODERN = 0x03, + +   PAN_PROP_EVEN_WIDTH = 0x04, + +   PAN_PROP_EXPANDED = 0x05, + +   PAN_PROP_CONDENSED = 0x06, + +   PAN_PROP_VERY_EXPANDED = 0x07, + +   PAN_PROP_VERY_CONDENSED = 0x08, + +   PAN_PROP_MONOSPACED = 0x09 + + } Proportion; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_PROP_OLD_STYLE:** Old style. + +**PAN_PROP_MODERN:** Modern. + +**PAN_PROP_EVEN_WIDTH:** Even width. + +**PAN_PROP_EXPANDED:** Expanded. + +**PAN_PROP_CONDENSED:** Condensed. + +**PAN_PROP_VERY_EXPANDED:** Very expanded. + +**PAN_PROP_VERY_CONDENSED:** Very condensed. + +**PAN_PROP_MONOSPACED:** Monospaced. + +### RegionMode Enumeration + +The **RegionMode** enumeration defines values that are used with [EMR_SELECTCLIPPATH](#Section_4a26bcf866074a098ec3a8768eadc8e8) and [EMR_EXTSELECTCLIPRGN](#Section_c6b9f4e627f64a4da383c2daf5da11d9), specifying the current [**path bracket**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601) or a new [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) that is being combined with the current clipping region. + +367. typedef enum + + { + +   RGN_AND = 0x01, + +   RGN_OR = 0x02, + +   RGN_XOR = 0x03, + +   RGN_DIFF = 0x04, + +   RGN_COPY = 0x05 + + } RegionMode; + +**RGN_AND:** The new clipping region includes the intersection (overlapping areas) of the current clipping region and the current path bracket (or new region). + +**RGN_OR:** The new clipping region includes the union (combined areas) of the current clipping region and the current path bracket (or new region). + +**RGN_XOR:** The new clipping region includes the union of the current clipping region and the current path bracket (or new region) but without the overlapping areas. + +**RGN_DIFF:** The new clipping region includes the areas of the current clipping region with those of the current path bracket (or new region) excluded. + +**RGN_COPY:** The new clipping region is the current path bracket (or the new region). + +### SerifType Enumeration + +The SerifType enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +375. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_SERIF_COVE = 0x02, + +   PAN_SERIF_OBTUSE_COVE = 0x03, + +   PAN_SERIF_SQUARE_COVE = 0x04, + +   PAN_SERIF_OBTUSE_SQUARE_COVE = 0x05, + +   PAN_SERIF_SQUARE = 0x06, + +   PAN_SERIF_THIN = 0x07, + +   PAN_SERIF_BONE = 0x08, + +   PAN_SERIF_EXAGGERATED = 0x09, + +   PAN_SERIF_TRIANGLE = 0x0A, + +   PAN_SERIF_NORMAL_SANS = 0x0B, + +   PAN_SERIF_OBTUSE_SANS = 0x0C, + +   PAN_SERIF_PERP_SANS = 0x0D, + +   PAN_SERIF_FLARED = 0x0E, + +   PAN_SERIF_ROUNDED = 0x0F + + } SerifType; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_SERIF_COVE:** Cove. + +**PAN_SERIF_OBTUSE_COVE:** Obtuse cove. + +**PAN_SERIF_SQUARE_COVE:** Square cove. + +**PAN_SERIF_OBTUSE_SQUARE_COVE:** Obtuse square cove. + +**PAN_SERIF_SQUARE:** Square. + +**PAN_SERIF_THIN:** Thin. + +**PAN_SERIF_BONE:** Bone. + +**PAN_SERIF_EXAGGERATED:** Exaggerated. + +**PAN_SERIF_TRIANGLE:** Triangle. + +**PAN_SERIF_NORMAL_SANS:** Normal sans. + +**PAN_SERIF_OBTUSE_SANS:** Obtuse sans. + +**PAN_SERIF_PERP_SANS:** Perp sans. + +**PAN_SERIF_FLARED:** Flared. + +**PAN_SERIF_ROUNDED:** Rounded. + +### StockObject Enumeration + +The **StockObject** enumeration specifies the indexes of predefined logical graphics objects that can be used in graphics operations. + +The specific structures of [**stock objects**](#gt_b1328cb9-acd8-47f8-9896-fe985af2d6d6) are implementation-dependent; however, the properties of stock objects SHOULD be equivalent to the properties of explicitly created objects of the same type. These properties are specified where possible for the stock objects defined in this enumeration. + +394. typedef enum + + { + +   WHITE_BRUSH = 0x80000000, + +   LTGRAY_BRUSH = 0x80000001, + +   GRAY_BRUSH = 0x80000002, + +   DKGRAY_BRUSH = 0x80000003, + +   BLACK_BRUSH = 0x80000004, + +   NULL_BRUSH = 0x80000005, + +   WHITE_PEN = 0x80000006, + +   BLACK_PEN = 0x80000007, + +   NULL_PEN = 0x80000008, + +   OEM_FIXED_FONT = 0x8000000A, + +   ANSI_FIXED_FONT = 0x8000000B, + +   ANSI_VAR_FONT = 0x8000000C, + +   SYSTEM_FONT = 0x8000000D, + +   DEVICE_DEFAULT_FONT = 0x8000000E, + +   DEFAULT_PALETTE = 0x8000000F, + +   SYSTEM_FIXED_FONT = 0x80000010, + +   DEFAULT_GUI_FONT = 0x80000011, + +   DC_BRUSH = 0x80000012, + +   DC_PEN = 0x80000013 + + } StockObject; + +**WHITE_BRUSH:** A white, solid-color brush that is equivalent to a logical brush (LogBrushEx object, section [2.2.12](#Section_6d790f8d51654746bac33443915c2071)) with the following properties: + +- **BrushStyle**: BS_SOLID from the BrushStyle enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.4) + +- **Color**: 0x00FFFFFF in a ColorRef object (\[MS-WMF\] section 2.2.2.8) + +**LTGRAY_BRUSH:** A light gray, solid-color brush that is equivalent to a logical brush with the following properties: + +- **BrushStyle**: BS_SOLID + +- **Color**: 0x00C0C0C0 + +**GRAY_BRUSH:** A gray, solid-color brush that is equivalent to a logical brush with the following properties: + +- **BrushStyle**: BS_SOLID + +- **Color**: 0x00808080 + +**DKGRAY_BRUSH:** A dark gray, solid color brush that is equivalent to a logical brush with the following properties: + +- **BrushStyle**: BS_SOLID + +- **Color**: 0x00404040 + +**BLACK_BRUSH:** A black, solid color brush that is equivalent to a logical brush with the following properties: + +- **BrushStyle**: BS_SOLID + +- **Color**: 0x00000000 + +**NULL_BRUSH:** A null brush that is equivalent to a logical brush with the following properties: + +- **BrushStyle**: BS_NULL + +**WHITE_PEN:** A white, solid-color pen that is equivalent to a logical pen (LogPen object, section [2.2.19](#Section_93ce3f4537ac4affb6e82f6db054c4c4)) with the following properties: + +- **PenStyle**: PS_COSMETIC + PS_SOLID from the PenStyle enumeration (section [2.1.25](#Section_b2e629158401429fbb6db2506a4c2fe8)) + +- **ColorRef**: 0x00FFFFFF in a ColorRef object. + +**BLACK_PEN:** A black, solid-color pen that is equivalent to a logical pen with the following properties: + +- **PenStyle**: PS_COSMETIC + PS_SOLID + +- **ColorRef**: 0x00000000 + +**NULL_PEN:** A null pen that is equivalent to a logical pen with the following properties: + +- **PenStyle**: PS_NULL + +**OEM_FIXED_FONT:** A fixed-width, [**OEM character set**](#gt_3240e34e-920e-40ac-a672-342ac34a5e22) font that is equivalent to a LogFont object (section [2.2.13](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100)) with the following properties: + +- **Charset**: OEM_CHARSET from the CharacterSet enumeration (\[MS-WMF\] section 2.1.1.5) + +- **PitchAndFamily**: **FF_DONTCARE** (FamilyFont enumeration, \[MS-WMF\] section 2.1.1.8) + **FIXED_PITCH** (PitchFont enumeration, \[MS-WMF\] section 2.1.1.24) + +**ANSI_FIXED_FONT:** A fixed-width font that is equivalent to a LogFont object with the following properties:[\<33\>](#Appendix_A_33) + +- **Charset**: ANSI_CHARSET + +- **PitchAndFamily**: FF_DONTCARE + FIXED_PITCH + +**ANSI_VAR_FONT:** A variable-width font that is equivalent to a logical font with the following properties:[\<34\>](#Appendix_A_34) + +- **Charset**: ANSI_CHARSET + +- **PitchAndFamily**: FF_DONTCARE + VARIABLE_PITCH + +**SYSTEM_FONT:** A font that is guaranteed to be available in the operating system. The actual font that is specified by this value is implementation-dependent.[\<35\>](#Appendix_A_35) + +**DEVICE_DEFAULT_FONT:** The default font that is provided by the graphics device driver for the current output device. The actual font that is specified by this value is implementation-dependent.[\<36\>](#Appendix_A_36) + +**DEFAULT_PALETTE:** The default [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) that is defined for the current output device. The actual palette that is specified by this value is implementation-dependent.[\<37\>](#Appendix_A_37) + +**SYSTEM_FIXED_FONT:** A fixed-width font that is guaranteed to be available in the operating system. The actual font that is specified by this value is implementation-dependent. + +**DEFAULT_GUI_FONT:** The default font that is used for user interface objects such as menus and dialog boxes. The actual font that is specified by this value is implementation-dependent.[\<38\>](#Appendix_A_38) + +**DC_BRUSH:** The solid-color brush that is currently selected in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The default SHOULD[\<39\>](#Appendix_A_39) be WHITE_BRUSH. + +**DC_PEN:** The solid-color pen that is currently selected in the playback device context. The default SHOULD[\<40\>](#Appendix_A_40) be BLACK_PEN. + +During [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) processing, stock object indexes can be used by object manipulation records (section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998)) in the same way as indexes of graphics objects that are explicitly created by object creation records (section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18)). The index of a stock object can be distinguished from the index of an explicit object by the value of the most-significant bit. If that bit is set, the object is a stock object; if the bit is clear, the object was created by a previous metafile record. + +### StretchMode Enumeration + +The **StretchMode** enumeration is used to specify how color data is added to or removed from [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) that are stretched or compressed.[\<41\>](#Appendix_A_41) + +416. typedef enum + + { + +   STRETCH_ANDSCANS = 0x01, + +   STRETCH_ORSCANS = 0x02, + +   STRETCH_DELETESCANS = 0x03, + +   STRETCH_HALFTONE = 0x04 + + } StretchMode; + +**STRETCH_ANDSCANS:** Performs a [**Boolean**](#gt_1d79d7a7-ba2c-4b34-931c-7ba8057c87b2) AND operation using the color values for the eliminated and existing pixels. If the bitmap is a monochrome bitmap, this mode preserves black pixels at the expense of white pixels. + +**STRETCH_ORSCANS:** Performs a Boolean OR operation using the color values for the eliminated and existing pixels. If the bitmap is a monochrome bitmap, this mode preserves white pixels at the expense of black pixels. + +**STRETCH_DELETESCANS:** Deletes the pixels. This mode deletes all eliminated lines of pixels without trying to preserve their information. + +**STRETCH_HALFTONE:** Maps pixels from the source rectangle into blocks of pixels in the destination rectangle. The average color over the destination block of pixels approximates the color of the source pixels. + +After setting the **STRETCH_HALFTONE** stretching mode, the brush origin SHOULD be defined by an [EMR_SETBRUSHORGEX](#Section_b02ab7ee4c884bf29ce99100636d86be) record. If it fails to do so, brush misalignment can occur. + +### StrokeVariation Enumeration + +The StrokeVariation enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +423. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_STROKE_GRADUAL_DIAG = 0x02, + +   PAN_STROKE_GRADUAL_TRAN = 0x03, + +   PAN_STROKE_GRADUAL_VERT = 0x04, + +   PAN_STROKE_GRADUAL_HORZ = 0x05, + +   PAN_STROKE_RAPID_VERT = 0x06, + +   PAN_STROKE_RAPID_HORZ = 0x07, + +   PAN_STROKE_INSTANT_VERT = 0x08 + + } StrokeVariation; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_STROKE_GRADUAL_DIAG:** Gradual/diagonal. + +**PAN_STROKE_GRADUAL_TRAN:** Gradual/transitional. + +**PAN_STROKE_GRADUAL_VERT:** Gradual/vertical. + +**PAN_STROKE_GRADUAL_HORZ:** Gradual/horizontal. + +**PAN_STROKE_RAPID_VERT:** Rapid/vertical. + +**PAN_STROKE_RAPID_HORZ:** Rapid/horizontal. + +**PAN_STROKE_INSTANT_VERT:** Instant/vertical. + +### Weight Enumeration + +The Weight enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +435. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_WEIGHT_VERY_LIGHT = 0x02, + +   PAN_WEIGHT_LIGHT = 0x03, + +   PAN_WEIGHT_THIN = 0x04, + +   PAN_WEIGHT_BOOK = 0x05, + +   PAN_WEIGHT_MEDIUM = 0x06, + +   PAN_WEIGHT_DEMI = 0x07, + +   PAN_WEIGHT_BOLD = 0x08, + +   PAN_WEIGHT_HEAVY = 0x09, + +   PAN_WEIGHT_BLACK = 0x0A, + +   PAN_WEIGHT_NORD = 0x0B + + } Weight; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_WEIGHT_VERY_LIGHT:** Very light. + +**PAN_WEIGHT_LIGHT:** Light. + +**PAN_WEIGHT_THIN:** Thin. + +**PAN_WEIGHT_BOOK:** Book. + +**PAN_WEIGHT_MEDIUM:** Medium. + +**PAN_WEIGHT_DEMI:** Demi. + +**PAN_WEIGHT_BOLD:** Bold. + +**PAN_WEIGHT_HEAVY:** Heavy. + +**PAN_WEIGHT_BLACK:** Black. + +**PAN_WEIGHT_NORD:** Nord. + +### XHeight Enumeration + +The XHeight enumeration defines values for one of the characteristics in the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) system for classifying [**typefaces**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789). + +450. typedef enum + + { + +   PAN_ANY = 0x00, + +   PAN_NO_FIT = 0x01, + +   PAN_XHEIGHT_CONSTANT_SMALL = 0x02, + +   PAN_XHEIGHT_CONSTANT_STD = 0x03, + +   PAN_XHEIGHT_CONSTANT_LARGE = 0x04, + +   PAN_XHEIGHT_DUCKING_SMALL = 0x05, + +   PAN_XHEIGHT_DUCKING_STD = 0x06, + +   PAN_XHEIGHT_DUCKING_LARGE = 0x07 + + } XHeight; + +**PAN_ANY:** Any. + +**PAN_NO_FIT:** No fit. + +**PAN_XHEIGHT_CONSTANT_SMALL:** Constant/small. + +**PAN_XHEIGHT_CONSTANT_STD:** Constant/standard. + +**PAN_XHEIGHT_CONSTANT_LARGE:** Constant/large. + +**PAN_XHEIGHT_DUCKING_SMALL: [Ducking](#gt_85a2a285-eeff-4059-82e9-d924141f244e)**/small + +**PAN_XHEIGHT_DUCKING_STD:** Ducking/standard. + +**PAN_XHEIGHT_DUCKING_LARGE:** Ducking/large. + +## EMF Objects + +### BitFIX28_4 Object + +The BitFIX28_4 object defines a numeric value in [**28.4 bit FIX notation**](#gt_1bcc53a6-1861-49e9-bd00-3a38a888d9f4). + +[TABLE] + +**IntValue (28 bits):** The signed, integral part of the number. + +**FracValue (4 bits):** The unsigned fractional part of the number, in units of one-sixteenth. + +The real number represented by this object is computed as follows: + +461. IntValue + (FracValue / 16) + +### ColorAdjustment Object + +The ColorAdjustment object defines values for adjusting the colors in source [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) in bit-block transfers.[\<42\>](#Appendix_A_42) + +[TABLE] + +**Size (2 bytes):** An unsigned integer that specifies the size in bytes of this object. This value is 0x0018. + +**Values (2 bytes):** An unsigned integer that specifies how to prepare the output image. This field can be set to NULL or to any combination of values in the [ColorAdjustment](#Section_c80a94d5415d4c4c83b812c0eb98b81f) enumeration (section 2.1.5). + +**IlluminantIndex (2 bytes):** An unsigned integer that specifies the type of standard light source under which the image is viewed, from the [Illuminant](#Section_7cd7679e4a1445d19cacbf7f80be2c10) enumeration (section 2.1.19). + +**RedGamma (2 bytes):** An unsigned integer that specifies the nth power [**gamma correction**](#gt_60eaec33-bd4f-4e71-93e6-4ef382aa80f9) value for the red primary of the source colors. This value SHOULD be in the range from 2,500 to 65,000.[\<43\>](#Appendix_A_43) A value of 10,000 means gamma correction MUST NOT be performed. + +**GreenGamma (2 bytes):** An unsigned integer that specifies the nth power gamma correction value for the green primary of the source colors. This value SHOULD be in the range from 2,500 to 65,000. A value of 10,000 means gamma correction MUST NOT be performed. + +**BlueGamma (2 bytes):** An unsigned integer that specifies the nth power gamma correction value for the blue primary of the source colors. This value SHOULD be in the range from 2,500 to 65,000. A value of 10,000 means gamma correction MUST NOT be performed. + +**ReferenceBlack (2 bytes):** An unsigned integer that specifies the black reference for the source colors. Any colors that are darker than this are treated as black. This value SHOULD be in the range from zero to 4,000. + +**ReferenceWhite (2 bytes):** An unsigned integer that specifies the white reference for the source colors. Any colors that are lighter than this are treated as white. This value SHOULD be in the range from 6,000 to 10,000. + +**Contrast (2 bytes):** A signed integer that specifies the amount of [**contrast**](#gt_ceb96b0c-3f4c-4ad8-aa79-289d935ac577) to be applied to the source object. This value SHOULD be in the range from –100 to 100. A value of zero means contrast adjustment MUST NOT be performed. + +**Brightness (2 bytes):** A signed integer that specifies the amount of [**brightness**](#gt_227798e1-af7a-4ab5-b3a9-c73f02d9c504) to be applied to the source object. This value SHOULD be in the range from –100 to 100. A value of zero means brightness adjustment MUST NOT be performed. + +**Colorfulness (2 bytes):** A signed integer that specifies the amount of [**colorfulness**](#gt_0140633b-37c2-4260-bae2-ca578de1b278) to be applied to the source object. This value SHOULD be in the range from –100 to 100. A value of zero means colorfulness adjustment MUST NOT be performed. + +**RedGreenTint (2 bytes):** A signed integer that specifies the amount of red or green [**tint**](#gt_ff6845a6-3de9-4eaf-a14d-0b3137c58691) adjustment to be applied to the source object. This value SHOULD be in the range from –100 to 100. Positive numbers adjust towards red and negative numbers adjust towards green. A value of zero means tint adjustment MUST NOT be performed. + +The ColorAdjustment object is used in bit-block transfers performed by [EMR_STRETCHBLT](#Section_0dd551f380f7485289c29ddba803a192) and [EMR_STRETCHDIBITS](#Section_89c0d8080dea413fbe402e9e51fa36ac) records when the [StretchMode](#Section_e72f20aa2e2d453f9e95eaef50b76e19) enumeration (section 2.1.32) value is **STRETCH_HALFTONE**. The color adjustment values can apply a color filter or lighten or darken an image. + +An [EMR_SETCOLORADJUSTMENT](#Section_81b3cd7ced6742aaab9847b99d697231) record (section 2.3.11.13) sets the current ColorAdjustment object in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). That ColorAdjustment object affects all subsequent EMR_STRETCHBLT and EMR_STRETCHDIBITS records until a different ColorAdjustment object is specified by another EMR_SETCOLORADJUSTMENT record, or until the object is removed by a [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record. + +### DesignVector Object + +The DesignVector (section 2.2.3) object defines the [**design vector**](#gt_68697457-d046-45a9-b822-86cb2b8c3320), which specifies values for the [**font axes**](#gt_5d727201-0a47-44b1-86e5-faf77f0f2463) of a [**multiple master**](#gt_fef5ee7a-ad0c-4395-a1ac-f130405eec03) font. + +[TABLE] + +**Signature (4 bytes):** An unsigned integer that MUST be set to the value 0x08007664. + +**NumAxes (4 bytes):** An unsigned integer that specifies the number of elements in the **Values** array. It MUST be in the range 0 to 16, inclusive. + +**Values (variable, optional):** An array of 32-bit signed integers that specify the values of the font axes of a multiple master, [**OpenType**](#gt_5e824598-05ae-44e2-99bd-78c347279ad9) font. The maximum number of values in the array is 16. + +### EmrFormat Object + +The EmrFormat object contains information that identifies the format of image data in an [EMR_COMMENT_MULTIFORMATS record (section 2.3.3.4.3)](#Section_4bc4608eca82426dac0e5ded2ad3fc4e). + +[TABLE] + +**Signature (4 bytes):** An unsigned integer that specifies the format of the image data. This value is in the [FormatSignature enumeration (section 2.1.14)](#Section_b55cbd24612d47fe81c91da6a682246f). + +**Version (4 bytes):** An unsigned integer that specifies the format version number. If the **Signature** field specifies [**encapsulated PostScript (EPS)**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f), this value is 0x00000001; otherwise, this value is ignored. + +**SizeData (4 bytes):** An unsigned integer that specifies the size of the data in bytes. + +**offData (4 bytes):** An unsigned integer that specifies the offset to the data from the start of the **identifier** field in an [EMR_COMMENT_PUBLIC record (section 2.3.3.4)](#Section_39c91f22e4cc4e82a6050137caa8457c). The offset MUST be 32-bit aligned. + +### EmrText Object + +The **EmrText** object contains values for text output. + +[TABLE] + +**Reference (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15) that specifies the coordinates of the reference point used to position the string. The reference point is defined by the last EMR_SETTEXTALIGN record (section [2.3.11.25](#Section_a49bb565a58341da8d4a8a0314b3e397)). If no such record has been set, the default alignment is (TA_LEFT, TA_TOP), which is specified using TextAlignmentMode flags (\[MS-WMF\] section 2.1.2.3). + +**Chars (4 bytes):** An unsigned integer that specifies the number of characters in the string. + +**offString (4 bytes):** An unsigned integer that specifies the offset to the output string in bytes, from the start of the record in which this object is contained. This value is 8- or 16-bit aligned, according to the character format. + +**Options (4 bytes):** An unsigned integer that specifies how to use the rectangle specified in the **Rectangle** field. This field can be a combination of more than one ExtTextOutOptions enumeration (section [2.1.11](#Section_e7ffcc5340d148738edac5c5ee104aa5)) values. + +**Rectangle (16 bytes, optional):** A RectL object (\[MS-WMF\] section 2.2.2.19) that defines a clipping and/or opaquing rectangle in logical units. This rectangle is applied to the text output performed by the containing record.[\<44\>](#Appendix_A_44) + +**offDx (4 bytes):** An unsigned integer that specifies the offset to an intercharacter spacing array in bytes, from the start of the record in which this object is contained. This value is 32-bit aligned. + +**StringBuffer (variable):** The character string buffer. + +[TABLE] + +> **UndefinedSpace1 (variable, optional):** The number of unused bytes. The **OutputString** field is not required to follow immediately the preceding portion of this structure. +> +> **OutputString (variable):** An array of characters that specify the string to output. The location of this field is specified by the value of **offString** in bytes from the start of this record. The number of characters is specified by the value of **Chars**. + +**DxBuffer (variable, optional):** The character spacing buffer. + +[TABLE] + +> **UndefinedSpace2 (variable, optional):** The number of unused bytes. The **OutputDx** field is not required to follow immediately the preceding portion of this structure. +> +> **OutputDx (variable):** An array of 32-bit unsigned integers that specify the output spacing between the origins of adjacent character cells in logical units. The location of this field is specified by the value of **offDx** in bytes from the start of this record. If spacing is defined, this field contains the same number of values as characters in the output string. + +If the Options field of the EmrText object contains the ETO_PDY flag, then this buffer contains twice as many values as there are characters in the output string, one horizontal and one vertical offset for each, in that order. + +If ETO_RTLREADING is specified, characters are laid right to left instead of left to right. No other options affect the interpretation of this field. + +The size and encoding of the characters in the **OutputString** is determined by the type of record that contains this object, as follows: + +- EMR_EXTTEXTOUTA (section [2.3.5.7](#Section_6b582a713c294fc6a0f41f8a313739a1)) and EMR_POLYTEXTOUTA (section [2.3.5.32](#Section_d8b7ac2176b84f9aa7cc05f9d2d5627e)) records: 8-bit [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters. + +- EMR_EXTTEXTOUTW (section [2.3.5.8](#Section_a59a79ac328e492da34de02727af6edf)) and EMR_POLYTEXTOUTW (section [2.3.5.33](#Section_381015eb29a7477493ada210697f5972)) records: 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) characters. + +### EpsData Object + +The EpsData object is a container for [**EPS**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f) data. + +[TABLE] + +**SizeData (4 bytes):** An unsigned integer that specifies the total size of this object in bytes. + +**Version (4 bytes):** An unsigned integer that specifies the [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) language level. This value is 0x00000001. + +**Points (24 bytes):** An array of three [Point28_4 objects (section 2.2.23)](#Section_c66bda3b65ae4b3f8c8f62ad7f94f730) that defines the coordinates of the output parallelogram using [**28.4 bit FIX notation**](#gt_1bcc53a6-1861-49e9-bd00-3a38a888d9f4). + +The upper-left corner of the parallelogram is the first point in this array, the upper-right corner is the second point, and the lower-left corner is the third point. The lower-right corner of the parallelogram is computed from the first three points (A, B, and C) by treating them as vectors. + +462. D = B + C A + +**PostScriptData (variable):** An array of bytes of PostScript data. The length of this array can be computed from the **SizeData** field. This data MAY be used to render an image.[\<45\>](#Appendix_A_45) + +An EpsData object can be used to embed a PostScript image in an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) as follows: + +- An EMF metafile contains an [EMR_COMMENT_MULTIFORMATS record (section 2.3.3.4.3)](#Section_4bc4608eca82426dac0e5ded2ad3fc4e). + +- The EMR_COMMENT_MULTIFORMATS record specifies an **aFormats** field that contains an [EmrFormat object (section 2.2.4)](#Section_1bd63563ce674528bf285a8852ff0270). + +- The EmrFormat object specifies a **Signature** field that is set to **EPS_SIGNATURE** from the [FormatSignature enumeration (section 2.1.14)](#Section_b55cbd24612d47fe81c91da6a682246f). + +- The **EPS_SIGNATURE** value specifies that the **FormatData** field in the EMR_COMMENT_MULTIFORMATS record contains an EpsData object. + +- The EmrFormat object also specifies an **offData** field that indicates where the EpsData object is in the **FormatData** field in the EMR_COMMENT_MULTIFORMATS record. + +### GradientRectangle Object + +The GradientRectangle object defines a rectangle using [TriVertex objects (section 2.2.26)](#Section_33578509834946b68f8f107c3f70bace) in an [EMR_GRADIENTFILL record (section 2.3.5.12)](#Section_1a3849c8be6c4d30b5d3f43b4c70ca0d). + +[TABLE] + +**UpperLeft (4 bytes):** An index into an array of TriVertex objects that specifies the upper-left vertex of a rectangle. The index MUST be smaller than the size of the array, as defined by the **nVer** field of the EMR_GRADIENTFILL record. + +**LowerRight (4 bytes):** An index into an array of TriVertex objects that specifies the lower-right vertex of a rectangle. The index MUST be smaller than the size of the array, as defined by the **nVer** field of the EMR_GRADIENTFILL record. + +### GradientTriangle Object + +The GradientTriangle object defines a triangle using [TriVertex objects (section 2.2.26)](#Section_33578509834946b68f8f107c3f70bace) in an [EMR_GRADIENTFILL record (section 2.3.5.12)](#Section_1a3849c8be6c4d30b5d3f43b4c70ca0d). + +[TABLE] + +**Vertex1 (4 bytes):** An index into an array of TriVertex objects that specifies a vertex of a triangle. The index MUST be smaller than the size of the array, as defined by the **nVer** field of the EMR_GRADIENTFILL record. + +**Vertex2 (4 bytes):** An index into an array of TriVertex objects that specifies a vertex of a triangle. The index MUST be smaller than the size of the array, as defined by the **nVer** field of the EMR_GRADIENTFILL record. + +**Vertex3 (4 bytes):** An index into an array of TriVertex objects that specifies a vertex of a triangle. The index MUST be smaller than the size of the array, as defined by the **nVer** field of the EMR_GRADIENTFILL record. + +### Header Object + +The Header object defines the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) header. It specifies properties of the device on which the image in the metafile was created. + +[TABLE] + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the rectangular [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounds in logical units of the smallest rectangle that can be drawn around the image stored in the metafile. + +**Frame (16 bytes):** A RectL object that specifies the rectangular inclusive-inclusive dimensions, in .01 millimeter units, of a rectangle that surrounds the image stored in the metafile. + +**RecordSignature (4 bytes):** An unsigned integer that specifies the record signature. This MUST be **ENHMETA_SIGNATURE**, from the FormatSignature enumeration (section [2.1.14](#Section_b55cbd24612d47fe81c91da6a682246f)). + +**Version (4 bytes):** An unsigned integer that specifies the EMF version for interoperability. This MAY be 0x00010000. + +**Bytes (4 bytes):** An unsigned integer that specifies the size of the metafile in bytes. + +**Records (4 bytes):** An unsigned integer that specifies the number of records in the metafile. + +**Handles (2 bytes):** An unsigned integer that specifies the number of graphics objects that are used during the processing of the metafile. + +**Reserved (2 bytes):** An unsigned integer that MUST be 0x0000 and MUST be ignored. + +**nDescription (4 bytes):** An unsigned integer that specifies the number of characters in the array that contains the description of the metafile's contents. This is zero if there is no description string. + +**offDescription (4 bytes):** An unsigned integer that specifies the offset from the beginning of this record to the array that contains the description of the metafile's contents. + +**nPalEntries (4 bytes):** An unsigned integer that specifies the number of entries in the metafile [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). The palette is located in the [EMR_EOF](#Section_3f47fde00e6b40c187f3f4129af03aa1) record. + +**Device (8 bytes):** A SizeL object (\[MS-WMF\] section 2.2.2.22) that specifies the size of the reference device, in pixels. + +**Millimeters (8 bytes):** A SizeL object that specifies the size of the reference device, in millimeters. + +### HeaderExtension1 Object + +The HeaderExtension1 object defines the first extension to the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) header. It adds support for a [PixelFormatDescriptor](#Section_1db036d62da84b92b4f8e9cab8cc93b7) object (section 2.2.22) and [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) [\[OPENGL\]](https://go.microsoft.com/fwlink/?LinkId=90241) records (section [2.3.9](#Section_4a6c2fc239af43b48254449f5f1c5c05)). + +[TABLE] + +**cbPixelFormat (4 bytes):** An unsigned integer that specifies the size of the PixelFormatDescriptor object. This value is 0x00000000 if no pixel format is set. + +**offPixelFormat (4 bytes):** An unsigned integer that specifies the offset to the PixelFormatDescriptor object. This value is 0x00000000 if no pixel format is set. + +**bOpenGL (4 bytes):** An unsigned integer that indicates whether OpenGL commands are present in the metafile. + +| Value | Meaning | +|------------|-------------------------------------------------| +| 0x00000000 | OpenGL records are not present in the metafile. | +| 0x00000001 | OpenGL records are present in the metafile. | + +### HeaderExtension2 Object + +The HeaderExtension2 object defines the second extension to the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) header. It adds the ability to measure device surfaces in micrometers, which enhances the resolution and scalability of EMF metafiles. + +[TABLE] + +**MicrometersX (4 bytes):** The 32-bit horizontal size of the display device for which the metafile image was generated, in micrometers. + +**MicrometersY (4 bytes):** The 32-bit vertical size of the display device for which the metafile image was generated, in micrometers. + +### LogBrushEx Object + +The **LogBrushEx** object defines the style, color, and pattern of a device-independent brush. + +[TABLE] + +**BrushStyle (4 bytes):** An unsigned integer that specifies the brush style. The value MUST be an enumeration from BrushStyle enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.4). The style values that are supported in this structure are listed later in this section. The BS_NULL style SHOULD be used to specify a brush that has no effect. + +**Color (4 bytes):** A 32-bit ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies a color. The interpretation of this field depends on the value of **BrushStyle**, as explained in the following table. + +**BrushHatch (4 bytes):** A 32-bit unsigned field that contains the brush hatch data. Its interpretation depends on the value of **BrushStyle**, as explained in the following table. + +The following table shows the relationship between the **BrushStyle**, **Color**, and **BrushHatch** fields in a LogBrushEx object. Only supported brush styles are listed. + +| BrushStyle | Color | BrushHatch | +|----|----|----| +| **BS_SOLID** | A ColorRef object, which specifies the color of the brush. | Not used and SHOULD be ignored. | +| **BS_NULL** | Not used and SHOULD be ignored. | Not used and SHOULD be ignored. | +| **BS_HATCHED** | A ColorRef object, which specifies the foreground color of the hatch pattern. | A value from the HatchStyle enumeration (section [2.1.17](#Section_db3f9395eb7540a7ba9f0f836658712d)), which specifies the orientation of lines used to create the hatch. | + +### LogFont Object + +The LogFont object specifies the basic attributes of a logical font. + +[TABLE] + +**Height (4 bytes):** A signed integer that specifies the height of the font's character cell in logical units. The character height value, also known as the [**em size**](#gt_d27c8bde-0ac3-4410-bc49-5b988ab28dd6), is the character [**cell height**](#gt_b97118e3-2175-4af5-b1f9-462e57501090) value minus the [**internal leading**](#gt_9efb809f-982e-4f1e-9dc8-89a65f22c732) value. The [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) SHOULD interpret the value specified in the **Height** field in the following manner. + +| Value | Meaning | +|----|----| +| 0x00000000 \< *value* | The font mapper transforms this value into device units and matches it against the cell height of the available fonts. | +| 0x00000000 | The font mapper uses a default height value when it searches for a match. | +| *value* \< 0x00000000 | The font mapper transforms this value into device units and matches its absolute value against the character height of the available fonts. | + +For all height comparisons, the font mapper SHOULD look for the largest font that does not exceed the requested size. + +**Width (4 bytes):** A signed integer that specifies the average width of characters in the font in logical units. If the **Width** field value is zero, an appropriate value SHOULD[\<46\>](#Appendix_A_46) be calculated from other values in this object to find a font that has the typographer's intended [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5). + +**Escapement (4 bytes):** A signed integer that specifies the angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62) of a row of text. + +When the graphics mode is set to **GM_ADVANCED**, the escapement angle of the string can be specified independently of the orientation angle of the string's characters. Graphics modes are specified in section [2.1.16](#Section_fe60a5a523044b639949e11bfdbebae9) + +**Orientation (4 bytes):** A signed integer that specifies the angle, in tenths of degrees, between each character's baseline and the x-axis of the device. + +**Weight (4 bytes):** A signed integer that specifies the [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) of the font in the range zero through 1000. For example, 400 is normal and 700 is bold. If this value is zero, a default weight can be used.[\<47\>](#Appendix_A_47) + +**Italic (1 byte):** An unsigned integer that specifies an italic font if set to 0x01; otherwise, it MUST be set to 0x00. + +**Underline (1 byte):** An unsigned integer that specifies an underlined font if set to 0x01; otherwise, it MUST be set to 0x00. + +**StrikeOut (1 byte):** An unsigned integer that specifies a strikeout font if set to 0x01; otherwise, it MUST be set to 0x00. + +**CharSet (1 byte):** An unsigned integer that specifies the set of character glyphs. It MUST be a value in the CharacterSet enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.5). If the character set is unknown, [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) processing SHOULD NOT attempt to translate or interpret strings that are rendered with that font. + +If a [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) name is specified in the **Facename** field, the **CharSet** field value MUST match the character set of that typeface. + +**OutPrecision (1 byte):** An unsigned integer that specifies the output precision. The output precision defines how closely the font is required to match the requested height, width, character orientation, escapement, [**pitch**](#gt_0f2ba14a-c9b3-4cc8-8840-a24c0aed5eb9), and font type. It MUST be a value from the OutPrecision enumeration (\[MS-WMF\] section 2.1.1.21). + +Applications can use the output precision to control how the font mapper chooses a font when the operating system contains more than one font with a specified name. For example, if an operating system contains a font named **Symbol** in [**rasterized**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c) and [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) forms, an output precision value of **OUT_TT_PRECIS** forces the font mapper to choose the TrueType version. A value of **OUT_TT_ONLY_PRECIS** forces the font mapper to choose a TrueType font, even if it is necessary to substitute a TrueType font with another name. + +**ClipPrecision (1 byte):** An unsigned integer that specifies the clipping precision. The clipping precision defines how to clip characters that are partially outside the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). It can be one or more of the ClipPrecision Flags (\[MS-WMF\] section 2.1.2.1). + +**Quality (1 byte):** An unsigned integer that specifies the output quality. The output quality defines how closely to attempt to match the logical-font attributes to those of an actual physical font. It MUST be one of the values in the FontQuality enumeration (\[MS-WMF\] section 2.1.1.10). + +**PitchAndFamily (1 byte):** A PitchAndFamily object (\[MS-WMF\] section 2.2.2.14) that specifies the pitch and family of the font. Font families describe the look of a font in a general way. They are intended for specifying a font when the specified typeface is not available. + +**Facename (64 bytes):** A string of no more than 32 [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that specifies the typeface name of the font. If the length of this string is less than 32 characters, a terminating NULL MUST be present, after which the remainder of this field MUST be ignored. + +### LogFontEx Object + +The LogFontEx object specifies the extended attributes of a logical font. + +[TABLE] + +**LogFont (92 bytes):** A [LogFont (section 2.2.13)](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100) object that specifies the basic attributes of the logical font. + +**FullName (128 bytes):** A string of 64 [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that contains the font's full name. If the length of this string is less than 64 characters, a terminating NULL MUST be present, after which the remainder of this field MUST be ignored. + +**Style (64 bytes):** A string of 32 Unicode characters that defines the font's style. If the length of this string is less than 32 characters, a terminating NULL MUST be present, after which the remainder of this field MUST be ignored. + +**Script (64 bytes):** A string of 32 Unicode characters that defines the character set of the font. If the length of this string is less than 32 characters, a terminating NULL MUST be present, after which the remainder of this field MUST be ignored. + +### LogFontExDv Object + +The LogFontExDv object specifies the [**design vector**](#gt_68697457-d046-45a9-b822-86cb2b8c3320) for an extended logical font. + +[TABLE] + +**LogFontEx (348 bytes):** A [LogFontEx object (section 2.2.14)](#Section_71516231003445f2af78c463b98db4af) that specifies the extended attributes of the logical font. + +**DesignVector (variable):** A [DesignVector object (section 2.2.3)](#Section_cdf6681fbf454eec923e08c8be16aaf2). This field MUST NOT be longer than 72 bytes. + +A design vector SHOULD be specified only for a [**multiple master**](#gt_fef5ee7a-ad0c-4395-a1ac-f130405eec03) [**OpenType**](#gt_5e824598-05ae-44e2-99bd-78c347279ad9) font. + +### LogFontPanose Object + +The LogFontPanose object specifies the [**PANOSE**](#gt_8290d13f-8670-4b8e-ae6e-1ebb49319792) characteristics of a logical font. + +[TABLE] + +**LogFont (92 bytes):** A [LogFont (section 2.2.13)](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100) object that specifies the basic attributes of the logical font. + +**FullName (128 bytes):** A string of 64 [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that defines the font's full name. If the length of this string is less than 64 characters, a terminating NULL MUST be present, after which the remainder of this field MUST be ignored. + +**Style (64 bytes):** A string of 32 Unicode characters that defines the font's style. If the length of this string is less than 32 characters, a terminating NULL MUST be present, after which the remainder of this field MUST be ignored. + +**Version (4 bytes):** This field MUST be ignored. + +**StyleSize (4 bytes):** An unsigned integer that specifies the point size at which [**font hinting**](#gt_d77e65f2-e12f-4d0f-866b-7252e368b32f) is performed. If set to zero, font hinting is performed at the point size corresponding to the **Height** field in the LogFont object in the **LogFont** field. + +**Match (4 bytes):** This field MUST be ignored. + +**Reserved (4 bytes):** An unsigned integer that MUST be set to zero and MUST be ignored. + +**VendorId (4 bytes):** This field MUST be ignored. + +**Culture (4 bytes):** An unsigned integer that MUST be set to zero and MUST be ignored. + +**Panose (10 bytes):** A [Panose object (section 2.2.21)](#Section_4f1d246221334247ae1b2192cd91adb6) that specifies the PANOSE characteristics of the logical font. If all fields of this object are zero, it MUST be ignored. + +**Padding (2 bytes):** A field that exists only to ensure 32-bit alignment of this structure. It MUST be ignored. + +### LogPalette Object + +The **LogPalette** object specifies a [**logical_palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that contains device-independent color definitions. + +[TABLE] + +**Version (2 bytes):** An unsigned integer that specifies the version number of the system. This value is 0x0300. + +**NumberOfEntries (2 bytes):** An unsigned integer that specifies the number of entries in the **PaletteEntries** field. + +**PaletteEntries (variable):** An array of LogPaletteEntry objects (section [2.2.18](#Section_c1f7b285be164112a4e60b2fd4c1d148)) that defines the color and usage of each entry in the logical_palette. + +[**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) MUST define colors as device-independent values because the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) itself is device-independent. + +### LogPaletteEntry Object + +The **LogPaletteEntry** object defines the values that make up a single entry in a LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)). + +[TABLE] + +**Reserved (1 byte):** An unsigned integer that MUST NOT be used and MUST be ignored. + +**Blue (1 byte):** An unsigned integer that defines the blue [**intensity**](#gt_f44dd201-e056-4467-bf8a-2dc1f4586a44) value for the entry. + +**Green (1 byte):** An unsigned integer that defines the green intensity value for the entry. + +**Red (1 byte):** An unsigned integer that defines the red intensity value for the entry. + +[**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) MUST define colors as device-independent values because the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) itself is device-independent. + +### LogPen Object + +The **LogPen** object defines the style, width, and color of a logical pen. + +[TABLE] + +**PenStyle (4 bytes):** An unsigned integer that specifies a value from the PenStyle enumeration (section [2.1.25](#Section_b2e629158401429fbb6db2506a4c2fe8)). + +**Width (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15) that specifies the width of the pen by the value of its **x** field. The value of its **y** field MUST be ignored. + +If the pen type in the **PenStyle** field is PS_GEOMETRIC, this value is the width in logical units; otherwise, the width is specified in device units. If the pen type in the **PenStyle** field is PS_COSMETIC, this value MUST be 0x00000001. + +**ColorRef (4 bytes):** A **ColorRef** object (\[MS-WMF\] section 2.2.2.8) that specifies the pen color value. + +### LogPenEx Object + +The **LogPenEx** object specifies the style, width, and color of an extended logical pen. + +[TABLE] + +**PenStyle (4 bytes):** An unsigned integer that specifies the pen style. This value is defined from the PenStyle enumeration (section [2.1.25](#Section_b2e629158401429fbb6db2506a4c2fe8)). + +The pen style is a combination of pen type, line style, [**line cap**](#gt_b0341150-ca76-4424-88fe-607e03848dbf), and [**line join**](#gt_4fd3ebb8-54f8-47e8-aded-399a08ad873e). + +**Width (4 bytes):** An unsigned integer that specifies the width of the line drawn by the pen. + +If the pen type in the **PenStyle** field is PS_GEOMETRIC, this value is the width in logical units; otherwise, the width is specified in device units. If the pen type in the **PenStyle** field is PS_COSMETIC, this value MUST be 0x00000001. + +**BrushStyle (4 bytes):** An unsigned integer that specifies a brush style for the pen from the BrushStyle enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.4). + +If the pen type in the **PenStyle** field is PS_GEOMETRIC, this value is either BS_SOLID or BS_HATCHED. The value of this field can be BS_NULL, but only if the line style specified in **PenStyle** is PS_NULL. The BS_NULL style SHOULD be used to specify a brush that has no effect. + +**ColorRef (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8). The interpretation of this field depends on the **BrushStyle** value, as shown in the table later in this section. + +**BrushHatch (4 bytes):** The brush hatch pattern. The definition of this field depends on the **BrushStyle** value, as shown in the table later in this section. + +**NumStyleEntries (4 bytes):** The number of elements in the array specified in the **StyleEntry** field. This value SHOULD be zero if **PenStyle** does not specify PS_USERSTYLE. + +**StyleEntry (variable, optional):** An array of 32-bit unsigned integers that defines the lengths of dashes and gaps in the line drawn by this pen when the value of **PenStyle** is PS_USERSTYLE. The array contains the number of entries specified by **NumStyleEntries**, but it is used as if it repeated indefinitely. + +The first entry in the **StyleEntry** array specifies the length of the first dash. The second entry specifies the length of the first gap. Thereafter, lengths of dashes and gaps alternate. + +If the pen type in the **PenStyle** field is PS_GEOMETRIC, lengths are specified in logical units; otherwise, they are specified in device units. + +The LogPenEx object includes the specification of brush attributes, so it can be used to draw lines that consist of custom or predefined patterns. The following table shows the relationship between the **BrushStyle**, **ColorRef**, and **BrushHatch** fields in this object. Only supported brush styles are listed. + +| BrushStyle | ColorRef | BrushHatch | +|----|----|----| +| **BS_SOLID** | A ColorRef object that specifies the color of lines drawn by the pen. | Not used and is ignored. | +| **BS_NULL** | Not used and is ignored. | Not used and is ignored. | +| **BS_HATCHED** | A ColorRef object that specifies the foreground color of the hatch pattern. | A value from the HatchStyle enumeration (section [2.1.17](#Section_db3f9395eb7540a7ba9f0f836658712d)) that specifies the orientation of lines used to create the hatch. If **PS_GEOMETRIC** is not set in the **PenStyle** field, this field MUST be either **HS_SOLIDTEXTCLR (0x0008)** or **HS_SOLIDBKCLR (0x000A)**. | +| **BS_PATTERN** | The low-order 16-bits is a value from the ColorUsage enumeration (\[MS-WMF\] section 2.1.1.6). | Not used and is ignored. | +| **BS_DIBPATTERN** | The low-order 16 bits is a value from the ColorUsage enumeration. | Not used and is ignored. | +| **BS_DIBPATTERNPT** | The low-order word is be a value from the ColorUsage enumeration. | Not used and is ignored. | + +### Panose Object + +The Panose object describes the PANOSE font-classification values for a TrueType font. These characteristics are used to associate the font with other fonts of similar appearance but different names. + +[TABLE] + +**FamilyType (1 byte):** An unsigned integer that specifies the family type. This value is in the [FamilyType (section 2.1.12)](#Section_cfb9abd0a0a446dfb782eb856e19a5d3) enumeration table. + +**SerifStyle (1 byte):** An unsigned integer that specifies the serif style. This value is in the [SerifType (section 2.1.30)](#Section_750aae5cb2574e15acfac1be27b8c408) enumeration table. + +**Weight (1 byte):** An unsigned integer that specifies the [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) of the font. This value is in the [Weight (section 2.1.34)](#Section_46caba8a83e5450d8c4dd3999be38b93) enumeration table. + +**Proportion (1 byte):** An unsigned integer that specifies the proportion of the font. This value is in the [Proportion (section 2.1.28)](#Section_d59152c4deb049d88eeb0407167698fe) enumeration table. + +**Contrast (1 byte):** An unsigned integer that specifies the contrast of the font. This value is in the [Contrast (section 2.1.8)](#Section_652d38bb5626462caf8ba5dcb828d814) enumeration table. + +**StrokeVariation (1 byte):** An unsigned integer that specifies the stroke variation for the font. This value is in the [StrokeVariation (section 2.1.33)](#Section_08b1f3afc0c14ebf823a757ade94df22) enumeration table. + +**ArmStyle (1 byte):** An unsigned integer that specifies the arm style of the font. This value is in the [ArmStyle (section 2.1.3)](#Section_3ae0077a0c9d4e26bc2d773858bb0ac3) enumeration table. + +**Letterform (1 byte):** An unsigned integer that specifies the letterform of the font. This value is in the [Letterform (section 2.1.20)](#Section_ee9127c4596f4744a59f44d9c3c5760f) enumeration table. + +**Midline (1 byte):** An unsigned integer that specifies the midline of the font. This value is in the [MidLine (section 2.1.23)](#Section_27eb84dc85b14a9dbf9a15808b2c61d8) enumeration table. + +**XHeight (1 byte):** An unsigned integer that specifies the x height of the font. This value is in the [XHeight (section 2.1.35)](#Section_47e9daaf0fff4ea09b4fc30329c79b64) enumeration table. + +### PixelFormatDescriptor Object + +The **PixelFormatDescriptor** object specifies the pixel format of a drawing surface. + +[TABLE] + +**nSize (2 bytes):** An unsigned integer that specifies the size in bytes, of this data structure. + +**nVersion (2 bytes):** An unsigned integer that MUST be set to 0x0001. + +**dwFlags (4 bytes):** A set of bit flags that specify properties of the pixel buffer that is used for output to the drawing surface. These properties are not all mutually exclusive; combinations of flags are allowed, except where noted otherwise. + +[TABLE] + +The following bit flag constants are defined. + +[TABLE] + +**iPixelType (1 byte):** The type of pixel data. + +[TABLE] + +**cColorBits (1 byte):** The number of bits per pixel for RGBA pixel types, excluding the [**alpha**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) bitplanes. For color table pixels, it is the size of each color table index. + +**cRedBits (1 byte):** Specifies the number of red bitplanes in each RGBA color buffer. + +**cRedShift (1 byte):** Specifies the shift count in bits for red bitplanes in each RGBA color buffer. + +**cGreenBits (1 byte):** Specifies the number of green bitplanes in each RGBA color buffer. + +**cGreenShift (1 byte):** Specifies the shift count for green bitplanes in each RGBA color buffer. + +**cBlueBits (1 byte):** Specifies the number of blue bitplanes in each RGBA color buffer. + +**cBlueShift (1 byte):** Specifies the shift count for blue bitplanes in each RGBA color buffer. + +**cAlphaBits (1 byte):** Specifies the number of alpha bitplanes in each RGBA color buffer.[\<52\>](#Appendix_A_52) + +**cAlphaShift (1 byte):** Specifies the shift count for alpha bitplanes in each RGBA color buffer.[\<53\>](#Appendix_A_53) + +**cAccumBits (1 byte):** Specifies the total number of bitplanes in the accumulation buffer. + +**cAccumRedBits (1 byte):** Specifies the number of red bitplanes in the accumulation buffer. + +**cAccumGreenBits (1 byte):** Specifies the number of green bitplanes in the accumulation buffer. + +**cAccumBlueBits (1 byte):** Specifies the number of blue bitplanes in the accumulation buffer. + +**cAccumAlphaBits (1 byte):** Specifies the number of alpha bitplanes in the accumulation buffer.[\<54\>](#Appendix_A_54) + +**cDepthBits (1 byte):** Specifies the depth of the depth (z-axis) buffer. + +**cStencilBits (1 byte):** Specifies the depth of the stencil buffer. + +**cAuxBuffers (1 byte):** Specifies the number of auxiliary buffers. Auxiliary buffers are not supported. + +**iLayerType (1 byte):** This field MAY be ignored. + +**bReserved (1 byte):** Specifies the number of overlay and underlay planes. Bits 0 through 3 specify up to 15 overlay planes and bits 4 through 7 specify up to 15 underlay planes. + +**dwLayerMask (4 bytes):** This field MAY be ignored. + +**dwVisibleMask (4 bytes):** Specifies the transparent color or index of an underlay plane. When the pixel type is RGBA, **dwVisibleMask** is a transparent [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color value. When the pixel type is color index, it is a transparent index value. + +**dwDamageMask (4 bytes):** This field SHOULD be ignored. + +The PixelFormatDescriptor object is used in EMR_HEADER records (section [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab)) to specify the pixel format of the output surface. + +### Point28_4 Object + +The Point28_4 object represents the location of a point on a device surface with coordinates in [**28.4 bit FIX notation**](#gt_1bcc53a6-1861-49e9-bd00-3a38a888d9f4). + +[TABLE] + +**x (4 bytes):** A [BitFIX28_4 object (section 2.2.1)](#Section_075e694f901848ada22c81dd07c67c69) that represents the horizontal coordinate of the point. + +**y (4 bytes):** A BitFIX28_4 object that represents the vertical coordinate of the point. + +### RegionData Object + +The **RegionData** object specifies data that defines a region, which is made of non-overlapping rectangles. + +[TABLE] + +**RegionDataHeader (32 bytes):** A 256-bit RegionDataHeader object (section [2.2.25](#Section_5ca68a15181145b6a51b5e40d1055ccc)) that defines the contents of the **Data** field. + +**Data (variable):** An array of RectL objects ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19); the objects are merged to create the [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). + +### RegionDataHeader Object + +The **RegionDataHeader** object defines the properties of a RegionData (section [2.2.24](#Section_e66601f29b5c46198476ddb7b087551b)) object. + +[TABLE] + +**Size (4 bytes):** An unsigned integer that specifies the size of this object in bytes. This value is 0x00000020. + +**Type (4 bytes):** An unsigned integer that specifies the [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) type. This value is 0x00000001. + +**CountRects (4 bytes):** An unsigned integer that specifies the number of rectangles in this region. + +**RgnSize (4 bytes):** An unsigned integer that specifies the size of the buffer of rectangles in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the bounds of the region. + +### TriVertex Object + +The TriVertex object specifies color and position information for the definition of a rectangle or triangle vertex. + +[TABLE] + +**x (4 bytes):** A signed integer that specifies the horizontal position, in logical units. + +**y (4 bytes):** A signed integer that specifies the vertical position, in logical units. + +**Red (2 bytes):** An unsigned integer that specifies the red color value for the point. + +**Green (2 bytes):** An unsigned integer that specifies the green color value for the point. + +**Blue (2 bytes):** An unsigned integer that specifies the blue color value for the point. + +**Alpha (2 bytes):** An unsigned integer that specifies the [**alpha transparency**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) value for the point. + +### UniversalFontId Object + +The **UniversalFontId** object defines a mechanism for identifying fonts in [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +[TABLE] + +**Checksum (4 bytes):** An unsigned integer that is the checksum of the font. The checksum value has the following meanings. + +[TABLE] + +If a checksum value is computed, it SHOULD be computed using the following algorithm. + +For the purpose of this computation, the font is considered simply to be a stream of bytes that is external to this [EMF record](#Section_e0137630f3ad492cbde9e68866e255ba). Any larger file structure in which the font might reside is system-dependent or implementation-dependent. + +463. ULONG ComputeFileviewCheckSum(PVOID pvView, ULONG cjView) + + { + + ULONG sum; + + PULONG pulCur,pulEnd; + + pulCur = (PULONG) pvView; + + for (sum = 0, pulEnd = pulCur + cjView / sizeof(ULONG); + + pulCur \< pulEnd; pulCur += 1) + + { + + sum += 256 \* sum + \*pulCur; + + } + + return ( sum \< 2 ) ? 2 : sum; + + } + +**pvView**: A pointer to the start of the font. + +**cjView**: The length of the font in bytes. + +**Index (4 bytes):** An unsigned integer that is an index associated with the font object. The meaning of this field is determined by the type of font. + +### XForm Object + +The **XForm** object defines a two-dimensional, linear [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) matrix. + +[TABLE] + +**M11 (4 bytes):** A FLOAT matrix value. + +**M12 (4 bytes):** A FLOAT matrix value. + +**M21 (4 bytes):** A FLOAT matrix value. + +**M22 (4 bytes):** A FLOAT matrix value. + +**Dx (4 bytes):** A FLOAT value that contains a horizontal [**translation**](#gt_4d42abda-3b31-4828-bc4c-684f2de4e2af) component, in logical units. + +**Dy (4 bytes):** A FLOAT value that contains a vertical translation component, in logical units. + +The following equations specify how the matrix values are used to transform a point (X,Y) to a new point (X',Y'): + +477. X' = M11 \* X + M21 \* Y + Dx + + Y' = M12 \* X + M22 \* Y + Dy + +For more information concerning transforms and [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). + +## EMF Records + +This section specifies the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) records, which have been grouped into the following categories. + +| Name | Section | Description | +|----|----|----| +| Bitmap record types | [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a) | Manage and output [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) images. | +| Clipping record types | [2.3.2](#Section_0ca0d18e324e452f9a4126e1a82e3e03) | Specify and manage clipping regions. | +| Comment record types | [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9) | Define formats for specifying arbitrary private data, embedding records in other metafile formats, and adding new or special-purpose commands. | +| Control record types | [2.3.4](#Section_2caf0f4781a44079931dfca6fa499869) | Define the start and end of an EMF metafile and its properties. | +| Drawing record types | [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) | Perform graphics drawing. | +| Escape record types | [2.3.6](#Section_5370873a5fe64fdd8c5abade4ee54a1f) | Execute [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) functions. | +| Object creation record types | [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18) | Create graphics objects. | +| Object manipulation record types | [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) | Manage and modify graphics objects. | +| OpenGL record types | [2.3.9](#Section_4a6c2fc239af43b48254449f5f1c5c05) | Specify metafile records generated by [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) [\[OPENGL\]](https://go.microsoft.com/fwlink/?LinkId=90241). | +| Path bracket record types | [2.3.10](#Section_b930b98930ec4954a8891dc60ce0b689) | Specify and manipulate paths in [**path brackets**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601). | +| State record types | [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) | Specify and manage graphics properties. | +| Transform record types | [2.3.12](#Section_a0442ad12d6e43e7ac8ce252e492f97e) | Specify and modify [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transforms**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). | + +All EMF records MUST be multiples of 4 bytes in length; hence, each record starts on a 32-bit offset from the start of the metafile. To ensure each subsequent record also starts on a 32-bit boundary, an **AlignmentPadding** field is used, if necessary. The contents of **AlignmentPadding** fields are indeterminate and MUST be ignored. In general, such fields are shown only in the generic definitions of record categories. + +To ensure maximum compatibility, implementations need to allow for record truncation for unused fields at the end of an EMF record. If there are extra data at the end of the record undocumented by this specification, these data MUST be ignored. + +### Bitmap Record Types + +The **Bitmap** record types perform block transfers of [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) images. + +The following are the bitmap record types. + +| Name | Section | Description | +|----|----|----| +| EMR_ALPHABLEND | [2.3.1.1](#Section_34e07d4faee64b63a4bb96996ad47669) | Specifies a block transfer of pixels from a source bitmap to a destination rectangle, including [**alpha transparency**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) data, according to a specified blending operation. | +| EMR_BITBLT | [2.3.1.2](#Section_347d1c44184747ec87627059e9e9b185) | Specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern, according to a specified [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc). | +| EMR_MASKBLT | [2.3.1.3](#Section_e6f715c0d0344eb3952ef8ee66adb9ed) | Specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern and with the application of a color mask bitmap, according to specified foreground and background raster operations. | +| EMR_PLGBLT | [2.3.1.4](#Section_b6c8b39d42c74221ab7093f1e09b644e) | Specifies a block transfer of pixels from a source bitmap to a destination parallelogram, with the application of a color mask bitmap. | +| EMR_SETDIBITSTODEVICE | [2.3.1.5](#Section_e8816cc635d243e68d88d69cd342372e) | Specifies a block transfer of pixels from specified scanlines of a source bitmap to a destination rectangle. | +| EMR_STRETCHBLT | [2.3.1.6](#Section_0dd551f380f7485289c29ddba803a192) | Specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern, according to a specified raster operation, stretching or compressing the output to fit the dimensions of the destination, if necessary. | +| EMR_STRETCHDIBITS | [2.3.1.7](#Section_89c0d8080dea413fbe402e9e51fa36ac) | Specifies a block transfer of pixels from a source bitmap to a destination rectangle, optionally in combination with a brush pattern, according to a specified raster operation, stretching or compressing the output to fit the dimensions of the destination, if necessary. | +| EMR_TRANSPARENTBLT | [2.3.1.8](#Section_aa2160512dc04317b343525431cfa103) | Specifies a block transfer of pixels from a source bitmap to a destination rectangle, treating a specified color as transparent, stretching or compressing the output to fit the dimensions of the destination, if necessary. | + +The generic structure of bitmap records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The bitmap record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|-----------------------|------------| +| EMR_BITBLT | 0x0000004C | +| EMR_STRETCHBLT | 0x0000004D | +| EMR_MASKBLT | 0x0000004E | +| EMR_PLGBLT | 0x0000004F | +| EMR_SETDIBITSTODEVICE | 0x00000050 | +| EMR_STRETCHDIBITS | 0x00000051 | +| EMR_ALPHABLEND | 0x00000072 | +| EMR_TRANSPARENTBLT | 0x00000074 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**BitmapRecordBuffer (variable):** An array of bytes that contains the remainder of the bitmap record. + +[TABLE] + +> **BitmapRecordParm (variable):** An array of bytes that contains the parameters for the bitmap record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +The following notes apply generally to [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) bitmap block transfers, unless specified otherwise: + +- Source and mask bitmaps are in [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) format. DIBs are specified by DeviceIndependentBitmap objects ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9). + +- The clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) used by bitmap records are maintained in a **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +- If the color format of the source or pattern bitmap does not match the color format of the destination, the source pr pattern bits MUST be converted to the destination format prior to performing the block transfer. + +- If the source and destination rectangles are not the same size, the source bitmap MUST be expanded or compressed to match the destination rectangle. This stretching function is performed according to a property from the StretchMode enumeration (section [2.1.32](#Section_e72f20aa2e2d453f9e95eaef50b76e19)). + +- If an XForm object (section [2.2.28](#Section_e84107e9bc2b4a1492345d173adc1b59)) is specified, a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) SHOULD be applied to the source bitmap. [**Scaling**](#gt_f3f5f638-16f6-4159-a3f1-9d845b1196f5), [**translation**](#gt_4d42abda-3b31-4828-bc4c-684f2de4e2af), and [**reflection transforms**](#gt_bbc1ce5c-0fd6-4fde-abb3-40525a95147d) SHOULD be supported, and [**rotation**](#gt_5cdd5e5b-fe3d-46e6-9019-50483463a76a) and [**shear transforms**](#gt_de5c1f5c-2ce7-4e79-9be9-a01b09175f5b) MAY be supported. + +For more information concerning transforms and [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_ALPHABLEND Record + +The **EMR_ALPHABLEND** record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle, including [**alpha transparency**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) data, according to a specified blending operation.[\<56\>](#Appendix_A_56) + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_ALPHABLEND**. This value is 0x00000072. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes):** A signed integer that specifies the logical width of the destination rectangle. This value MUST be greater than zero. + +**cyDest (4 bytes):** A signed integer that specifies the logical height of the destination rectangle. This value MUST be greater than zero. + +**BLENDFUNCTION (4 bytes):** A structure that specifies the blending operations for source and destination bitmaps. + +[TABLE] + +> **BlendOperation (1 byte):** The blend operation code. The only source and destination blend operation that has been defined is 0x00, which specifies that the source bitmap MUST be combined with the destination bitmap based on the alpha transparency values of the source pixels. See the following equations for details. +> +> **BlendFlags (1 byte):** This value is 0x00 and MUST be ignored. +> +> **SrcConstantAlpha (1 byte):** An unsigned integer that specifies alpha transparency, which determines the blend of the source and destination bitmaps. This value MUST be used on the entire source bitmap. The minimum alpha transparency value, zero, corresponds to completely transparent; the maximum value, 0xFF, corresponds to completely opaque. In effect, a value of 0xFF specifies that the per-pixel alpha values determine the blend of the source and destination bitmaps. See the equations later in this section for details. +> +> **AlphaFormat (1 byte):** A structure that specifies how source and destination pixels are interpreted with respect to alpha transparency. + +[TABLE] + +**xSrc (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**XformSrc (24 bytes):** An [XForm](#Section_e84107e9bc2b4a1492345d173adc1b59) object (section 2.2.28) that specifies a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to apply to the source bitmap. + +**BkColorSrc (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the background color of the source bitmap. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes from the start of this record to the source bitmap header in the **BitmapBuffer** field. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes from the start of this record to the source bitmap bits in the **BitmapBuffer** field. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes of the source bitmap bits. + +**cxSrc (4 bytes):** A signed integer that specifies the logical width of the source rectangle. This value MUST be greater than zero. + +**cySrc (4 bytes):** A signed integer that specifies the logical height of the source rectangle. This value MUST be greater than zero. + +**BitmapBuffer (variable):** A buffer containing the source bitmap, which is not required to be contiguous with the fixed portion of the **EMR_ALPHABLEND** record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. + +The following equations show how destination pixels are computed from source pixels using **BLENDFUNCTION**. In the equations, "dst" refers to the destination bitmap, and "src" refers to the source bitmap. The color and transparency values of the source and destination pixels are denoted by "Red", "Green", "Blue", and "Alpha". + +**Case I**: The **AlphaFormat** value is 0, which means the **SrcConstantAlpha** value MUST be used to blend the source and destination bitmaps, as follows. + +479. dst.Red = src.Red \* (SrcConstantAlpha/255.0) + + + dst.Red \* (1.0 - (SrcConstantAlpha/255.0)) + + dst.Green = src.Green \* (SrcConstantAlpha/255.0) + + + dst.Green \* (1.0 - (SrcConstantAlpha/255.0)) + + dst.Blue = src.Blue \* (SrcConstantAlpha/255.0) + + + dst.Blue \* (1.0 - (SrcConstantAlpha/255.0)) + +If the destination bitmap has an alpha channel, then it is blended as follows. + +488. dst.Alpha = src.Alpha \* (SrcConstantAlpha/255.0) + + + dst.Alpha \* (1.0 - (SrcConstantAlpha/255.0)) + +Note that if **SrcConstantAlpha** is 0xFF, these equations reduce to a simple source copy to the destination. + +**Case II**: The **AlphaFormat** value is **AC_SRC_ALPHA**, which means the source pixels MUST be premultiplied by **SrcConstantAlpha**, and then the blend MUST be based on the per-pixel source alpha channel, as follows. + +491. src.Red = src.Red \* (SrcConstantAlpha/255.0) + + src.Green = src.Green \* (SrcConstantAlpha/255.0) + + src.Blue = src.Blue \* (SrcConstantAlpha/255.0) + + dst.Red = src.Red + (1.0 - (src.Alpha/255.0)) \* dst.Red + + dst.Green = src.Green + (1.0 - (src.Alpha/255.0)) \* dst.Green + + dst.Blue = src.Blue + (1.0 - (src.Alpha/255.0)) \* dst.Blue + +If the destination bitmap has an alpha channel, it is blended as follows. + +504. src.Alpha = src.Alpha \* (SrcConstantAlpha)/255.0) + + dst.Alpha = src.Alpha + (1.0 - (src.Alpha/255.0)) \* dst.Alpha + +If **SrcConstantAlpha** is 0xFF, there is in effect no premultiplication of the source values. + +See section 2.3.1 for more bitmap record types. + +#### EMR_BITBLT Record + +The EMR_BITBLT record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle, optionally in combination with a brush pattern, according to a specified [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc). + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_BITBLT. This value is 0x0000004C. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes):** A signed integer that specifies the logical width of the source and destination rectangles. + +**cyDest (4 bytes):** A signed integer that specifies the logical height of the source and destination rectangles. + +**BitBltRasterOperation (4 bytes):** An unsigned integer that specifies the raster operation code. This code defines how the color data of the source rectangle is to be combined with the color data of the destination rectangle and optionally a brush pattern, to achieve the final color. + +This value is in the Ternary Raster Operation enumeration (\[MS-WMF\] section 2.1.1.31). + +**xSrc (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**XformSrc (24 bytes):** An [XForm](#Section_e84107e9bc2b4a1492345d173adc1b59) object (section 2.2.28) that specifies a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to apply to the source bitmap. + +**BkColorSrc (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the background color of the source bitmap. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap header in the **BitmapBuffer** field. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits in the **BitmapBuffer** field. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap bits. + +**BitmapBuffer (variable):** A buffer containing the source bitmap, which is not required to be contiguous with the fixed portion of the EMR_BITBLT record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +If the raster operation specified by **BitBltRasterOperation** does not require a source bitmap, the source bitmap can be omitted. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. + +See section 2.3.1 for more bitmap record types. + +#### EMR_MASKBLT Record + +The EMR_MASKBLT record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle, optionally in combination with a brush pattern and with the application of a color mask bitmap, according to specified foreground and background [**raster operations**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc). + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_MASKBLT**. This value is 0x0000004E. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes):** A signed integer that specifies the logical width of the destination rectangle. + +**cyDest (4 bytes):** A signed integer that specifies the logical height of the destination rectangle. + +**ROP4 (4 bytes):** A quaternary raster operation, which specifies ternary raster operations for the foreground and background colors of a bitmap. These values define how the color data of the source rectangle is to be combined with the color data of the destination rectangle. + +[TABLE] + +> **Reserved (2 bytes):** This field SHOULD be 0x0000 and MUST be ignored.[\<57\>](#Appendix_A_57) +> +> **BackgroundROP3 (1 byte):** The unsigned, most-significant 8 bits of a 24-bit ternary raster operation value from the Ternary Raster Operation enumeration (\[MS-WMF\] section 2.1.1.31). This code defines how to combine the background color data of the source and destination bitmaps and brush pattern. +> +> **ForegroundROP3 (1 byte):** The unsigned, most-significant 8 bits of a 24-bit ternary raster operation value from the Ternary Raster Operation enumeration. This code defines how to combine the foreground color data of the source and destination bitmaps and brush pattern. + +**xSrc (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**XformSrc (24 bytes):** An [XForm](#Section_e84107e9bc2b4a1492345d173adc1b59) object (section 2.2.28) that specifies a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to apply to the source bitmap. + +**BkColorSrc (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the background color of the source bitmap. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap header in the **BitmapBuffer** field. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits in the **BitmapBuffer** field. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap bits. + +**xMask (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the mask bitmap. + +**yMask (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the mask bitmap. + +**UsageMask (4 bytes):** An unsigned integer that specifies how to interpret values in the color table in the mask bitmap header. This value is in the DIBColors enumeration. + +**offBmiMask (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the mask bitmap header in the **BitmapBuffer** field. + +**cbBmiMask (4 bytes):** An unsigned integer that specifies the size in bytes, of the mask bitmap header. + +**offBitsMask (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the mask bitmap bits in the **BitmapBuffer** field. + +**cbBitsMask (4 bytes):** An unsigned integer that specifies the size in bytes, of the mask bitmap bits. + +**BitmapBuffer (variable):** A buffer containing the source and mask bitmaps, which are not required to be contiguous with the fixed portion of the EMR_MASKBLT record or with each other. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +**Note:** The source and mask bitmaps can be present in this buffer in any order. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. +> +> **BmiMask (variable):** The mask bitmap header. +> +> **BitsMask (variable):** The mask bitmap bits. + +The mask bitmap MUST be monochrome; that is, each pixel value MUST be zero or one. A pixel value of one in the mask indicates that the color of the corresponding pixel in the source bitmap SHOULD be copied to the destination. A value of zero in the mask indicates that the destination pixel color SHOULD NOT be changed. If the mask rectangle is smaller than the source and destination rectangles, the mask pattern MUST be replicated as necessary. + +See section 2.3.1 for more bitmap record types. + +#### EMR_PLGBLT Record + +The EMR_PLGBLT record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination parallelogram, with the application of a color mask bitmap. + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_PLGBLT**. This value is 0x0000004F. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**aptlDest (24 bytes):** An array of three PointL objects (\[MS-WMF\] section 2.2.2.15) that specifies three corners a parallelogram destination area for the block transfer. + +The upper-left corner of the source rectangle is mapped to the first point in this array, the upper-right corner to the second point, and the lower-left corner to the third point. The lower-right corner of the source rectangle is mapped to the implicit fourth point in the parallelogram, which is computed from the first three points (A, B, and C) by treating them as vectors. + +508. D = B + C A + +**xSrc (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**cxSrc (4 bytes):** A signed integer that specifies the logical width of the source rectangle. + +**cySrc (4 bytes):** A signed integer that specifies the logical height of the source rectangle. + +**XformSrc (24 bytes):** An [XForm](#Section_e84107e9bc2b4a1492345d173adc1b59) object (section 2.2.28) that specifies a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to apply to the source bitmap. + +**BkColorSrc (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the background color of the source bitmap. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap header in the **BitmapBuffer** field. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits in the **BitmapBuffer** field. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap. + +**xMask (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the mask bitmap. + +**yMask (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the mask bitmap. + +**UsageMask (4 bytes):** An unsigned integer that specifies how to interpret values in the color table in the mask bitmap header. This value is in the DIBColors enumeration. + +**offBmiMask (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the header of the mask bitmap in the **BitmapBuffer** field. + +**cbBmiMask (4 bytes):** An unsigned integer that specifies the size in bytes, of the mask bitmap header. + +**offBitsMask (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the mask bitmap bits in the **BitmapBuffer** field. + +**cbBitsMask (4 bytes):** An unsigned integer that specifies the size in bytes, of the mask bitmap bits. + +**BitmapBuffer (variable):** A buffer containing the source and mask bitmaps, which are not required to be contiguous with the fixed portion of the EMR_PLGBLT record or with each other. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +**Note:** The source and mask bitmaps can be present in this buffer in any order. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. +> +> **BmiMask (variable):** The mask bitmap header. +> +> **BitsMask (variable):** The mask bitmap bits. + +The mask bitmap MUST be monochrome; that is, each pixel value MUST be zero or one. A pixel value of one in the mask indicates that the color of the corresponding pixel in the source bitmap SHOULD be copied to the destination. A value of zero in the mask indicates that the destination pixel color SHOULD NOT be changed. If the mask rectangle is smaller than the source and destination rectangles, the mask pattern MUST be replicated as necessary. + +See section 2.3.1 for more bitmap record types. + +#### EMR_SETDIBITSTODEVICE Record + +The EMR_SETDIBITSTODEVICE record specifies a block transfer of pixels from specified scanlines of a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle. + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETDIBITSTODEVICE**. This value is 0x00000050. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**xSrc (4 bytes):** A signed integer that specifies the x-coordinate in pixels of the lower-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the y-coordinate in pixels of the lower-left corner of the source rectangle. + +**cxSrc (4 bytes):** A signed integer that specifies the width in pixels of the source rectangle. + +**cySrc (4 bytes):** A signed integer that specifies the height in pixels of the source rectangle. + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap header in the **BitmapBuffer** field. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits in the **BitmapBuffer** field. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap bits. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**iStartScan (4 bytes):** An unsigned integer that specifies the first scan line in the array. + +**cScans (4 bytes):** An unsigned integer that specifies the number of scan lines. + +**BitmapBuffer (variable):** A buffer containing the source bitmap, which is not required to be contiguous with the fixed portion of the EMR_SETDIBITSTODEVICE record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. + +This record supports source images in [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) and [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) format. The **Compression** field in the source bitmap header specifies the image format. + +See section 2.3.1 for more bitmap record types. + +#### EMR_STRETCHBLT Record + +The EMR_STRETCHBLT record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle, optionally in combination with a brush pattern, according to a specified [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc), stretching or compressing the output to fit the dimensions of the destination, if necessary. + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_STRETCHBLT**. This value is 0x0000004D. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes):** A signed integer that specifies the logical width of the destination rectangle. + +**cyDest (4 bytes):** A signed integer that specifies the logical height of the destination rectangle. + +**BitBltRasterOperation (4 bytes):** An unsigned integer that specifies the raster operation code. This code defines how the color data of the source rectangle is to be combined with the color data of the destination rectangle and optionally a brush pattern, to achieve the final color. + +This value is in the Ternary Raster Operation enumeration (\[MS-WMF\] section 2.1.1.31). + +**xSrc (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**XformSrc (24 bytes):** An [XForm](#Section_e84107e9bc2b4a1492345d173adc1b59) object (section 2.2.28) that specifies a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to apply to the source bitmap. + +**BkColorSrc (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the background color of the source bitmap. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap header. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap bits. + +**cxSrc (4 bytes):** A signed integer that specifies the logical width of the source rectangle. + +**cySrc (4 bytes):** A signed integer that specifies the logical height of the source rectangle. + +**BitmapBuffer (variable):** A buffer containing the source bitmap, which is not required to be contiguous with the fixed portion of the EMR_STRETCHBLT record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +If the raster operation specified by **BitBltRasterOperation** does not require a source bitmap, the source bitmap can be omitted. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. + +See section 2.3.1 for more bitmap record types. + +#### EMR_STRETCHDIBITS Record + +The EMR_STRETCHDIBITS record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle, optionally in combination with a brush pattern, according to a specified [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc), stretching or compressing the output to fit the dimensions of the destination, if necessary. + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_STRETCHDIBITS**. This value is 0x00000051. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**xSrc (4 bytes):** A signed integer that specifies the x-coordinate in pixels of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the y-coordinate in pixels of the upper-left corner of the source rectangle. + +**cxSrc (4 bytes):** A signed integer that specifies the width in pixels of the source rectangle. + +**cySrc (4 bytes):** A signed integer that specifies the height in pixels of the source rectangle. + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes from the start of this record to the source bitmap header. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap bits. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**BitBltRasterOperation (4 bytes):** An unsigned integer that specifies a raster operation code. These codes define how the color data of the source rectangle is to be combined with the color data of the destination rectangle and optionally a brush pattern, to achieve the final color. + +This value is in the Ternary Raster Operation enumeration (\[MS-WMF\] section 2.1.1.31). + +**cxDest (4 bytes):** A signed integer that specifies the logical width of the destination rectangle. + +**cyDest (4 bytes):** A signed integer that specifies the logical height of the destination rectangle. + +**BitmapBuffer (variable):** A buffer containing the source bitmap, which is not required to be contiguous with the fixed portion of the EMR_STRETCHDIBITS record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +If the raster operation specified by **BitBltRasterOperation** does not require a source bitmap, the source bitmap can be omitted. + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. + +This record supports source images in [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) and [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) formats. The **Compression** field in the source bitmap header specifies the image format. + +If the signs of the source and destination height and width fields differ, this record specifies a mirror-image copy of the source bitmap to the destination. That is, if **cxSrc** and **cxDest** have different signs, a mirror image of the source bitmap along the x-axis is specified. If **cySrc** and **cyDest** have different signs, a mirror image of the source bitmap along the y-axis is specified. + +See section 2.3.1 for more bitmap record types. + +#### EMR_TRANSPARENTBLT Record + +The EMR_TRANSPARENTBLT record specifies a block transfer of pixels from a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) to a destination rectangle, treating a specified color as transparent, stretching or compressing the output to fit the dimensions of the destination, if necessary.[\<58\>](#Appendix_A_58) + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_TRANSPARENTBLT**. This value is 0x00000074. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)) is empty, this record has no effect. + +**xDest (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes):** A signed integer that specifies the logical width of the destination rectangle. + +**cyDest (4 bytes):** A signed integer that specifies the logical height of the destination rectangle. + +**TransparentColor (4 bytes):** A ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the color in the source bitmap to be treated as transparent. + +**xSrc (4 bytes):** A signed integer that specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes):** A signed integer that specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**XformSrc (24 bytes):** An [XForm](#Section_e84107e9bc2b4a1492345d173adc1b59) object (section 2.2.28) that specifies a [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to apply to the source bitmap. + +**BkColorSrc (4 bytes):** A ColorRef object that specifies the background color of the source bitmap. + +**UsageSrc (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the source bitmap header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap header. + +**cbBmiSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap header. + +**offBitsSrc (4 bytes):** An unsigned integer that specifies the offset in bytes, from the start of this record to the source bitmap bits. + +**cbBitsSrc (4 bytes):** An unsigned integer that specifies the size in bytes, of the source bitmap bits. + +**cxSrc (4 bytes):** A signed integer that specifies the logical width of the source rectangle. + +**cySrc (4 bytes):** A signed integer that specifies the logical height of the source rectangle. + +**BitmapBuffer (variable):** A buffer containing the source bitmap, which is not required to be contiguous with the fixed portion of the EMR_TRANSPARENTBLT record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +If the source bitmap color format is 32 bits-per-pixel, only the [**alpha transparency**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) value in each pixel SHOULD be copied to the destination.[\<59\>](#Appendix_A_59) + +[TABLE] + +> **BmiSrc (variable):** The source bitmap header. +> +> **BitsSrc (variable):** The source bitmap bits. + +See section 2.3.1 for more bitmap record types. + +### Clipping Record Types + +The **Clipping** record types define and manage clipping regions. The clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) used by clipping record types are part of the **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +**Note:** The EMR_SETMETARGN record does not specify parameters. + +The following are the clipping record types. + +[TABLE] + +The generic structure of clipping records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The clipping record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|-----------------------|------------| +| EMR_OFFSETCLIPRGN | 0x0000001A | +| EMR_SETMETARGN | 0x0000001C | +| EMR_EXCLUDECLIPRECT | 0x0000001D | +| EMR_INTERSECTCLIPRECT | 0x0000001E | +| EMR_SELECTCLIPPATH | 0x00000043 | +| EMR_EXTSELECTCLIPRGN | 0x0000004B | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**ClippingRecordBuffer (variable, optional):** An array of bytes that contains the data for the clipping record. The size of this field is a multiple of 4 bytes. + +The EMR_SETMETARGN record does not contain this field. + +[TABLE] + +> **ClippingRecordParm (variable):** An array of bytes that contains the parameters for the clipping record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_EXCLUDECLIPRECT Record + +The **EMR_EXCLUDECLIPRECT** record excludes the specified rectangle from the current clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). + +Fields not specified in this section are specified in section [2.3.2](#Section_0ca0d18e324e452f9a4126e1a82e3e03). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_EXCLUDECLIPRECT. This value is 0x0000001D. + +**Clip (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies a rectangle in logical units. + +The result of the intersection is saved as the new current clipping region. The lower and right edges of the specified rectangle MUST NOT be excluded from clipping. + +See section 2.3.2 for more clipping record types. + +#### EMR_EXTSELECTCLIPRGN Record + +The EMR_EXTSELECTCLIPRGN record combines the specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) with the current clipping region using the specified mode. + +Fields not specified in this section are specified in section [2.3.2](#Section_0ca0d18e324e452f9a4126e1a82e3e03). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_EXTSELECTCLIPRGN. This value is 0x0000004B. + +**RgnDataSize (4 bytes):** An unsigned integer that specifies the size of the **RgnData** field in bytes. + +**RegionMode (4 bytes):** An unsigned integer that specifies the way to use the region. This value is in the RegionMode (section [2.1.29](#Section_b7f99f50dd2f45289624f74140368019)) enumeration. + +**RgnData (variable):** An array of bytes that specifies a **RegionData** object (section [2.2.24](#Section_e66601f29b5c46198476ddb7b087551b)) in logical units. If **RegionMode** is **RGN_COPY**, this data can be omitted and the clipping region SHOULD be set to the default clipping region. + +See section 2.3.2 for more clipping record types. + +#### EMR_INTERSECTCLIPRECT Record + +The EMR_INTERSECTCLIPRECT record specifies a new clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) from the intersection of the current clipping region and the specified rectangle. + +Fields not specified in this section are specified in section [2.3.2](#Section_0ca0d18e324e452f9a4126e1a82e3e03). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_INTERSECTCLIPRECT**. This value is 0x0000001E. + +**Clip (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the rectangle in logical units. + +The lower and right edges of the specified rectangle are excluded from the clipping region. + +See section 2.3.2 for more clipping record types. + +#### EMR_OFFSETCLIPRGN Record + +The EMR_OFFSETCLIPRGN record moves the current clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by the specified offsets. + +Fields not specified in this section are specified in section [2.3.2](#Section_0ca0d18e324e452f9a4126e1a82e3e03). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_OFFSETCLIPRGN. This value is 0x0000001A. + +**Offset (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15) that specifies the horizontal and vertical offsets in logical units. + +See section 2.3.2 for more clipping record types. + +#### EMR_SELECTCLIPPATH Record + +The **EMR_SELECTCLIPPATH** record sets the current clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to the current clipping region combined with current [**path bracket**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601). + +Fields not specified in this section are specified in section [2.3.2](#Section_0ca0d18e324e452f9a4126e1a82e3e03). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SELECTCLIPPATH. This value is 0x00000043. + +**RegionMode (4 bytes):** An unsigned integer that specifies how to combine the current clipping region with the current path bracket. This value is in the RegionMode enumeration (section [2.1.29](#Section_b7f99f50dd2f45289624f74140368019)). + +See section 2.3.2 for more clipping record types. + +### Comment Record Types + +The **Comment** record types define formats for specifying arbitrary private data, embedding records in other [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) formats, and adding new or special-purpose commands. + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) comment record types. + +| Name | Section | Description | +|----|----|----| +| EMR_COMMENT | [2.3.3.1](#Section_e081b202429d4c34b21ca0ad501858a6) | Contains arbitrary private data. | +| EMR_COMMENT_EMFPLUS | [2.3.3.2](#Section_929b78e1b84844a59fac327cae5c2ae5) | Contains embedded [**EMF+**](#gt_41a5b58b-b050-4001-85ec-d6ed56379ee2) records ([\[MS-EMFPLUS\]](%5bMS-EMFPLUS%5d.pdf#Section_5f92c78964f246b59ed415a9bb0946c6) section 2.3). | +| EMR_COMMENT_EMFSPOOL | [2.3.3.3](#Section_a1a907e3cd444475a8cfdfad513a4243) | Contains embedded [**EMFSPOOL**](#gt_3bd355a2-4faa-40ab-bc79-0d158eba43b6) records ([\[MS-EMFSPOOL\]](%5bMS-EMFSPOOL%5d.pdf#Section_3d8cd6cc528742e8925f4a53afd04534) section 2.2). | +| EMR_COMMENT_PUBLIC | [2.3.3.4](#Section_39c91f22e4cc4e82a6050137caa8457c) | Specifies extensions to EMF processing. | + +The generic structure of comment records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer from the RecordType enumeration (section [2.1.1](#Section_1eec80ba799b4784a9ac91597d590ae1)) that identifies this record as a comment record. This value is 0x00000046. + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the metafile. This value MUST be a multiple of 4 bytes. + +**DataSize (4 bytes):** An unsigned integer that specifies the size in bytes, of the **CommentIdentifier** and **CommentRecordParm** fields in the **RecordBuffer** field that follows. It MUST NOT include the size of itself or the size of the **AlignmentPadding** field, if present. + +**CommentRecordBuffer (variable):** An array of bytes that contains the remainder of the comment record. + +[TABLE] + +> **CommentIdentifier (4 bytes, optional):** An unsigned integer that identifies the type of comment record. See the preceding table for descriptions of these record types. +> +> Valid comment identifier values are listed in the following table. If this field contains any other value, the comment record is processed as an EMR_COMMENT record. + +| Name | Value | +|----------------------|------------| +| EMR_COMMENT_EMFSPOOL | 0x00000000 | +| EMR_COMMENT_EMFPLUS | 0x2B464D45 | +| EMR_COMMENT_PUBLIC | 0x43494447 | + +**CommentRecordParm (variable):** An array of bytes that contains the parameters for the comment record. + +**AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_COMMENT Record + +The **EMR_COMMENT** record contains arbitrary private data. + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9). + +[TABLE] + +**PrivateData (variable, optional):** An array of bytes that specifies the private data. The first 32-bit field of this data MUST NOT be one of the predefined comment identifier values specified in section 2.3.3. + +Private data is unknown to [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36); it is meaningful only to applications that know the format of the data and how to use it. EMR_COMMENT private data records MAY[\<60\>](#Appendix_A_60) be ignored. + +See section 2.3.3 for more comment record types. + +#### EMR_COMMENT_EMFPLUS Record + +The **EMR_COMMENT_EMFPLUS** record contains embedded [**EMF+**](#gt_41a5b58b-b050-4001-85ec-d6ed56379ee2) records ([\[MS-EMFPLUS\]](%5bMS-EMFPLUS%5d.pdf#Section_5f92c78964f246b59ed415a9bb0946c6) section 2.3). + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9). + +[TABLE] + +**CommentIdentifier (4 bytes):** An unsigned integer that identifies this comment record as containing EMF+ records. The value 0x2B464D45, which is the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) string "+FME", identifies this as an EMR_COMMENT_EMFPLUS record. + +**EMFPlusRecords (variable):** An array of bytes that contains one or more EMF+ records. + +See section 2.3.3 for more comment record types. + +#### EMR_COMMENT_EMFSPOOL Record + +The **EMR_COMMENT_EMFSPOOL** record contains embedded [**EMFSPOOL**](#gt_3bd355a2-4faa-40ab-bc79-0d158eba43b6) records ([\[MS-EMFSPOOL\]](%5bMS-EMFSPOOL%5d.pdf#Section_3d8cd6cc528742e8925f4a53afd04534) section 2.2). + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9). + +[TABLE] + +**CommentIdentifier (4 bytes):** An unsigned integer that identifies this comment record as containing EMFSPOOL records. The value 0x00000000 identifies this as an EMR_COMMENT_EMFSPOOL record. + +**EMFSpoolRecordIdentifier (4 bytes):** An unsigned integer that identifies the type of EMR_COMMENT_EMFSPOOL record. The value 0x544F4E46, which is the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) string "TONE", identifies this as an EMFSPOOL font definition record (\[MS-EMFSPOOL\] section 2.2.3.3). + +**EMFSpoolRecords (variable):** An array of bytes that contain one or more font definition records. + +See section 2.3.3 for more comment record types. + +#### EMR_COMMENT_PUBLIC Record Types + +The **EMR_COMMENT_PUBLIC** record types specify extensions to [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) processing. + +Following are the EMF public comment record types that have been defined. + +| Name | Section | Description | +|----|----|----| +| EMR_COMMENT_BEGINGROUP | [2.3.3.4.1](#Section_9f0561a0adfe4a97a45299664787c1d2) | Specifies the beginning of a group of drawing records. | +| EMR_COMMENT_ENDGROUP | [2.3.3.4.2](#Section_11829e5dd2594179b66bbc2c7ab6b985) | Specifies the end of a group of drawing records. | +| EMR_COMMENT_MULTIFORMATS | [2.3.3.4.3](#Section_4bc4608eca82426dac0e5ded2ad3fc4e) | Specifies an image in multiple graphics formats. | +| EMR_COMMENT_WINDOW_METAFILE | [2.3.3.4.4](#Section_0dbabbd2c61d4534b526b9431c494da8) | Specifies an image in an embedded [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). | + +The generic structure of EMR_COMMENT_PUBLIC records is specified as follows. + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9). + +[TABLE] + +**CommentIdentifier (4 bytes):** An unsigned integer that identifies this comment record as specifying public data. The value 0x43494447, which is the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) string "CIDG", identifies this as an EMR_COMMENT_PUBLIC record. + +**PublicCommentIdentifier (4 bytes):** An unsigned integer that identifies the type of public comment record. This SHOULD be one of the values listed in the preceding table, which are specified in the EmrComment enumeration (section [2.1.10](#Section_cd57866bd2ef49f09dd1d928ddc02885)), unless additional public comment record types have been implemented on the [**print server**](#gt_59fb3ddc-63cf-45df-8a90-46a6af9e00cb). + +**PublicCommentRecordBuffer (variable, optional):** An array of bytes that contains the remainder of the public comment record. + +[TABLE] + +> **PublicCommentRecordParm (variable):** An array of bytes that contains the parameters for the public comment record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section 2.3.3 for more comment record types. + +##### EMR_COMMENT_BEGINGROUP Record + +The **EMR_COMMENT_BEGINGROUP** record specifies the beginning of a group of drawing records. + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9) or [2.3.3.4](#Section_39c91f22e4cc4e82a6050137caa8457c). + +[TABLE] + +**PublicCommentIdentifier (4 bytes):** An unsigned integer that identifies the type of public comment record as EMR_COMMENT_BEGINGROUP from the EmrComment enumeration (section [2.1.10](#Section_cd57866bd2ef49f09dd1d928ddc02885)). This value is 0x00000002. + +**Rectangle (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the output rectangle in logical coordinates. + +**nDescription (4 bytes):** The number of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters in the optional description string that follows. + +**Description (variable, optional):** A null-terminated Unicode string that describes this group of records. + +This record MUST be followed by a corresponding EMR_COMMENT_ENDGROUP record (section [2.3.3.4.2](#Section_11829e5dd2594179b66bbc2c7ab6b985)). These record groups can be nested. + +See section 2.3.3.4 for more public comment record types. + +##### EMR_COMMENT_ENDGROUP Record + +The **EMR_COMMENT_ENDGROUP** record specifies the end of a group of drawing records. + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9) or [2.3.3.4](#Section_39c91f22e4cc4e82a6050137caa8457c). + +[TABLE] + +**PublicCommentIdentifier (4 bytes):** An unsigned integer that identifies the type of public comment record as EMR_COMMENT_ENDGROUP from the EmrComment enumeration (section [2.1.10](#Section_cd57866bd2ef49f09dd1d928ddc02885)). This value is 0x00000003. + +This record MUST be preceded by a corresponding. EMR_COMMENT_BEGINGROUP (section [2.3.3.4.1](#Section_9f0561a0adfe4a97a45299664787c1d2)). These records can be nested. + +See section 2.3.3.4 for more public comment record types. + +##### EMR_COMMENT_MULTIFORMATS Record + +The **EMR_COMMENT_MULTIFORMATS** record specifies an image in multiple graphics formats. + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9) or [2.3.3.4](#Section_39c91f22e4cc4e82a6050137caa8457c). + +[TABLE] + +**PublicCommentIdentifier (4 bytes):** An unsigned integer that identifies the type of public comment record as EMR_COMMENT_MULTIFORMATS from the EmrComment enumeration (section [2.1.10)](#Section_cd57866bd2ef49f09dd1d928ddc02885). This value is 0x40000004. + +**OutputRect (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the output rectangle, in logical coordinates. + +**CountFormats (4 bytes):** An unsigned integer that specifies the number of graphics formats contained in this record. + +**aFormats (variable):** A **CountFormats** length array of graphics formats, specified by EmrFormat objects (section [2.2.4](#Section_1bd63563ce674528bf285a8852ff0270)) in order of preference. + +**FormatData (variable):** The image data for all graphics formats contained in this record. + +The size of the data for each image is specified by the **DataSize** field in the corresponding EmrFormat object. Thus, the total size of this field is the sum of **DataSize** values in all EmrFormat objects. + +The graphics format of the data for each image is specified by the **Signature** field in the corresponding EmrFormat object. + +For example, an application can use this record type to specify an image in [**EPS**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f) format using EpsData objects (section [2.2.6](#Section_a624b402f7aa4cb6b289612c9775f37e)). Subsequently, the [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) version of the image can be rendered if that graphics format is supported by the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) on the playback system.[\<61\>](#Appendix_A_61) + +See section 2.3.3.4 for more public comment record types. + +##### EMR_COMMENT_WINDOWS_METAFILE Record + +The **EMR_COMMENT_WINDOWS_METAFILE** record specifies an image in an embedded [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +Fields not specified in this section are specified in section [2.3.3](#Section_05940d07e1124146ac0588fc6a1f70b9) or [2.3.3.4](#Section_39c91f22e4cc4e82a6050137caa8457c). + +[TABLE] + +**PublicCommentIdentifier (4 bytes):** An unsigned integer that identifies the type of public comment record as EMR_COMMENT_WINDOWS_METAFILE from the EmrComment enumeration (section [2.1.10](#Section_cd57866bd2ef49f09dd1d928ddc02885)). This value is 0x80000001. + +**Version (2 bytes):** An unsigned integer that specifies the WMF metafile version in terms of support for DIBs, from the MetafileVersion enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.19). + +**Reserved (2 bytes):** A value that MUST be 0x0000 and MUST be ignored. + +**Checksum (4 bytes):** An unsigned integer that specifies the checksum for this record. + +**Flags (4 bytes):** A value that MUST be 0x00000000 and MUST be ignored. + +**WinMetafileSize (4 bytes):** An unsigned integer that specifies the size in bytes, of the **WinMetafile** field. + +**WinMetafile (variable):** A buffer that contains the WMF metafile. + +See section 2.3.3.4 for more public comment record types. + +### Control Record Types + +The **Control** record types define the start and end of an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) and its properties. + +The following are EMF control record types. + +| Name | Section | Description | +|----|----|----| +| EMR_EOF | [2.3.4.1](#Section_3f47fde00e6b40c187f3f4129af03aa1) | Indicates the end of the metafile and specifies a [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). | +| EMR_HEADER | [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab) | Indicates the start of the metafile and specifies properties of the device on which the metafile was created. | + +The generic structure of control records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The control record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|------------|------------| +| EMR_HEADER | 0x00000001 | +| EMR_EOF | 0x0000000E | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the metafile. This value MUST be a multiple of 4 bytes. + +**RecordBuffer (variable):** An array of bytes that contains the remainder of the control record. + +[TABLE] + +> **ControlRecordParm (variable):** An array of bytes that contains the parameters for the control record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_EOF Record + +The **EMR_EOF** record indicates the end of the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) and specifies a [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). + +Fields not specified in this section are specified in section [2.3.4](#Section_2caf0f4781a44079931dfca6fa499869). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_EOF. This value is 0x0000000E. + +**nPalEntries (4 bytes):** An unsigned integer that specifies the number of palette entries. + +**offPalEntries (4 bytes):** An unsigned integer that specifies the offset to the palette entries from the start of this record. + +**PaletteBuffer (variable, optional):** An array of bytes that contains palette data, which is not required to be contiguous with the fixed-length portion of the EMR_EOF record. Thus, fields in this buffer that are labeled "UndefinedSpace" are optional and MUST be ignored. + +[TABLE] + +> **PaletteEntries (variable):** An array of LogPaletteEntry objects (section [2.2.18](#Section_c1f7b285be164112a4e60b2fd4c1d148)) that specifies the palette data. + +**SizeLast (4 bytes):** An unsigned integer that MUST be the same as **Size** and MUST be the last field of the record and hence the metafile. LogPaletteEntry objects, if they exist, MUST precede this field. + +See section 2.3.4 for more control record types. + +#### EMR_HEADER Record Types + +The **EMR_HEADER** record is the starting point of an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). It specifies properties of the device on which the image in the metafile was recorded; this information in the header record makes it possible for EMF metafiles to be independent of any specific output device. + +The following are the EMR_HEADER record types. + +| Name | Section | Description | +|----|----|----| +| EmfMetafileHeader | [2.3.4.2.1](#Section_80c0684b9a0e4bdb8d6d0e5a9e9673e7) | The original EMF header record. | +| EmfMetafileHeaderExtension1 | [2.3.4.2.2](#Section_120a68e1e1994768ba1bb6b0bd019989) | The header record defined in the first extension to EMF, which added support for [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) records and an optional internal pixel format descriptor.[\<62\>](#Appendix_A_62) | +| EmfMetafileHeaderExtension2 | [2.3.4.2.3](#Section_3b393b9124db4daab5bac74434a1d67c) | The header record defined in the second extension to EMF, which added the capability of measuring display dimensions in micrometers.[\<63\>](#Appendix_A_63) | + +EMF metafiles SHOULD be created with an **EmfMetafileHeaderExtension2** header record. + +The generic structure of EMR_HEADER records is specified as follows. + +Fields not specified in this section are specified in section [2.3.4](#Section_2caf0f4781a44079931dfca6fa499869). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_HEADER**. This value is 0x00000001. + +**EmfHeader (80 bytes):** A Header object (section [2.2.9](#Section_e4a35c41e8e343f9bc07a18e99bb866d)), which contains information about the content and structure of the metafile. + +**EmfHeaderRecordBuffer (variable, optional):** An array of bytes that contains the remainder of the EMF header record. + +[TABLE] + +> **EmfHeaderRecordParm (variable):** An array of bytes that contains additional parameters for the EMF header record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +The value of the **Size** field can be used to distinguish between the different EMR_HEADER record types listed earlier in this section. There are three possible headers: + +- The EmfMetafileHeader record. The fixed-size part of this header is 88 bytes, and it contains a Header object (section 2.2.9). + +- The EmfMetafileHeaderExtension1 record. The fixed-size part of this header is 100 bytes, and it contains a Header object and a HeaderExtension1 object (section [2.2.10](#Section_00cc8ab4ea2e4bb195691201af47a0c8)). + +- The EmfMetafileHeaderExtension2 record. The fixed-size part of this header is 108 bytes, and it contains a Header object, a HeaderExtension1 object, and a HeaderExtension2 object (section [2.2.11](#Section_9e96e5cfe94949aebaa83fffd948e588)). + +There are one or two optional, variable-length fields that are possible in each header: a description string and a pixel format field. In all three types of headers, the fixed-size part comes first, followed by the variable-length fields. + +The algorithm shown in the following figure computes a non-negative integer variable called **HeaderSize** from the offsets and lengths of the variable-length data. The type of header is determined from that value. + +![Header type determination algorithm](media/image3.bin "Header type determination algorithm") + +Figure 3: Header type determination algorithm + +After applying the algorithm, consider the value of **HeaderSize** field: + +- If **HeaderSize** \>= 108, the record type is EmfMetafileHeaderExtension2. + +- If **HeaderSize** \>= 100, the record type is EmfMetafileHeaderExtension1. + +- Otherwise, the record type is EmfMetafileHeader. + +See section 2.3.4 for more control record types. + +##### EmfMetafileHeader Record + +The **EmfMetafileHeader** record is the header record used in the original version of [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +Fields not specified in this section are specified in section [2.3.4](#Section_2caf0f4781a44079931dfca6fa499869) or [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab). + +[TABLE] + +**EmfDescriptionBuffer (variable, optional):** An array of bytes that contains the EMF description string, which is not required to be contiguous with the fixed portion of this record. Thus, the undefined space field in this buffer is optional and MUST be ignored. + +[TABLE] + +> **EmfDescription (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) string of arbitrary length and content. Its location in the record and number of characters are specified by the **offDescription** and **nDescription** fields, respectively, in **EmfHeader**. If the value of either field is zero, no description string is present. + +The value of the **Size** field can be used to distinguish between the different EMR_HEADER record types. See the flowchart in section 2.3.4.2 for details. + +See section 2.3.4.2 for more header record types. + +##### EmfMetafileHeaderExtension1 Record + +The **EmfMetafileHeaderExtension1** record is the header record used in the first extension to [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). Following the **EmfHeaderExtension1** field, the remaining fields are optional and can be present in any order. + +Fields not specified in this section are specified in section [2.3.4](#Section_2caf0f4781a44079931dfca6fa499869) or [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab). + +[TABLE] + +**EmfHeaderExtension1 (12 bytes):** A HeaderExtension1 object (section [2.2.10](#Section_00cc8ab4ea2e4bb195691201af47a0c8)), which specifies additional information about the image in the metafile. + +**EmfDescriptionBuffer (variable, optional):** An array of bytes that contains the EMF description string, which is not required to be contiguous with the fixed-length part of this record. Thus, the undefined space field in this buffer is optional and MUST be ignored. + +[TABLE] + +> **EmfDescription (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) string of arbitrary length and content. Its location in the record and number of characters are specified by the **offDescription** and **nDescription** fields, respectively, in **EmfHeader**. If the value of either field is zero, no description string is present. + +**EmfPixelFormatBuffer (variable, optional):** An array of bytes that contains the EMF pixel format descriptor. It is not required to be contiguous with the **EmfHeaderExtension1** or **EmfDescription** fields. Thus, the undefined space field in this buffer is optional and MUST be ignored. + +[TABLE] + +> **EmfPixelFormat (40 bytes):** A PixelFormatDescriptor object (section [2.2.22](#Section_1db036d62da84b92b4f8e9cab8cc93b7)), which specifies the pixel format that was defined when the metafile was recorded. Its size and location in the record are specified by the **cbPixelFormat** and **offPixelFormat** fields, respectively, in **EmfHeaderExtension1**. If the value of either field is zero, no pixel format descriptor is present. + +**Note:** No single structure definition can accurately represent every possible combination of optional fields. Therefore, the implementer is responsible for writing software that determines which fields are present in each metafile and for unmarshaling the contents of each field appropriately. + +The value of the **Size** field can be used to distinguish between the different EMR_HEADER record types. See the flowchart in section 2.3.4.2 for details. + +##### EmfMetafileHeaderExtension2 Record + +The **EmfMetafileHeaderExtension2** record is the header record used in the second extension to [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). Following the **EmfHeaderExtension2** field, the remaining fields are optional and can be present in any order. + +Fields not specified in this section are specified in section [2.3.4](#Section_2caf0f4781a44079931dfca6fa499869) or [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab). + +[TABLE] + +**EmfHeaderExtension1 (12 bytes):** A HeaderExtension1 object (section [2.2.10](#Section_00cc8ab4ea2e4bb195691201af47a0c8)), which specifies additional information about the image in the metafile. + +**EmfHeaderExtension2 (8 bytes):** A HeaderExtension2 object (section [2.2.11](#Section_9e96e5cfe94949aebaa83fffd948e588)), which specifies additional information about the image in the metafile. + +**EmfDescriptionBuffer (variable, optional):** An array of bytes that contains the EMF description string, which is not required to be contiguous with the fixed portion of the EmfMetafileHeaderExtension2 record. Thus, the undefined space field in this buffer is optional and MUST be ignored. + +[TABLE] + +> **EmfDescription (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) string of arbitrary length and content. Its location in the record and number of characters are specified by the **offDescription** and **nDescription** fields, respectively, in **EmfHeader**. If the value of either field is zero, no description string is present. + +**EmfPixelFormatBuffer (variable, optional):** An array of bytes that contains the EMF pixel format descriptor, which is not required to be contiguous with the fixed portion of the EmfMetafileHeaderExtension2 record or with the EMF description string. Thus, the field in this buffer that is labeled "UndefinedSpace" is optional and MUST be ignored. + +[TABLE] + +> **EmfPixelFormat (40 bytes):** A PixelFormatDescriptor object (section [2.2.22](#Section_1db036d62da84b92b4f8e9cab8cc93b7)) that specifies the last pixel format that was defined when the metafile was recorded. Its size and location in the record are specified by the **cbPixelFormat** and **offPixelFormat** fields, respectively, in **EmfHeaderExtension1**. If the value of either field is zero, no pixel format descriptor is present. + +**Note:** No single structure definition can accurately represent every possible combination of optional fields. Therefore, the implementer is responsible for writing software that determines which fields are present in each metafile, and for unmarshaling the contents of each field appropriately. + +The value of the **Size** field can be used to distinguish between the different EMR_HEADER record types. See the flowchart in section 2.3.4.2 for details. + +### Drawing Record Types + +The **Drawing** record types perform graphics drawing and painting functions. The clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) used by drawing records are maintained in the **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) drawing record types. + +| Name | Section | Description | +|----|----|----| +| EMR_ANGLEARC | [2.3.5.1](#Section_3b04a2e29ba5477fb79c5710635d04b9) | Draws a line segment of an arc. | +| EMR_ARC | [2.3.5.2](#Section_3e148f197e7543aa9259fda562f60315) | Draws an elliptical arc. | +| EMR_ARCTO | [2.3.5.3](#Section_51b4a890bfd4496ebbd9dbde9ad49d1c) | Draws an elliptical arc, resetting the current drawing position to the endpoint of the arc. | +| EMR_CHORD | [2.3.5.4](#Section_b442d2fbf92b4103aa7d44f864f719d5) | Draws a chord, which is a region bounded by the intersection of an ellipse and a line segment, called a secant. | +| EMR_ELLIPSE | [2.3.5.5](#Section_d9462a32d18840e7bf7205614ec4ff18) | Draws an ellipse. | +| EMR_EXTFLOODFILL | 2.3.5.1 | Draws a line segment of an arc. | +| EMR_EXTTEXTOUTA | [2.3.5.7](#Section_6b582a713c294fc6a0f41f8a313739a1) | Draws an [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) text string using the current font and text colors. | +| EMR_EXTTEXTOUTW | [2.3.5.8](#Section_a59a79ac328e492da34de02727af6edf) | Draws a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) text string using the current font and text colors. | +| EMR_FILLPATH | [2.3.5.9](#Section_7cc0afcb06934810a3cbb69c871ce473) | Closes any open figures in the current [**path bracket**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601) and fills the path's interior with the current brush. | +| EMR_FILLRGN | [2.3.5.10](#Section_a1bb0f88bb224956b45a7005546561cc) | Fills the specified region with the specified brush. | +| EMR_FRAMERGN | [2.3.5.11](#Section_c370fc169045467ba1257239428df6b3) | Draws a border around the specified region with the specified brush. | +| EMR_GRADIENTFILL | [2.3.5.12](#Section_1a3849c8be6c4d30b5d3f43b4c70ca0d) | Fills the specified rectangle and triangle structures. | +| EMR_LINETO | [2.3.5.13](#Section_9b3eccf94a554a9cb0df3c495e7b9a8c) | Draws a line from the current position up to, but not including, the specified point. This record resets the current position to that point. | +| EMR_PAINTRGN | [2.3.5.14](#Section_68c457dc6df34609b6f9e28e5ca4d9c1) | Paints the specified region with the current brush. | +| EMR_PIE | [2.3.5.15](#Section_c326f6b2ae7e447fb8dc02c703f054c3) | Draws a pie-shaped wedge bounded by the intersection of an ellipse and two radials. | +| EMR_POLYBEZIER | [2.3.5.16](#Section_4e53793a95af49d4ae1f4c407eda9440) | Draws one or more [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5). The cubic Bezier curves are defined with the endpoints and control points specified in this record. | +| EMR_POLYBEZIER16 | [2.3.5.17](#Section_3329ee2617ed43718f51e3985d764d77) | Draws one or more Bezier curves with the current pen. | +| EMR_POLYBEZIERTO | [2.3.5.18](#Section_28431e45a87441dc864d8f4f69e8e831) | Draws one or more Bezier curves based on the current position. | +| EMR_POLYBEZIERTO16 | [2.3.5.19](#Section_d27cc96684a44715a6de45aa6cd03292) | Draws one or more Bezier curves based on the current position. | +| EMR_POLYDRAW | [2.3.5.20](#Section_95794fafeed84d5bb6ffc6765a58166e) | Draws a set of line segments and Bezier curves. | +| EMR_POLYDRAW16 | [2.3.5.21](#Section_57f0cfe721394199b6ad61fb61a1d4ec) | Draws a set of line segments and Bezier curves. | +| EMR_POLYGON | [2.3.5.22](#Section_eb91678158b64e92b60668071aa65733) | Draws a polygon consisting of two or more vertexes connected by straight lines. | +| EMR_POLYGON16 | [2.3.5.23](#Section_ac6d65ac9d39439382ebb58fa0c0f635) | Draws a polygon consisting of two or more vertexes connected by straight lines. | +| EMR_POLYLINE | [2.3.5.24](#Section_9ce6c9bb1a1348a59aa2d95b334b5358) | Draws a series of line segments by connecting the points in the specified array. | +| EMR_POLYLINE16 | [2.3.5.25](#Section_ca3a6590c02343548d6de3d40d7eb5b9) | Draws a series of line segments by connecting the points in the specified array. | +| EMR_POLYLINETO | [2.3.5.26](#Section_a2d8b73883514a9c9f3aa6a8481c4c6f) | Draws one or more straight lines based upon the current position. | +| EMR_POLYLINETO16 | [2.3.5.27](#Section_0d5a471025f943bebb083e38a4db1249) | Draws one or more straight lines based upon the current position. | +| EMR_POLYPOLYGON | [2.3.5.28](#Section_c60ff127271142d385d4502ca2e4caef) | Paints a series of closed polygons. Each polygon is outlined with the current pen and filled with the current brush and polygon fill mode. | +| EMR_POLYPOLYGON16 | [2.3.5.29](#Section_96ad447f25d642728d1851b395e669c6) | Paints a series of closed polygons. Each polygon is outlined with the current pen and filled with the current brush and polygon fill mode. | +| EMR_POLYPOLYLINE | [2.3.5.30](#Section_e23f75fd3af649f38c86ef121ff61701) | Draws multiple series of connected line segments. | +| EMR_POLYPOLYLINE16 | [2.3.5.31](#Section_a8b4cdfd50394a56b7cb9458f819f23f) | Draws multiple series of connected line segments. | +| EMR_POLYTEXTOUTA | [2.3.5.32](#Section_d8b7ac2176b84f9aa7cc05f9d2d5627e) | Draws one or more ASCII text strings using the current font and text colors. | +| EMR_POLYTEXTOUTW | [2.3.5.33](#Section_381015eb29a7477493ada210697f5972) | Draws one or more Unicode text strings using the current font and text colors. | +| EMR_RECTANGLE | [2.3.5.34](#Section_3c4712380a02499290a2bfd2afd98f2a) | Draws a rectangle. The rectangle is outlined with the current pen and filled with the current brush. | +| EMR_ROUNDRECT | [2.3.5.35](#Section_2e4f55a15f694a818329423eeedb3812) | Draws a rectangle with rounded corners. | +| EMR_SETPIXELV | [2.3.5.36](#Section_21d44fb9b3c74ce7a4027601f34d0cda) | Defines the color of the pixel at the specified logical coordinates. | +| EMR_SMALLTEXTOUT | [2.3.5.37](#Section_20eee81d0bd442d1a624860adfe62358) | Outputs a string. | +| EMR_STROKEANDFILLPATH | [2.3.5.38](#Section_2794792a38b44d19adec28fc2a6273b2) | Closes any open figures in a path, draws the outline of the path with the current pen, and fills its interior with the current brush. | +| EMR_STROKEPATH | [2.3.5.39](#Section_c8b86df6746445b0bca46ffab9174961) | Draws the specified path with the current pen. | + +The generic structure of drawing records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The drawing record types are listed in the following table. See the preceding table for descriptions of these records. + +| Name | Value | +|-----------------------|------------| +| EMR_POLYBEZIER | 0x00000002 | +| EMR_POLYGON | 0x00000003 | +| EMR_POLYBEZIERTO | 0x00000005 | +| EMR_POLYLINETO | 0x00000006 | +| EMR_POLYPOLYLINE | 0x00000007 | +| EMR_POLYPOLYGON | 0x00000008 | +| EMR_SETPIXELV | 0x0000000F | +| EMR_ANGLEARC | 0x00000029 | +| EMR_ELLIPSE | 0x0000002A | +| EMR_RECTANGLE | 0x0000002B | +| EMR_ROUNDRECT | 0x0000002C | +| EMR_ARC | 0x0000002D | +| EMR_CHORD | 0x0000002E | +| EMR_PIE | 0x0000002F | +| EMR_EXTFLOODFILL | 0x00000035 | +| EMR_LINETO | 0x00000036 | +| EMR_ARCTO | 0x00000037 | +| EMR_POLYDRAW | 0x00000038 | +| EMR_FILLPATH | 0x0000003E | +| EMR_STROKEANDFILLPATH | 0x0000003F | +| EMR_STROKEPATH | 0x00000040 | +| EMR_FILLRGN | 0x00000047 | +| EMR_FRAMERGN | 0x00000048 | +| EMR_PAINTRGN | 0x0000004A | +| EMR_EXTTEXTOUTA | 0x00000053 | +| EMR_EXTTEXTOUTW | 0x00000054 | +| EMR_POLYBEZIER16 | 0x00000055 | +| EMR_POLYGON16 | 0x00000056 | +| EMR_POLYLINE16 | 0x00000057 | +| EMR_POLYBEZIERTO16 | 0x00000058 | +| EMR_POLYLINETO16 | 0x00000059 | +| EMR_POLYPOLYLINE16 | 0x0000005A | +| EMR_POLYPOLYGON16 | 0x0000005B | +| EMR_POLYDRAW16 | 0x0000005C | +| EMR_POLYTEXTOUTA | 0x00000060 | +| EMR_POLYTEXTOUTW | 0x00000061 | +| EMR_SMALLTEXTOUT | 0x0000006C | +| EMR_GRADIENTFILL | 0x00000076 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**DrawingRecordBuffer (variable):** An array of bytes that contains the remainder of the drawing record. + +[TABLE] + +> **DrawingRecordParm (variable):** An array of bytes that contains the parameters for the drawing record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more [EMF record types](#Section_1eec80ba799b4784a9ac91597d590ae1). + +#### EMR_ANGLEARC Record + +The EMR_ANGLEARC record specifies a line segment of an arc. The line segment is drawn from the current position to the beginning of the arc. The arc is drawn along the perimeter of a circle with the given radius and center. The length of the arc is defined by the given start and sweep angles. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_ANGLEARC**. This value is 0x00000029. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Center (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15), which specifies the logical coordinates of the circle's center. + +**Radius (4 bytes):** An unsigned integer that specifies the circle's radius, in logical units. + +**StartAngle (4 bytes):** A 32-bit float that specifies the arc's start angle, in degrees. + +**SweepAngle (4 bytes):** A 32-bit float that specifies the arc's sweep angle, in degrees. + +The arc is drawn by recording an imaginary circle around the specified center point with the specified radius. The starting point of the arc is determined by measuring counterclockwise from the x-axis of the circle by the number of degrees in the start angle. The ending point is similarly located by measuring counterclockwise from the starting point by the number of degrees in the sweep angle. + +If the sweep angle is greater than 360 degrees, the arc is swept multiple times. + +This record specifies lines by using the current pen. The figure is not filled. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_ARC Record + +The EMR_ARC record specifies an elliptical arc. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_ARC**. This value is 0x0000002D. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +**Start (8 bytes):** A PointL object (\[MS-WMF\] section 2.2.2.15), which specifies the coordinates in logical units of the ending point of the radial line defining the starting point of the arc. + +**End (8 bytes):** A PointL object that specifies the coordinates in logical units of the ending point of the radial line defining the ending point of the arc. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_ARCTO Record + +The EMR_ARCTO record specifies an elliptical arc. It resets the current drawing position to the endpoint of the arc. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_ARCTO**. This value is 0x00000037. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +**Start (8 bytes):** A PointL object (\[MS-WMF\] section 2.2.2.15), which specifies the coordinates, in logical units, of the first radial ending point, in logical units. + +**End (8 bytes):** A PointL object that specifies the coordinates of the second radial ending point, in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_CHORD Record + +The EMR_CHORD record specifies a chord, which is a [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) bounded by the intersection of an ellipse and a line segment, called a secant. The chord is outlined by using the current pen and filled by using the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_CHORD**. This value is 0x0000002E. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +**Start (8 bytes):** A PointL object (\[MS-WMF\] section 2.2.2.15), which specifies the coordinates, in logical units, of the endpoint of the radial defining the beginning of the chord. + +**End (8 bytes):** A PointL object that specifies the logical coordinates of the endpoint of the radial defining the end of the chord. + +The curve of the chord is defined by an ellipse that fits the specified bounding rectangle. The curve begins at the point where the ellipse intersects the first radial and extends counterclockwise to the point where the ellipse intersects the second radial. The chord is closed by drawing a line from the intersection of the first radial and the curve to the intersection of the second radial and the curve. + +If the starting point and ending point of the curve are the same, a complete ellipse is drawn. + +The current drawing position is neither used nor updated by processing this record. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_ELLIPSE Record + +The EMR_ELLIPSE record specifies an ellipse. The center of the ellipse is the center of the specified bounding rectangle. The ellipse is outlined by using the current pen and is filled by using the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_ELLIPSE**. This value is 0x0000002A. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_EXTFLOODFILL Record + +The EMR_EXTFLOODFILL record fills an area of the display surface with the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_EXTFLOODFILL**. This value is 0x00000035. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Start (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15), which specifies the coordinates, in logical units, where filling begins. + +**Color (4 bytes):** A **ColorRef** object (\[MS-WMF\] section 2.2.2.8), which is used with the **FloodFillMode** to determine the area to fill. + +**FloodFillMode (4 bytes):** An unsigned integer that specifies how to use the **Color** value to determine the area for the flood fill operation. This value is in the [FloodFill](#Section_e9e1009705f540d190ac79ccbe0b5fa9) enumeration (section 2.1.13). + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_EXTTEXTOUTA Record + +The **EMR_EXTTEXTOUTA** record draws an [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) text string using the current font and text colors. + +Fields not specified in this section are specified in section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies the record type as EMR_EXTTEXTOUTA from the RecordType enumeration (section [2.1.1](#Section_1eec80ba799b4784a9ac91597d590ae1)). This value is 0x00000053. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which is not used and MUST be ignored on receipt. + +**iGraphicsMode (4 bytes):** An unsigned integer that specifies the graphics mode from the GraphicsMode enumeration (section [2.1.16](#Section_fe60a5a523044b639949e11bfdbebae9)). + +**exScale (4 bytes):** A FLOAT value that specifies the scale factor to apply along the X axis to convert from [**page space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) units to .01mm units. This SHOULD be used only if the graphics mode specified by **iGraphicsMode** is GM_COMPATIBLE. + +**eyScale (4 bytes):** A FLOAT value that specifies the scale factor to apply along the Y axis to convert from page space units to .01mm units. This SHOULD be used only if the graphics mode specified by **iGraphicsMode** is GM_COMPATIBLE. + +**aEmrText (variable):** An EmrText object (section [2.2.5](#Section_dd585d0a5d7c4034963a1141af836972)) that specifies the output string in 8-bit ASCII characters, text attributes, and spacing values. + +The font and text colors used for output are specified by the state of the current graphics environment (section [3.1.1.2](#Section_00de3e5e6f104be4943d8de5e2b95fe8)). A rectangle for clipping and/or opaquing can be defined in the EmrText object in the **aEmrText** field. + +This record SHOULD[\<64\>](#Appendix_A_64) be emulated with an EMR_EXTTEXTOUTW record (section [2.3.5.8](#Section_a59a79ac328e492da34de02727af6edf)), which requires the ASCII text string in the EmrText object to be converted to [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) encoding. + +See section 2.3.5 for more drawing record types. + +#### EMR_EXTTEXTOUTW Record + +The EMR_EXTTEXTOUTW record draws a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) text string using the current font and text colors. + +Fields not specified in this section are specified in section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies the record type as **EMR_EXTTEXTOUTW** from the [RecordType enumeration (section 2.1.1)](#Section_1eec80ba799b4784a9ac91597d590ae1). This value is 0x00000054. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19). It is not used and MUST be ignored on receipt. + +**iGraphicsMode (4 bytes):** An unsigned integer that specifies the current graphics mode from the [GraphicsMode enumeration (section 2.1.16)](#Section_fe60a5a523044b639949e11bfdbebae9). + +**exScale (4 bytes):** A FLOAT value that specifies the scale factor to apply along the X axis to convert from [**page space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) units to .01mm units. This is used only if the graphics mode specified by **iGraphicsMode** is **GM_COMPATIBLE**. + +**eyScale (4 bytes):** A FLOAT value that specifies the scale factor to apply along the Y axis to convert from page space units to .01mm units. This is used only if the graphics mode specified by **iGraphicsMode** is **GM_COMPATIBLE**. + +**wEmrText (variable):** An [EmrText object (section 2.2.5)](#Section_dd585d0a5d7c4034963a1141af836972) that specifies the output string in Unicode [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) characters, with text attributes and spacing values. + +The font and text colors used for output are specified by properties in the current state of EMF metafile playback (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). A rectangle for clipping and/or opaquing can be defined in the EmrText object that is specified in the **aEmrText** field. + +See section 2.3.5 for more drawing record types. + +#### EMR_FILLPATH Record + +The EMR_FILLPATH record closes any open figures in the current [**path bracket**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601) and fills the path's interior by using the current brush and polygon-filling mode. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_FILLPATH**. This value is 0x0000003E. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the bounding rectangle in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_FILLRGN Record + +The EMR_FILLRGN record fills the specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) by using the specified brush. The current clipping regions used by this record are maintained in a **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_FILLRGN**. This value is 0x00000047. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical units. If the intersection of this rectangle with the current clipping region is empty, this record has no effect. + +**RgnDataSize (4 bytes):** An unsigned integer that specifies the size of region data in bytes. + +**ihBrush (4 bytes):** An unsigned integer that specifies the index of the brush in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)) for filling the region. + +**RgnData (variable):** A **RgnDataSize** length array of bytes that specifies the output region in a **RegionData** object (section [2.2.24](#Section_e66601f29b5c46198476ddb7b087551b)). The bounds specified by the **RegionDataHeader** field of this object MAY[\<65\>](#Appendix_A_65) be used as the bounding region when this record is processed. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_FRAMERGN Record + +The EMR_FRAMERGN record draws a border around the specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) using the specified brush. The current clipping regions used by this record are maintained in a **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_FRAMERGN**. This value is 0x00000048. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping region is empty, this record has no effect. + +**RgnDataSize (4 bytes):** An unsigned integer that specifies the size of region data in bytes. + +**ihBrush (4 bytes):** An unsigned integer that specifies the index of the brush in the EMF object table index. + +**Width (4 bytes):** A signed integer that specifies the width of the vertical brush stroke, in logical units. + +**Height (4 bytes):** A signed integer that specifies the height of the horizontal brush stroke, in logical units. + +**RgnData (variable):** A **RgnDataSize** length array of bytes that specifies the output region in a **RegionData** object (section [2.2.24](#Section_e66601f29b5c46198476ddb7b087551b)). The bounds specified by the **RegionDataHeader** field of this object MAY[\<66\>](#Appendix_A_66) be used as the bounding region when this record is processed. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_GRADIENTFILL Record + +The **EMR_GRADIENTFILL** record specifies filling rectangles or triangles with gradients of color.[\<67\>](#Appendix_A_67) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_GRADIENTFILL. This value is 0x00000076. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +**nVer (4 bytes):** An unsigned integer that specifies the number of vertexes. + +**nTri (4 bytes):** An unsigned integer that specifies the number of rectangles or triangles to fill. + +**ulMode (4 bytes):** An unsigned integer that specifies the gradient fill mode. This value is in the GradientFill enumeration (section [2.1.15](#Section_699e75a028af4d6fb7aadc76e1b0001a)). + +**VertexData (variable):** Objects that specify the vertexes of either rectangles or triangles and the colors that correspond to them. + +[TABLE] + +> **VertexObjects (variable):** An array of **nVer** [TriVertex objects (section 2.2.26)](#Section_33578509834946b68f8f107c3f70bace). Each object specifies the position and color of a vertex of either a rectangle or a triangle, depending on the value of the **ulMode** field. +> +> **VertexIndexes (variable):** An array of **nTri** [GradientRectangle objects (section 2.2.7)](#Section_93ba94f784fc4dd58c943d476aa7588b) or [GradientTriangle objects (section 2.2.8)](#Section_9aa3346cdc29448d9dcf6a4f6b77d229), depending on the value of the **ulMode** field. Each object specifies indexes into the array of TriVertex objects in the **VertexObjects** field. +> +> **VertexPadding (variable, optional):** An array of **nTri** times four bytes that MUST be present if the value of the **ulMode** field indicates GradientRectangle objects (section 2.2.7). If the value of the **ulMode** field indicates GradientTriangle objects (section 2.2.8), no **VertexPadding** is present. This field MUST be ignored. + +An EMR_GRADIENTFILL record that specifies that the three vertexes of a triangle SHOULD fill the figure with smooth gradients of colors.[\<68\>](#Appendix_A_68) + +An EMR_GRADIENTFILL record that specifies that the upper-left and lower-right vertexes of a rectangle SHOULD fill the figure with smooth gradients of color. There are two gradient fill modes in the GradientFill enumeration that can be used when drawing a rectangle. In **GRADIENT_FILL_RECT_H** mode, the rectangle is filled from left to right. In **GRADIENT_FILL_RECT_V** mode, the rectangle is filled from top to bottom. + +An EMR_GRADIENTFILL record MUST ignore the **Alpha** fields in the TriVertex objects. An [EMR_ALPHABLEND record (section 2.3.1.1)](#Section_34e07d4faee64b63a4bb96996ad47669) that immediately follows the EMR_GRADIENTFILL record can be used to apply an [**alpha transparency**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) gradient to the filled area. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_LINETO Record + +The EMR_LINETO record specifies a line from the current drawing position up to, but not including, the specified point. It resets the current position to the specified point. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_LINETO**. This value is 0x00000036. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Point (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15), which specifies the coordinates of the line's endpoint. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_PAINTRGN Record + +The EMR_PAINTRGN record paints the specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) by using the current brush. The current clipping regions used by this record are maintained in a **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_PAINTRGN**. This value is 0x0000004A. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping region is empty, this record has no effect. + +**RgnDataSize (4 bytes):** An unsigned integer that specifies the size of the **RgnData** field data in bytes. + +**RgnData (variable):** An array of bytes that specifies the output region in a **RegionData** object (section [2.2.24](#Section_e66601f29b5c46198476ddb7b087551b)). The bounds specified by the **RegionDataHeader** field of that object MAY[\<69\>](#Appendix_A_69) be used as the bounding rectangle of the region when this record is processed. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_PIE Record + +The EMR_PIE record specifies a pie-shaped wedge bounded by the intersection of an ellipse and two radials. The pie is outlined by using the current pen and filled by using the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_PIE**. This value is 0x0000002F. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +**Start (8 bytes):** A PointL object (\[MS-WMF\] section 2.2.2.15), which specifies the coordinates, in logical units, of the endpoint of the first radial. + +**End (8 bytes):** A PointL object that specifies the coordinates, in logical units, of the endpoint of the second radial. + +The curve of the pie is defined by an ellipse that fits the specified bounding rectangle. The curve begins at the point where the ellipse intersects the first radial and extends counterclockwise to the point where the ellipse intersects the second radial. + +The current drawing position is neither used nor updated by this record. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYBEZIER Record + +The EMR_POLYBEZIER record specifies one or more [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYBEZIER**. This value is 0x00000002. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points in the **aPoints** array. This value MUST be one more than three times the number of curves to be drawn because each Bezier curve requires two control points and an endpoint, and the initial curve requires an additional starting point. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. + +**aPoints (variable):** An array of PointL objects (\[MS-WMF\] section 2.2.2.15) that specify the endpoints and control points of the Bezier curves in logical units. + +Cubic Bezier curves are defined using the endpoints and control points specified by the **aPoints** field. The first curve is drawn from the first point to the fourth point, using the second and third points as control points. Each subsequent curve in the sequence needs exactly three more points: the ending point of the previous curve is used as the starting point, the next two points in the sequence are control points, and the third is the ending point. + +The cubic Bezier curves SHOULD be drawn using the current pen. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYBEZIER16 Record + +The EMR_POLYBEZIER16 record specifies one or more Bezier curves. The curves are drawn using the current pen. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYBEZIER16**. This value is 0x00000055. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points. This value MUST be one more than three times the number of curves to be drawn because each [**Bezier curve**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5) requires two control points and an endpoint, and the initial curve requires an additional starting point. + +**aPoints (variable):** An array of **PointS** objects (\[MS-WMF\] section 2.2.2.16), which specify the points of the Bezier curves in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYBEZIERTO Record + +The EMR_POLYBEZIERTO record specifies one or more [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5) based upon the current drawing position. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYBEZIERTO**. This value is 0x00000005. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points in the **aPoints** array. The first curve MUST be drawn from the current position to the third point by using the first two points as control points. For each subsequent curve, exactly three more points MUST be specified, and the ending point of the previous curve MUST be used as the starting point for the next. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. + +**aPoints (variable):** An array of PointL objects (\[MS-WMF\] section 2.2.2.15), which specify the endpoints and control points of the Bezier curves in logical units. + +The Bezier curves SHOULD be drawn using the current pen. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYBEZIERTO16 Record + +The EMR_POLYBEZIERTO16 record specifies one or more Bezier curves based on the current drawing position. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYBEZIERTO16**. This value is 0x00000058. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points. The first curve is drawn from the current position to the third point by using the first two points as control points. For each subsequent curve, three more points MUST be specified, and the ending point of the previous curve MUST be used as the starting point for the next. + +**aPoints (variable):** An array of **PointS** objects (\[MS-WMF\] section 2.2.2.16), which specify the points of the [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5) in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYDRAW Record + +The EMR_POLYDRAW record specifies a set of line segments and [**Bezier curves**](#gt_b12730d5-b22e-4027-ba59-ff53749022a5). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYDRAW**. This value is 0x00000038. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object, specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19, which specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points in the **aPoints** field. + +**aPoints (variable):** An array of PointL objects (\[MS-WMF\] section 2.2.2.15), which specify the points in logical units. + +**abTypes (variable):** A **Count** length array of byte values that specifies how each point in the **aPoints** array is used. This value is in the Point (section [2.1.26](#Section_01b63e3f19d6437c8fc62758884bc08d)) enumeration. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYDRAW16 Record + +The EMR_POLYDRAW16 record specifies a set of line segments and Bezier curves. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYDRAW16**. This value is 0x0000005C. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object, specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19, which specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points. + +**aPoints (variable):** A **Count** length array of **PointS** objects, specified in \[MS-WMF\] section 2.2.2.16, which specifies the array of points. + +**abTypes (variable):** A **Count** length array of bytes that specifies the point types. This value is in the [Point (section 2.1.26)](#Section_01b63e3f19d6437c8fc62758884bc08d) enumeration. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYGON Record + +The EMR_POLYGON record specifies a polygon consisting of two or more vertexes connected by straight lines. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYGON**. This value is 0x00000003. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points in the **aPoints** array. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. + +**aPoints (variable):** A **Count** length array of PointL objects (\[MS-WMF\] section 2.2.2.15) that specifies the vertexes of the polygon in logical units. + +The polygon SHOULD be outlined using the current pen and filled using the current brush and polygon fill mode. The polygon SHOULD be closed automatically by drawing a line from the last vertex to the first. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYGON16 Record + +The EMR_POLYGON16 record specifies a polygon consisting of two or more vertexes connected by straight lines. The polygon is outlined by using the current pen and filled by using the current brush and polygon fill mode. The polygon is closed automatically by drawing a line from the last vertex to the first. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYGON16**. This value is 0x00000056. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object, specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19, which specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points. + +**aPoints (variable):** A **Count** length array of **PointS** objects, specified in \[MS-WMF\] section 2.2.2.16, which specifies the array of points. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYLINE Record + +The EMR_POLYLINE record specifies a series of line segments by connecting the points in the specified array. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYLINE**. This value is 0x00000004. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points in the **aPoints** array. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. + +**aPoints (variable):** A **Count** length array of PointL objects (\[MS-WMF\] section 2.2.2.15) that specifies the point data, in logical units. + +The line segments SHOULD be drawn using the current pen. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYLINE16 Record + +The EMR_POLYLINE16 record specifies a series of line segments by connecting the points in the specified array. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYLINE16**. This value is 0x00000057. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object, specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19, which specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points. + +**aPoints (variable):** A **Count** length array of **PointS** objects, specified in \[MS-WMF\] section 2.2.2.16, which specifies the array of points. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYLINETO Record + +The EMR_POLYLINETO record specifies one or more straight lines based upon the current drawing position. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYLINETO**. This value is 0x00000006. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object, specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19, which specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points in the **aPoints** array. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. + +**aPoints (variable):** A **Count** length array of PointL objects (\[MS-WMF\] section 2.2.2.15, which specifies the point data, in logical units. + +A line SHOULD be drawn from the current position to the first point specified by the **aPoints** field using the current pen. Each additional line SHOULD be drawn from the ending point of the previous line to the next point specified by **aPoints**. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYLINETO16 Record + +The EMR_POLYLINETO16 record specifies one or more straight lines based upon the current drawing position. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYLINETO16**. This value is 0x00000059. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19, which specifies the bounding rectangle in logical units. + +**Count (4 bytes):** An unsigned integer that specifies the number of points. + +**aPoints (variable):** A **Count** length array of **PointS** objects (\[MS-WMF\] section 2.2.2.16, which specifies the array of points. + +A line is drawn from the current drawing position to the first point specified by the **aPoints** field by using the current pen. For each additional line, drawing is performed from the ending point of the previous line to the next point specified by **aPoints**. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYPOLYGON Record + +The EMR_POLYPOLYGON record specifies a series of closed polygons. + +Fields not specified in this section are specified in section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYPOLYGON**. This value is 0x00000008. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**NumberOfPolygons (4 bytes):** An unsigned integer that specifies the number of polygons. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points in all polygons. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. To draw a line with more points, the data SHOULD be divided into groups that have less than the maximum number of points, and an EMR_POLYPOLYGON operation SHOULD be performed for each group of points. + +**PolygonPointCount (variable):** An array of 32-bit unsigned integers that specifies the point count for each polygon. + +**aPoints (variable):** An array of PointL objects (\[MS-WMF\] section 2.2.2.15) that specifies the points for all polygons in logical units. The number of points is specified by the **Count** field value. + +Each polygon SHOULD be outlined using the current pen, and filled using the current brush and polygon fill mode that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The polygons defined by this record can overlap. + +See section 2.3.5 for more drawing record types. + +#### EMR_POLYPOLYGON16 Record + +The EMR_POLYPOLYGON16 record specifies a series of closed polygons. Each polygon is outlined using the current pen, and filled using the current brush and polygon fill mode. The polygons drawn by this record can overlap. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYPOLYGON16**. This value is 0x0000005B. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the bounding rectangle in logical units. + +**NumberOfPolygons (4 bytes):** An unsigned integer that specifies the number of polygons. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points in all polygons. + +**PolygonPointCount (variable):** A **NumberOfPolygons** length array of 32-bit unsigned integers that specifies the point counts for each polygon. + +**aPoints (variable):** A **Count** length array of **PointS** objects (\[MS-WMF\] section 2.2.2.16), which specifies the array of points. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYPOLYLINE Record + +The EMR_POLYPOLYLINE record draws multiple series of connected line segments. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYPOLYLINE**. This value is 0x00000007. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**NumberOfPolylines (4 bytes):** An unsigned integer that specifies the number of polylines, which is the number of elements in the **aPolylinePointCount** array. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points in all polylines, which is the number of elements in the **aPoints** array. + +| Line width | Device supports wideline | Maximum points allowed | +|------------|--------------------------|------------------------| +| 1 | n/a | 16K | +| \> 1 | yes | 16K | +| \> 1 | no | 1360 | + +Any extra points MUST be ignored. + +**aPolylinePointCount (variable):** A **NumberOfPolylines**-length array of 32-bit unsigned integers that specify the point counts for all polylines. Each value MUST be \>= 0x00000002. + +Each point count refers to a number of consecutive elements in the **aPoints** array. + +**aPoints (variable):** A **Count**-length array of PointL objects (\[MS-WMF\] section 2.2.2.15) that specify the point data, in logical units. + +The line segments SHOULD be drawn using the current pen. The figures formed by the segments SHOULD NOT filled. The current drawing position SHOULD neither be used nor updated by this record. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYPOLYLINE16 Record + +The EMR_POLYPOLYLINE16 record specifies multiple series of connected line segments. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYPOLYLINE16**. This value is 0x0000005A. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the bounding rectangle in logical units. + +**NumberOfPolylines (4 bytes):** An unsigned integer that specifies the number of polylines. + +**Count (4 bytes):** An unsigned integer that specifies the total number of points in all polylines. + +**PolylinePointCount (variable):** A **NumberOfPolylines** length array of 32-bit unsigned integers that specifies the point counts for each polyline. + +**aPoints (variable):** A **Count** length array of **PointS** objects (\[MS-WMF\] section 2.2.2.16), which specifies the array of points. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_POLYTEXTOUTA Record + +The EMR_POLYTEXTOUTA record draws one or more [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) text strings using the current font and text colors. + +Fields not specified in this section are specified in section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYTEXTOUTA**. This value is 0x00000060. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the bounding rectangle in logical units. + +**iGraphicsMode (4 bytes):** An unsigned integer that specifies the current graphics mode, from the [GraphicsMode](#Section_fe60a5a523044b639949e11bfdbebae9) enumeration (section 2.1.16). + +**exScale (4 bytes):** A FLOAT value that specifies the X scale from page units to .01mm units if graphics mode is **GM_COMPATIBLE**. + +**eyScale (4 bytes):** A FLOAT value that specifies the Y scale from page units to .01mm units if graphics mode is **GM_COMPATIBLE**. + +**cStrings (4 bytes):** An unsigned integer that specifies the number of **EmrText** objects. + +**aEmrText (variable):** An array of [EmrText](#Section_dd585d0a5d7c4034963a1141af836972) objects (section 2.2.5) that specify the output strings in 8-bit ASCII characters, with text attributes, and spacing values. The number of EmrText objects is specified by **cStrings**. + +The font and text colors used for output are specified by properties in the current state of EMF metafile playback (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +EMR_POLYTEXTOUTA SHOULD[\<70\>](#Appendix_A_70) be emulated with a series of [EMR_EXTTEXTOUTW](#Section_a59a79ac328e492da34de02727af6edf) records (section [2.3.5.7](#Section_6b582a713c294fc6a0f41f8a313739a1)), one per string. This requires the ASCII text string in each EmrText object to be converted to [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) encoding. + +See section 2.3.5 for more drawing record types. + +#### EMR_POLYTEXTOUTW Record + +The EMR_POLYTEXTOUTW record draws one or more [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) text strings using the current font and text colors. + +Fields not specified in this section are specified in section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_POLYTEXTOUTW**. This value is 0x00000061. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the bounding rectangle in logical units. + +**iGraphicsMode (4 bytes):** An unsigned integer that specifies the current graphics mode. Graphics modes are specified in section [2.1.16](#Section_fe60a5a523044b639949e11bfdbebae9). + +**exScale (4 bytes):** A FLOAT value that specifies the X scale from page units to .01mm units if graphics mode is **GM_COMPATIBLE**. + +**eyScale (4 bytes):** A FLOAT value that specifies the X scale from page units to .01mm units if graphics mode is **GM_COMPATIBLE**. + +**cStrings (4 bytes):** An unsigned integer that specifies the number of **EmrText** objects. + +**wEmrText (variable):** An array of [EmrText objects (section 2.2.5)](#Section_dd585d0a5d7c4034963a1141af836972) that specify the output strings in Unicode [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) characters, with text attributes and spacing values. The number of EmrText objects is specified by **cStrings**. + +The font and text colors used for output are specified by properties in the current state of the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +EMR_POLYTEXTOUTW SHOULD be emulated with a series of [EMR_EXTTEXTOUTW](#Section_a59a79ac328e492da34de02727af6edf) records (section [2.3.5.7](#Section_6b582a713c294fc6a0f41f8a313739a1)), one per string.[\<71\>](#Appendix_A_71) + +See section 2.3.5 for more drawing record types. + +#### EMR_RECTANGLE Record + +The EMR_RECTANGLE record draws a rectangle. The rectangle is outlined by using the current pen and filled by using the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_RECTANGLE**. This value is 0x0000002B. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) rectangle to draw. + +The current drawing position is neither used nor updated by this record. + +If a **PS_NULL** pen is used, the dimensions of the rectangle are 1 pixel less in height and 1 pixel less in width. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_ROUNDRECT Record + +The EMR_ROUNDRECT record specifies a rectangle with rounded corners. The rectangle is outlined by using the current pen and filled by using the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_ROUNDRECT**. This value is 0x0000002C. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Box (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19), which specifies the [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounding rectangle, in logical coordinates. + +**Corner (8 bytes):** A 64-bit **SizeL** object (\[MS-WMF\] section 2.2.2.22), which specifies the **width** and **height**, in logical coordinates, of the ellipse used to draw the rounded corners. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_SETPIXELV Record + +The EMR_SETPIXELV record defines the color of the pixel at the specified logical coordinates. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETPIXELV**. This value is 0x0000000F. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Pixel (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15) that specifies the logical coordinates for the pixel. + +**Color (4 bytes):** A 32-bit ColorRef object (\[MS-WMF\] section 2.2.2.8) that specifies the pixel color. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_SMALLTEXTOUT Record + +The EMR_SMALLTEXTOUT record outputs a string. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SMALLTEXTOUT**. This value is 0x0000006C. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**x (4 bytes):** A signed integer specifying the x-coordinate of where to place the string. + +**y (4 bytes):** A signed integer specifying the y-coordinate of where to place the string. + +**cChars (4 bytes):** An unsigned integer specifying the number of 16-bit characters in the string. The string is NOT null-terminated. + +**fuOptions (4 bytes):** An unsigned integer specifying the text output options to use. These options are specified by one or a combination of values from the [ExtTextOutOptions enumeration (section 2.1.11)](#Section_e7ffcc5340d148738edac5c5ee104aa5). + +**iGraphicsMode (4 bytes):** An unsigned integer specifying the graphics mode, from the [GraphicsMode enumeration (section 2.1.16)](#Section_fe60a5a523044b639949e11bfdbebae9). + +**exScale (4 bytes):** A FLOAT value that specifies how much to scale the text in the x-direction. + +**eyScale (4 bytes):** A FLOAT value that specifies how much to scale the text in the y-direction. + +**Bounds (16 bytes, optional):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +**TextString (variable):** A string that contains the text string to draw, in either 8-bit or 16-bit character codes, according to the value of the **fuOptions** field. + +If **ETO_SMALL_CHARS** is set in the **fuOptions** field, **TextString** contains 8-bit codes for characters, derived from the low bytes of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) character codes, in which the high byte is assumed to be 0. + +If **ETO_NO_RECT** is set in the **fuOptions** field, the **Bounds** field is not included in the record. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_STROKEANDFILLPATH Record + +The EMR_STROKEANDFILLPATH record closes any open figures in a path, strokes the outline of the path by using the current pen, and fills its interior by using the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_STROKEANDFILLPATH**. This value is 0x0000003F. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_STROKEPATH Record + +The EMR_STROKEPATH record renders the specified path by using the current pen. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_STROKEPATH**. This value is 0x00000040. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the bounding rectangle in logical units. + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +### Escape Record Types + +The **Escape** record types execute [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) functions. + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) escape record types. + +| Name | Section | Description | +|----|----|----| +| EMR_DRAWESCAPE | [2.3.6.1](#Section_86405bb1cc2c42bc9e0f28874f208d98) | Passes arbitrary information to the printer driver. The intent is that the information results in drawing being done. | +| EMR_EXTESCAPE | [2.3.6.2](#Section_a31ef1e754ba41aeb79de6fd102dc6b1) | Passes arbitrary information to the printer driver. The intent is that the information does not result in drawing being done. | +| EMR_NAMEDESCAPE | [2.3.6.3](#Section_125759e0c8394dc1b5fbe014e7e1159e) | Passes arbitrary information to the given named printer driver. | + +The generic structure of escape records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of the record. The escape record types are listed in the following table. See the preceding table for descriptions of these records. + +| Name | Value | +|-----------------|------------| +| EMR_DRAWESCAPE | 0x00000069 | +| EMR_EXTESCAPE | 0x0000006A | +| EMR_NAMEDESCAPE | 0x0000006E | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**iEscape (4 bytes):** An unsigned integer that specifies the printer driver escape to execute. This MUST be one of the values in the MetafileEscapes enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.17). + +**EscapeRecordBuffer (variable):** An array of bytes that contains the remainder of the escape record. + +[TABLE] + +> **EscapeRecordParm (variable):** An array of bytes that contains the parameters for the escape record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_DRAWESCAPE Record + +The EMR_DRAWESCAPE record passes arbitrary information to a [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). The intent is that the information results in drawing being done. + +Fields not specified in this section are specified in section [2.3.6](#Section_5370873a5fe64fdd8c5abade4ee54a1f). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type from the RecordType enumeration (section [2.1.1](#Section_1eec80ba799b4784a9ac91597d590ae1)). It MUST be **EMR_DRAWESCAPE**, which is 0x00000069. + +**cjIn (4 bytes):** An unsigned integer specifying the number of bytes to pass to the printer driver. + +**Data (variable):** The data to pass to the printer driver. There MUST be **cjIn** bytes available. + +See section 2.3.6 for more escape record types. + +#### EMR_EXTESCAPE Record + +The EMR_EXTESCAPE record passes arbitrary information to a [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). The intent is that the information does not result in drawing being done. + +Fields not specified in this section are specified in section [2.3.6](#Section_5370873a5fe64fdd8c5abade4ee54a1f). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type from the RecordType enumeration (section [2.1.1](#Section_1eec80ba799b4784a9ac91597d590ae1)). This value is 0x0000006A. + +**cjIn (4 bytes):** An unsigned integer specifying the number of bytes to pass to the printer driver. + +**Data (variable):** The data to pass to the printer driver. There MUST be **cjIn** bytes available. + +See section 2.3.6 for more escape record types. + +#### EMR_NAMEDESCAPE Record + +The **EMR_NAMEDESCAPE** record passes arbitrary information to a named [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +Fields not specified in this section are specified in section [2.3.6](#Section_5370873a5fe64fdd8c5abade4ee54a1f). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type from the RecordType enumeration (section [2.1.1](#Section_1eec80ba799b4784a9ac91597d590ae1)). It MUST be EMR_NAMEDESCAPE, which is 0x0000006E. + +**cjDriver (4 bytes):** An unsigned integer that specifies the number of bytes in the **DriverName** field. This value MUST be an even number. + +**cjIn (4 bytes):** An unsigned integer specifying the number of bytes in the **Data** field to pass to the printer driver. + +**DriverName (variable):** A null-terminated string of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that specifies the name of the printer driver to receive data. + +**Data (variable):** The data to pass to the printer driver. + +See section 2.3.6 for more escape record types. + +### Object Creation Record Types + +The **Object Creation** record types create graphics objects. + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) object creation record types. + +| Name | Section | Description | +|----|----|----| +| EMR_CREATEBRUSHINDIRECT | [2.3.7.1](#Section_b9a8ef5d00894e42b317e6ebc0ff098f) | Defines a logical brush with a LogBrushEx object (section [2.2.12](#Section_6d790f8d51654746bac33443915c2071)). | +| EMR_CREATECOLORSPACE | [2.3.7.2](#Section_954af0ffa8d74d3480ed89f570bac016) | Defines a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) with a LogColorSpace object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.11). | +| EMR_CREATECOLORSPACEW | [2.3.7.3](#Section_d1cd21477fb64d978f7ea289006b6064) | Defines a logical color space with a LogColorSpaceW object (\[MS-WMF\] section 2.2.2.12). | +| EMR_CREATEDIBPATTERNBRUSHPT | [2.3.7.4](#Section_332116b4c6f94b18a7cc22c531b52afc) | Defines a pattern brush with a DeviceIndependentBitmap object (\[MS-WMF\] section 2.2.2.9). | +| EMR_CREATEMONOBRUSH | [2.3.7.5](#Section_49b4227731b04eb9a6af86d9be9b568f) | Defines a monochrome pattern brush with a monochrome DeviceIndependentBitmap object. | +| EMR_CREATEPALETTE | [2.3.7.6](#Section_07e1492be4bb4394934f4eaee67ab8ff) | Defines a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) with a LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)). | +| EMR_CREATEPEN | [2.3.7.7](#Section_2374647fdf6748e386aa384715c28e71) | Defines a logical pen with a LogPen object (section [2.2.19](#Section_93ce3f4537ac4affb6e82f6db054c4c4)). | +| EMR_EXTCREATEFONTINDIRECTW | [2.3.7.8](#Section_7e266b6d32e54201b6878ec40c24cd73) | Defines a logical font with either a LogFont object (section [2.2.13](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100)) or LogFontExDv object (section [2.2.15](#Section_595fcaaebc3741489afe859e81ca7f76)). | +| EMR_EXTCREATEPEN | [2.3.7.9](#Section_d7f51e054024497cad4a8aeca9d34256) | Defines a logical pen with a LogPenEx object (section [2.2.20](#Section_5b67b3eeea004f809b732959804381be)) and optional DeviceIndependentBitmap object. | + +The generic structure of object creation records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The object creation record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|-----------------------------|------------| +| EMR_CREATEMONOBRUSH | 0x0000005D | +| EMR_CREATEDIBPATTERNBRUSHPT | 0x0000005E | +| EMR_EXTCREATEPEN | 0x0000005F | +| EMR_CREATECOLORSPACEW | 0x0000007A | +| EMR_CREATEPEN | 0x00000026 | +| EMR_CREATEBRUSHINDIRECT | 0x00000027 | +| EMR_CREATEPALETTE | 0x00000031 | +| EMR_EXTCREATEFONTINDIRECTW | 0x00000052 | +| EMR_CREATECOLORSPACE | 0x00000063 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**ObjectRecordBuffer (variable):** An array of bytes that contains the remainder of the object creation record. + +[TABLE] + +> **ObjectRecordParm (variable):** An array of bytes that contains the parameters for the object creation record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_CREATEBRUSHINDIRECT Record + +The **EMR_CREATEBRUSHINDIRECT** record defines a logical brush for graphics operations. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_CREATEBRUSHINDIRECT. This value is 0x00000027. + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes, of this record. This value is 0x00000018. + +**ihBrush (4 bytes):** An unsigned integer that specifies the index of the logical brush object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index is used to refer to the object, so it can be reused or modified. + +**LogBrush (12 bytes):** A LogBrushEx object (section [2.2.12](#Section_6d790f8d51654746bac33443915c2071)) that specifies the style, color, and pattern of the logical brush. The **BrushStyle** field in this object MUST be BS_SOLID, BS_HATCHED, or BS_NULL. + +See section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18) for more object creation record types. + +#### EMR_CREATECOLORSPACE Record + +The **EMR_CREATECOLORSPACE** record creates a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) object from a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) with a name consisting of [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters.[\<72\>](#Appendix_A_72) + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_CREATECOLORSPACE**. This value is 0x00000063. + +**ihCS (4 bytes):** An unsigned integer that specifies the index of the logical color space object in the **EMF object table** (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**lcs (variable):** A LogColorSpace object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.11), which can specify the name of a color profile in ASCII characters. + +The logical color space object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an EMR_SETCOLORSPACE record (section [2.3.8.7](#Section_2a84d7a5f8c14dd2ae79a029a25ad601)), which defines the logical color space to use in subsequent graphics operations. + +See section 2.3.7 for more object creation record types. + +#### EMR_CREATECOLORSPACEW Record + +The EMR_CREATECOLORSPACEW record creates a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) object from a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) with a name consisting of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters.[\<73\>](#Appendix_A_73) + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_CREATECOLORSPACEW**. This value is 0x0000007A. + +**ihCS (4 bytes):** An unsigned integer that specifies the index of the logical color space object in the **EMF object table** (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**lcs (variable):** A LogColorSpaceW object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.12) that can specify the name of a color profile in Unicode [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) characters. + +**dwFlags (4 bytes):** An unsigned integer that provides information about the data in this record. + +[TABLE] + +> **C (1 bit):** If set, the **Data** field contains color profile data. + +**cbData (4 bytes):** An unsigned integer that specifies the size in bytes, of the **Data** field. + +**Data (variable, optional):** An array of bytes that specifies color profile data. When **cbData** is zero, this field is optional and is ignored. + +The logical color space object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an EMR_SETCOLORSPACE record (section [2.3.8.7](#Section_2a84d7a5f8c14dd2ae79a029a25ad601)), which defines the logical color spaceto use in subsequent graphics operations. + +See section 2.3.7 for more object creation record types. + +#### EMR_CREATEDIBPATTERNBRUSHPT Record + +The EMR_CREATEDIBPATTERNBRUSHPT record defines a pattern brush for graphics operations. The pattern is specified by a [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_CREATEDIBPATTERNBRUSHPT. This value is 0x0000005E. + +**ihBrush (4 bytes):** An unsigned integer that specifies the index of the pattern brush object in the **EMF object table** (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**Usage (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the DIB header. This value is in the DIBColors enumeration (section [2.1.9](#Section_a5e722e3891a4a67be1aed5a48a7fda1)). + +**offBmi (4 bytes):** An unsigned integer that specifies the offset from the start of this record to the DIB header. + +**cbBmi (4 bytes):** An unsigned integer that specifies the size of the DIB header. + +**offBits (4 bytes):** An unsigned integer that specifies the offset from the start of this record to the DIB bits. + +**cbBits (4 bytes):** An unsigned integer that specifies the size of the DIB bits. + +**BitmapBuffer (variable):** A buffer containing a [**packed DIB**](#gt_6b4f9d56-b04f-4fd3-a069-412866dcce4d) in the form of a DeviceIndependentBitmap object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9). It is not required to be contiguous with the fixed portion of this record. + +[TABLE] + +> **UndefinedSpace (variable, optional):** An array of bytes that MUST be ignored. +> +> **BmiSrc (variable):** The DIB header, which is the **DibHeaderInfo** field of a DeviceIndependentBitmap object. +> +> **BitsSrc (variable):** The DIB bits, which is the **aData** field of a DeviceIndependentBitmap object. + +The pattern brush object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an EMR_SELECTOBJECT record (section [2.3.8.5](#Section_145b063d5f9641feb7ae1e615b2bc2bf)), which specifies the pattern brush to use in subsequent graphics operations. + +See section 2.3.7 for more object creation record types. + +#### EMR_CREATEMONOBRUSH Record + +The **EMR_CREATEMONOBRUSH** record defines a monochrome pattern brush for graphics operations. The pattern is specified by a monochrome [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_CREATEMONOBRUSH**. This value is 0x0000005D. + +**ihBrush (4 bytes):** An unsigned integer that specifies the index of the monochrome pattern brush object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**Usage (4 bytes):** An unsigned integer that specifies how to interpret values in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) in the DIB header. This value is in the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmi (4 bytes):** An unsigned integer that specifies the offset from the start of this record to the DIB header. + +**cbBmi (4 bytes):** An unsigned integer that specifies the size of the DIB header. + +**offBits (4 bytes):** An unsigned integer that specifies the offset from the start of this record to the DIB bits. + +**cbBits (4 bytes):** An unsigned integer that specifies the size of the DIB bits. + +**BitmapBuffer (variable):** A buffer containing a [**packed DIB**](#gt_6b4f9d56-b04f-4fd3-a069-412866dcce4d) in the form of a monochrome DeviceIndependentBitmap object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9). It is not required to be contiguous with the fixed portion of this record. + +[TABLE] + +> **UndefinedSpace (variable, optional):** An array of bytes that MUST be ignored. +> +> **BmiSrc (variable):** The DIB header, which is the **DibHeaderInfo** field of a DeviceIndependentBitmap object. +> +> **BitsSrc (variable):** The DIB bits, which is the **aData** field of a DeviceIndependentBitmap object. + +The monochrome pattern brush object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an EMR_SELECTOBJECT record (section [2.3.8.5](#Section_145b063d5f9641feb7ae1e615b2bc2bf)), which specifies the pattern brush to use in subsequent graphics operations. + +See section 2.3.7 for more object creation record types. + +#### EMR_CREATEPALETTE Record + +The EMR_CREATEPALETTE record defines a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) for graphics operations. + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_CREATEPALETTE**. This value is 0x00000031. + +**ihPal (4 bytes):** An unsigned integer that specifies the index of the logical palette object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**LogPalette (variable):** A [LogPalette](#Section_758f047d765e424c9204a833b7b4e527) object (section 2.2.17). The **Version** field of this object MUST be set to 0x0300. If the **NumberOfEntries** value in this object is zero, processing of this record MUST fail. + +The logical palette defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an [EMR_SELECTPALETTE](#Section_e6a4ce2a209d43dfb7635d8e54c21a10) record (section 2.3.8.6), which specifies the logical palette to use in subsequent graphics operations. + +See section 2.3.7 for more object creation record types. + +#### EMR_CREATEPEN Record + +The EMR_CREATEPEN record defines a logical pen for graphics operations. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_CREATEPEN**. This value is 0x00000026. + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes, of this record. This value is 0x0000001C. + +**ihPen (4 bytes):** An unsigned integer that specifies the index of the logical pen object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**LogPen (16 bytes):** A [LogPen](#Section_93ce3f4537ac4affb6e82f6db054c4c4) object (section 2.2.19) that specifies the style, width, and color of the logical pen. + +The logical pen object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5), which specifies the logical pen to use in subsequent graphics operations. + +See section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18) for more object creation record types. + +#### EMR_EXTCREATEFONTINDIRECTW Record + +The **EMR_EXTCREATEFONTINDIRECTW** record defines a logical font for graphics operations. + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_EXTCREATEFONTINDIRECTW**. This value is 0x00000052. + +**ihFonts (4 bytes):** An unsigned integer that specifies the index of the logical font object in the **EMF object table** (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**elw (variable):** A LogFontExDv object (section [2.2.15](#Section_595fcaaebc3741489afe859e81ca7f76)), which specifies the logical font. A LogFont object (section [2.2.13](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100)) MAY[\<74\>](#Appendix_A_74) be present instead. The process for determining the type of object in this field is described below. + +The logical font object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an EMR_SELECTOBJECT record (section [2.3.8.5](#Section_145b063d5f9641feb7ae1e615b2bc2bf)), which specifies the logical font to use in subsequent graphics operations. + +The type of logical font object in the **elw** field of this record is determined by the following algorithm (all size and length values are in bytes): + +- First, note that the size in bytes of the static part of this record—that is, the sum of the sizes of its **Type**, **Size**, and **ihFonts** fields—is 12. + +- Next, note that because the size in bytes of the entire record is present in its **Size** field, the size in bytes of the variable-length **elw** field can be computed as follows. + +509. Size - 12 + +- The size of the **elw** field must be equal to or greater than the size of a **LogFontPanose** object.[\<75\>](#Appendix_A_75) + +- If the size of the **elw** field is equal to the size of a **LogFontPanose** object (section [2.2.16](#Section_c68ffff81c324398ac812cb6f0cd7a7c)), **elw** MUST be treated as a fixed-length **LogFontPanose** object. + +- If the size of the **elw** field is greater than the size of a **LogFontPanose** object, then **elw** MUST be treated as a variable-length **LogFontExDv** object. + +The size of a LogFontPanose object is 0x0140 (320 decimal). It is determined by adding up the sizes of its fields, as follows: + +- **LogFont**: The size of a LogFont object is 0x005C (92 decimal). It is determined by adding up the sizes of its fields, as follows: + + - Fields from **Height** through **PitchAndFamily**: 0x001C (28 decimal). + + - **Facename**: The length is 32 16-bit characters: 0x0040 (64 decimal). + +- **Fullname**: The length is 64 16-bit characters: 0x0080 (128 decimal). + +- **Style**: The length is 32 16-bit characters: 0x0040 (64 decimal). + +- Fields from **Version** through **Culture**: 0x0018 (24 decimal). + +- **Panose**: The exact length of this field is 0x000A, but it MUST be padded by two additional bytes for 32-bit alignment, so for the purposes of this computation the length is 0x000C (12 decimal). + +See section 2.3.7 for more object creation record types. + +#### EMR_EXTCREATEPEN Record + +The **EMR_EXTCREATEPEN** record defines an extended logical pen for graphics operations. An optional [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) can be specified to use as the line style. + +Fields not specified in this section are specified in section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_EXTCREATEPEN**. This value is 0x0000005F. + +**ihPen (4 bytes):** An unsigned integer that specifies the index of the extended logical pen object in the **EMF object table** (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). This index MUST be saved so that this object can be reused or modified. + +**offBmi (4 bytes):** An unsigned integer that specifies the offset from the start of this record to the DIB header if the record contains a DIB. + +**cbBmi (4 bytes):** An unsigned integer that specifies the size of the DIB header if the record contains a DIB. + +**offBits (4 bytes):** An unsigned integer that specifies the offset from the start of this record to the DIB bits if the record contains a DIB. + +**cbBits (4 bytes):** An unsigned integer that specifies the size of the DIB bits if the record contains a DIB. + +**elp (variable):** A LogPenEx object (section [2.2.20](#Section_5b67b3eeea004f809b732959804381be)) that specifies an extended logical pen with attributes including an optional line style array. + +**BitmapBuffer (variable, optional):** An array of bytes containing a [**packed DIB**](#gt_6b4f9d56-b04f-4fd3-a069-412866dcce4d) in the form of a DeviceIndependentBitmap object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9). It is not required to be contiguous with the fixed portion of this record. + +[TABLE] + +> **UndefinedSpace (variable, optional):** An array of bytes that MUST be ignored. +> +> **BmiSrc (variable):** The DIB header, which is the **DibHeaderInfo** field of a DeviceIndependentBitmap object. +> +> **BitsSrc (variable):** The DIB bits, which is the **aData** field of a DeviceIndependentBitmap object. + +The extended logical pen object defined by this record can be selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by an EMR_SELECTOBJECT record (section [2.3.8.5](#Section_145b063d5f9641feb7ae1e615b2bc2bf)), which specifies the logical pen to use in subsequent graphics operations. + +See section 2.3.7 for more object creation record types. + +### Object Manipulation Record Types + +The **Object Manipulation** record types manage and modify graphics objects. + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) object manipulation record types. + +| Name | Section | Description | +|----|----|----| +| EMR_COLORCORRECTPALETTE | [2.3.8.1](#Section_99de1bfb3d77455b86797386903e1472) | Specifies how to correct the entries of a LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) by using [**WCS**](#gt_e4f9c4a4-c195-43d0-b189-f9727ec8a2b3) values. | +| EMR_DELETECOLORSPACE | [2.3.8.2](#Section_5d137387d79a4bc89a4d38291320e148) | Specifies how to delete a logical color space from the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). | +| EMR_DELETEOBJECT | [2.3.8.3](#Section_6f0f12a3111a478b8251a9505168f9a9) | Specifies the index of the object to be deleted from the EMF object table. | +| EMR_RESIZEPALETTE | [2.3.8.4](#Section_ec78933296b54bb89d7c8b5c8c0da8b9) | Increases or decreases the size of an existing LogPalette object. | +| EMR_SELECTOBJECT | [2.3.8.5](#Section_145b063d5f9641feb7ae1e615b2bc2bf) | Specifies an existing object based on its index in the EMF object table and selects it into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) | +| EMR_SELECTPALETTE | [2.3.8.6](#Section_e6a4ce2a209d43dfb7635d8e54c21a10) | Selects the specified LogPalette object into the playback device context. | +| EMR_SETCOLORSPACE | [2.3.8.7](#Section_2a84d7a5f8c14dd2ae79a029a25ad601) | Specifies a logical color space, based on its index in the EMF object table. | +| EMR_SETPALETTEENTRIES | [2.3.8.8](#Section_883482963c9a488fbbf719c897535372) | Defines [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color values in a range of entries for an existing LogPalette object. | + +The generic structure of object manipulation records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The object manipulation record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|-------------------------|------------| +| EMR_SELECTOBJECT | 0x00000025 | +| EMR_DELETEOBJECT | 0x00000028 | +| EMR_SELECTPALETTE | 0x00000030 | +| EMR_SETPALETTEENTRIES | 0x00000032 | +| EMR_RESIZEPALETTE | 0x00000033 | +| EMR_SETCOLORSPACE | 0x00000064 | +| EMR_DELETECOLORSPACE | 0x00000065 | +| EMR_COLORCORRECTPALETTE | 0x0000006F | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**ObjectRecordBuffer (variable):** An array of bytes that contains the remainder of the object manipulation record. + +[TABLE] + +> **ObjectRecordParm (variable):** An array of bytes that contains the parameters for the object manipulation record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_COLORCORRECTPALETTE Record + +The **EMR_COLORCORRECTPALETTE** record specifies the correction of entries of a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) object using [**WCS**](#gt_e4f9c4a4-c195-43d0-b189-f9727ec8a2b3).[\<76\>](#Appendix_A_76) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_COLORCORRECTPALETTE**. This value is 0x0000006F. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x00000018. + +**ihPalette (4 bytes):** An unsigned integer that specifies the index of a logical palette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) in the **EMF object table** (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +**nFirstEntry (4 bytes):** An unsigned integer that specifies the index of the first entry to correct. + +**nPalEntries (4 bytes):** An unsigned integer that specifies the number of [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) entries to correct. + +**nReserved (4 bytes):** An unsigned integer that is undefined and unused. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_DELETECOLORSPACE Record + +The **EMR_DELETECOLORSPACE** record deletes a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) object.[\<77\>](#Appendix_A_77) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_DELETECOLORSPACE**. This value is 0x00000065. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ihCS (4 bytes):** An unsigned integer that specifies the index of a logical color space object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +The color space is specified by either a LogColorSpace or LogColorSpaceW object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) sections 2.2.2.11 and 2.2.2.12, respectively). If the deleted color space is currently selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45), the default object MUST be restored. + +An EMR_DELETEOBJECT record (section [2.3.8.3](#Section_6f0f12a3111a478b8251a9505168f9a9)) SHOULD be used instead of this record to delete a logical color space object. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_DELETEOBJECT Record + +The **EMR_DELETEOBJECT** record deletes a graphics object, which is specified by its index in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_DELETEOBJECT**. This value is 0x00000028. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ihObject (4 bytes):** An unsigned integer that specifies the index of a graphics object in the EMF object table. + +This value MUST NOT be 0, which is a reserved index that refers to the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) itself; and it MUST NOT be the index of a [**stock object**](#gt_b1328cb9-acd8-47f8-9896-fe985af2d6d6), which cannot be deleted. Stock object indexes are specified in the StockObject (section [2.1.31](#Section_d6dffd25861542f8aed1309f1fe54ab2)) enumeration. + +The object specified by this record MUST be deleted from the EMF object table. If the deleted object is currently selected into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45), the default object MUST be restored. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_RESIZEPALETTE Record + +The **EMR_RESIZEPALETTE** record increases or decreases the size of an existing LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_RESIZEPALETTE**. This value is 0x00000033. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ihPal (4 bytes):** An unsigned integer that specifies the index of the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +**NumberOfEntries (4 bytes):** An unsigned integer that specifies the number of entries in the palette after resizing. The value MUST be \<= 0x00000400 and \> 0x00000000.[\<78\>](#Appendix_A_78) + +The new size of the LogPalette object MUST be reflected in the **NumberOfEntries** field in that structure. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_SELECTOBJECT Record + +The **EMR_SELECTOBJECT** record selects a graphics object into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SELECTOBJECT**. This value is 0x00000025. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ihObject (4 bytes):** An unsigned integer that specifies either the index of a graphics object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)) or the index of a [**stock object**](#gt_b1328cb9-acd8-47f8-9896-fe985af2d6d6) in the StockObject enumeration (section [2.1.31](#Section_d6dffd25861542f8aed1309f1fe54ab2)). + +The object index MUST NOT be zero, which is reserved and refers to the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) itself. + +The object specified by this record MUST be used in subsequent EMF drawing operations, until another EMR_SELECTOBJECT record changes the object of that type or the object is deleted. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_SELECTPALETTE Record + +The **EMR_SELECTPALETTE** record selects a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SELECTPALETTE. This value is 0x00000030. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x0000000C. + +**ihPal (4 bytes):** An unsigned integer that specifies either the index of a LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) in the [EMF object table](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4) (section 3.1.1.1) or the value DEFAULT_PALETTE from the StockObject enumeration (section [2.1.31](#Section_d6dffd25861542f8aed1309f1fe54ab2)), which is the index of a stock [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). + +The object index MUST NOT be zero, which is reserved and refers to the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) itself. + +The palette specified by this record MUST be used in subsequent EMF drawing operations, until another EMR_SELECTPALETTE record changes the object or the object is deleted. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_SETCOLORSPACE Record + +The **EMR_SETCOLORSPACE** record selects a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45).[\<79\>](#Appendix_A_79) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETCOLORSPACE**. This value is 0x00000064. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x0000000C. + +**ihCS (4 bytes):** An unsigned integer that specifies the index of a logical color space object in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +This object is either a LogColorSpace or LogColorSpaceW object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) sections 2.2.2.11 and 2.2.2.12, respectively). + +The color space specified by this record MUST be used in subsequent EMF drawing operations, until another EMR_SETCOLORSPACE record changes the object or the object is deleted. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +#### EMR_SETPALETTEENTRIES Record + +The **EMR_SETPALETTEENTRIES** record defines [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color values in a range of entries for an existing [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETPALETTEENTRIES. This value is 0x00000032. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ihPal (4 bytes):** An unsigned integer that specifies an index of a LogPalette object (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) in the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +**Start (4 bytes):** An unsigned integer that specifies the index in the palette of the first entry to set. + +**NumberofEntries (4 bytes):** An unsigned integer that specifies the number of entries in the **aPalEntries** array. + +**aPalEntries (variable):** An array of LogPaletteEntry objects (section [2.2.18](#Section_c1f7b285be164112a4e60b2fd4c1d148)) that specify the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) data. + +See section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998) for more object manipulation record types. + +### OpenGL Record Types + +The **OpenGL** record types specify [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) functions [\[OPENGL\]](https://go.microsoft.com/fwlink/?LinkId=90241). + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) OpenGL record types.[\<80\>](#Appendix_A_80) + +| Name | Section | Description | +|----|----|----| +| EMR_GLSBOUNDEDRECORD | [2.3.9.1](#Section_cb5036dac79d4aaeb1c0a48361447a0b) | Specifies an OpenGL function with a bounding rectangle for output. | +| EMR_GLSRECORD | [2.3.9.2](#Section_4f2e25120c5d468bbb81484cb1d4aa89) | Specifies an OpenGL function. | + +The generic structure of OpenGL records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The OpenGL record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|----------------------|------------| +| EMR_GLSRECORD | 0x00000066 | +| EMR_GLSBOUNDEDRECORD | 0x00000067 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**OpenGLRecordBuffer (variable):** An array of bytes that contains the remainder of the OpenGL record. + +[TABLE] + +> **OpenGLRecordParm (variable):** An array of bytes that contains the parameters for the OpenGL record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +#### EMR_GLSBOUNDEDRECORD Record + +The **EMR_GLSBOUNDEDRECORD** record specifies an [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) function with a bounding rectangle for output. + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_GLSBOUNDEDRECORD. This value is 0x00000067. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that defines a bounding rectangle in logical units, for output produced by executing the OpenGL function. + +**cbData (4 bytes):** An unsigned integer that specifies the size of the **Data** field in bytes. If this value is zero, no data is attached to this record. + +**Data (variable, optional):** An array of bytes that specifies data for the OpenGL function. + +See section [2.3.9](#Section_4a6c2fc239af43b48254449f5f1c5c05) for more OpenGL record types. + +#### EMR_GLSRECORD Record + +The **EMR_GLSRECORD** record specifies an [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) function. + +Fields not specified in this section are specified in section [2.3.1](#Section_2a57d4bdf3dc45df95fd447382b5262a). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_GLSRECORD. This value is 0x00000066. + +**cbData (4 bytes):** An unsigned integer that specifies the size in bytes, of the **Data** field. If this value is zero, no data is attached to this record. + +**Data (variable, optional):** An array of bytes that specifies data for the OpenGL function. + +See section [2.3.9](#Section_4a6c2fc239af43b48254449f5f1c5c05) for more OpenGL record types. + +### Path Bracket Record Types + +The **Path Bracket** record types are used to construct a [**path bracket**](#gt_b89ea7da-c0bf-4c45-9f3e-fc430d7ab601), which defines the current [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +**Note:** None of the path bracket records specify parameters. + +The following are the path bracket record types. + +[TABLE] + +The generic structure of path bracket records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of the record. The types of records that specify no parameters are listed in the following table. See the preceding table for descriptions of these records. + +| Name | Value | +|-----------------|------------| +| EMR_BEGINPATH | 0x0000003B | +| EMR_ENDPATH | 0x0000003C | +| EMR_CLOSEFIGURE | 0x0000003D | +| EMR_FLATTENPATH | 0x00000041 | +| EMR_WIDENPATH | 0x00000042 | +| EMR_ABORTPATH | 0x00000044 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). For path bracket records, this value is 0x00000008 + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more EMF record types. + +### State Record Types + +The **State** record types specify graphics properties that define the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) during the processing of [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) records. For more information about the state used for metafile playback, see the Abstract Data Model section [3.1.1](#Section_fd90d425af0c493dbcb5f7d927f5ca20). + +**Note:** The EMR_REALIZEPALETTE and EMR_SAVEDC records do not specify parameters. + +The following are EMF state record types. + +[TABLE] + +The generic structure of state records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The state record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|--------------------------|------------| +| EMR_SETWINDOWORGEX | 0x0000000A | +| EMR_SETVIEWPORTEXTEX | 0x0000000B | +| EMR_SETVIEWPORTORGEX | 0x0000000C | +| EMR_SETBRUSHORGEX | 0x0000000D | +| EMR_SETCOLORADJUSTMENT | 0x00000017 | +| EMR_MOVETOEX | 0x0000001B | +| EMR_SCALEVIEWPORTEXTEX | 0x0000001F | +| EMR_SETWINDOWEXTEX | 0x00000009 | +| EMR_SETMAPPERFLAGS | 0x00000010 | +| EMR_SETMAPMODE | 0x00000011 | +| EMR_SETBKMODE | 0x00000012 | +| EMR_SETPOLYFILLMODE | 0x00000013 | +| EMR_SETROP2 | 0x00000014 | +| EMR_SETSTRETCHBLTMODE | 0x00000015 | +| EMR_SETTEXTALIGN | 0x00000016 | +| EMR_SETTEXTCOLOR | 0x00000018 | +| EMR_SETBKCOLOR | 0x00000019 | +| EMR_SCALEWINDOWEXTEX | 0x00000020 | +| EMR_SAVEDC | 0x00000021 | +| EMR_RESTOREDC | 0x00000022 | +| EMR_REALIZEPALETTE | 0x00000034 | +| EMR_SETARCDIRECTION | 0x00000039 | +| EMR_SETMITERLIMIT | 0x0000003A | +| EMR_INVERTRGN | 0x00000049 | +| EMR_SETICMMODE | 0x00000062 | +| EMR_PIXELFORMAT | 0x00000068 | +| EMR_FORCEUFIMAPPING | 0x0000006D | +| EMR_SETICMPROFILEA | 0x00000070 | +| EMR_SETICMPROFILEW | 0x00000071 | +| EMR_SETLAYOUT | 0x00000073 | +| EMR_SETLINKEDUFIS | 0x00000077 | +| EMR_SETTEXTJUSTIFICATION | 0x00000078 | +| EMR_COLORMATCHTOTARGETW | 0x00000079 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the metafile. This value MUST be a multiple of 4 bytes. + +**StateRecordBuffer (variable, optional):** An array of bytes that contains the remainder of the state record. + +The EMR_REALIZEPALETTE and EMR_SAVEDC records do not contain this field. + +[TABLE] + +> **StateRecordParm (variable):** An array of bytes that contains the parameters for the state record. +> +> **AlignmentPadding (variable, optional):** An array of up to 3 bytes that pads the record so that its total size is a multiple of 4 bytes. This field MUST be ignored. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more [EMF record types](#Section_1eec80ba799b4784a9ac91597d590ae1). + +#### EMR_COLORMATCHTOTARGETW Record + +The **EMR_COLORMATCHTOTARGETW** record specifies whether to perform [**color matching**](#gt_a3322d29-7dc5-4696-b17a-55311db1cb33) with a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) that is specified in a file with a name consisting of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters.[\<81\>](#Appendix_A_81) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_COLORMATCHTOTARGETW. This value is 0x00000079. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**dwAction (4 bytes):** An unsigned integer that specifies a value from the ColorSpace enumeration (section [2.1.7](#Section_75da12f8f43748e886774b46e0045969)). + +**dwFlags (4 bytes):** An unsigned integer that specifies a value from the ColorMatchToTarget enumeration (section [2.1.6](#Section_b63c02c176444ef3a4963127621cb7b5)). + +**cbName (4 bytes):** An unsigned integer that specifies the number of bytes in the Unicode [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) name of the target color profile. + +**cbData (4 bytes):** An unsigned integer that specifies the size of the raw data of the target color profile in the **Data** field. + +**Data (variable):** An array of size (**cbName** + **cbData**) bytes, which specifies the UTF16-LE name and raw data of the target color profile. + +An EMR_COLORMATCHTOTARGETW record can be used to control whether to apply the current color [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) to subsequent graphics operations. If the **dwAction** field value is **CS_ENABLE**, [**color mapping**](#gt_a216d932-5b97-4882-b1a1-58c47532795c) is enabled, and the current color transform SHOULD be applied. If **dwAction** is set to **CS_DISABLE**, the color transform SHOULD NOT be applied. + +Before applying the current color transform, [**WCS**](#gt_e4f9c4a4-c195-43d0-b189-f9727ec8a2b3) SHOULD be enabled in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45).[\<82\>](#Appendix_A_82) + +While color mapping to the target is enabled by a **dwAction** value of **CS_ENABLE**, changes to the [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) or [**color gamut**](#gt_cc6ddf19-b7de-4820-8b48-ecd73c45eef2) mapping are not applied. However, those changes MUST take effect when color mapping to the target is disabled. + +The **dwAction** field SHOULD NOT be set to **CS_DELETE_TRANSFORM** unless color management has already been enabled with an EMR_SETICMMODE record (section [2.3.11.14](#Section_a7c9d4834a2440588dc1b5e0809ea758)). + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_FORCEUFIMAPPING Record + +The **EMR_FORCEUFIMAPPING** record forces the font mapper to match fonts based on their **UniversalFontId** in preference to their LogFont (section [2.2.13](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100)) information. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_FORCEUFIMAPPING. This value is 0x0000006D. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ufi (8 bytes):** The font id to use, specified as a UniversalFontId ([section 2.2.27](#Section_34502dab22b44855b9b288f00a4a0c52)). + +See section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4) for more drawing record types. + +#### EMR_INVERTRGN Record + +The **EMR_INVERTRGN** record inverts the colors in the specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). The current clipping regions used by this record are maintained in a **Regions** state element (section [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877)) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section [3.1](#Section_50ae16a09d1748018bf1e28e9533a889)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_INVERTRGN. This value is 0x00000049. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Bounds (16 bytes):** A RectL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.19) that specifies the destination bounding rectangle in logical coordinates. If the intersection of this rectangle with the current clipping region is empty, this record has no effect. + +**RgnDataSize (4 bytes):** An unsigned integer that specifies the size of region data in bytes. + +**RgnData (variable):** A **RgnDataSize** length array of bytes that specifies the output region in a **RegionData** object (section [2.2.24](#Section_e66601f29b5c46198476ddb7b087551b)). The bounds specified by the **RegionDataHeader** field of this object MAY[\<83\>](#Appendix_A_83) be used as the bounding rectangle of the region when this record is processed. + +If the output surface is monochrome, this record SHOULD convert white pixels to black and black pixels to white. For color output, the inversion is dependent on the type of technology used to generate the colors. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_MOVETOEX Record + +The EMR_MOVETOEX record specifies the coordinates of s new drawing position in logical units. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_MOVETOEX**. This value is 0x0000001B. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Offset (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15), which specifies coordinates of the new drawing position in logical units. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_PIXELFORMAT Record + +The EMR_PIXELFORMAT record specifies the pixel format to use for graphics operations.[\<84\>](#Appendix_A_84) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_PIXELFORMAT**. This value is 0x00000068. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**pfd (40 bytes):** A PixelFormatDescriptor object (section [2.2.22](#Section_1db036d62da84b92b4f8e9cab8cc93b7)) that specifies pixel format data. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_RESTOREDC Record + +The **EMR_RESTOREDC** record restores the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to the specified state. The playback device context is restored by popping state information off a stack that was created by a prior EMR_SAVEDC record ([section 2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652)). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies the record type as **EMR_RESTOREDC**. This value is 0x00000022. + +**Size (4 bytes):** An unsigned integer that specifies the size of the record in bytes. This value is 0x0000000C. + +**SavedDC (4 bytes):** A signed integer that specifies the saved state to restore relative to the current state. This value MUST be negative; –1 represents the state that was most recently saved on the stack, –2 the one before that, etc. + +The stack can contain state information for multiple instances of the playback device context. When a state is restored, all state instances that were saved more recently MUST be discarded. + +See section 2.3.11 for more state record types. + +#### EMR_SCALEVIEWPORTEXTEX Record + +The **EMR_SCALEVIEWPORTEXTEX** record specifies the current viewport in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by using ratios formed by the specified multiplicands and divisors. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SCALEVIEWPORTEXTEX. This value is 0x0000001F. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**xNum (4 bytes):** A signed integer that specifies the horizontal multiplicand. Cannot be zero. + +**xDenom (4 bytes):** A signed integer that specifies the horizontal divisor. Cannot be zero. + +**yNum (4 bytes):** A signed integer that specifies the vertical multiplicand. Cannot be zero. + +**yDenom (4 bytes):** A signed integer that specifies the vertical divisor. Cannot be zero. + +The extent MUST NOT be changed if the current [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) (section [2.1.21](#Section_109d7955767e4955a0e2f8b5e14f757a)) is fixed scale. Only MM_ISOTROPIC and MM_ANISOTROPIC are not fixed scale. + +The new viewport extent is computed as follows. + +510. xNewWE = (xOldWE \* xNum) / xDenom + + yNewWE = (yOldWE \* yNum) / yDenom + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SCALEWINDOWEXTEX Record + +The **EMR_SCALEWINDOWEXTEX** record specifies the current window in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by using ratios formed by the specified multiplicands and divisors. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SCALEWINDOWEXTEX. This value is 0x00000020. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**xNum (4 bytes):** A signed integer that specifies the horizontal multiplicand. MUST NOT be zero. + +**xDenom (4 bytes):** A signed integer that specifies the horizontal divisor. MUST NOT be zero. + +**yNum (4 bytes):** A signed integer that specifies the vertical multiplicand. MUST NOT be zero. + +**yDenom (4 bytes):** A signed integer that specifies the vertical divisor. MUST NOT be zero. + +The extent MUST NOT be changed if the current [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) (section [2.1.21](#Section_109d7955767e4955a0e2f8b5e14f757a)) is fixed scale. Only MM_ISOTROPIC and MM_ANISOTROPIC are not fixed scale. + +The new window extent is computed as follows. + +512. xNewWE = (xOldWE \* xNum) / xDenom + + yNewWE = (yOldWE \* yNum) / yDenom + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETARCDIRECTION Record + +The **EMR_SETARCDIRECTION** record specifies the drawing direction to be used for arc and rectangle output. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETARCDIRECTION. This value is 0x00000039. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x0000000C. + +**ArcDirection (4 bytes):** An unsigned integer that specifies the arc direction. This value is in the ArcDirection enumeration (section [2.1.2](#Section_9886c62f17884118894a76d5a8733685)). The default direction is counterclockwise. + +The arc direction affects the direction in which the following records draw: + +- [EMR_ARC (section 2.3.5.2)](#Section_3e148f197e7543aa9259fda562f60315) + +- [EMR_ARCTO (section 2.3.5.3)](#Section_51b4a890bfd4496ebbd9dbde9ad49d1c) + +- [EMR_CHORD (section 2.3.5.4)](#Section_b442d2fbf92b4103aa7d44f864f719d5) + +- [EMR_ELLIPSE (section 2.3.5.5)](#Section_d9462a32d18840e7bf7205614ec4ff18) + +- [EMR_PIE (section 2.3.5.15)](#Section_c326f6b2ae7e447fb8dc02c703f054c3) + +- [EMR_RECTANGLE (section 2.3.5.34)](#Section_3c4712380a02499290a2bfd2afd98f2a) + +- [EMR_ROUNDRECT (section 2.3.5.35)](#Section_2e4f55a15f694a818329423eeedb3812) + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETBKCOLOR Record + +The **EMR_SETBKCOLOR** record specifies the background color for text output. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETBKCOLOR. This value is 0x00000019. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Color (4 bytes):** A ColorRef object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.8), which specifies the background color value. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETBKMODE Record + +The **EMR_SETBKMODE** record specifies the background mix mode to use with text, hatched brushes, and pens that are not solid lines. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETBKMODE. This value is 0x00000012. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**BackgroundMode (4 bytes):** An unsigned integer that specifies the background mode, from the BackgroundMode enumeration (section [2.1.4](#Section_2f57054c2b694303a6f85aacd401f759)). + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETBRUSHORGEX Record + +The **EMR_SETBRUSHORGEX** record specifies the origin of the current brush. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETBRUSHORGEX. This value is 0x0000000D. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Origin (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15), which specifies the horizontal and vertical origin of the current brush in logical units. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETCOLORADJUSTMENT Record + +The **EMR_SETCOLORADJUSTMENT** record specifies color adjustment properties in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETCOLORADJUSTMENT**. This value is 0x00000017. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x00000020. + +**ColorAdjustment (24 bytes):** A ColorAdjustment object (section [2.2.2](#Section_71d7f4d0b6454de8a5588a2e0fc596cb)) that specifies color adjustment values. + +Color adjustment values are used to adjust the input color of the source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) for graphics operations performed by [EMR_STRETCHBLT](#Section_0dd551f380f7485289c29ddba803a192) and [EMR_STRETCHDIBITS](#Section_89c0d8080dea413fbe402e9e51fa36ac) records when **STRETCH_HALFTONE** mode is set from the [StretchMode](#Section_e72f20aa2e2d453f9e95eaef50b76e19) enumeration (section 2.1.32). + +The ColorAdjustment object specified by this record MUST be used in graphics operations that require a ColorAdjustment object, until a different ColorAdjustment object is specified by another EMR_SETCOLORADJUSTMENT record, or until the object is removed by a [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) more state record types. + +#### EMR_SETICMMODE Record + +The **EMR_SETICMMODE** record specifies the mode of [**Image Color Management (ICM)**](#gt_fcd5ee55-57ff-45d6-b51e-2ccba47329e3) for graphics operations.[\<85\>](#Appendix_A_85) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETICMMODE**. This value is 0x00000062. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x0000000C. + +**ICMMode (4 bytes):** An unsigned integer that specifies whether to enable or disable ICM, from the ICMMode enumeration (section [2.1.18](#Section_4935fb3cc6464d16a8f0f86ee0a9d096)). + +When ICM mode is enabled in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45), colors specified in EMF records SHOULD be [**color matched**](#gt_a3322d29-7dc5-4696-b17a-55311db1cb33), whereas the default [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) SHOULD be used when a bit-block transfer is performed. If the default color profile is not desired, ICM mode SHOULD be turned off before performing the bit-block transfer. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETICMPROFILEA Record + +The **EMR_SETICMPROFILEA** record specifies a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) in a file with a name consisting of [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters, for graphics output.[\<86\>](#Appendix_A_86) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETICMPROFILEA. This value is 0x00000070. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**dwFlags (4 bytes):** An unsigned integer that contains color profile flags. + +**cbName (4 bytes):** An unsigned integer that specifies the number of bytes in the ASCII name of the desired color profile. + +**cbData (4 bytes):** An unsigned integer that specifies the size of the color profile data, if it is contained in the **Data** field. + +**Data (variable):** An array of size (**cbName** + **cbData**) in bytes, which specifies the ASCII name and raw data of the desired color profile. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETICMPROFILEW Record + +The **EMR_SETICMPROFILEW** record specifies a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) in a file with a name consisting of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters, for graphics output.[\<87\>](#Appendix_A_87) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETICMPROFILEW**. This value is 0x00000071. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**dwFlags (4 bytes):** An unsigned integer that contains color profile flags. + +**cbName (4 bytes):** An unsigned integer that specifies the number of bytes in the Unicode [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) name of the desired color profile. + +**cbData (4 bytes):** An unsigned integer that specifies the size of color profile data, if attached. + +**Data (variable):** An array of size (**cbName** + **cbData**) in bytes, which specifies the UTF16-LE name and raw data of the desired color profile. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETLAYOUT Record + +The **EMR_SETLAYOUT** record specifies the order in which text and graphics are drawn.[\<88\>](#Appendix_A_88) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETLAYOUT. This value is 0x00000073. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x0000000C. + +**LayoutMode (4 bytes):** An unsigned integer that specifies the layout mode as follows: + +[TABLE] + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETLINKEDUFIS Record + +The **EMR_SETLINKEDUFIS** record sets the **UniversalFontIds** ([section 2.2.27](#Section_34502dab22b44855b9b288f00a4a0c52)) of linked fonts to use during character lookup. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETLINKEDUFIS**. This value is 0x00000077. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**uNumLinkedUFI (4 bytes):** An unsigned integer specifying the number of UFIs to follow. + +**ufis (variable):** An array of **uNumLinkedUFI** elements of type UniversalFontId (section 2.2.27), which specifies the identifiers of the linked fonts. + +**Reserved (8 bytes):** This field is reserved and MUST be ignored. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETMAPMODE Record + +The **EMR_SETMAPMODE** record specifies the current [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae), which specifies the unit of measure used to transform [**page space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) units into [**device space**](#gt_25d586c7-f440-45c6-b965-5c025bea9fc0) units, and also specifies the orientation of the device's x-axis and y-axis. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETMAPMODE**. This value is 0x00000011. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**MapMode (4 bytes):** An unsigned integer from the MapMode enumeration (section [2.1.21](#Section_109d7955767e4955a0e2f8b5e14f757a)). + +**MM_TEXT** mode allows applications to work in device pixels, whose size varies from device to device. + +The **MM_HIENGLISH**, **MM_HIMETRIC**, **MM_LOENGLISH**, **MM_LOMETRIC**, and **MM_TWIPS** modes are useful for applications drawing in physically meaningful units such as inches or millimeters. + +**MM_ISOTROPIC** mode ensures a 1:1 aspect ratio. + +**MM_ANISOTROPIC** mode allows the x-coordinates and y-coordinates to be adjusted independently. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETMAPPERFLAGS Record + +The **EMR_SETMAPPERFLAGS** record specifies parameters for the process of matching logical fonts to physical fonts, which is performed by the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1).[\<89\>](#Appendix_A_89) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETMAPPERFLAGS. This value is 0x00000010. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x0000000C. + +**Flags (4 bytes):** An unsigned integer that specifies parameters for the font matching process. + +| Value | Meaning | +|----|----| +| 0x00000000 | The font mapper is not limited to fonts that match the [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5) of the output device. | +| 0x00000001 | The font mapper SHOULD select only fonts that match the aspect ratio of the output device. | + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETMITERLIMIT Record + +The EMR_SETMITERLIMIT record specifies the limit for the length of miter joins. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETMITERLIMIT**. This value is 0x0000003A. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**MiterLimit (4 bytes):** An unsigned integer that specifies the new [**miter length**](#gt_7d78ab9f-9531-4993-b140-8c2bb6e82220) limit.[\<90\>](#Appendix_A_90) + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETPOLYFILLMODE Record + +The **EMR_SETPOLYFILLMODE** record defines polygon fill mode. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETPOLYFILLMODE. This value is 0x00000013. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**PolygonFillMode (4 bytes):** An unsigned integer that specifies the polygon fill mode and is in the PolygonFillMode (section [2.1.27](#Section_879a186908ad497783e809be265e2c7c)) enumeration. + +In general, the modes differ only in cases where a complex, overlapping polygon MUST be filled; for example, a five-sided polygon that forms a five-pointed star with a pentagon in the center. In such cases, ALTERNATE mode SHOULD fill every other enclosed [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) within the polygon (the points of the star), but WINDING mode SHOULD fill all regions (the points of the star and the pentagon). + +When the fill mode is ALTERNATE, the area between odd-numbered and even-numbered polygon sides on each scan line SHOULD be filled. That is, the area between the first and second side SHOULD be filled, and between the third and fourth side, and so on. + +When the fill mode is WINDING, any region that has a nonzero winding value SHOULD be filled. The winding value is the number of times a pen used to draw the polygon would go around the region. The direction of each edge of the polygon is significant. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETROP2 Record + +The EMR_SETROP2 record defines a binary [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) mode. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETROP2**. This value is 0x00000014. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**ROP2Mode (4 bytes):** An unsigned integer that specifies the raster operation mode and is in the Binary Raster Op enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.2). + +Binary raster operation mix modes define how to combine source and destination colors when drawing with the current pen. The mix modes are binary raster operation codes, representing all possible [**Boolean**](#gt_1d79d7a7-ba2c-4b34-931c-7ba8057c87b2) functions of two variables, using the binary operations AND, OR, and XOR (exclusive OR), and the unary operation NOT. The mix mode is for raster devices only; it is not available for vector devices. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETSTRETCHBLTMODE Record + +The EMR_SETSTRETCHBLTMODE record specifies [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) stretch mode. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETSTRETCHBLTMODE**. This value is 0x00000015. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**StretchMode (4 bytes):** An unsigned integer that specifies the stretch mode and MAY be in the [StretchMode](#Section_e72f20aa2e2d453f9e95eaef50b76e19) enumeration. + +The stretching mode specifies how to combine rows or columns of a bitmap with existing pixels on the display device that the [EMR_STRETCHBLT](#Section_0dd551f380f7485289c29ddba803a192) record is processed on. + +The **STRETCH_ANDSCANS** and **STRETCH_ORSCANS** modes are typically used to preserve foreground pixels in monochrome bitmaps. The **STRETCH_DELETESCANS** mode is typically used to preserve color in color bitmaps. + +The **STRETCH_HALFTONE** mode is slower and requires more processing of the source image than the other three modes, but produces higher quality images. Also note that an [EMR_SETBRUSHORGEX](#Section_b02ab7ee4c884bf29ce99100636d86be) SHOULD be encountered after setting the **STRETCH_HALFTONE** mode to avoid brush misalignment. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETTEXTALIGN Record + +The **EMR_SETTEXTALIGN** record specifies text alignment for text drawing. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETTEXTALIGN. This value is 0x00000016. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**TextAlignmentMode (4 bytes):** An unsigned integer that specifies text alignment by using a mask of text alignment flags. These are either TextAlignmentMode flags ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.2.3) for text with a horizontal baseline, or VerticalTextAlignmentMode flags (\[MS-WMF\] section 2.1.2.4) for text with a vertical baseline. Only one value can be chosen from those that affect horizontal and vertical alignment. + +The EMR_SMALLTEXTOUT, EMR_EXTTEXTOUTA, and EMR_EXTTEXTOUTW records (section [2.3.5](#Section_1f7da2e4df0441d48f7d180fa642cab4)) use text alignment values to position a string of text on the output medium. The values specify the relationship between a reference point and a rectangle that bounds the text. The reference point is either the current drawing position or a point passed to a text output record. + +The rectangle that bounds the text is formed by the character cells in the text string. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETTEXTCOLOR Record + +The **EMR_SETTEXTCOLOR** record defines the current text foreground color. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETTEXTCOLOR. This value is 0x00000018. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Color (4 bytes):** A ColorRef object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.8) that specifies the text foreground color. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETTEXTJUSTIFICATION Record + +The **EMR_SETTEXTJUSTIFICATION** record specifies the amount of extra space to add to break characters for text justification.[\<91\>](#Appendix_A_91) + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETTEXTJUSTIFICATION. This value is 0x00000078. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**nBreakExtra (4 bytes):** A signed integer that specifies the total amount of extra space to add in logical units. + +**nBreakCount (4 bytes):** A signed integer that specifies the number of break characters. + +Instead of using this record, an implementation SHOULD use EMR_EXTTEXTOUTW (section [2.3.5.8](#Section_a59a79ac328e492da34de02727af6edf)) to perform this function. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETVIEWPORTEXTEX Record + +The **EMR_SETVIEWPORTEXTEX** record defines the viewport extent. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETVIEWPORTEXTEX. This value is 0x0000000B. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Extent (8 bytes):** A SizeL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.22) that specifies the horizontal and vertical extents in device units. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETVIEWPORTORGEX Record + +The **EMR_SETVIEWPORTORGEX** record defines the viewport origin. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETVIEWPORTORGEX. This value is 0x0000000C. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Origin (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15) that specifies the window horizontal and vertical origin in device units. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETWINDOWEXTEX Record + +The **EMR_SETWINDOWEXTEX** record defines the window extent. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETWINDOWEXTEX. This value is 0x00000009. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Extent (8 bytes):** A SizeL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.22) that specifies the horizontal and vertical extents in logical units. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +#### EMR_SETWINDOWORGEX Record + +The **EMR_SETWINDOWORGEX** record defines the window origin. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as EMR_SETWINDOWORGEX. This value is 0x0000000A. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. + +**Origin (8 bytes):** A PointL object ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.15) that specifies the window horizontal and vertical origin in logical units. + +See section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652) for more state record types. + +### Transform Record Types + +The transform record types specify and modify [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transforms**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). + +The following are [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) transform record types. + +| Name | Section | Description | +|----|----|----| +| EMR_MODIFYWORLDTRANSFORM | [2.3.12.1](#Section_c70b85e58c31418fa7b8349e417e0f76) | Modifies the current world-space to page-space transform. | +| EMR_SETWORLDTRANSFORM | [2.3.12.2](#Section_985724c04db148f0b34667288b3288cb) | Specifies a two-dimensional linear transform between world space and page space. | + +The generic structure of EMF transform records is specified as follows. + +[TABLE] + +**Type (4 bytes):** An unsigned integer that defines the type of record. The transform record types are listed in the following table. See the preceding table for descriptions of these record types. + +| Name | Value | +|--------------------------|------------| +| EMR_SETWORLDTRANSFORM | 0x00000023 | +| EMR_MODIFYWORLDTRANSFORM | 0x00000024 | + +**Size (4 bytes):** An unsigned integer that specifies the size in bytes of this record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This value MUST be a multiple of 4 bytes. + +**Xform (24 bytes):** An [XForm object (section 2.2.28)](#Section_e84107e9bc2b4a1492345d173adc1b59), which defines a world-space to page-space transform. + +**TransformData (4 bytes, optional):** An unsigned integer that specifies an additional parameter for the record. + +See section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba) for more [EMF record types](#Section_1eec80ba799b4784a9ac91597d590ae1). + +#### EMR_MODIFYWORLDTRANSFORM Record + +The EMR_MODIFYWORLDTRANSFORM record modifies the current [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_MODIFYWORLDTRANSFORM**. This value is 0x00000024. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x00000024. + +**Xform (24 bytes):** An [XForm object (section 2.2.28)](#Section_e84107e9bc2b4a1492345d173adc1b59) that defines a two-dimensional linear transform in logical units. This transform is used according to the **ModifyWorldTransformMode** to define a new value for the world-space to page-space transform in the playback device context. + +**ModifyWorldTransformMode (4 bytes):** An unsigned integer that specifies how the transform specified in **Xform** is used. This value is in the [ModifyWorldTransformMode enumeration (section 2.1.24)](#Section_e6bb2996195f473f80c69dc1afe474f9). + +For more information concerning transforms and [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). See section [2.3.12](#Section_a0442ad12d6e43e7ac8ce252e492f97e) for more transform record types. + +#### EMR_SETWORLDTRANSFORM Record + +The EMR_SETWORLDTRANSFORM record specifies a [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) for the current [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) transform in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**Type (4 bytes):** An unsigned integer that identifies this record type as **EMR_SETWORLDTRANSFORM**. This value is 0x00000023. + +**Size (4 bytes):** An unsigned integer that specifies the size of this record in bytes. This value is 0x00000020. + +**Xform (24 bytes):** An XForm object (section [2.2.28](#Section_e84107e9bc2b4a1492345d173adc1b59)) that specifies a two-dimensional linear transform in logical units. This transform defines a new value for the current world-space to page-space transform. + +For more information concerning transforms and [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). See section [2.3.12](#Section_a0442ad12d6e43e7ac8ce252e492f97e) for more transform record types. + +# Structure Examples + +## EMF Metafile Playback + +This section describes the data and processing required for rendering the image stored in an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This process is referred to as “playback” throughout this specification. During metafile playback, the graphics state is maintained in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) (section 3.1). + +### Abstract Data Model + +This section describes a conceptual model of possible data organization that an implementation maintains during the processing of this file format. The description of the organization is provided to facilitate the explanation of that processing. This document does not mandate that implementations adhere to this model, provided their external behavior is consistent with that specified in this document. + +The following abstract data model elements are used to maintain the current state of the playback of an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +**EMF object table (variable):** A table of object metadata that is used to keep track of objects created and used during metafile playback. The **EMF object table** structure is described in section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4). + +**Graphics Environment (variable):** The set of drawing parameters and metadata that specify the rendering of the image in the metafile. The **Graphics Environment** is described in section [3.1.1.2](#Section_00de3e5e6f104be4943d8de5e2b95fe8). + +No part of the abstract data model is assumed to persist across system restarts; however, with this data it would be possible to recover the playback device context and resume metafile playback. + +#### EMF Object Table + +The **EMF object table** is an element of the state maintained during [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) playback. It contains data used for managing graphics objects as they are created, activated, used, deactivated, and deleted by the processing of EMF records. + +A possible implementation is described by the following elements. + +| Element name | Type | Set by | +|----|----|----| +| **EMFObjectArray** | **EMFObject\[\]** | Object creation record (section [2.3.7](#Section_7d914464d5464393bddb6d1e747fca18)) | +| **EMFObject** | **EMFObject** | Object creation record | + +**EMFObjectArray (variable):** An array of **EMFObject** elements. The maximum number of objects is specified in the **Handles** field of the Header object (section [2.2.9](#Section_e4a35c41e8e343f9bc07a18e99bb866d)) in an EMF_HEADER record (section [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab)). The table should be large enough for (**Handles** + 1) because element zero in the array is reserved. + +**EMFObject (variable):** A graphics object and its associated index. + +When a graphics object is created by an object creation record, the record specifies a numerical index. The object can be referenced by its index during metafile processing until the object is deleted. Object indexes start at 1; zero is reserved for references to the metafile itself. + +An object manipulation record (section [2.3.8](#Section_2f1c3268b43b4c28988b41aa49354998)) can use the index of a graphics object to select it into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). This has the effect of activating the object so that it can be used in graphics operations specified by subsequent metafile records. Until the object is activated, it is not used. Later, if a different object of the same type is activated, the former object is deactivated but not deleted. An object is not deleted until an object manipulation record is processed that deletes it. + +Before a graphics object is instantiated and activated, a default [**stock object**](#gt_b1328cb9-acd8-47f8-9896-fe985af2d6d6) (section [2.1.31](#Section_d6dffd25861542f8aed1309f1fe54ab2)) for that type is used in graphics operations. + +| Element name | Type | Set by | +|-------------------------|--------------------------|------------------------| +| **GraphicsObjectIndex** | UINT32 | Object creation record | +| **GraphicsObject** | See element description. | Object creation record | + +> **GraphicsObjectIndex (4 bytes):** An unsigned integer that specifies the index associated with the **GraphicsObject**, which is used to refer to the object after it is created. +> +> **GraphicsObject (variable):** One of the following structures. + +- DeviceIndependentBitmap ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.9) + +- LogBrushEx (section [2.2.12](#Section_6d790f8d51654746bac33443915c2071)) + +- LogColorSpace (\[MS-WMF\] section 2.2.2.11) + +- LogColorSpaceW (\[MS-WMF\] section 2.2.2.12) + +- LogFont (section [2.2.13](#Section_1cd7cb7a1a7c48d2b4a4c218f9d12100)) + +- LogFontExDv (section [2.2.15](#Section_595fcaaebc3741489afe859e81ca7f76)) + +- LogPalette (section [2.2.17](#Section_758f047d765e424c9204a833b7b4e527)) + +- LogPenEx (section [2.2.20](#Section_5b67b3eeea004f809b732959804381be)) + +The following process can be used to manage graphics objects with the **EMF object table**: + +1. At the start of metafile processing, the **EMFObjectArray** structure is created. + +2. The **EMF object table** needs to be large enough to keep track of objects that are explicitly created as well as stock objects. Each element in the object table contains information that indicates whether an object with that index has been created, a way to access the object, and whether the object is currently active. + +3. When a graphics object is created, the element in the **EMF object table** that corresponds to its index is updated so that it can be accessed later. + +4. When a graphics object is activated, the element in the **EMF object table** that corresponds to its index is updated. In addition, the element that was activated before is now deactivated. + +5. When a graphics object is deactivated, the element in the **EMF object table** that corresponds to its index is updated. In addition, the default stock object of that type is now activated. + +6. When a record is encountered that deletes the graphics object, its memory is released, and the EMF object table is updated accordingly. A graphics object can be deleted without first being deactivated. If that happens, the default stock object of that type is now activated. + +There are some index values that are reserved: + +- The index zero is reserved; it refers to the EMF metafile itself. + +- Indexes that have the most-significant bit set refer to stock objects. + +The object state changes of creation, activation, deactivation, and deletion, require management during playback to achieve the expected results in rendering the image stored in the metafile. + +#### Graphics Environment + +The **Graphics Environment** describes the graphics state maintained during [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) playback. A possible implementation is described by the following elements. + +| Element name | Type | Set by | +|----|----|----| +| **PlaybackStateArray** | **PlaybackState\[\]** | EMR_SAVEDC (section [2.3.11](#Section_8f8a4df2f8d74d39afc094e19f524652)) | +| **PlaybackState** | UINT8\[\] | EMF records (section [2.3](#Section_e0137630f3ad492cbde9e68866e255ba)) | + +**PlaybackStateArray:** An array of saved **PlaybackState** elements, any of which can be used by the EMR_RESTOREDC record (section [2.3.11.6](#Section_efa2f1804c7e4a7bb4efa1d06a0ce89f)) to restore a previous graphics environment. + +**PlaybackState:** The [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) at some point in EMF record processing, including region definitions, color profiles, fonts and text properties, and graphics drawing metadata. The elements of the **PlaybackState** are grouped as shown in the following table. + +| Element group | Section | Description | +|----|----|----| +| **Regions** | [3.1.1.2.1](#Section_939400bc0ecd4a28aa8c60c7e4cc9877) | The current clipping regions and related properties | +| **Colors** | [3.1.1.2.2](#Section_fc99138f11fa48a2903fd6bf332fa9e7) | The current [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) and related properties | +| **Text** | [3.1.1.2.3](#Section_fcf144823aa7424989f6f04dacaf6388) | Properties related to fonts and rendering text | +| **Drawing** | [3.1.1.2.4](#Section_ea08d73894374e80840ad2751ea73a39) | The graphics properties that determine how drawing commands render the image | + +The sections that follow describe the elements in each group as well as the EMF records that set their values. Unreferenced intrinsic types are defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2). + +##### Regions + +The **Regions** group of elements control the output area and clipping properties in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**Clipping:** The current clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), which with **MetaClipping** defines the bounds of the drawing area. The default value for the **Clipping** element is implementation-specific.[\<92\>](#Appendix_A_92) + +**MetaClipping:** The current metaregion, which with the **Clipping** region defines the bounds of the drawing area. + +**Viewport:** A rectangular drawing area using coordinates in the [**device space**](#gt_25d586c7-f440-45c6-b965-5c025bea9fc0). + +[TABLE] + +> **Extent:** Horizontal and vertical sizes of the drawing area in device units. +> +> **Origin:** Point value of the origin of the drawing area in device units. + +**Window:** A rectangular drawing area using the coordinates of the [**page space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a). + +[TABLE] + +> **Extent:** Horizontal and vertical sizes of the drawing area in logical units. +> +> **Origin:** Point value of the origin of the drawing area in logical units. + +##### Colors + +The **Colors** group of elements define the current state of color management in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +##### Text + +The **Text** group of elements define the current font and text properties in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +**Text** elements are used by the following [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) text drawing records. + +- EMR_EXTTEXTOUTA (section [2.3.5.7](#Section_6b582a713c294fc6a0f41f8a313739a1)) + +- EMR_EXTTEXTOUTW (section [2.3.5.8](#Section_a59a79ac328e492da34de02727af6edf)) + +- EMR_POLYTEXTOUTA (section [2.3.5.32](#Section_d8b7ac2176b84f9aa7cc05f9d2d5627e)) + +- EMR_POLYTEXTOUTW (section [2.3.5.33](#Section_381015eb29a7477493ada210697f5972)) + +- EMR_SMALLTEXTOUT (section [2.3.5.37](#Section_20eee81d0bd442d1a624860adfe62358)) + +| Element name | Type | Set by | +|----|----|----| +| **FontMapperFlags** | UINT32 | EMR_SETMAPPERFLAGS (section [2.3.11.20](#Section_6647abf7bd7043ef87661a6e06ed2f03)) | +| **ForceUFIMapping** | UniversalFontId (section [2.2.27](#Section_34502dab22b44855b9b288f00a4a0c52)) | EMR_FORCEUFIMAPPING (section [2.3.11.2](#Section_e9a05924e704403783126bef2e19f6bd)) | +| **LinkedUFIs** | UniversalFontId\[\] | EMR_SETLINKEDUFIS (section [2.3.11.18](#Section_3bb62157624f443fa88cef5e696740dd)) | +| **TextAlignment** | UINT32 | EMR_SETTEXTALIGN (section [2.3.11.25](#Section_a49bb565a58341da8d4a8a0314b3e397)) | +| **TextJustification** | UINT32 \[2\] | EMR_SETTEXTJUSTIFICATION (section [2.3.11.27](#Section_edbc2be01da045d69c05677cbcaa2d47)) | + +##### Drawing + +The **Drawing** group of elements define various graphics flags and other metadata values that affect how the image in the [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) is rendered. + +| Element name | Type | Set by | +|----|----|----| +| **ArcDirection** | UINT32 | EMR_SETARCDIRECTION (section [2.3.11.9](#Section_83a955e613b84720a521542e3dd91cba)) | +| **BackgroundColor** | ColorRef ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.2.2.8) | EMR_SETBKCOLOR (section [2.3.11.10](#Section_24f4095262d440b0ba40aad8fb4fc421)) | +| **BackgroundMode** | UINT32 | EMR_SETBKMODE (section [2.3.11.11](#Section_7c584a42b6dd47b8a0b6f529133292f4)) | +| **BrushOrigin** | PointL | EMR_SETBRUSHORGEX (section [2.3.11.12](#Section_b02ab7ee4c884bf29ce99100636d86be)) | +| **CurrentPosition** | PointL (\[MS-WMF\] section 2.2.2.15) | EMR_MOVETOEX (section [2.3.11.4](#Section_8ae57e5a22e3435298ca09628f47c693)) | +| **LayoutMode** | UINT32 | EMR_SETLAYOUT (section [2.3.11.17](#Section_dcb69f9d6f69466aaf1e6f505d86cc67)) | +| **LineCap** | UINT32 | | +| **LineJoin** | UINT32 | | +| **MappingMode** | UINT32 | EMR_SETMAPMODE (section [2.3.11.19](#Section_aa4ad35dfa424a4f959a8b41304e1b05)) | +| **MiterLimit** | UINT32 | EMR_SETMITERLIMIT (section [2.3.11.21](#Section_2637d0d092dd48e8be5e6400b4d1fc5e)) | +| **Path** | PointL\[\] | Path bracket records (section [2.3.10](#Section_b930b98930ec4954a8891dc60ce0b689)) | +| **PathBracket** | [**Boolean**](#gt_1d79d7a7-ba2c-4b34-931c-7ba8057c87b2) | Path bracket records | +| **PolyFillMode** | UINT32 | EMR_SETPOLYFILLMODE (section [2.3.11.22](#Section_e8799c80fe7445c1bf6d3eb78edd4ed2)) | +| **ROP2** | UINT32 | EMR_SETROP2 (section [2.3.11.23](#Section_cedee7e04e6647b6ae1d816e1e319786)) | +| **StretchBLTMode** | UINT32 | EMR_SETSTRETCHBLTMODE (section [2.3.11.24](#Section_ff00ab986e2c4ecab66404ab2956b6a5)) | +| **TextColor** | ColorRef | EMR_SETTEXTCOLOR (section [2.3.11.26](#Section_1ae5c616cf8e4f5da7c3bfc1f70ece28)) | + +**ArcDirection:** The drawing direction for arcs and rectangles, from the ArcDirection enumeration (section [2.1.2](#Section_9886c62f17884118894a76d5a8733685)). + +**BackgroundColor:** The color used as background for drawing text, hatched brushes, and pen styles that are not solid lines, depending on the **BackgroundMode** value. + +**BackgroundMode:** How to combine the drawing background with the **BackgroundColor** value, from the BackgroundMode enumeration (section [2.1.4](#Section_2f57054c2b694303a6f85aacd401f759)). + +**BrushOrigin:** The horizontal and vertical origin of the current brush in logical units, which is used as needed to maintain an alignment of patterns on the display surface. + +### Byte Ordering + +The following code snippet illustrates how the use of the [**big-endian**](#gt_6f6f9e8e-5966-4727-8527-7e02fb864e7e) and [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) methods can affect the compatibility of applications. + +515. \#include \ + + \#include \ + + \#include \ + + int main() + + { + + int buf; + + int in; + + int nread; + + in = open("file.in", O_RDONLY); + + nread = read(in, (int \*) &buf, sizeof(buf)); + + printf("First Integer in file.in = %x\n", buf); + + exit(0); + + } + +In the preceding code, if the first integer word stored in the file.in file on a big-endian computer was the hexadecimal number 0x12345678, the resulting output on that computer would be as follows. + +529. % ./test + + First Integer in file.in = 12345678 + + % + +If the file.in file were read by the same program running on a little-endian computer, the resulting output would be as follows. + +533. % ./test + + First Integer in file.in = 78563412 + + % + +Because of the difference in output, [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) playback is implemented so that it can read multi-byte values based on the endian method used by the computer that generated the output. + +Because metafiles are developed and written on little-endian computers, playback performs this computation on computers that are big-endian. + +## EMF Metafile Example + +This section describes an example of an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7), which when processed renders the following image. + +![EMF metafile example](media/image4.bin "EMF metafile example") + +Figure 4: EMF metafile example + +The contents of this metafile example are shown in this section in hexadecimal bytes. The far-left column is the byte count; the far-right characters are the interpretation of the bytes in the Latin-1 [**ANSI Character Set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583) [\[ISO/IEC-8859-1\]](https://go.microsoft.com/fwlink/?LinkId=90689). The sections that follow describe the packets that convey this series of bytes. + +537. 00000000:01 00 00 00 D4 00 00 00 00 00 00 00 00 00 00 00 ....Ô........... + + 00000010:59 00 00 00 59 00 00 00 00 00 00 00 00 00 00 00 Y...Y........... + + 00000020:42 0C 00 00 41 0C 00 00 20 45 4D 46 00 00 01 00 B...A... EMF.... + + 00000030:FC 37 00 00 16 00 00 00 05 00 00 00 34 00 00 00 ü7..........4... + + 00000040:6C 00 00 00 00 00 00 00 80 07 00 00 B0 04 00 00 l.......€...°... + + 00000050:A5 02 00 00 A7 01 00 00 00 00 00 00 00 00 00 00 ¥...§........... + + 00000060:00 00 00 00 D5 55 0A 00 A5 75 06 00 53 00 61 00 ....ÕU..¥u..S.a. + + 00000070:6D 00 70 00 6C 00 65 00 20 00 45 00 4D 00 46 00 m.p.l.e. .E.M.F. + + 00000080:20 00 74 00 68 00 61 00 74 00 20 00 68 00 61 00 .t.h.a.t. .h.a. + + 00000090:73 00 20 00 61 00 20 00 62 00 72 00 75 00 73 00 s. .a. .b.r.u.s. + + 000000A0:68 00 20 00 66 00 69 00 6C 00 6C 00 2C 00 20 00 h. .f.i.l.l.,. . + + 000000B0:62 00 69 00 74 00 6D 00 61 00 70 00 2C 00 20 00 b.i.t.m.a.p.,. . + + 000000C0:61 00 6E 00 64 00 20 00 74 00 65 00 78 00 74 00 a.n.d. .t.e.x.t. + + 000000D0:00 00 00 00 27 00 00 00 18 00 00 00 01 00 00 00 ....'........... + + 000000E0:02 00 00 00 52 47 2A 00 03 00 00 00 25 00 00 00 ....RG\*.....%... + + 000000F0:0C 00 00 00 01 00 00 00 4C 00 00 00 64 00 00 00 ........L...D... + + 00000100:00 00 00 00 00 00 00 00 59 00 00 00 59 00 00 00 ........Y...Y... + + 00000110:00 00 00 00 00 00 00 00 5A 00 00 00 5A 00 00 00 ........Z...Z... + + 00000120:21 00 F0 00 00 00 00 00 00 00 00 00 00 00 80 3F !.ð...........€? + + 00000130:00 00 00 00 00 00 00 00 00 00 80 3F 00 00 00 00 ..........€?.... + + 00000140:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00000150:00 00 00 00 00 00 00 00 00 00 00 00 25 00 00 00 ............%... + + 00000160:0C 00 00 00 00 00 00 80 4C 00 00 00 A8 2F 00 00 .......€L...¨/.. + + 00000170:00 00 00 00 2D 00 00 00 59 00 00 00 59 00 00 00 ....-...Y...Y... + + 00000180:00 00 00 00 2D 00 00 00 5A 00 00 00 2D 00 00 00 ....-...Z...-... + + 00000190:20 00 CC 00 00 00 00 00 00 00 00 00 00 00 80 3F .Ì...........€? + + 000001A0:00 00 00 00 00 00 00 00 00 00 80 3F 00 00 00 00 ..........€?.... + + 000001B0:00 00 00 00 FF FF FF 00 00 00 00 00 64 00 00 00 ....ÿÿÿ.....D... + + 000001C0:28 00 00 00 8C 00 00 00 1C 2F 00 00 28 00 00 00 (...Œ..../..(... + + 000001D0:59 00 00 00 2D 00 00 00 01 00 18 00 00 00 00 00 Y...-........... + + 000001E0:1C 2F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ./.............. + + 000001F0:00 00 00 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E ....?\_.?\_.?\_.?\_. + + 00000200:3F 5F 0E 3F 5F 0E 3F 5F 0E 3E 5E 0D 3F 5F 0E 3F ?\_.?\_.?\_.\>^.?\_.? + + 00000210:5F 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E \_.A^.A^.A^.A^.A^ + + 00000220:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E .A^.A^.A^.A^.A^. + + 00000230:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 3D A^.A^.A^.A^.@\].= + + 00000240:59 0C 5A 60 4E AE AE AE BF BF BF C5 C5 C5 C0 C0 Y.Z\`N®®®¿¿¿ÅÅÅÀÀ + + 00000250:C1 B1 B2 B1 A1 A1 A1 A9 AA AA AE AF B0 A2 A2 A2 Á±²±¡¡¡©ªª®¯°¢¢¢ + + 00000260:A6 A6 A4 AF AE AD AC AC AC A6 A6 A6 99 99 99 7D ¦¦¤¯®­¬¬¬¦¦¦™™™} + + 00000270:7D 7D 66 66 65 5A 5A 59 4F 4F 4F 58 58 58 76 76 }}FFEZZYOOOXXXvv + + 00000280:76 9E 9E 9E B5 B5 B5 3C 43 2D 32 46 0A 34 4A 0A vžžžµµµ\^.?\_.?\_.A^ + + 00000320:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E .A^.A^.A^.A^.A^. + + 00000330:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 A^.A^.A^.A^.A^.A + + 00000340:5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 39 52 0C 70 73 ^.A^.A^.@\].9R.ps. + + 00000350:6B AD AD AD A8 A8 A8 99 99 98 A6 A6 A6 A6 A7 A7 k­­­¨¨¨™™˜¦¦¦¦§§ + + 00000360:A3 A5 A6 A6 A5 A3 AE A5 9D C9 BB AD A1 9B 95 A2 £¥¦¦¥£®¥□É»­¡›•¢ + + 00000370:9F 9C B3 B1 AF B6 B4 B3 A9 A9 A9 97 93 90 8E 87 Ÿœ³±¯¶´³©©©--"□އ + + 00000380:81 89 84 7F 81 7E 7A 79 78 76 80 7F 7E 98 98 98 □‰„□~zyxv€~˜˜˜ + + 00000390:BC BC BC 6D 70 65 33 47 0A 37 4D 0B 35 4B 0A 35 ¼¼¼mpE3G.7M.5K.5 + + 000003A0:4B 0B 38 4F 0B 3D 56 0C 41 5B 0D 42 5D 0D 42 5D K.8O.=V.A\[.B\].B\] + + 000003B0:0D 43 5D 0D 44 5D 0D 43 5C 0C 43 5C 0C 43 5C 0C .C\].D\].C\\C\\C\\ + + 000003C0:42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 B\[.C\\C\\C\\C\\C + + 000003D0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 000003E0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000003F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 45 C\\C\\C\\C\\E\[.E + + 00000400:5B 0C 45 5C 0A 45 5C 0A 45 5C 0A 00 3F 5F 0E 3F \[.E\\E\\E\\.?\_.? + + 00000410:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F \_.?\_.?\_.?\_.?\_.?\_ + + 00000420:0E 3E 5E 0D 3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0E .\>^.?\_.?\_.A^.A^. + + 00000430:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 A^.A^.A^.A^.A^.A + + 00000440:5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E ^.A^.A^.A^.A^.A^ + + 00000450:0E 41 5E 0E 40 5D 0D 38 51 0E 90 91 8E AC AC AC .A^.@\].8Q.□'ެ¬¬ + + 00000460:C3 C3 C3 C5 C6 C6 B9 BB BC B3 B0 AD BA AD 9E C8 ÃÃÃÅÆÆ¹»¼³°­º­žÈ + + 00000470:B4 A0 DB C8 B4 E4 D1 BE C2 B5 A9 82 7E 7A 8C 88 ´ ÛÈ´äѾµ©‚~zŒˆ + + 00000480:84 83 80 7E 98 8F 85 BE AC 9A C9 B6 A3 CC BB A9 „ƒ€~˜□…¾¬šÉ¶£Ì»© + + 00000490:CD C0 B3 AB A3 9B 80 7E 76 78 76 70 91 8F 8D 84 ÍÀ³«£›€~vxvp'□□„ + + 000004A0:86 80 36 4B 0B 39 50 0B 38 4E 0B 37 4D 0B 38 4F †€6K.9P.8N.7M.8O + + 000004B0:0B 3C 55 0C 40 5A 0D 42 5D 0D 42 5D 0D 42 5D 0D .\^. + + 00000530:3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 ?\_.?\_.A^.A^.A^.A + + 00000540:5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E ^.A^.A^.A^.A^.A^ + + 00000550:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E .A^.A^.A^.A^.A^. + + 00000560:40 5D 0D 3D 50 1C 94 94 94 A1 A1 A0 C9 CA CA BC @\].=P."""¡¡ ÉÊʼ + + 00000570:BB B8 BB AC 9C C4 AD 94 D2 BB A4 E0 CF BD E0 D0 »¸»¬œÄ­"Ò»¤àϽàÐ + + 00000580:BF DA C7 B5 DE CB B8 9A 93 8B 7C 76 70 A2 93 83 ¿ÚǵÞ˸š"‹\|vp¢"ƒ + + 00000590:C0 AB 95 C6 B2 9D CA B8 A4 D1 C0 AD E0 D2 C4 E8 À«•Ʋ□ʸ¤ÑÀ­àÒÄè + + 000005A0:DC CF CD C3 B5 8A 85 74 72 72 61 83 82 7E 34 43 ÜÏÍÃµŠ…trrAƒ‚~4C + + 000005B0:15 3C 54 0C 38 50 0B 38 4E 0B 39 50 0B 3D 55 0C .\^.?\_.? + + 00000640:5F 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E \_.A^.A^.A^.A^.A^ + + 00000650:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E .A^.A^.A^.A^.A^. + + 00000660:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 4B A^.A^.A^.A^.@\].K + + 00000670:56 33 B8 B8 B8 B7 B7 B7 A1 A1 A2 BC AC 9B CC B2 V3¸¸¸•••¡¡¢¼¬›Ì² + + 00000680:97 D6 C3 AE E5 D6 C6 E4 D4 C4 E1 D2 C2 D9 C6 B4 --ÖîåÖÆäÔÄáÒÂÙÆ´ + + 00000690:D7 C3 AD CE BF AF AD 9A 85 BB A5 8D BD A9 93 C3 ×íο¯­š…»¥□½©"à + + 000006A0:AF 9B C8 B5 A2 CE BD AA DC CE C0 E2 D5 C9 E1 D4 ¯›Èµ¢Î½ªÜÎÀâÕÉáÔ + + 000006B0:C7 D5 C5 B4 B1 A9 95 91 97 7B 4A 57 2D 39 51 0B ÇÕÅ´±©•'--{JW-9Q. + + 000006C0:38 50 0B 38 50 0B 3A 52 0C 3E 58 0C 41 5C 0D 42 8P.8P.:R.\>X.A\\B + + 000006D0:5D 0D 42 5D 0D 42 5D 0D 41 5C 0C 43 5C 0C 43 5C \].B\].B\].A\\C\\C\\ + + 000006E0:0C 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C .C\\B\[.C\\C\\C\\ + + 000006F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00000700:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00000710:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5D 0A .C\\C\\C\\C\\C\]. + + 00000720:45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 00 E\\E\\E\\E\\E\\. + + 00000730:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F ?\_.?\_.?\_.?\_.?\_.? + + 00000740:5F 0E 3F 5F 0E 40 5D 0D 3F 5F 0E 3F 5F 0E 41 5E \_.?\_.@\].?\_.?\_.A^ + + 00000750:0F 41 5E 0F 41 5E 0F 41 5E 0E 41 5E 0E 40 5D 0D .A^.A^.A^.A^.@\]. + + 00000760:40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 @\].@\].A^.@\].@\].@ + + 00000770:5D 0D 40 5D 0D 41 5E 0E 41 5E 0E 61 6C 44 D0 D0 \].@\].A^.A^.AlDÐÐ + + 00000780:D0 B0 B0 B0 C8 C3 BE DB C8 B3 DC CA B8 EB DD CF а°°ÈþÛȳÜʸëÝÏ + + 00000790:E8 D9 CA E5 D6 C7 E4 D6 C8 D9 C8 B5 D2 BF AA DD èÙÊåÖÇäÖÈÙȵҿªÝ + + 000007A0:CC BA C7 B3 9E B6 9F 89 BC A7 92 C1 AD 98 C6 B3 ̺dzž¶Ÿ‰¼§'Á­˜Æ³ + + 000007B0:9F CC BA A8 DB CD BF DD D0 C2 DF D3 C6 E0 D3 C5 ŸÌº¨ÛÍ¿ÝÐÂßÓÆàÓÅ + + 000007C0:E2 D4 C4 A7 AA 8E 52 62 2B 37 4D 0B 39 51 0B 3B âÔħªŽRB+7M.9Q.; + + 000007D0:53 0C 3E 57 0C 40 5A 0D 42 5D 0D 42 5D 0D 42 5D S.\>W.@Z.B\].B\].B\] + + 000007E0:0D 42 5D 0D 44 5D 0D 43 5C 0C 43 5C 0C 45 5B 0D .B\].D\].C\\C\\E\[. + + 000007F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00000800:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00000810:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00000820:43 5C 0C 43 5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 C\\C\\C\\E\\E\\E + + 00000830:5C 0A 45 5C 0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F \\E\\E\\E\[..?\_.? + + 00000840:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F \_.?\_.?\_.?\_.?\_.?\_ + + 00000850:0E 40 5D 0D 3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0F .@\].?\_.?\_.A^.A^. + + 00000860:41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 A^.@\].@\].@\].@\].@ + + 00000870:5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].A^.@\].@\].@\].@\] + + 00000880:0D 41 5E 0E 3F 5B 0D 6A 79 47 D1 D2 CE C5 C2 BF .A^.?\[.jyGÑÒÎÅ¿ + + 00000890:EF E6 DD E7 D8 CA EE E0 D3 ED DF D2 EA DC CE E9 ïæÝçØÊîàÓíßÒêÜÎé + + 000008A0:DB CD E1 D1 C1 D6 C3 B0 D7 C4 B1 DA C9 B8 D5 C3 ÛÍáÑÁÖð×ıÚɸÕà + + 000008B0:B1 B8 A3 8C BC A7 91 C0 AC 97 C5 B1 9D CB B9 A5 ±¸£Œ¼§'À¬--ű□˹¥ + + 000008C0:D6 C8 B8 CE BF AE D9 CB BD E1 D4 C7 E3 D4 C6 BC Öȸο®Ù˽áÔÇãÔÆ¼ + + 000008D0:B9 A2 53 63 2C 37 4C 0B 3C 55 0C 3E 58 0C 40 5B ¹¢SC,7L.\X.@\[ + + 000008E0:0D 41 5C 0D 42 5D 0D 42 5D 0D 42 5D 0D 42 5D 0D .A\\B\].B\].B\].B\]. + + 000008F0:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 43 5C 0C 43 C\\C\\C\\E\[.C\\C + + 00000900:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00000910:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00000920:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00000930:5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 5C 0A 45 5C \\C\\E\\E\\E\\E\\ + + 00000940:0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F 5F 0E 3F 5F .E\\E\[..?\_.?\_.?\_ + + 00000950:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D .?\_.?\_.?\_.?\_.@\]. + + 00000960:3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0E 40 5D 0D 40 ?\_.?\_.A^.A^.@\].@ + + 00000970:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E \].@\].@\].@\].@\].A^ + + 00000980:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E .@\].@\].@\].@\].A^. + + 00000990:40 59 0F 75 84 54 A6 B1 8E DC D9 CE F5 EE E8 E7 @Y.u„T¦±ŽÜÙÎõîèç + + 000009A0:DA CE E5 D7 C8 EB DD D0 EC DF D2 E4 D5 C4 D8 C8 ÚÎå×ÈëÝÐìßÒäÕÄØÈ + + 000009B0:B5 D9 CA B8 D9 CB BA D9 C8 B6 D9 C8 B6 C4 B0 9C µÙʸÙ˺ÙȶÙȶİœ + + 000009C0:BA A5 90 BF AA 95 C3 AF 9B C9 B6 A3 C9 B9 A7 C7 º¥□¿ª•ï›É¶£É¹§Ç + + 000009D0:B7 A6 D1 C2 B3 DC CF C0 E0 D2 C3 CE C4 B3 5B 69 •¦Ñ³ÜÏÀàÒÃÎij\[i + + 000009E0:33 3C 52 0D 40 5A 0D 41 5C 0D 42 5D 0D 42 5D 0D 3\^.\>^.@\].@\]. + + 00000C90:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00000CA0:5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].A^.@\].@\].@\].@\] + + 00000CB0:0D 41 5E 0E 52 64 1F A4 AF 8A 95 A3 75 B3 AC 84 .A^.RD.¤¯Š•£u³¬„ + + 00000CC0:DC AB 87 D7 A3 7D DB CD BD D2 A1 7F CD 76 42 CB Ü«‡×£}ÛͽҡÍvBË + + 00000CD0:71 3C C9 69 32 C7 62 2A C5 5B 20 C3 54 19 D8 AD q\<Éi2ÇB\*Å\[ ÃT.Ø­ + + 00000CE0:90 E2 D7 CA D3 BE A9 CA B6 A0 D0 BD AA D1 BD A9 □â×ÊÓ¾©Ê¶ нªÑ½© + + 00000CF0:DD CD BD DD D0 C2 D0 C1 B1 DA CD BE DE D1 C3 DB ÝͽÝÐÂÐÁ±Ú;ÞÑÃÛ + + 00000D00:CD BC 91 9A 6E 4E 62 18 42 5D 0D 42 5D 0D 42 5D ͼ'šnNB.B\].B\].B\] + + 00000D10:0D 42 5D 0D 42 5E 0B 41 5C 0C 41 5C 0C 41 5C 0C .B\].B^.A\\A\\A\\ + + 00000D20:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 43 5C 0C 43 C\\C\\C\\E\[.C\\C + + 00000D30:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00000D40:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00000D50:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00000D60:5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 5C 0A 45 5C \\C\\E\\E\\E\\E\\ + + 00000D70:0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F 5F 0E 3F 5F .E\\E\[..?\_.?\_.?\_ + + 00000D80:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D .?\_.?\_.?\_.?\_.@\]. + + 00000D90:3E 5D 0D 3E 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 \>\].\>\].@\].@\].@\].@ + + 00000DA0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00000DB0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0E .@\].@\].@\].@\].@\]. + + 00000DC0:58 67 26 A4 B1 8B B8 B1 8A D6 9F 74 D5 98 6B D7 Xg&¤±‹¸±ŠÖŸtÕ˜k× + + 00000DD0:A4 7F DD CF BF D2 90 66 CD 77 43 CA 6E 38 C8 65 ¤ÝÏ¿Ò□FÍwCÊn8ÈE + + 00000DE0:2C C6 60 27 C6 5B 21 C3 56 1B CB 71 40 DD C8 B6 ,Æ\`'Æ\[!ÃV.Ëq@Ýȶ + + 00000DF0:D5 C3 AF E1 D2 C2 DF D0 C1 D9 C8 B7 E1 D3 C4 E4 ÕïáÒÂßÐÁÙÈ•áÓÄä + + 00000E00:D8 CA D1 C2 B2 E0 D4 C7 E7 DA CD AD AA 90 6F 7F ØÊѲàÔÇçÚÍ­ª□o + + 00000E10:47 52 63 1F 41 5B 0D 41 5C 0C 41 5C 0C 42 5D 0D GRC.A\[.A\\A\\B\]. + + 00000E20:42 5D 0B 41 5C 0C 41 5C 0C 41 5B 0C 42 5B 0C 43 B\].A\\A\\A\[.B\[.C + + 00000E30:5B 0C 43 5C 0C 43 5B 0B 43 5C 0C 43 5C 0C 43 5B \[.C\\C\[.C\\C\\C\[ + + 00000E40:0C 43 5B 0C 43 5B 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\[.C\[.C\\C\\C\\ + + 00000E50:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00000E60:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00000E70:0C 44 5C 0A 44 5C 0A 45 5B 0A 45 5B 0A 45 5B 0A .D\\D\\E\[.E\[.E\[. + + 00000E80:45 5B 0B 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E E\[..?\_.?\_.?\_.?\_. + + 00000E90:3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 ?\_.?\_.?\_.@\].@\].@ + + 00000EA0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00000EB0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E .@\].@\].@\].@\].A^. + + 00000EC0:40 5D 0D 40 5D 0D 40 5D 0D 42 5C 0E 60 6E 33 A9 @\].@\].@\].B\\\`n3© + + 00000ED0:B6 91 CD B0 8B D7 A2 78 D6 99 6D D9 A8 86 E2 D7 ¶'Ͱ‹×¢xÖ™mÙ¨†â× + + 00000EE0:CA DE BC A2 CC 78 44 D0 85 57 D2 8B 61 CC 74 42 ÊÞ¼¢ÌxDÐ…WÒ‹AÌtB + + 00000EF0:CC 76 46 CD 7D 4F CC 76 47 CF 9C 7A D8 C9 B7 DF ÌvFÍ}OÌvGÏœzØÉ•ß + + 00000F00:D0 C0 DF CF BF DD CE BE E4 D7 C9 EB E0 D4 D1 C3 ÐÀßÏ¿Ýξä×ÉëàÔÑà + + 00000F10:B3 DC CF C1 F1 E6 DA C8 C0 AE 72 80 4F 56 66 24 ³ÜÏÁñæÚÈÀ®r€OVF\$ + + 00000F20:42 5B 0E 41 5C 0C 41 5C 0C 42 5D 0D 43 5C 0C 43 B\[.A\\A\\B\].C\\C + + 00000F30:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C \\C\\C\[.BZ.C\[.C\\ + + 00000F40:0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B 0D 43 5B 0D .B\[.C\\C\\C\[.C\[. + + 00000F50:43 5B 0D 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\[.C\\C\\C\\C\\C + + 00000F60:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00000F70:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00000F80:43 5C 0C 45 5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 C\\E\[.E\[.E\[.E\\. + + 00000F90:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F ?\_.?\_.?\_.?\_.?\_.? + + 00000FA0:5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \_.?\_.@\].@\].@\].@\] + + 00000FB0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 00000FC0:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 @\].@\].@\].A^.@\].@ + + 00000FD0:5D 0D 40 5D 0D 43 5C 10 78 82 4C B9 BF 9C D8 AB \].@\].C\\x‚L¹¿œØ« + + 00000FE0:84 D6 A3 7A D6 A2 7C DE BE A5 E7 DA CD E8 DA CB „Ö£zÖ¢\|Þ¾¥çÚÍèÚË + + 00000FF0:DA AA 89 E7 D9 CC DB AE 91 C7 63 2B C6 5D 24 C4 Úª‰çÙÌÛ®'ÇC+Æ\]\$Ä + + 00001000:56 1B C2 51 15 D1 A2 83 E1 D4 C5 E1 D2 C2 E1 D1 V.ÂQ.Ñ¢ƒáÔÅáÒÂáÑ + + 00001010:C2 D1 C0 AD D1 C2 B1 E2 D6 C9 D3 C5 B5 D4 C6 B7 ÂÑÀ­Ñ±âÖÉÓÅµÔÆ• + + 00001020:E2 D6 C8 EA DE D2 95 9A 76 5B 6B 2A 44 5C 0F 41 âÖÈêÞÒ•šv\[k\*D\\A + + 00001030:5C 0C 41 5C 0C 41 5C 0C 43 5C 0C 43 5C 0C 43 5C \\A\\A\\C\\C\\C\\ + + 00001040:0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B .C\[.BZ.C\[.C\\B\[. + + 00001050:43 5C 0C 43 5C 0C 43 5B 0D 43 5B 0D 43 5B 0D 43 C\\C\\C\[.C\[.C\[.C + + 00001060:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00001070:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00001080:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 C\\C\\C\\C\\C\\E + + 00001090:5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F \[.E\[.E\[.E\\.?\_.? + + 000010A0:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F \_.?\_.?\_.?\_.?\_.?\_ + + 000010B0:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000010C0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000010D0:5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D \].@\].A^.@\].@\].@\] + + 000010E0:0D 47 5E 13 8E 97 67 C4 BF 9F CE A9 81 CA B7 99 .G^.Ž--gÄ¿ŸÎ©□Ê•™ + + 000010F0:E4 DA CF DB CC BC E9 DA CC E8 DA CC E9 DB CE E5 äÚÏÛ̼éÚÌèÚÌéÛÎå + + 00001100:CF BE CB 73 40 C6 5F 26 C6 5C 22 C3 52 15 CA 75 ϾËs@Æ\_&Æ\\ÃR.Êu + + 00001110:45 D9 CA B9 E6 D8 CA E3 D5 C6 D1 BF AE C3 AF 9A EÙʹæØÊãÕÆÑ¿®Ã¯š + + 00001120:CE BE AD D1 C3 B3 CC BD AD D2 C4 B5 D9 CC BD DD ξ­Ñó̽­ÒĵÙÌ½Ý + + 00001130:CE BF CE C6 B3 6A 78 3A 47 5C 11 41 5C 0C 41 5C Î¿ÎÆ³jx:G\\A\\A\\ + + 00001140:0C 42 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D .B\\C\\C\\C\\C\[. + + 00001150:42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 BZ.C\[.C\\B\[.C\\C + + 00001160:5C 0C 43 5B 0D 43 5B 0D 43 5B 0D 43 5C 0C 43 5C \\C\[.C\[.C\[.C\\C\\ + + 00001170:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00001180:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00001190:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 45 5B \\C\\C\\C\\E\[.E\[ + + 000011A0:0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 5F .E\[.E\\.?\_.?\_.?\_ + + 000011B0:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D .?\_.?\_.?\_.?\_.@\]. + + 000011C0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000011D0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000011E0:0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 4C 61 17 .A^.@\].@\].@\].LA. + + 000011F0:9C A5 7A D1 BF 9E D6 A5 7D E2 BD 9F E3 CF BE DB œ¥zÑ¿žÖ¥}⽟ãÏ¾Û + + 00001200:CB BB E9 DA CC E8 D9 CB EA DF D3 DC B0 93 C7 63 Ë»éÚÌèÙËêßÓܰ"ÇC + + 00001210:29 C5 5C 22 C5 59 1F C5 5B 21 DD BC A4 DE D2 C4 )Å\\ÅY.Å\[!ݼ¤ÞÒÄ + + 00001220:E6 D8 CA E8 DA CC CD BB A9 C6 B3 9F CE BD AB CA æØÊèÚÌÍ»©Æ³ŸÎ½«Ê + + 00001230:B8 A5 CF BE AC D5 C4 B2 BD B4 9D AB AC 8B B6 BA ¸¥Ï¾¬ÕIJ½´□«¬‹¶º + + 00001240:9A 78 86 4D 4A 5E 14 43 5C 0C 43 5C 0C 43 5C 0C šx†MJ^.C\\C\\C\\ + + 00001250:43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 C\\C\\C\\C\[.BZ.C + + 00001260:5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B \[.C\\B\[.C\\C\\C\[ + + 00001270:0D 42 5A 0C 43 5B 0D 43 5C 0C 43 5C 0C 43 5C 0C .BZ.C\[.C\\C\\C\\ + + 00001280:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00001290:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 000012A0:0C 43 5C 0C 43 5C 0C 45 5B 0C 45 5B 0C 45 5B 0C .C\\C\\E\[.E\[.E\[. + + 000012B0:45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E E\\.?\_.?\_.?\_.?\_. + + 000012C0:3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 ?\_.?\_.?\_.@\].@\].@ + + 000012D0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000012E0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E .@\].@\].@\].@\].A^. + + 000012F0:40 5D 0D 40 5D 0D 40 5D 0D 53 64 1D A2 AA 82 D7 @\].@\].@\].SD.¢ª‚× + + 00001300:BC 99 D8 A7 7F DA A8 81 E3 CE BB E1 D2 C3 E8 D9 ¼™Ø§Ú¨□ãλáÒÃèÙ + + 00001310:CC E8 D9 CB E4 D6 C7 E6 D7 C9 E2 BC A3 D2 84 57 ÌèÙËäÖÇæ×Éâ¼£Ò„W + + 00001320:C5 56 1A D4 9A 76 E6 DE D2 E0 D0 C1 E3 D5 C6 F0 ÅV.ÔšvæÞÒàÐÁãÕÆð + + 00001330:E4 D7 E1 D2 C3 CA B7 A4 D1 C1 B0 C9 B7 A3 D0 BD ä×áÒÃÊ•¤ÑÁ°É•£Ð½ + + 00001340:A9 D8 C6 B2 B5 AC 92 7B 89 53 75 89 4D 70 82 46 ©ØÆ²µ¬'{‰Su‰Mp‚F + + 00001350:53 61 1C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 SA.C\\C\\C\\C\\C + + 00001360:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C \\C\\C\[.BZ.C\[.C\\ + + 00001370:0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C .B\[.C\\C\\C\[.BZ. + + 00001380:42 5A 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 BZ.C\\C\\C\\C\\C + + 00001390:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 000013A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000013B0:43 5C 0C 45 5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 C\\E\[.E\[.E\[.E\\. + + 000013C0:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F ?\_.?\_.?\_.?\_.?\_.? + + 000013D0:5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \_.?\_.@\].@\].@\].@\] + + 000013E0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000013F0:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 @\].@\].@\].A^.@\].@ + + 00001400:5D 0D 41 5D 0E 59 67 24 A9 B2 8C D1 BB 98 D7 A5 \].A\].Yg\$©²ŒÑ»˜×¥ + + 00001410:7C D4 B0 8D DE D4 C5 DA CA BB DE D1 C5 DB D0 C3 \|Ô°□ÞÔÅÚÊ»ÞÑÅÛÐà + + 00001420:DC CE BF E4 D5 C5 EC E2 D7 F0 E5 D9 E4 C4 AE D7 ÜοäÕÅìâ×ðåÙäÄ®× + + 00001430:C8 B9 D4 C7 BA D8 C9 BB E0 D2 C4 E9 DD D0 E3 D4 ȹÔǺØÉ»àÒÄéÝÐãÔ + + 00001440:C6 CF BD AB D2 C3 B3 C2 B2 A1 C6 B6 A3 CD BA A7 ÆÏ½«Ò󲡯¶£Íº§ + + 00001450:CD BD A7 8B 97 65 7D 8E 55 74 85 49 5A 66 21 44 ͽ§‹--E}ŽUt…IZF!D + + 00001460:5C 0E 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00001470:0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B .C\[.BZ.C\[.C\\B\[. + + 00001480:43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 42 5A 0C 42 C\\C\\C\[.BZ.BZ.B + + 00001490:5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \[.C\\C\\C\\C\\C\\ + + 000014A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000014B0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 C\\C\\C\\C\\C\\E + + 000014C0:5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F \[.E\[.E\[.E\\.?\_.? + + 000014D0:5F 0E 3F 5F 0C 3F 5F 0C 3F 5F 0C 3F 5F 0E 40 5E \_.?\_.?\_.?\_.?\_.@^ + + 000014E0:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000014F0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00001500:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 43 5D \].@\].@\].@\].@\].C\] + + 00001510:0F 69 71 33 B3 BC 99 CD BA 96 D6 A4 79 A2 9B 72 .iq3³¼™Íº–Ö¤y¢›r + + 00001520:B3 AE 91 DE D0 C2 D9 C2 AF CE 9D 7C CF 8E 64 CE ³®'ÞÐÂÙ¯Î□\|ÏŽDÎ + + 00001530:7D 4C D6 AB 8D DD D4 C9 DB D1 C6 DB CF C2 D8 CA }LÖ«□ÝÔÉÛÑÆÛÏÂØÊ + + 00001540:BC CF C1 B2 D1 C4 B6 DB CF C3 D6 C8 BB C6 B6 A5 ¼ÏÁ²ÑĶÛÏÃÖȻƶ¥ + + 00001550:CF C2 B4 D4 C8 BC A1 9B 81 69 6C 3C 60 63 2E 6C Ï´Ôȼ¡›□il\<\`C.l + + 00001560:77 41 7A 88 54 74 83 4B 60 6C 27 45 5C 0E 43 5C wAzˆTtƒK\`l'E\\C\\ + + 00001570:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D .C\\C\\C\\C\\C\[. + + 00001580:42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 BZ.C\[.C\\B\[.C\\C + + 00001590:5C 0C 43 5B 0D 44 5A 0C 44 5A 0C 44 5B 0B 43 5C \\C\[.DZ.DZ.D\[.C\\ + + 000015A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000015B0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 000015C0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0C 43 5B \\C\\C\\C\\C\[.C\[ + + 000015D0:0C 45 5B 0C 43 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 60 .E\[.C\\.?\_.?\_.?\` + + 000015E0:0C 3F 60 0C 3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D .?\`.?\`.?\_.A^.@\]. + + 000015F0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00001600:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00001610:0D 40 5D 0D 40 5D 0D 40 5D 0D 45 5E 10 7D 82 48 .@\].@\].@\].E^.}‚H + + 00001620:BE C5 A4 B9 B0 8A BA B2 93 D1 C9 B6 DB AC 89 E6 ¾Å¤¹°Šº²"Ñɶ۬‰æ + + 00001630:CC B7 E8 D2 C0 D1 85 55 CC 75 41 CA 6C 36 C6 6E Ì•èÒÀÑ…UÌuAÊl6Æn + + 00001640:3B B5 A4 8E D2 C6 B8 E7 D8 C9 E5 D6 C7 E0 D1 C2 ;µ¤ŽÒƸçØÉåÖÇàÑ + + 00001650:DA CC BD DB CD C0 D3 C6 B7 BE AF A0 D0 C3 B5 E9 Ú̽ÛÍÀÓÆ•¾¯ Ðõé + + 00001660:DE D2 EA E2 D6 C3 BE A9 8B 89 64 61 66 34 65 6D ÞÒêâÖþ©‹‰DAF4Em + + 00001670:3E 68 76 45 63 6C 2D 47 5D 0F 43 5C 0C 43 5C 0C \>hvECl-G\].C\\C\\ + + 00001680:43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 C\\C\\C\\C\[.BZ.C + + 00001690:5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B \[.C\\B\[.C\\C\\C\[ + + 000016A0:0D 45 5B 0D 45 5B 0C 45 5B 0C 43 5C 0C 42 5B 0B .E\[.E\[.E\[.C\\B\[. + + 000016B0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 000016C0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 000016D0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C .C\\C\\C\\C\\E\[. + + 000016E0:43 5D 0A 00 3F 5F 0E 3F 5F 0E 3F 60 0C 3F 60 0C C\]..?\_.?\_.?\`.?\`. + + 000016F0:3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 ?\`.?\_.A^.@\].@\].@ + + 00001700:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00001710:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 00001720:40 5D 0D 40 5D 0D 47 5E 12 91 93 61 BC C2 A1 C3 @\].@\].G^.'"A¼Â¡Ã + + 00001730:C4 AB E8 E0 D4 DF B4 93 D4 96 68 DE B2 93 E0 BB Ä«èàÔß´"Ô–hÞ²"à» + + 00001740:A0 CF 81 50 CD 7A 48 CB 71 3C C8 63 2A D3 9A 75 Ï□PÍzHËq\<ÈC\*Óšu + + 00001750:E1 D5 C7 DB CB BB D8 C7 B7 D7 C6 B5 D8 C7 B6 D8 áÕÇÛË»ØÇ•ׯµØÇ¶Ø + + 00001760:C7 B6 D3 C1 AF C5 B2 9E DB CD BE E9 DE D3 EF E5 ǶÓÁ¯Å²žÛ;éÞÓïå + + 00001770:DB F6 EE E4 FA F0 E7 E3 D8 CA BB B0 9A A1 9D 83 ÛöîäúðçãØÊ»°š¡□ƒ + + 00001780:71 74 3B 4A 5E 12 43 5C 0C 43 5C 0C 43 5C 0C 43 qt;J^.C\\C\\C\\C + + 00001790:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C \\C\\C\[.BZ.C\[.C\\ + + 000017A0:0C 42 5B 0B 43 5B 0C 43 5B 0C 43 5C 0C 45 5B 0C .B\[.C\[.C\[.C\\E\[. + + 000017B0:44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 DZ.DZ.B\[.B\[.C\\C + + 000017C0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 000017D0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000017E0:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 43 5C 0A 00 C\\C\\C\\E\[.C\\. + + 000017F0:3F 5F 0E 3F 5F 0E 3F 60 0C 3F 60 0C 3F 60 0C 3F ?\_.?\_.?\`.?\`.?\`.? + + 00001800:5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \_.A^.@\].@\].@\].@\] + + 00001810:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 00001820:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00001830:5D 0D 4E 60 17 9B 9C 6F BB C2 9E D7 D5 C2 E0 C0 \].N\`.›œo»Âž×ÕÂàÀ + + 00001840:A6 D7 A0 76 D6 9C 72 D8 A1 7A D4 95 6A D0 82 51 ¦× vÖœrØ¡zÔ•jЂQ + + 00001850:CD 7A 47 CA 6D 38 D7 A7 88 DB BF AA D9 C9 B8 D3 ÍzGÊm8×§ˆÛ¿ªÙÉ¸Ó + + 00001860:C3 B2 D0 BF AC D0 BE AC D1 C0 AE CF BD AA C6 B3 òп¬Ð¾¬ÑÀ®Ï½ªÆ³ + + 00001870:9F D1 BF AD E2 D5 C7 E6 DC D0 EA DF D4 E9 DE D3 ŸÑ¿­âÕÇæÜÐêßÔéÞÓ + + 00001880:E4 D8 CC DC CE C0 D1 C0 AF CC BD AA 73 79 3E 50 äØÌÜÎÀÑÀ¯Ì½ªsy\>P + + 00001890:5F 17 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \_.C\\C\\C\\C\\C\\ + + 000018A0:0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B .C\[.BZ.C\[.C\\B\[. + + 000018B0:43 5B 0D 43 5B 0D 43 5C 0C 45 5B 0C 44 5A 0B 44 C\[.C\[.C\\E\[.DZ.D + + 000018C0:5A 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C Z.B\[.B\[.C\\C\\C\\ + + 000018D0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000018E0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 000018F0:5C 0C 43 5C 0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F \\C\\E\[.E\\.?\_.? + + 00001900:5F 0E 3F 60 0C 3F 60 0C 3F 60 0C 3F 5F 0E 41 5E \_.?\`.?\`.?\`.?\_.A^ + + 00001910:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 00001920:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00001930:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 57 64 \].@\].@\].@\].@\].WD + + 00001940:1E A5 A5 7C B8 BE 9B D4 D1 BF E2 C5 AD D8 A2 78 .¥¥\|¸¾›ÔÑ¿âÅ­Ø¢x + + 00001950:D7 9E 74 D8 A4 7E D2 8C 5E D0 83 53 CC 74 40 D1 מtؤ~ÒŒ^ЃSÌt@Ñ + + 00001960:8D 62 DE D0 C2 DC CE C0 D4 C2 B1 CF BD AB D1 BF □BÞÐÂÜÎÀÔ±Ͻ«Ñ¿ + + 00001970:AD D4 C3 B2 D4 C3 B1 CF BE AB D1 BF AD DC CC BC ­ÔòÔñϾ«Ñ¿­Ü̼ + + 00001980:DE D0 C3 DF D3 C6 DD D0 C3 DC CF C1 DF D3 C5 DA ÞÐÃßÓÆÝÐÃÜÏÁßÓÅÚ + + 00001990:CC BF D3 C5 B6 90 8D 58 60 6D 27 56 64 1E 43 5C Ì¿ÓŶ□□X\`m'VD.C\\ + + 000019A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D .C\\C\\C\\C\\C\[. + + 000019B0:42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B 43 5B 0D 43 BZ.C\[.C\\B\[.C\[.C + + 000019C0:5B 0D 43 5C 0C 44 5A 0B 44 5A 0B 44 5A 0B 42 5B \[.C\\DZ.DZ.DZ.B\[ + + 000019D0:0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .B\[.C\\C\\C\\C\\ + + 000019E0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 000019F0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00001A00:0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 60 .E\[.E\\.?\_.?\_.?\` + + 00001A10:0C 3F 60 0C 3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D .?\`.?\`.?\_.A^.@\]. + + 00001A20:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00001A30:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00001A40:0D 40 5D 0D 40 5D 0D 40 5D 0D 62 6B 26 B0 B1 8C .@\].@\].@\].Bk&°±Œ + + 00001A50:BB BE A0 E3 DD D0 E8 D7 C8 D8 A2 7A D7 A4 7D D5 »¾ ãÝÐè×ÈØ¢zפ}Õ + + 00001A60:9C 74 D1 87 57 CE 7C 4A D0 88 5C D7 C2 AF D4 C5 œtчWÎ\|JЈ\\¯ÔÅ + + 00001A70:B5 D5 C4 B2 D9 C9 B8 DD CD BD DC CC BC DA C9 B9 µÕIJÙɸÝͽÜ̼Úɹ + + 00001A80:D7 C6 B6 D7 C6 B5 DF D0 C0 D7 C7 B6 D7 C8 B9 D5 ׯ¶×ƵßÐÀ×Ƕ×È¹Õ + + 00001A90:C7 B9 D9 CB BD E5 DA CD E4 D9 CC E0 D3 C6 D7 CD ǹÙ˽åÚÍäÙÌàÓÆ×Í + + 00001AA0:BD 7C 84 48 5B 6A 1F 5C 67 21 43 5C 0C 43 5C 0C ½\|„H\[j.\g!C\\C\\ + + 00001AB0:43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 C\\C\\C\\C\[.BZ.C + + 00001AC0:5B 0D 43 5C 0C 42 5B 0B 43 5B 0D 42 5A 0C 42 5B \[.C\\B\[.C\[.BZ.B\[ + + 00001AD0:0B 44 5A 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B .DZ.DZ.DZ.B\[.B\[. + + 00001AE0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00001AF0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00001B00:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C .C\\C\\C\\C\\E\[. + + 00001B10:45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 60 0C 3F 60 0C E\\.?\_.?\_.?\`.?\`. + + 00001B20:3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 ?\`.?\_.A^.@\].@\].@ + + 00001B30:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00001B40:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 00001B50:40 5D 0D 41 5D 0D 6D 73 32 B9 BA 9B D6 D1 BF EC @\].A\].ms2¹º›ÖÑ¿ì + + 00001B60:E3 DA EE E7 DF E1 C0 A5 D7 AB 88 D7 A3 7E DA A7 ãÚîçßáÀ¥×«ˆ×£~Ú§ + + 00001B70:84 DD B1 94 D9 C4 B1 D4 C5 B4 DB CB BB E9 DB CD „ݱ"ÙıÔÅ´ÛË»éÛÍ + + 00001B80:E9 DB CE E3 D5 C6 DE CF BF DC CD BC DF CF C0 E1 éÛÎãÕÆÞÏ¿ÜͼßÏÀá + + 00001B90:D1 C2 DF CF C0 DA CA B9 D6 C7 B8 D5 C7 B9 E8 DC ÑÂßÏÀÚʹÖǸÕǹèÜ + + 00001BA0:D1 E8 DC D1 E4 D8 CC E5 D9 CC B2 AD 93 7D 89 53 ÑèÜÑäØÌåÙ̲­"}‰S. + + 00001BB0:6A 77 32 60 6A 24 44 5C 0C 43 5C 0C 43 5C 0C 43 jw2\`j\$D\\C\\C\\C + + 00001BC0:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C \\C\\C\[.BZ.C\[.C\\ + + 00001BD0:0C 42 5B 0B 42 5A 0C 42 5A 0C 42 5B 0B 44 5A 0B .B\[.BZ.BZ.B\[.DZ. + + 00001BE0:44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 DZ.DZ.B\[.B\[.C\\C + + 00001BF0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00001C00:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00001C10:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 45 5C 0A 00 C\\C\\C\\E\[.E\\. + + 00001C20:40 5D 0D 41 5E 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F @\].A^.?\_.?\_.?\_.? + + 00001C30:5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \_.A^.@\].@\].@\].@\] + + 00001C40:0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .A^.@\].@\].@\].@\]. + + 00001C50:41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 A^.@\].@\].@\].@\].A + + 00001C60:5E 0F 77 79 3C CC CA B4 EB E2 D9 ED E4 DB EF E7 ^.wy\<ÌÊ´ëâÙíäÛïç + + 00001C70:E0 EF E7 DE DE CC BB DD CD BC E8 DB CD E9 DC CF àïçÞÞÌ»ÝͼèÛÍéÜÏ + + 00001C80:DC CD BD E5 D6 C7 F1 E4 D8 F0 E3 D6 EA DC CE E5 ÜͽåÖÇñäØðãÖêÜÎå + + 00001C90:D6 C7 E1 D2 C2 DF CF C0 DF CF C0 DD CD BD D9 C8 ÖÇáÒÂßÏÀßÏÀÝͽÙÈ + + 00001CA0:B8 D7 C6 B5 E0 D3 C6 E6 DB CF EB E0 D5 E1 D5 C8 ¸×ƵàÓÆæÛÏëàÕáÕÈ + + 00001CB0:DF D3 C7 E4 D8 CB A7 A3 88 77 82 4F 77 86 4B 6B ßÓÇäØË§£ˆw‚Ow†Kk + + 00001CC0:71 30 44 5D 0E 41 5C 0C 43 5C 0C 43 5C 0C 43 5C q0D\].A\\C\\C\\C\\ + + 00001CD0:0C 43 5C 0C 43 5C 0C 43 5B 0D 43 5B 0D 43 5B 0D .C\\C\\C\[.C\[.C\[. + + 00001CE0:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A 0B 44 B\[.B\[.B\[.B\[.DZ.D + + 00001CF0:5A 0B 42 5B 0B 42 5B 0B 44 5A 0B 43 5C 0C 43 5C Z.B\[.B\[.DZ.C\\C\\ + + 00001D00:0C 43 5D 0A 43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C .C\].C\].C\].C\\C\\ + + 00001D10:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 C\\C\\C\\C\\C\\C + + 00001D20:5C 0C 43 5C 0C 42 5B 0B 44 5B 09 00 40 5D 0D 41 \\C\\B\[.D\[..@\].A + + 00001D30:5E 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 41 5E ^.?\_.?\_.?\_.?\_.A^ + + 00001D40:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E .@\].@\].@\].@\].A^. + + 00001D50:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00001D60:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 47 5F 13 80 7F \].@\].@\].@\].G\_.€ + + 00001D70:46 DE DA C9 EF E6 DD EE E5 DD F0 E8 E0 F1 E8 E0 FÞÚÉïæÝîåÝðèàñèà + + 00001D80:E2 D2 C3 DE CD BD E3 D3 C3 E3 D4 C5 E2 D3 C5 E6 âÒÃÞͽãÓÃãÔÅâÓÅæ + + 00001D90:D9 CA E5 D7 C9 E7 DA CB E9 DA CC E5 D6 C8 E2 D3 ÙÊå×ÉçÚËéÚÌåÖÈâÓ + + 00001DA0:C4 E0 D1 C2 DA CA B9 D3 C2 B1 CF BD AA CC B9 A6 ÄàÑÂÚʹÓ±ϽªÌ¹¦ + + 00001DB0:D6 C7 B8 E1 D5 C9 E7 DB CF DF D3 C6 E0 D3 C7 DE ÖǸáÕÉçÛÏßÓÆàÓÇÞ + + 00001DC0:D1 C5 D4 C9 B9 7F 85 5B 75 83 4A 74 78 3A 4A 5F ÑÅÔɹ…\[uƒJtx:J\_ + + 00001DD0:14 41 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .A\\C\\C\\C\\C\\ + + 00001DE0:42 5B 0B 42 5B 0C 42 5B 0C 43 5B 0C 42 5B 0B 42 B\[.B\[.B\[.C\[.B\[.B + + 00001DF0:5B 0B 42 5B 0B 42 5B 0B 43 5A 0B 43 5A 0B 42 5B \[.B\[.B\[.CZ.CZ.B\[ + + 00001E00:0B 42 5B 0B 44 5A 0B 43 5C 0C 43 5C 0C 43 5D 0A .B\[.DZ.C\\C\\C\]. + + 00001E10:43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C 43 5C 0C 43 C\].C\].C\\C\\C\\C + + 00001E20:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \\C\\C\\C\\C\\C\\ + + 00001E30:0C 42 5B 0B 44 5B 09 00 40 5D 0D 41 5E 0E 3F 5F .B\[.D\[..@\].A^.?\_ + + 00001E40:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 41 5E 0E 40 5D 0D .?\_.?\_.?\_.A^.@\]. + + 00001E50:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 @\].@\].@\].A^.@\].@ + + 00001E60:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 00001E70:0D 40 5D 0D 40 5D 0D 4B 61 15 8E 8B 57 CF CE B6 .@\].@\].KA.Ž‹WÏζ + + 00001E80:EA E2 D6 F0 E7 DF F1 E9 E1 F1 E8 E0 E4 D5 C5 E1 êâÖðçßñéáñèàäÕÅá + + 00001E90:D1 C0 E0 D0 C0 E0 D0 C2 E4 D5 C6 E3 D4 C5 E3 D4 ÑÀàÐÀàÐÂäÕÆãÔÅãÔ + + 00001EA0:C5 E5 D6 C8 E8 DB CD EB DD D0 EB DD CF E8 DA CC ÅåÖÈèÛÍëÝÐëÝÏèÚÌ + + 00001EB0:E0 D1 C2 D7 C6 B5 CE BB A9 C9 B5 A2 D3 C4 B5 D3 àÑÂׯµÎ»©Éµ¢ÓÄµÓ + + 00001EC0:C4 B6 DA CD BF E1 D5 C9 E3 D7 CB DD D1 C4 EA DF ĶÚÍ¿áÕÉã×ËÝÑÄêß + + 00001ED0:D4 B7 B4 9C 77 85 4D 76 7D 3E 4F 61 17 41 5C 0C Ô•´œw…Mv}\>OA.A\\ + + 00001EE0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 42 C\\C\\C\\C\\B\[.B + + 00001EF0:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00001F00:0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5A 0B 43 5A 0B .B\[.B\[.B\[.CZ.CZ. + + 00001F10:44 5A 0B 43 5C 0C 43 5C 0C 43 5D 0A 43 5D 0A 43 DZ.C\\C\\C\].C\].C + + 00001F20:5D 0A 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \].C\\C\\C\\C\\C\\ + + 00001F30:0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 43 5A 0B .C\\C\\C\\B\[.CZ. + + 00001F40:44 5B 09 00 40 5D 0D 40 5D 0D 3F 5F 0E 3F 5F 0E D\[..@\].@\].?\_.?\_. + + 00001F50:3F 5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 ?\_.?\_.@\].@\].@\].@ + + 00001F60:5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D \].@\].A^.@\].@\].@\] + + 00001F70:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 00001F80:40 5D 0D 50 63 1A A3 9F 71 CA C9 B1 E0 D9 CB F1 @\].PC.£ŸqÊɱàÙËñ + + 00001F90:E8 E0 F2 EA E2 F2 E9 E0 E7 D8 C8 E4 D4 C4 E1 D0 èàòêâòéàçØÈäÔÄáÐ + + 00001FA0:C1 E4 D5 C6 DD CD BD D7 C6 B6 DE CF BF E5 D6 C8 ÁäÕÆÝÍ½×Æ¶ÞÏ¿åÖÈ + + 00001FB0:EB DE D0 F0 E3 D6 F1 E5 D8 F0 E3 D6 ED DF D3 E9 ëÞÐðãÖñåØðãÖíßÓé + + 00001FC0:DB CD E8 DA CC E3 D4 C5 E3 D7 CA E4 D8 CC D9 CB ÛÍèÚÌãÔÅã×ÊäØÌÙË + + 00001FD0:BD D9 CB BD E0 D3 C7 DF D3 C6 E7 DC D0 E1 D8 C8 ½Ù˽àÓÇßÓÆçÜÐáØÈ + + 00001FE0:80 8D 56 7A 82 45 55 64 1B 41 5C 0C 43 5C 0C 43 €□Vz‚EUD.A\\C\\C + + 00001FF0:5C 0C 43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \\C\\B\[.B\[.B\[.B\[ + + 00002000:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B .B\[.B\[.B\[.B\[.B\[. + + 00002010:42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B 44 5A 0B 43 B\[.B\[.DZ.DZ.DZ.C + + 00002020:5C 0C 43 5C 0C 43 5D 0A 43 5D 0A 43 5D 0A 43 5C \\C\\C\].C\].C\].C\\ + + 00002030:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00002040:43 5C 0C 43 5C 0C 43 5A 0B 44 5A 0B 44 5B 09 00 C\\C\\CZ.DZ.D\[.. + + 00002050:40 5D 0D 40 5D 0D 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F @\].@\].?\_.?\_.?\_.? + + 00002060:5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \_.@\].@\].@\].@\].@\] + + 00002070:0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .A^.@\].@\].@\].@\]. + + 00002080:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 58 @\].@\].@\].@\].@\].X + + 00002090:67 20 B2 AF 88 D8 D4 C5 F0 E7 DE F1 E9 E1 F3 EC g ²¯ˆØÔÅðçÞñéáóì + + 000020A0:E4 F3 E9 E1 E9 DA CB E6 D6 C7 E4 D4 C4 E6 D8 C9 äóéáéÚËæÖÇäÔÄæØÉ + + 000020B0:DF D0 C0 D5 C4 B3 DB CB BA E5 D7 C9 EB DD D0 EF ßÐÀÕijÛ˺å×ÉëÝÐï + + 000020C0:E2 D5 F1 E4 D8 F0 E4 D7 ED DF D2 EE E1 D4 E6 D8 âÕñäØðä×íßÒîáᆵ + + 000020D0:C9 C1 AE 98 CA B9 A8 E8 DC D1 EC E1 D7 E7 DC D0 ÉÁ®˜Ê¹¨èÜÑìá×çÜÐ + + 000020E0:DD D0 C3 D4 C6 B7 D8 CB BC AE AC 8B 79 87 4D 7B ÝÐÃÔÆ•ØË¼®¬‹y‡M{ + + 000020F0:84 4A 5C 67 20 41 5C 0C 43 5C 0C 43 5C 0C 43 5C „J\g A\\C\\C\\C\\ + + 00002100:0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B .B\[.B\[.B\[.B\[.B\[. + + 00002110:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002120:5B 0B 44 5A 0B 44 5A 0B 44 5A 0B 43 5C 0C 43 5C \[.DZ.DZ.DZ.C\\C\\ + + 00002130:0C 43 5D 0A 43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C .C\].C\].C\].C\\C\\ + + 00002140:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 C\\C\\C\\C\\C\\B + + 00002150:5B 0B 44 5A 0B 44 5A 0B 44 5B 09 00 40 5D 0D 40 \[.DZ.DZ.D\[..@\].@ + + 00002160:5D 0D 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D \].?\_.?\_.?\_.?\_.@\] + + 00002170:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E .@\].@\].@\].@\].A^. + + 00002180:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00002190:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 64 6C 29 C3 BD \].@\].@\].@\].Dl)ý + + 000021A0:A0 F4 EC E3 F2 E9 E0 F3 EA E2 F5 EE E6 F3 EA E1 ôìãòéàóêâõîæóêá + + 000021B0:EB DC CD E8 D9 CA E5 D5 C6 E4 D4 C5 E3 D3 C3 D9 ëÜÍèÙÊåÕÆäÔÅãÓÃÙ + + 000021C0:C8 B8 D3 C1 AF DC CC BC EB DD D0 EF E2 D6 F2 E5 ȸÓÁ¯Ü̼ëÝÐïâÖòå + + 000021D0:DA F2 E5 D9 F4 E7 DB EA DC CE C7 B3 A0 B7 A2 8B ÚòåÙôçÛêÜÎdz •¢‹ + + 000021E0:D1 C2 B3 EB E0 D6 E6 DA CF EA E0 D5 EF E4 DB E8 ѳëàÖæÚÏêàÕïäÛè + + 000021F0:DC D1 D0 C5 B4 8A 8F 63 7C 8B 51 79 85 4A 64 69 ÜÑÐÅ´Š□C\|‹Qy…JDi + + 00002200:27 41 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 'A\\C\\C\\C\\B\[. + + 00002210:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002220:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A \[.B\[.B\[.B\[.B\[.DZ + + 00002230:0B 44 5A 0B 44 5A 0B 43 5C 0C 43 5C 0C 43 5D 0A .DZ.DZ.C\\C\\C\]. + + 00002240:43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C 43 5C 0C 43 C\].C\].C\\C\\C\\C + + 00002250:5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 44 5A 0B 44 5A \\C\\C\\B\[.DZ.DZ + + 00002260:0B 44 5A 0B 44 5B 09 00 40 5D 0D 40 5D 0D 3F 5E .DZ.D\[..@\].@\].?^ + + 00002270:0D 3F 5E 0D 3F 5E 0D 3F 5E 0D 40 5D 0D 40 5D 0D .?^.?^.?^.@\].@\]. + + 00002280:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00002290:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000022A0:0D 3F 5C 0C 40 5C 0D 72 74 35 CC C5 AC F4 EC E4 .?\\@\\rt5ÌŬôìä + + 000022B0:F1 E9 E0 F6 EE E6 F5 EE E6 F2 E9 DE ED DE CF EB ñéàöîæõîæòéÞíÞÏë + + 000022C0:DC CE E3 D3 C3 D8 C7 B4 DB CB BA DF D0 BF D9 C8 ÜÎãÓÃØÇ´Û˺ßпÙÈ + + 000022D0:B7 D9 C8 B7 ED DE D0 F4 E6 D9 F9 ED E0 FD F0 E4 •ÙÈ•íÞÐôæÙùíàýðä + + 000022E0:FF F3 E7 E0 CF BD CA B6 A1 C7 B3 9D F3 E7 DC F4 ÿóçàϽʶ¡Ç³□óçÜô + + 000022F0:EA E0 E7 DD D0 E7 DC D0 E8 DD D2 EF E5 DB F0 E7 êàçÝÐçÜÐèÝÒïåÛðç + + 00002300:DD A5 A6 81 7C 8A 50 76 83 47 6F 71 31 43 5C 0E Ý¥¦□\|ŠPvƒGoq1C\\ + + 00002310:43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 C\\B\[.B\[.B\[.B\[.B + + 00002320:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00002330:0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B .B\[.B\[.B\[.DZ.DZ. + + 00002340:43 5A 0B 42 5B 0B 42 5B 0B 43 5C 0A 43 5C 0A 43 CZ.B\[.B\[.C\\C\\C + + 00002350:5C 0A 43 5C 0C 43 5C 0C 43 5C 0B 43 5C 0B 43 5C \\C\\C\\C\\C\\C\\ + + 00002360:0C 43 5B 0C 42 5A 0A 43 59 0A 44 5A 0B 44 5A 0B .C\[.BZ.CY.DZ.DZ. + + 00002370:43 5B 09 00 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D C\[..@\].@\].@\].@\]. + + 00002380:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00002390:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000023A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C .@\].@\].@\].@\].?\\ + + 000023B0:43 5E 0F 80 7E 41 D3 CD BA F2 E9 E0 F4 EB E2 F4 C^.€~AÓͺòéàôëâô + + 000023C0:EA E1 F0 E8 DF E5 D9 CD DD CE BE E4 D5 C7 DC CD êáðèßåÙÍÝξäÕÇÜÍ + + 000023D0:BF D9 CA BB D9 CA BB DA CC BD D2 C4 B6 CC BF B2 ¿ÙÊ»ÙÊ»Ú̽ÒĶ̿² + + 000023E0:CC C1 B5 C8 BD B2 C3 B9 AF C0 B6 AB BA AE A2 AA ÌÁµÈ½²Ã¹¯À¶«º®¢ª + + 000023F0:9A 8B A6 95 84 BB AD 9E D7 CE C5 D5 CA BF D3 C6 š‹¦•„»­ž×ÎÅÕÊ¿ÓÆ + + 00002400:B9 DC CF C1 E5 D7 C9 EB DF D2 E6 DC CF 8D 92 67 ¹ÜÏÁå×ÉëßÒæÜÏ□'g + + 00002410:7A 87 4D 73 82 45 79 79 39 49 5E 11 43 5C 0C 42 z‡Ms‚Eyy9I^.C\\B + + 00002420:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00002430:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B .B\[.B\[.B\[.B\[.B\[. + + 00002440:42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 B\[.B\[.DZ.DZ.B\[.B + + 00002450:5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \[.B\[.C\\C\\C\\C\\ + + 00002460:0C 43 5C 0C 43 5D 0A 43 5D 0A 43 5C 0C 44 5A 0B .C\\C\].C\].C\\DZ. + + 00002470:43 59 0A 43 59 0A 44 5A 0B 44 5A 0B 42 5C 09 00 CY.CY.DZ.DZ.B\\. + + 00002480:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 00002490:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000024A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000024B0:40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C 45 5F 11 90 @\].@\].@\].?\\E\_.□ + + 000024C0:8A 4F EA E1 D5 E8 DF D7 E7 DF D6 E7 E1 DA E5 E0 ŠOêáÕèß×çßÖçáÚåà + + 000024D0:DB E6 E3 DF EA E8 E5 F0 EE ED F2 F2 F1 F1 F1 F1 Ûæãßêèåðîíòòññññ + + 000024E0:F0 F0 F0 EB EB EB E3 E4 E4 D7 D7 D8 C2 C3 C4 A8 ðððëëëãää×רÂÃĨ + + 000024F0:A9 AA 8B 8B 8C 6C 6C 6D 53 54 55 45 45 46 3E 3F ©ª‹‹ŒllmSTUEEF\>? + + 00002500:3F 3B 3B 3B 3C 3B 3A 41 40 3F 4A 48 46 5B 57 54 ?;;;\<;:A@?JHF\[WT + + 00002510:78 72 6C 9C 94 8B B4 AB A2 A2 9F 86 95 9C 6F 7A xrlœ"‹´«¢¢Ÿ†•œoz + + 00002520:8A 4F 7B 7D 3D 4B 5F 13 43 5C 0C 42 5B 0B 42 5B ŠO{}=K\_.C\\B\[.B\[ + + 00002530:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B .B\[.B\[.B\[.B\[.B\[. + + 00002540:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002550:5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B \[.DZ.DZ.B\[.B\[.B\[ + + 00002560:0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 00002570:43 5D 0A 43 5D 0A 43 5C 0C 44 5A 0B 43 59 0A 43 C\].C\].C\\DZ.CY.C + + 00002580:59 0A 44 5A 0B 44 5A 0B 42 5C 09 00 40 5D 0D 40 Y.DZ.DZ.B\\.@\].@ + + 00002590:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000025A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000025B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000025C0:5D 0D 40 5D 0D 3F 5C 0C 52 64 1D A1 92 80 C5 C5 \].@\].?\\RD.¡'€ÅÅ + + 000025D0:C4 D2 D2 D2 E1 E2 E3 EB EC ED F2 F2 F3 F5 F5 F5 ÄÒÒÒáâãëìíòòóõõõ + + 000025E0:F7 F7 F6 F6 F6 F6 F5 F4 F3 F4 F3 F1 F1 EF EE F1 ÷÷ööööõôóôóññïîñ + + 000025F0:EF ED ED EC EA E7 E5 E3 DF DE DC D2 D1 D0 C4 C2 ïííìêçåãßÞÜÒÑÐÄ + + 00002600:C0 B7 B5 B2 AB A9 A6 A0 9D 9B 93 90 8D 89 88 87 À•µ²«©¦ □›"□□‰ˆ‡ + + 00002610:7E 7E 7F 72 72 71 6B 6A 6A 69 69 6A 69 6A 6B 6F \~~rrqkjjiijijko + + 00002620:71 73 83 86 89 A2 A3 A5 BB BA BA C4 C7 BF AE A4 qsƒ†‰¢£¥»ººÄÇ¿®¤ + + 00002630:81 55 64 1C 43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B □UD.C\\B\[.B\[.B\[. + + 00002640:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002650:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A \[.B\[.B\[.B\[.B\[.DZ + + 00002660:0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C .DZ.B\[.B\[.B\[.C\\ + + 00002670:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5D 0A 43 C\\C\\C\\C\\C\].C + + 00002680:5D 0A 43 5C 0C 44 5A 0B 44 5A 0B 43 59 0A 43 59 \].C\\DZ.DZ.CY.CY + + 00002690:0A 44 5A 0B 42 5C 09 00 40 5D 0D 40 5D 0D 40 5D .DZ.B\\.@\].@\].@\] + + 000026A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000026B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000026C0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000026D0:0D 3F 5C 0C 75 82 5E 9E A0 A2 C6 C7 C8 DE DE DE .?\\u‚^ž ¢ÆÇÈÞÞÞ + + 000026E0:EA E9 E8 F2 F1 F0 F5 F3 F0 F5 F3 F0 F1 ED E9 EB êéèòñðõóðõóðñíéë + + 000026F0:E6 E0 E9 E3 DD E6 E1 DA E0 DB D6 E9 E5 DD F6 F4 æàéãÝæáÚàÛÖéåÝöô + + 00002700:F3 E9 E5 E1 E4 DF DA DC D7 D0 D2 CA C1 D4 CC C4 óéåáäßÚÜ×ÐÒÊÁÔÌÄ + + 00002710:DB D4 CC E2 DC D5 D4 CC C3 CF C7 BC F3 EF EB DF ÛÔÌâÜÕÔÌÃÏǼóïëß + + 00002720:D9 D2 D9 D2 CB DC D7 D1 DB D8 D4 C9 C4 B8 B8 AF ÙÒÙÒËÜ×ÑÛØÔÉĸ¸¯ + + 00002730:96 C3 BF B7 D0 D0 D0 D0 D1 D2 CF D1 D3 86 8F 6D –ÿ•ÐÐÐÐÑÒÏÑÓ†□m + + 00002740:43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 C\\B\[.B\[.B\[.B\[.B + + 00002750:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00002760:0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B .B\[.B\[.B\[.DZ.DZ. + + 00002770:42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 B\[.B\[.B\[.C\\C\\C + + 00002780:5C 0C 43 5C 0C 43 5C 0C 43 5D 0A 43 5D 0A 44 5A \\C\\C\\C\].C\].DZ + + 00002790:0B 44 5A 0B 44 5A 0B 43 59 0A 43 59 0A 44 5A 0B .DZ.DZ.CY.CY.DZ. + + 000027A0:42 5C 09 00 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D B\\.@\].@\].@\].@\]. + + 000027B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000027C0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000027D0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C .@\].@\].@\].@\].?\\ + + 000027E0:89 91 7B AD AC AC AD A4 84 A2 97 5E A7 9B 5F EE ‰'{­¬¬­¤„¢--^§›\_î + + 000027F0:E9 DA FC FC FC F8 F6 F4 EE E9 E4 E5 DE D7 E6 E1 éÚüüüøöôîéäåÞ׿á + + 00002800:DB E4 E0 DB B8 AA 7D B7 AD 7C FF FF FF F2 F2 F2 ÛäàÛ¸ª}•­\|ÿÿÿòòò + + 00002810:E5 E1 DD DE D9 D3 D6 CF C8 DB D6 D0 DB D6 D0 D9 åáÝÞÙÓÖÏÈÛÖÐÛÖÐÙ + + 00002820:D3 CD D1 CA C2 BE B4 A8 BA AF A3 C6 BD B3 CE C6 ÓÍÑʾ´¨º¯£Æ½³ÎÆ + + 00002830:BE D1 CD C7 C5 B8 99 9A 8F 4D 91 88 43 9A 90 4E ¾ÑÍÇŸ™š□M'ˆCš□N + + 00002840:A5 99 61 B2 A9 8B CB CB CC 9D A4 90 43 5C 0C 42 ¥™A²©‹ËËÌ□¤□C\\B + + 00002850:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00002860:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B .B\[.B\[.B\[.B\[.B\[. + + 00002870:42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 B\[.B\[.DZ.DZ.B\[.B + + 00002880:5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C \[.B\[.C\\C\\C\\C\\ + + 00002890:0C 43 5C 0C 43 5D 0A 43 5D 0A 44 5A 0B 44 5A 0B .C\\C\].C\].DZ.DZ. + + 000028A0:43 59 0A 43 59 0A 43 59 0A 44 5A 0B 42 5C 09 00 CY.CY.CY.DZ.B\\. + + 000028B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000028C0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D \].@\].@\].@\].@\].@\] + + 000028D0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000028E0:40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C 90 99 7F 7D @\].@\].@\].?\\□™} + + 000028F0:7C 7C 73 70 69 83 7D 64 93 88 5F A6 9C 78 EA E8 \|\|spiƒ}D"ˆ\_¦œxêè + + 00002900:E4 FB F9 F7 E7 E1 DA E1 D9 D1 D9 D0 BF AB 9F 68 äûù÷çáÚáÙÑÙп«Ÿh + + 00002910:8D 84 3E 99 8F 4C C8 BB 90 E6 E0 CA F3 F0 EB E9 □„\>™□LÈ»□æàÊóðëé + + 00002920:E5 E1 E0 DA D4 E6 E2 DE DD D7 D2 CE C7 BF DF DA åáàÚÔæâÞÝ×ÒÎÇ¿ßÚ + + 00002930:D5 E1 DC D7 D5 CE C6 D6 CF C7 CC C3 B4 BC B1 99 ÕáÜ×ÕÎÆÖÏÇÌô¼±™ + + 00002940:96 8A 54 8C 80 47 90 84 56 8E 83 5D 89 82 6C 9A –ŠTŒ€G□„VŽƒ\]‰‚lš + + 00002950:97 91 B2 B2 B3 92 9B 80 43 5C 0C 42 5B 0B 42 5B --'²²³'›€C\\B\[.B\[ + + 00002960:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B .B\[.B\[.B\[.B\[.B\[. + + 00002970:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002980:5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B \[.DZ.DZ.B\[.B\[.B\[ + + 00002990:0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C .C\\C\\C\\C\\C\\ + + 000029A0:43 5D 0A 42 5C 09 44 5A 0B 44 5A 0B 43 59 0A 43 C\].B\\DZ.DZ.CY.C + + 000029B0:59 0A 44 5A 0B 44 5A 0B 42 5C 09 00 40 5D 0B 40 Y.DZ.DZ.B\\.@\].@ + + 000029C0:5D 0B 40 5E 0C 40 5E 0C 40 5E 0C 40 5E 0C 40 5E \].@^.@^.@^.@^.@^ + + 000029D0:0C 40 5D 0B 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D .@\].@\].@\].@\].@\]. + + 000029E0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 @\].@\].@\].@\].@\].@ + + 000029F0:5D 0D 40 5D 0D 3F 5C 0C 49 63 1A 85 94 6B A3 A7 \].@\].?\\IC.…"k£§ + + 00002A00:9E 9F A1 A3 9E A1 A5 A3 A4 A6 B9 B8 B7 EA E7 E5 žŸ¡£ž¡¥£¤¦¹¸•êçå + + 00002A10:DF D6 CD CE C8 C2 B6 B0 A3 A8 9F 81 A7 9F 81 A2 ßÖÍÎȶ°£¨Ÿ□§Ÿ□¢ + + 00002A20:98 77 9A 8F 66 9A 91 6B A2 9B 84 B5 B4 AB D4 D1 ˜wš□Fš'k¢›„µ´«ÔÑ + + 00002A30:CD DE D9 D3 DE D8 D1 D0 C9 C1 D0 CA C4 DF DD DC ÍÞÙÓÞØÑÐÉÁÐÊÄßÝÜ + + 00002A40:E4 E1 DE CB C8 C6 7E 7A 71 57 52 49 56 53 50 5B äáÞËÈÆ~zqWRIVSP\[ + + 00002A50:5C 5E 6E 71 74 86 88 8B A0 A1 A3 A6 AB A0 82 8F \\nqt†ˆ‹ ¡£¦« ‚□ + + 00002A60:66 4C 63 18 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B FLC.B\[.B\[.B\[.B\[. + + 00002A70:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002A80:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A \[.B\[.B\[.B\[.B\[.DZ + + 00002A90:0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C .DZ.B\[.B\[.B\[.C\\ + + 00002AA0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 09 43 C\\C\\C\\C\\C\[.C + + 00002AB0:5B 09 44 5A 09 44 5A 0B 43 59 0A 43 59 0A 43 59 \[.DZ.DZ.CY.CY.CY + + 00002AC0:0A 43 59 0A 43 5A 0A 00 40 5D 0D 40 5E 0E 41 5E .CY.CZ..@\].@^.A^ + + 00002AD0:0E 41 5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 40 5D 0D .A^.A^.A^.@\].@\]. + + 00002AE0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 3F @\].@\].@\].@\].@\].? + + 00002AF0:5C 0C 3F 5C 0C 3F 5C 0C 3F 5C 0C 40 5D 0D 40 5D \\?\\?\\?\\@\].@\] + + 00002B00:0D 40 5D 0D 3F 5C 0C 3F 5C 0C 44 60 13 58 70 2E .@\].?\\?\\D\`.Xp. + + 00002B10:73 85 53 84 92 6B 8F 99 7C A6 AC 9A B7 B8 AE B9 s…S„'k□™\|¦¬š•¸®¹ + + 00002B20:B9 B8 BB BD BE BA BD BF B8 BB BD B5 B8 BB B0 B3 ¹¸»½¾º½¿¸»½µ¸»°³ + + 00002B30:B6 A9 AB AD 9D 9E 9F 8F 8F 90 86 86 86 87 86 86 ¶©«­□žŸ□□□†††‡†† + + 00002B40:B5 B1 AD DE D8 D1 BB B5 AF 6C 6C 6C 79 79 79 6F µ±­ÞØÑ»µ¯lllyyyo + + 00002B50:6F 6F 71 72 71 7A 7C 76 7D 83 73 7C 86 68 7B 86 ooqrqz\|v}ƒs\|†h{† + + 00002B60:60 6F 7E 4D 57 6B 2A 46 5E 11 43 5C 0C 43 5D 0A \`o~MWk\*F^.C\\C\]. + + 00002B70:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 B\[.B\[.B\[.B\[.B\[.B + + 00002B80:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00002B90:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5A 0B 42 5A 0B .B\[.B\[.B\[.BZ.BZ. + + 00002BA0:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 B\[.B\[.B\[.B\[.C\\C + + 00002BB0:5C 0A 43 5C 0A 43 5C 0A 44 5B 09 44 5A 0A 44 5A \\C\\C\\D\[.DZ.DZ + + 00002BC0:0A 44 5A 0B 44 5A 0B 43 59 0A 43 59 0A 43 59 0A .DZ.DZ.CY.CY.CY. + + 00002BD0:44 5A 0B 00 3E 5E 0D 3F 5D 0D 3F 5D 0D 40 5E 0E DZ..\>^.?\].?\].@^. + + 00002BE0:41 5E 0E 40 5D 0D 40 5D 0D 3F 5C 0C 40 5D 0C 40 A^.@\].@\].?\\@\].@ + + 00002BF0:5D 0C 40 5D 0C 40 5D 0C 3F 5C 0B 3F 5C 0B 3F 5C \].@\].@\].?\\?\\?\\ + + 00002C00:0B 3F 5C 0B 40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C .?\\@\].@\].@\].?\\ + + 00002C10:3F 5C 0C 3F 5C 0C 40 5D 0D 40 5D 0D 40 5D 0D 40 ?\\?\\@\].@\].@\].@ + + 00002C20:5D 0D 40 5D 0D 41 5C 0C 48 62 16 52 69 23 58 6E \].@\].A\\HB.Ri#Xn + + 00002C30:2D 5D 72 34 61 75 3A 64 77 3F 67 79 42 68 7A 44 -\]r4Au:Dw?gyBhzD + + 00002C40:69 7B 46 69 7A 46 68 78 44 66 77 42 64 75 40 8C i{FizFhxDFwBDu@Œ + + 00002C50:96 6D C0 BE B0 51 62 2B 57 6B 2D 58 6D 2C 51 67 –mÀ¾°QB+Wk-Xm,Qg + + 00002C60:22 49 60 15 41 5B 0B 41 5B 0B 41 5B 0B 41 5B 0B "I\`.A\[.A\[.A\[.A\[. + + 00002C70:41 5B 0B 40 5B 0B 40 5B 0B 40 5C 09 42 5B 0A 42 A\[.@\[.@\[.@\\B\[.B + + 00002C80:5B 0A 42 5B 0A 42 5B 0A 42 5B 0A 42 5B 0A 42 5B \[.B\[.B\[.B\[.B\[.B\[ + + 00002C90:0A 41 5A 0A 42 5A 0C 42 5A 0C 42 5A 0C 42 5B 0B .AZ.BZ.BZ.BZ.B\[. + + 00002CA0:42 5B 0B 42 5B 0B 42 5B 0A 42 5B 0A 44 5A 0B 44 B\[.B\[.B\[.B\[.DZ.D + + 00002CB0:5A 0B 44 5A 0A 44 5A 0A 44 5A 0A 45 5B 0B 45 5B Z.DZ.DZ.DZ.E\[.E\[ + + 00002CC0:0B 45 5B 0B 44 5A 09 44 5A 09 44 5A 0B 44 5A 0B .E\[.DZ.DZ.DZ.DZ. + + 00002CD0:44 5A 0B 44 5A 0B 43 59 0A 43 59 0A 43 5B 09 00 DZ.DZ.CY.CY.C\[.. + + 00002CE0:3F 5F 0D 3F 5F 0D 3F 5F 0D 3F 5F 0D 40 5E 0D 40 ?\_.?\_.?\_.?\_.@^.@ + + 00002CF0:5E 0D 40 5E 0D 40 5E 0D 40 5F 0C 40 5F 0C 40 5F ^.@^.@^.@\_.@\_.@\_ + + 00002D00:0C 40 5F 0C 3F 5E 0B 3F 5E 0B 40 5E 0B 40 5E 0B .@\_.?^.?^.@^.@^. + + 00002D10:40 5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 @\].@\].@\].@\].@\].@ + + 00002D20:5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 5D \].@\].@\].@\].@\].@\] + + 00002D30:0C 41 5D 0C 41 5C 0B 41 5C 0B 41 5C 0B 41 5C 0B .A\].A\\A\\A\\A\\ + + 00002D40:41 5D 0C 41 5D 0C 41 5D 0C 40 5C 0B 40 5C 0B 40 A\].A\].A\].@\\@\\@ + + 00002D50:5C 0B 40 5C 0B 40 5C 0C 41 5C 0C 41 5C 0C 5A 70 \\@\\@\\A\\A\\Zp + + 00002D60:2B 41 5C 0C 41 5C 0C 41 5C 0C 41 5C 0C 41 5C 0C +A\\A\\A\\A\\A\\ + + 00002D70:41 5C 0B 41 5C 0B 41 5C 0B 41 5C 0B 41 5C 0B 41 A\\A\\A\\A\\A\\A + + 00002D80:5C 0B 41 5C 0B 41 5D 0B 42 5D 0A 42 5D 0A 42 5D \\A\\A\].B\].B\].B\] + + 00002D90:0A 42 5D 0A 42 5D 0A 42 5D 0A 42 5D 0A 42 5D 0A .B\].B\].B\].B\].B\]. + + 00002DA0:42 5C 0B 42 5C 0B 42 5C 0B 42 5C 0B 42 5C 0B 43 B\\B\\B\\B\\B\\C + + 00002DB0:5C 0B 43 5D 0A 43 5D 0A 44 5C 0B 44 5C 0B 44 5C \\C\].C\].D\\D\\D\\ + + 00002DC0:0A 44 5C 0A 44 5C 0A 44 5C 0A 44 5C 0A 44 5C 0A .D\\D\\D\\D\\D\\ + + 00002DD0:43 5B 0A 43 5B 0A 43 5B 0A 43 5B 0A 43 5B 0A 43 C\[.C\[.C\[.C\[.C\[.C + + 00002DE0:5B 0A 43 5B 0A 43 5B 0A 43 5D 09 00 3F 61 0C 40 \[.C\[.C\[.C\]..?A.@ + + 00002DF0:62 0D 40 62 0D 3F 61 0C 3F 61 0C 3F 61 0C 3F 61 B.@B.?A.?A.?A.?A + + 00002E00:0C 3F 61 0C 3F 61 0C 3F 61 0C 3F 61 0C 3F 61 0C .?A.?A.?A.?A.?A. + + 00002E10:3F 60 0C 3F 60 0C 40 60 0C 40 60 0C 40 60 0C 40 ?\`.?\`.@\`.@\`.@\`.@ + + 00002E20:60 0C 3F 5F 0C 3F 5F 0C 3F 5F 0C 40 60 0C 40 60 \`.?\_.?\_.?\_.@\`.@\` + + 00002E30:0C 40 60 0C 3F 5F 0B 3F 5F 0B 3F 5F 0C 41 5F 0C .@\`.?\_.?\_.?\_.A\_. + + 00002E40:41 5E 0B 41 5E 0B 42 5F 0C 42 5F 0C 40 60 0C 40 A^.A^.B\_.B\_.@\`.@ + + 00002E50:60 0C 40 60 0C 3F 5F 0B 3F 5F 0B 3F 5F 0B 3F 5F \`.@\`.?\_.?\_.?\_.?\_ + + 00002E60:0B 3F 5F 0B 42 5F 0C 42 5F 0C 41 5E 0B 41 5E 0B .?\_.B\_.B\_.A^.A^. + + 00002E70:41 5E 0B 41 5E 0B 41 5E 0B 41 5F 0C 41 5E 0B 41 A^.A^.A^.A\_.A^.A + + 00002E80:5E 0B 41 5E 0B 41 5E 0B 41 5E 0B 41 5F 0B 41 5F ^.A^.A^.A^.A\_.A\_ + + 00002E90:0B 41 5F 0A 41 5F 0B 41 5F 0B 41 5F 0B 41 5F 0B .A\_.A\_.A\_.A\_.A\_. + + 00002EA0:41 5F 0B 41 5F 0B 41 5F 0B 41 5F 0B 42 5F 0B 42 A\_.A\_.A\_.A\_.B\_.B + + 00002EB0:5F 0B 41 5F 0B 41 5F 0B 41 5F 0B 43 5F 0B 43 5E \_.A\_.A\_.A\_.C\_.C^ + + 00002EC0:0A 43 5E 0A 43 5F 0B 43 5F 0B 43 5F 0B 43 5F 0B .C^.C\_.C\_.C\_.C\_. + + 00002ED0:43 5F 0B 43 5F 0A 43 5F 0A 43 5F 0A 42 5E 09 42 C\_.C\_.C\_.C\_.B^.B + + 00002EE0:5E 09 42 5E 09 42 5E 09 42 5E 09 42 5E 09 42 5E ^.B^.B^.B^.B^.B^ + + 00002EF0:09 42 5E 09 42 5E 09 00 3F 64 0B 3F 64 0B 3F 64 .B^.B^..?D.?D.?D + + 00002F00:0B 3F 64 0B 3F 64 0B 3F 64 0B 3F 64 0B 3F 64 0B .?D.?D.?D.?D.?D. + + 00002F10:3F 64 0C 3F 64 0C 3F 64 0C 3F 62 0C 40 62 0C 40 ?D.?D.?D.?B.@B.@ + + 00002F20:62 0C 40 62 0C 40 62 0C 40 62 0C 40 62 0C 3F 62 B.@B.@B.@B.@B.?B + + 00002F30:0C 3F 62 0C 40 63 0C 40 63 0D 40 62 0C 40 62 0C .?B.@C.@C.@B.@B. + + 00002F40:3F 62 0B 3F 62 0B 3F 62 0C 40 62 0C 40 62 0C 41 ?B.?B.?B.@B.@B.A + + 00002F50:62 0C 41 63 0D 40 62 0C 40 63 0A 40 63 0A 40 63 B.AC.@B.@C.@C.@C + + 00002F60:0A 3F 62 0C 3F 62 0C 3F 62 0C 3F 62 0C 3F 62 0C .?B.?B.?B.?B.?B. + + 00002F70:40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 @A.@A.@A.@A.@A.@ + + 00002F80:61 0B 40 61 0B 41 62 0C 40 61 0B 40 61 0B 40 61 A.@A.AB.@A.@A.@A + + 00002F90:0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B .@A.@A.@A.@A.@A. + + 00002FA0:40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 @A.@A.@A.@A.@A.@ + + 00002FB0:61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 A.@A.@A.@A.@A.@A + + 00002FC0:0B 40 62 09 40 62 09 40 62 09 42 61 09 42 61 09 .@B.@B.@B.BA.BA. + + 00002FD0:42 61 09 42 61 09 42 61 09 42 61 09 42 61 09 42 BA.BA.BA.BA.BA.B + + 00002FE0:61 09 42 61 09 42 61 09 40 62 09 42 61 09 42 61 A.BA.BA.@B.BA.BA + + 00002FF0:09 42 61 09 42 61 09 42 61 09 42 61 09 42 61 09 .BA.BA.BA.BA.BA. + + 00003000:42 61 09 00 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F BA..=\`.=\`.=\`.=\`. + + 00003010:3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D =\`.=\`.=\`.=\`.=\`.= + + 00003020:60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 \`.=\`.=\`.=\`.=\`.=\` + + 00003030:0F 3D 60 0F 3D 61 0E 3D 61 0E 3C 60 0D 3C 60 0D .=\`.=A.=A.\<\`.\<\`. + + 00003040:3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D =A.=A.=A.=A.=A.= + + 00003050:61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 A.=A.=A.=A.=A.=A + + 00003060:0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E .=A.=A.=A.=A.=A. + + 00003070:3C 60 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E \<\`.\>\_.\>\_.\>\_.\>\_.\> + + 00003080:5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F \_.\>\_.\>\_.\>\_.\>\_.\>\_ + + 00003090:0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D .\>\_.\>\_.\>\_.\>\_.\>\_. + + 000030A0:3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E \>\_.\>\_.\>\_.\>\_.\>\_.\> + + 000030B0:5F 0D 3E 5F 0D 3E 5F 0D 3F 5F 0D 3F 5F 0D 3F 5F \_.\>\_.\>\_.?\_.?\_.?\_ + + 000030C0:0D 3F 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D .?\_.\>\_.\>\_.\>\_.\>\_. + + 000030D0:3E 60 0B 3D 5F 0A 3E 5F 0A 3E 5F 0A 3F 60 0B 3F \>\`.=\_.\>\_.\>\_.?\`.? + + 000030E0:60 0B 3F 60 0B 3F 60 0B 3F 60 0B 3F 60 0B 3F 60 \`.?\`.?\`.?\`.?\`.?\` + + 000030F0:0B 3F 60 0B 3E 60 0B 3E 60 0B 3E 60 0B 3F 60 0B .?\`.\>\`.\>\`.\>\`.?\`. + + 00003100:3F 60 0B 3F 60 0B 3F 5F 0D 3F 5F 0D 3D 5F 0A 00 ?\`.?\`.?\_.?\_.=\_.. + + 00003110:12 00 00 00 0C 00 00 00 01 00 00 00 52 00 00 00 ............R... + + 00003120:70 01 00 00 02 00 00 00 F3 FF FF FF 00 00 00 00 p.......óÿÿÿ.... + + 00003130:4E 0C 00 00 4E 0C 00 00 C8 00 00 00 00 00 00 01 N...N...È....... + + 00003140:04 00 00 02 41 00 72 00 69 00 61 00 6C 00 00 00 ....A.r.i.A.l... + + 00003150:00 00 00 00 00 00 00 00 00 00 00 00 0C 45 00 00 .............E.. + + 00003160:BC 16 E8 FE FE 07 00 00 20 00 CC 00 00 00 00 00 ¼.èþþ... .Ì..... + + 00003170:4C 00 00 00 FE 07 00 00 DA 16 01 B8 FF FF FF FF L...þ...Ú..¸ÿÿÿÿ + + 00003180:00 00 00 00 00 00 00 00 F0 F6 13 00 00 00 00 00 ........ðö...... + + 00003190:0E 20 05 27 00 00 00 00 28 00 00 00 00 00 00 00 . .'....(....... + + 000031A0:1C 2F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ./.............. + + 000031B0:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 000031C0:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 000031D0:00 00 00 00 00 00 00 00 28 00 00 00 FF FF FF 00 ........(...ÿÿÿ. + + 000031E0:1C 2F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ./.............. + + 000031F0:58 00 00 00 2C 00 00 00 00 00 00 00 00 00 00 00 X...,........... + + 00003200:00 00 80 3F 00 00 00 00 00 00 00 00 00 00 80 3F ..€?..........€? + + 00003210:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00003220:D0 C5 35 00 00 00 00 00 28 00 00 00 59 00 00 00 ÐÅ5.....(...Y... + + 00003230:2D 00 00 00 01 00 18 00 00 00 00 00 1C 2F 00 00 -............/.. + + 00003240:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00003250:10 00 90 01 00 00 00 00 25 00 00 00 00 00 00 00 ..□.....%....... + + 00003260:D3 3F EC FE FE 07 00 00 79 0D 21 11 00 00 00 00 Ó?ìþþ...y.!..... + + 00003270:10 00 90 01 00 00 00 00 00 00 00 00 59 00 00 00 ..□.........Y... + + 00003280:2D 00 00 00 64 76 00 08 00 00 00 00 25 00 00 00 -...Dv......%... + + 00003290:0C 00 00 00 02 00 00 00 54 00 00 00 A0 00 00 00 ........T... ... + + 000032A0:00 00 00 00 00 00 00 00 FF FF FF FF FF FF FF FF ........ÿÿÿÿÿÿÿÿ + + 000032B0:01 00 00 00 AB 0A 0D 42 00 00 0D 42 12 00 00 00 ....«..B...B.... + + 000032C0:05 00 00 00 0E 00 00 00 4C 00 00 00 00 00 00 00 ........L....... + + 000032D0:00 00 00 00 00 00 00 00 FF FF FF FF FF FF FF FF ........ÿÿÿÿÿÿÿÿ + + 000032E0:68 00 00 00 53 00 69 00 6D 00 70 00 6C 00 65 00 h...S.i.m.p.l.E. + + 000032F0:20 00 53 00 61 00 6D 00 70 00 6C 00 65 00 00 00 .S.A.m.p.l.E... + + 00003300:09 00 00 00 03 00 00 00 0B 00 00 00 07 00 00 00 ................ + + 00003310:03 00 00 00 07 00 00 00 04 00 00 00 09 00 00 00 ................ + + 00003320:07 00 00 00 0B 00 00 00 07 00 00 00 03 00 00 00 ................ + + 00003330:07 00 00 00 09 00 00 00 52 00 00 00 70 01 00 00 ........R...p... + + 00003340:03 00 00 00 F3 FF FF FF 00 00 00 00 4E 0C 00 00 ....óÿÿÿ....N... + + 00003350:4E 0C 00 00 C8 00 00 00 00 00 00 00 04 00 00 02 N...È........... + + 00003360:4D 00 69 00 63 00 72 00 6F 00 73 00 6F 00 66 00 M.i.C.r.o.s.o.F. + + 00003370:74 00 20 00 53 00 61 00 6E 00 73 00 20 00 53 00 t. .S.A.n.s. .S. + + 00003380:65 00 72 00 69 00 66 00 00 00 00 00 00 00 00 00 E.r.i.F......... + + 00003390:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 000033A0:00 00 00 00 28 00 00 00 59 00 00 00 2D 00 00 00 ....(...Y...-... + + 000033B0:01 00 18 00 00 00 00 00 1C 2F 00 00 00 00 00 00 ........./...... + + 000033C0:00 00 00 00 00 00 00 00 00 00 00 00 10 00 90 01 ..............□. + + 000033D0:00 00 00 00 25 00 00 00 00 00 00 00 D3 3F EC FE ....%.......Ó?ìþ + + 000033E0:FE 07 00 00 79 0D 21 11 00 00 00 00 10 00 90 01 þ...y.!.......□. + + 000033F0:00 00 00 00 00 00 00 00 59 00 00 00 2D 00 00 00 ........Y...-... + + 00003400:64 76 00 08 00 00 00 00 00 00 00 00 00 08 0D 00 Dv.............. + + 00003410:0D 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00003420:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00003430:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00003440:00 00 00 00 92 A0 CD 02 00 00 00 00 CA BE CD 02 ....' Í.....ʾÍ. + + 00003450:00 00 00 00 00 00 00 00 00 00 00 00 FF FF 5A FE ............ÿÿZþ + + 00003460:00 00 00 00 00 00 00 00 00 00 00 00 95 F1 53 FE ............•ñSþ + + 00003470:FE 07 00 00 BE 06 5A FE FE 07 00 00 87 F2 53 FE þ...¾.Zþþ...‡òSþ + + 00003480:FE 07 00 00 C4 04 5A FE FE 07 00 00 79 0D 21 11 þ...Ä.Zþþ...y.!. + + 00003490:00 00 00 00 01 00 00 00 00 00 00 00 F0 02 5A FE ............ð.Zþ + + 000034A0:64 76 00 08 00 00 00 00 25 00 00 00 0C 00 00 00 Dv......%....... + + 000034B0:03 00 00 00 52 00 00 00 70 01 00 00 04 00 00 00 ....R...p....... + + 000034C0:F2 FF FF FF 00 00 00 00 4E 0C 00 00 4E 0C 00 00 òÿÿÿ....N...N... + + 000034D0:C8 00 00 00 00 00 00 00 04 00 00 02 4D 00 69 00 È...........M.i. + + 000034E0:63 00 72 00 6F 00 73 00 6F 00 66 00 74 00 20 00 C.r.o.s.o.F.t. . + + 000034F0:53 00 61 00 6E 00 73 00 20 00 53 00 65 00 72 00 S.A.n.s. .S.E.r. + + 00003500:69 00 66 00 00 00 00 00 00 00 00 00 00 00 00 00 i.F............. + + 00003510:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 00003520:C8 F1 13 00 00 00 00 00 10 00 90 01 00 00 00 00 Èñ........□..... + + 00003530:20 AC CF 02 00 00 00 00 10 00 00 00 06 00 00 00 ¬Ï............. + + 00003540:06 00 00 00 04 00 00 00 01 00 00 00 01 00 00 00 ................ + + 00003550:01 00 00 00 01 00 00 00 0D 00 00 00 00 00 00 00 ................ + + 00003560:03 00 00 00 00 08 00 00 3B 09 00 00 00 00 00 00 ........;....... + + 00003570:A0 E8 07 02 00 00 00 00 03 00 00 00 FE 07 00 00 è..........þ... + + 00003580:90 01 00 00 4D 00 69 00 63 00 72 00 6F 00 73 00 □...M.i.C.r.o.s. + + 00003590:6F 00 66 00 74 00 20 00 53 00 61 00 00 00 73 00 o.F.t. .S.A...s. + + 000035A0:20 00 53 00 65 00 72 00 69 00 66 00 00 00 00 00 .S.E.r.i.F..... + + 000035B0:00 00 00 00 00 00 00 00 FF FF 5A FE 00 00 00 00 ........ÿÿZþ.... + + 000035C0:40 02 5A FE FE 07 00 00 9D 04 00 00 00 00 00 00 @.Zþþ...□....... + + 000035D0:FF FF FF FF FF FF FF FF 01 00 00 00 00 00 00 00 ÿÿÿÿÿÿÿÿ........ + + 000035E0:20 AC CF 02 00 00 00 00 00 00 07 02 00 00 00 00 ¬Ï............. + + 000035F0:10 AC CF 02 00 00 00 00 26 36 E3 76 00 00 00 00 .¬Ï.....&6ãv.... + + 00003600:00 00 07 02 00 00 00 00 01 00 00 00 00 27 00 00 .............'.. + + 00003610:00 00 00 00 00 00 00 00 20 AC CF 02 64 76 00 08 ........ ¬Ï.Dv.. + + 00003620:00 00 00 00 25 00 00 00 0C 00 00 00 04 00 00 00 ....%........... + + 00003630:28 00 00 00 0C 00 00 00 03 00 00 00 52 00 00 00 (...........R... + + 00003640:70 01 00 00 03 00 00 00 13 00 00 00 00 00 00 00 p............... + + 00003650:4E 0C 00 00 4E 0C 00 00 C8 00 00 00 00 00 00 00 N...N...È....... + + 00003660:04 00 00 02 4D 00 69 00 63 00 72 00 6F 00 73 00 ....M.i.C.r.o.s. + + 00003670:6F 00 66 00 74 00 20 00 53 00 61 00 6E 00 73 00 o.F.t. .S.A.n.s. + + 00003680:20 00 53 00 65 00 72 00 69 00 66 00 00 00 00 00 .S.E.r.i.F..... + + 00003690:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 ................ + + 000036A0:00 00 00 00 00 00 73 00 20 00 53 00 65 00 72 00 ......s. .S.E.r. + + 000036B0:69 00 66 00 00 00 00 00 00 00 00 00 00 00 00 00 i.F............. + + 000036C0:FF FF 5A FE 00 00 00 00 40 02 5A FE FE 07 00 00 ÿÿZþ....@.Zþþ... + + 000036D0:9D 04 00 00 00 00 00 00 FF FF FF FF FF FF FF FF □.......ÿÿÿÿÿÿÿÿ + + 000036E0:01 00 00 00 00 00 00 00 20 AC CF 02 00 00 00 00 ........ ¬Ï..... + + 000036F0:00 00 07 02 00 00 00 00 40 02 5A FE FE 07 00 00 ........@.Zþþ... + + 00003700:F3 14 00 00 00 00 00 00 F3 14 0A 1E 00 00 00 00 ó.......ó....... + + 00003710:94 8A E8 FE FE 07 00 00 04 00 00 00 00 00 00 00 "Šèþþ........... + + 00003720:65 58 53 FE 00 00 00 00 00 00 00 00 00 00 00 00 EXSþ............ + + 00003730:00 F5 13 00 00 00 00 00 03 01 56 E5 89 1A 00 00 .õ........Vå‰... + + 00003740:55 00 00 00 00 00 00 00 00 00 00 00 04 00 00 00 U............... + + 00003750:00 00 00 00 FE 07 00 00 79 0D 21 11 00 00 00 00 ....þ...y.!..... + + 00003760:40 02 5A FE 00 00 00 00 26 06 5A FE FE 07 00 00 @.Zþ....&.Zþþ... + + 00003770:08 F5 13 00 00 00 00 00 00 F5 13 00 00 00 00 00 .õ.......õ...... + + 00003780:07 CB 54 FE FE 07 00 00 79 0D 21 11 00 00 00 00 .ËTþþ...y.!..... + + 00003790:04 00 00 00 00 00 00 00 24 07 5A FE FE 07 00 00 ........\$.Zþþ... + + 000037A0:01 00 00 00 64 76 00 08 00 00 00 00 25 00 00 00 ....Dv......%... + + 000037B0:0C 00 00 00 03 00 00 00 25 00 00 00 0C 00 00 00 ........%....... + + 000037C0:02 00 00 00 28 00 00 00 0C 00 00 00 04 00 00 00 ....(........... + + 000037D0:28 00 00 00 0C 00 00 00 03 00 00 00 25 00 00 00 (...........%... + + 000037E0:0C 00 00 00 0D 00 00 80 0E 00 00 00 14 00 00 00 .......€........ + + 000037F0:00 00 00 00 10 00 00 00 14 00 00 00 ............ + +### EMR_HEADER Example + +This section provides an example of an EMR_HEADER record (section [2.3.4.2](#Section_de081cd7351f4cc2830bd03fb55e89ab)). + +1434. 00000000:01 00 00 00 D4 00 00 00 00 00 00 00 00 00 00 00 + + 00000010:59 00 00 00 59 00 00 00 00 00 00 00 00 00 00 00 + + 00000020:42 0C 00 00 41 0C 00 00 20 45 4D 46 00 00 01 00 + + 00000030:FC 37 00 00 16 00 00 00 05 00 00 00 34 00 00 00 + + 00000040:6C 00 00 00 00 00 00 00 80 07 00 00 B0 04 00 00 + + 00000050:A5 02 00 00 A7 01 00 00 00 00 00 00 00 00 00 00 + + 00000060:00 00 00 00 D5 55 0A 00 A5 75 06 00 53 00 61 00 + + 00000070:6D 00 70 00 6C 00 65 00 20 00 45 00 4D 00 46 00 + + 00000080:20 00 74 00 68 00 61 00 74 00 20 00 68 00 61 00 + + 00000090:73 00 20 00 61 00 20 00 62 00 72 00 75 00 73 00 + + 000000A0:68 00 20 00 66 00 69 00 6C 00 6C 00 2C 00 20 00 + + 000000B0:62 00 69 00 74 00 6D 00 61 00 70 00 2C 00 20 00 + + 000000C0:61 00 6E 00 64 00 20 00 74 00 65 00 78 00 74 00 + + 000000D0:00 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000001 identifies the record type as EMR_HEADER. + +**Size (4 bytes)**: 0x000000D4 is the record size in bytes. + +**Bounds (16 bytes)**: 0x00000000, 0x00000000, 0x00000059, 0x00000059 specify the rectangular [**inclusive-inclusive**](#gt_c706d1bc-8878-4743-9b94-e9643c5269e4) bounds of the smallest rectangle that can be drawn around the image stored in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) in logical units. + +**Frame (16 bytes)**: 0x00000000, 0x00000000, 0x00000C42, 0x00000C31 specify the rectangular inclusive-inclusive dimensions, in .01 millimeter units, of a rectangle that surrounds the image stored in the metafile. + +[TABLE] + +**Signature (4 bytes)**: 0x464D4520 is the record signature, which consists of the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) string "EMF". + +**Version (4 bytes)**: 0x00010000 specifies [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) metafile interoperability. + +**Bytes (4 bytes)**: 0x000037FC specifies the size of the metafile in bytes. + +**Records (4 bytes)**: 0x00000016 specifies the number of records in the metafile. + +**Handles (2 bytes)**: 0x0005 specifies the number of graphics objects that are created during the processing of the metafile. These objects are referenced by their indexes in metafile records. Index values for created objects start at 1. This value can be used to compute the size needed for the EMF object table (section [3.1.1.1](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4)). + +**Reserved (2 bytes)**: 0x0000 is ignored. + +**nDescription (4 bytes)**: 0x00000034 specifies the number of characters in the array that contains the description of the metafile's contents. + +**offDescription (4 bytes)**: 0x0000006C specifies the offset from the beginning of this record to the array that contains the description of the metafile's contents. + +**PalEntries (4 bytes)**: 0x00000000 specifies the number of entries in the metafile [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). The location of the palette is specified in the EMR_EOF record. + +[TABLE] + +**Device (8 bytes)**: 0x00000780, 0x00000780 specify the size of the reference device, in pixels. + +**Millimeters (8 bytes)**: 0x000002A5, 0x000001A7 specify the size of the reference device, in millimeters. + +**cbPixelFormat (4 bytes)**: 0x00000000 specifies the size of the [PixelFormatDescriptor (section 2.2.22)](#Section_1db036d62da84b92b4f8e9cab8cc93b7) structure. This value indicates that no pixel format is defined. + +**offPixelFormat (4 bytes)**: 0x00000000 specifies the offset to the PixelFormatDescriptor in the metafile. In this case, no pixel format structure is present. + +**bOpenGL (4 bytes)**: 0x00000000 specifies that no [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) commands are present in the metafile. + +**Micrometers (8 bytes)**: 0x000A55D5, 0x000675A5 specify the horizontal and vertical size of the reference device, in micrometers. + +**EmfDescription (4 bytes)**: "Sample EMF that has a brush fill, bitmap, and text". + +### EMR_CREATEBRUSHINDIRECT Example + +This section provides an example of an [EMR_CREATEBRUSHINDIRECT](#Section_b9a8ef5d00894e42b317e6ebc0ff098f) record (section 2.3.7.1). + +1449. 000000D0: 27 00 00 00 18 00 00 00 01 00 00 00 + + 000000E0:02 00 00 00 52 47 2A 00 03 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000027 identifies this record type as EMR_CREATEBRUSHINDIRECT. + +**Size (4 bytes)**: 0x00000018 specifies the size of this record in bytes. + +**ihBrush (4 bytes)**: 0x00000001 specifies the index of this brush object in the EMF object table (section [3.1.1.1)](#Section_e4fa4e6390964cdcb77685e2a1e4e1f4). + +**LogBrush (12 bytes)**: A [LogBrushEx](#Section_6d790f8d51654746bac33443915c2071) object (section 2.2.12) that contains brush data. + +[TABLE] + +**BrushStyle (4 bytes)**: 0x00000002 specifies a hatch brush style, from the **BrushStyle** enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.4). + +**Color (4 bytes)**: 0x0052472A is a **ColorRef** object (\[MS-WMF\] section 2.2.2.8) that specifies the brush color value. + +**BrushHatch (4 bytes)**: 0x00000003 specifies the brush hatch. Its interpretation depends on the value of **BrushStyle**. In this case, it specifies a 45-degree upward, left-to-right hatch pattern. + +### EMR_SELECTOBJECT Example 1 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +1452. 000000E0: 25 00 00 00 + + 000000F0:0C 00 00 00 01 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000025 identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x00000001 specifies the index of an object in the EMF object table. + +### EMR_BITBLT Example 1 + +This section provides an example of an [EMR_BITBLT record (section 2.3.1.2)](#Section_347d1c44184747ec87627059e9e9b185). + +1455. 000000F0: 4C 00 00 00 64 00 00 00 + + 00000100:00 00 00 00 00 00 00 00 59 00 00 00 59 00 00 00 + + 00000110:00 00 00 00 00 00 00 00 5A 00 00 00 5A 00 00 00 + + 00000120:21 00 F0 00 00 00 00 00 00 00 00 00 00 00 80 3F + + 00000130:00 00 00 00 00 00 00 00 00 00 80 3F 00 00 00 00 + + 00000140:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00000150:00 00 00 00 00 00 00 00 00 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x0000004C identifies this record type as EMR_BITBLT. + +**Size (4 bytes)**: 0x00000064 specifies the size of this record in bytes. + +**Bounds (16 bytes)**: 0x00000000, 0x00000000, 0x00000059, 0x00000059 specify the bounding rectangle in logical units. + +**xDest (4 bytes)**: 0x00000000 specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes)**: 0x00000000 specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes)**: 0x0000005A specifies the logical width of the destination rectangle. + +**cyDest (4 bytes)**: 0x0000005A specifies the logical height of the destination rectangle. + +[TABLE] + +**BitBlitRasterOperation (4 bytes)**: 0x00F00021 specifies the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) code from the **Ternary Raster Operation** enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.31). This code defines how the color data of the source rectangle is to be combined with the color data of the destination rectangle to achieve the final color. + +**xSrc (4 bytes)**: 0x00000000 specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes)**: 0x00000000 specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**xformSrc (24 bytes)**: 0x3F800000, 0x00000000, 0x00000000, 0x3F800000, 0x00000000, 0x00000000 specify the [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). For more information on [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). + +[TABLE] + +**BkColorSrc (4 bytes)**: 0x00000000 specifies the background [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color. + +**UsageSrc (4 bytes)**: 0x00000000 specifies the value of the **Colors** field of the **DeviceIndependentBitmap** object (\[MS-WMF\] section 2.2.2.9) from the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes)**: 0x00000000 specifies the offset to the source **DeviceIndependentBitmap** object. + +**cbBmiSrc (4 bytes)**: 0x00000000 specifies the size of the source **DeviceIndependentBitmap** object. + +**offBitsSrc (4 bytes)**: 0x00000000 specifies the offset to the source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) bits. + +**cbBitsSrc (4 bytes)**: 0x00000000 specifies the size of the source bitmap bits. + +### EMR_SELECTOBJECT Example 2 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +1463. 00000150: 25 00 00 00 + + 00000160:0C 00 00 00 00 00 00 80 + +[TABLE] + +**Type (4 bytes)**: 0x00000025 identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x80000000 specifies the index of an object in the EMF object table. + +### EMR_BITBLT Example 2 + +This section provides an example of an [EMR_BITBLT record (section 2.3.1.2)](#Section_347d1c44184747ec87627059e9e9b185). + +1466. 00000160: 4C 00 00 00 A8 2F 00 00 + + 00000170:00 00 00 00 2D 00 00 00 59 00 00 00 59 00 00 00 + + 00000180:00 00 00 00 2D 00 00 00 5A 00 00 00 2D 00 00 00 + + 00000190:20 00 CC 00 00 00 00 00 00 00 00 00 00 00 80 3F + + 000001A0:00 00 00 00 00 00 00 00 00 00 80 3F 00 00 00 00 + + 000001B0:00 00 00 00 FF FF FF 00 00 00 00 00 64 00 00 00 + + 000001C0:28 00 00 00 8C 00 00 00 1C 2F 00 00 28 00 00 00 + + 000001D0:59 00 00 00 2D 00 00 00 01 00 18 00 00 00 00 00 + + 000001E0:1C 2F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000001F0:00 00 00 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E + + 00000200:3F 5F 0E 3F 5F 0E 3F 5F 0E 3E 5E 0D 3F 5F 0E 3F + + 00000210:5F 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E + + 00000220:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E + + 00000230:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 3D + + 00000240:59 0C 5A 60 4E AE AE AE BF BF BF C5 C5 C5 C0 C0 + + 00000250:C1 B1 B2 B1 A1 A1 A1 A9 AA AA AE AF B0 A2 A2 A2 + + 00000260:A6 A6 A4 AF AE AD AC AC AC A6 A6 A6 99 99 99 7D + + 00000270:7D 7D 66 66 65 5A 5A 59 4F 4F 4F 58 58 58 76 76 + + 00000280:76 9E 9E 9E B5 B5 B5 3C 43 2D 32 46 0A 34 4A 0A + + 00000290:34 49 0A 36 4C 0B 3A 52 0B 3F 59 0C 41 5C 0D 42 + + 000002A0:5D 0D 42 5D 0D 44 5D 0D 44 5D 0D 43 5C 0C 43 5C + + 000002B0:0C 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C + + 000002C0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 000002D0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000002E0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000002F0:45 5B 0C 45 5B 0C 45 5C 0A 45 5C 0A 45 5C 0A 00 + + 00000300:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 00000310:5F 0E 3F 5F 0E 3E 5E 0D 3F 5F 0E 3F 5F 0E 41 5E + + 00000320:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E + + 00000330:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 + + 00000340:5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 39 52 0C 70 73 + + 00000350:6B AD AD AD A8 A8 A8 99 99 98 A6 A6 A6 A6 A7 A7 + + 00000360:A3 A5 A6 A6 A5 A3 AE A5 9D C9 BB AD A1 9B 95 A2 + + 00000370:9F 9C B3 B1 AF B6 B4 B3 A9 A9 A9 97 93 90 8E 87 + + 00000380:81 89 84 7F 81 7E 7A 79 78 76 80 7F 7E 98 98 98 + + 00000390:BC BC BC 6D 70 65 33 47 0A 37 4D 0B 35 4B 0A 35 + + 000003A0:4B 0B 38 4F 0B 3D 56 0C 41 5B 0D 42 5D 0D 42 5D + + 000003B0:0D 43 5D 0D 44 5D 0D 43 5C 0C 43 5C 0C 43 5C 0C + + 000003C0:42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 000003D0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000003E0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000003F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 45 + + 00000400:5B 0C 45 5C 0A 45 5C 0A 45 5C 0A 00 3F 5F 0E 3F + + 00000410:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F + + 00000420:0E 3E 5E 0D 3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0E + + 00000430:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 + + 00000440:5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E + + 00000450:0E 41 5E 0E 40 5D 0D 38 51 0E 90 91 8E AC AC AC + + 00000460:C3 C3 C3 C5 C6 C6 B9 BB BC B3 B0 AD BA AD 9E C8 + + 00000470:B4 A0 DB C8 B4 E4 D1 BE C2 B5 A9 82 7E 7A 8C 88 + + 00000480:84 83 80 7E 98 8F 85 BE AC 9A C9 B6 A3 CC BB A9 + + 00000490:CD C0 B3 AB A3 9B 80 7E 76 78 76 70 91 8F 8D 84 + + 000004A0:86 80 36 4B 0B 39 50 0B 38 4E 0B 37 4D 0B 38 4F + + 000004B0:0B 3C 55 0C 40 5A 0D 42 5D 0D 42 5D 0D 42 5D 0D + + 000004C0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 43 + + 000004D0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000004E0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000004F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000500:5C 0C 43 5C 0C 43 5C 0C 45 5B 0A 45 5B 0A 45 5C + + 00000510:0A 45 5C 0A 45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 5F + + 00000520:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3E 5E 0D + + 00000530:3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 + + 00000540:5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E + + 00000550:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E + + 00000560:40 5D 0D 3D 50 1C 94 94 94 A1 A1 A0 C9 CA CA BC + + 00000570:BB B8 BB AC 9C C4 AD 94 D2 BB A4 E0 CF BD E0 D0 + + 00000580:BF DA C7 B5 DE CB B8 9A 93 8B 7C 76 70 A2 93 83 + + 00000590:C0 AB 95 C6 B2 9D CA B8 A4 D1 C0 AD E0 D2 C4 E8 + + 000005A0:DC CF CD C3 B5 8A 85 74 72 72 61 83 82 7E 34 43 + + 000005B0:15 3C 54 0C 38 50 0B 38 4E 0B 39 50 0B 3D 55 0C + + 000005C0:40 5B 0D 42 5D 0D 42 5D 0D 42 5D 0D 43 5C 0C 43 + + 000005D0:5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 43 5C 0C 43 5C + + 000005E0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000005F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000600:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000610:0C 43 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A + + 00000620:45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E + + 00000630:3F 5F 0E 3F 5F 0E 3F 5F 0E 3E 5E 0D 3F 5F 0E 3F + + 00000640:5F 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E + + 00000650:0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E + + 00000660:41 5E 0E 41 5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 4B + + 00000670:56 33 B8 B8 B8 B7 B7 B7 A1 A1 A2 BC AC 9B CC B2 + + 00000680:97 D6 C3 AE E5 D6 C6 E4 D4 C4 E1 D2 C2 D9 C6 B4 + + 00000690:D7 C3 AD CE BF AF AD 9A 85 BB A5 8D BD A9 93 C3 + + 000006A0:AF 9B C8 B5 A2 CE BD AA DC CE C0 E2 D5 C9 E1 D4 + + 000006B0:C7 D5 C5 B4 B1 A9 95 91 97 7B 4A 57 2D 39 51 0B + + 000006C0:38 50 0B 38 50 0B 3A 52 0C 3E 58 0C 41 5C 0D 42 + + 000006D0:5D 0D 42 5D 0D 42 5D 0D 41 5C 0C 43 5C 0C 43 5C + + 000006E0:0C 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C + + 000006F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000700:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000710:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5D 0A + + 00000720:45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 00 + + 00000730:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 00000740:5F 0E 3F 5F 0E 40 5D 0D 3F 5F 0E 3F 5F 0E 41 5E + + 00000750:0F 41 5E 0F 41 5E 0F 41 5E 0E 41 5E 0E 40 5D 0D + + 00000760:40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 + + 00000770:5D 0D 40 5D 0D 41 5E 0E 41 5E 0E 61 6C 44 D0 D0 + + 00000780:D0 B0 B0 B0 C8 C3 BE DB C8 B3 DC CA B8 EB DD CF + + 00000790:E8 D9 CA E5 D6 C7 E4 D6 C8 D9 C8 B5 D2 BF AA DD + + 000007A0:CC BA C7 B3 9E B6 9F 89 BC A7 92 C1 AD 98 C6 B3 + + 000007B0:9F CC BA A8 DB CD BF DD D0 C2 DF D3 C6 E0 D3 C5 + + 000007C0:E2 D4 C4 A7 AA 8E 52 62 2B 37 4D 0B 39 51 0B 3B + + 000007D0:53 0C 3E 57 0C 40 5A 0D 42 5D 0D 42 5D 0D 42 5D + + 000007E0:0D 42 5D 0D 44 5D 0D 43 5C 0C 43 5C 0C 45 5B 0D + + 000007F0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000800:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000810:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000820:43 5C 0C 43 5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 + + 00000830:5C 0A 45 5C 0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F + + 00000840:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F + + 00000850:0E 40 5D 0D 3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0F + + 00000860:41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00000870:5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00000880:0D 41 5E 0E 3F 5B 0D 6A 79 47 D1 D2 CE C5 C2 BF + + 00000890:EF E6 DD E7 D8 CA EE E0 D3 ED DF D2 EA DC CE E9 + + 000008A0:DB CD E1 D1 C1 D6 C3 B0 D7 C4 B1 DA C9 B8 D5 C3 + + 000008B0:B1 B8 A3 8C BC A7 91 C0 AC 97 C5 B1 9D CB B9 A5 + + 000008C0:D6 C8 B8 CE BF AE D9 CB BD E1 D4 C7 E3 D4 C6 BC + + 000008D0:B9 A2 53 63 2C 37 4C 0B 3C 55 0C 3E 58 0C 40 5B + + 000008E0:0D 41 5C 0D 42 5D 0D 42 5D 0D 42 5D 0D 42 5D 0D + + 000008F0:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 43 5C 0C 43 + + 00000900:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000910:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000920:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000930:5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 5C 0A 45 5C + + 00000940:0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F 5F 0E 3F 5F + + 00000950:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D + + 00000960:3F 5F 0E 3F 5F 0E 41 5E 0E 41 5E 0E 40 5D 0D 40 + + 00000970:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E + + 00000980:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E + + 00000990:40 59 0F 75 84 54 A6 B1 8E DC D9 CE F5 EE E8 E7 + + 000009A0:DA CE E5 D7 C8 EB DD D0 EC DF D2 E4 D5 C4 D8 C8 + + 000009B0:B5 D9 CA B8 D9 CB BA D9 C8 B6 D9 C8 B6 C4 B0 9C + + 000009C0:BA A5 90 BF AA 95 C3 AF 9B C9 B6 A3 C9 B9 A7 C7 + + 000009D0:B7 A6 D1 C2 B3 DC CF C0 E0 D2 C3 CE C4 B3 5B 69 + + 000009E0:33 3C 52 0D 40 5A 0D 41 5C 0D 42 5D 0D 42 5D 0D + + 000009F0:42 5D 0D 42 5D 0D 41 5C 0C 42 5D 0D 43 5C 0C 43 + + 00000A00:5C 0C 43 5C 0C 45 5B 0C 43 5C 0C 43 5C 0C 43 5C + + 00000A10:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000A20:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000A30:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000A40:0C 45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A + + 00000A50:45 5B 0C 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E + + 00000A60:3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D 3F 5F 0E 3F + + 00000A70:5F 0E 41 5E 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 5D + + 00000A80:0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D + + 00000A90:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 44 5C 12 8B + + 00000AA0:97 6A 93 A2 76 C8 CA B5 F5 EE E9 E8 DC CF E0 D0 + + 00000AB0:C1 DF D2 C4 E1 BB A1 D4 AC 8E D5 B2 97 D3 A4 84 + + 00000AC0:D3 A5 86 D7 C4 B0 D7 C5 B1 CF BB A6 C2 AE 99 C1 + + 00000AD0:AD 98 C1 AE 99 C5 B0 9B C7 B5 A2 C8 B8 A7 D1 C2 + + 00000AE0:B2 E0 D3 C6 E4 D8 CA E2 D5 C6 71 7B 4B 42 58 10 + + 00000AF0:42 5D 0D 42 5D 0D 42 5D 0D 42 5D 0D 42 5D 0D 42 + + 00000B00:5D 0D 41 5C 0C 41 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000B10:0C 45 5B 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000B20:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000B30:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000B40:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5C 0A + + 00000B50:45 5C 0A 45 5C 0A 45 5C 0A 45 5C 0A 45 5B 0C 00 + + 00000B60:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 00000B70:5F 0E 3F 5F 0E 40 5D 0D 3F 5F 0E 3F 5F 0E 41 5E + + 00000B80:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00000B90:40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 + + 00000BA0:5D 0D 40 5D 0D 41 5E 0E 4B 60 17 A0 AB 83 92 A2 + + 00000BB0:73 AC B6 94 F4 ED E7 E2 CF BE DA CA BA D7 C4 B2 + + 00000BC0:D0 86 58 CA 71 3D C9 69 32 C6 5D 24 C4 54 17 CC + + 00000BD0:86 5D D5 C5 B2 D2 BC A6 C9 B3 9D C2 AD 96 C1 AC + + 00000BE0:97 C8 B1 9A D9 C8 B6 D3 C4 B4 D1 C3 B3 DE D1 C4 + + 00000BF0:E0 D3 C5 E3 D5 C6 A3 A4 81 48 5E 13 42 5D 0D 42 + + 00000C00:5D 0D 42 5D 0D 42 5D 0D 42 5D 0D 42 5D 0D 41 5C + + 00000C10:0C 41 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C + + 00000C20:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000C30:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000C40:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000C50:43 5C 0C 43 5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 + + 00000C60:5C 0A 45 5C 0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F + + 00000C70:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F + + 00000C80:0E 40 5D 0D 3E 5E 0D 3E 5E 0D 40 5D 0D 40 5D 0D + + 00000C90:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00000CA0:5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00000CB0:0D 41 5E 0E 52 64 1F A4 AF 8A 95 A3 75 B3 AC 84 + + 00000CC0:DC AB 87 D7 A3 7D DB CD BD D2 A1 7F CD 76 42 CB + + 00000CD0:71 3C C9 69 32 C7 62 2A C5 5B 20 C3 54 19 D8 AD + + 00000CE0:90 E2 D7 CA D3 BE A9 CA B6 A0 D0 BD AA D1 BD A9 + + 00000CF0:DD CD BD DD D0 C2 D0 C1 B1 DA CD BE DE D1 C3 DB + + 00000D00:CD BC 91 9A 6E 4E 62 18 42 5D 0D 42 5D 0D 42 5D + + 00000D10:0D 42 5D 0D 42 5E 0B 41 5C 0C 41 5C 0C 41 5C 0C + + 00000D20:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 43 5C 0C 43 + + 00000D30:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000D40:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000D50:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000D60:5C 0C 43 5C 0C 45 5C 0A 45 5C 0A 45 5C 0A 45 5C + + 00000D70:0A 45 5C 0A 45 5B 0C 00 3F 5F 0E 3F 5F 0E 3F 5F + + 00000D80:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D + + 00000D90:3E 5D 0D 3E 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00000DA0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00000DB0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0E + + 00000DC0:58 67 26 A4 B1 8B B8 B1 8A D6 9F 74 D5 98 6B D7 + + 00000DD0:A4 7F DD CF BF D2 90 66 CD 77 43 CA 6E 38 C8 65 + + 00000DE0:2C C6 60 27 C6 5B 21 C3 56 1B CB 71 40 DD C8 B6 + + 00000DF0:D5 C3 AF E1 D2 C2 DF D0 C1 D9 C8 B7 E1 D3 C4 E4 + + 00000E00:D8 CA D1 C2 B2 E0 D4 C7 E7 DA CD AD AA 90 6F 7F + + 00000E10:47 52 63 1F 41 5B 0D 41 5C 0C 41 5C 0C 42 5D 0D + + 00000E20:42 5D 0B 41 5C 0C 41 5C 0C 41 5B 0C 42 5B 0C 43 + + 00000E30:5B 0C 43 5C 0C 43 5B 0B 43 5C 0C 43 5C 0C 43 5B + + 00000E40:0C 43 5B 0C 43 5B 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000E50:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000E60:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000E70:0C 44 5C 0A 44 5C 0A 45 5B 0A 45 5B 0A 45 5B 0A + + 00000E80:45 5B 0B 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E + + 00000E90:3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 + + 00000EA0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00000EB0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E + + 00000EC0:40 5D 0D 40 5D 0D 40 5D 0D 42 5C 0E 60 6E 33 A9 + + 00000ED0:B6 91 CD B0 8B D7 A2 78 D6 99 6D D9 A8 86 E2 D7 + + 00000EE0:CA DE BC A2 CC 78 44 D0 85 57 D2 8B 61 CC 74 42 + + 00000EF0:CC 76 46 CD 7D 4F CC 76 47 CF 9C 7A D8 C9 B7 DF + + 00000F00:D0 C0 DF CF BF DD CE BE E4 D7 C9 EB E0 D4 D1 C3 + + 00000F10:B3 DC CF C1 F1 E6 DA C8 C0 AE 72 80 4F 56 66 24 + + 00000F20:42 5B 0E 41 5C 0C 41 5C 0C 42 5D 0D 43 5C 0C 43 + + 00000F30:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C + + 00000F40:0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B 0D 43 5B 0D + + 00000F50:43 5B 0D 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00000F60:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00000F70:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00000F80:43 5C 0C 45 5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 + + 00000F90:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 00000FA0:5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00000FB0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00000FC0:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 + + 00000FD0:5D 0D 40 5D 0D 43 5C 10 78 82 4C B9 BF 9C D8 AB + + 00000FE0:84 D6 A3 7A D6 A2 7C DE BE A5 E7 DA CD E8 DA CB + + 00000FF0:DA AA 89 E7 D9 CC DB AE 91 C7 63 2B C6 5D 24 C4 + + 00001000:56 1B C2 51 15 D1 A2 83 E1 D4 C5 E1 D2 C2 E1 D1 + + 00001010:C2 D1 C0 AD D1 C2 B1 E2 D6 C9 D3 C5 B5 D4 C6 B7 + + 00001020:E2 D6 C8 EA DE D2 95 9A 76 5B 6B 2A 44 5C 0F 41 + + 00001030:5C 0C 41 5C 0C 41 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001040:0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B + + 00001050:43 5C 0C 43 5C 0C 43 5B 0D 43 5B 0D 43 5B 0D 43 + + 00001060:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001070:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00001080:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 + + 00001090:5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F + + 000010A0:5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F + + 000010B0:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000010C0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000010D0:5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D + + 000010E0:0D 47 5E 13 8E 97 67 C4 BF 9F CE A9 81 CA B7 99 + + 000010F0:E4 DA CF DB CC BC E9 DA CC E8 DA CC E9 DB CE E5 + + 00001100:CF BE CB 73 40 C6 5F 26 C6 5C 22 C3 52 15 CA 75 + + 00001110:45 D9 CA B9 E6 D8 CA E3 D5 C6 D1 BF AE C3 AF 9A + + 00001120:CE BE AD D1 C3 B3 CC BD AD D2 C4 B5 D9 CC BD DD + + 00001130:CE BF CE C6 B3 6A 78 3A 47 5C 11 41 5C 0C 41 5C + + 00001140:0C 42 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D + + 00001150:42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 + + 00001160:5C 0C 43 5B 0D 43 5B 0D 43 5B 0D 43 5C 0C 43 5C + + 00001170:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00001180:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001190:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 45 5B + + 000011A0:0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 5F + + 000011B0:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D + + 000011C0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000011D0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000011E0:0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 4C 61 17 + + 000011F0:9C A5 7A D1 BF 9E D6 A5 7D E2 BD 9F E3 CF BE DB + + 00001200:CB BB E9 DA CC E8 D9 CB EA DF D3 DC B0 93 C7 63 + + 00001210:29 C5 5C 22 C5 59 1F C5 5B 21 DD BC A4 DE D2 C4 + + 00001220:E6 D8 CA E8 DA CC CD BB A9 C6 B3 9F CE BD AB CA + + 00001230:B8 A5 CF BE AC D5 C4 B2 BD B4 9D AB AC 8B B6 BA + + 00001240:9A 78 86 4D 4A 5E 14 43 5C 0C 43 5C 0C 43 5C 0C + + 00001250:43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 + + 00001260:5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B + + 00001270:0D 42 5A 0C 43 5B 0D 43 5C 0C 43 5C 0C 43 5C 0C + + 00001280:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001290:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000012A0:0C 43 5C 0C 43 5C 0C 45 5B 0C 45 5B 0C 45 5B 0C + + 000012B0:45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E + + 000012C0:3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 + + 000012D0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000012E0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E + + 000012F0:40 5D 0D 40 5D 0D 40 5D 0D 53 64 1D A2 AA 82 D7 + + 00001300:BC 99 D8 A7 7F DA A8 81 E3 CE BB E1 D2 C3 E8 D9 + + 00001310:CC E8 D9 CB E4 D6 C7 E6 D7 C9 E2 BC A3 D2 84 57 + + 00001320:C5 56 1A D4 9A 76 E6 DE D2 E0 D0 C1 E3 D5 C6 F0 + + 00001330:E4 D7 E1 D2 C3 CA B7 A4 D1 C1 B0 C9 B7 A3 D0 BD + + 00001340:A9 D8 C6 B2 B5 AC 92 7B 89 53 75 89 4D 70 82 46 + + 00001350:53 61 1C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001360:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C + + 00001370:0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C + + 00001380:42 5A 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001390:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000013A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000013B0:43 5C 0C 45 5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 + + 000013C0:3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 000013D0:5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000013E0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000013F0:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 + + 00001400:5D 0D 41 5D 0E 59 67 24 A9 B2 8C D1 BB 98 D7 A5 + + 00001410:7C D4 B0 8D DE D4 C5 DA CA BB DE D1 C5 DB D0 C3 + + 00001420:DC CE BF E4 D5 C5 EC E2 D7 F0 E5 D9 E4 C4 AE D7 + + 00001430:C8 B9 D4 C7 BA D8 C9 BB E0 D2 C4 E9 DD D0 E3 D4 + + 00001440:C6 CF BD AB D2 C3 B3 C2 B2 A1 C6 B6 A3 CD BA A7 + + 00001450:CD BD A7 8B 97 65 7D 8E 55 74 85 49 5A 66 21 44 + + 00001460:5C 0E 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001470:0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B + + 00001480:43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 42 5A 0C 42 + + 00001490:5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000014A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000014B0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 + + 000014C0:5B 0C 45 5B 0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F + + 000014D0:5F 0E 3F 5F 0C 3F 5F 0C 3F 5F 0C 3F 5F 0E 40 5E + + 000014E0:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000014F0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001500:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 43 5D + + 00001510:0F 69 71 33 B3 BC 99 CD BA 96 D6 A4 79 A2 9B 72 + + 00001520:B3 AE 91 DE D0 C2 D9 C2 AF CE 9D 7C CF 8E 64 CE + + 00001530:7D 4C D6 AB 8D DD D4 C9 DB D1 C6 DB CF C2 D8 CA + + 00001540:BC CF C1 B2 D1 C4 B6 DB CF C3 D6 C8 BB C6 B6 A5 + + 00001550:CF C2 B4 D4 C8 BC A1 9B 81 69 6C 3C 60 63 2E 6C + + 00001560:77 41 7A 88 54 74 83 4B 60 6C 27 45 5C 0E 43 5C + + 00001570:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D + + 00001580:42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 + + 00001590:5C 0C 43 5B 0D 44 5A 0C 44 5A 0C 44 5B 0B 43 5C + + 000015A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000015B0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 000015C0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0C 43 5B + + 000015D0:0C 45 5B 0C 43 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 60 + + 000015E0:0C 3F 60 0C 3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D + + 000015F0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001600:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001610:0D 40 5D 0D 40 5D 0D 40 5D 0D 45 5E 10 7D 82 48 + + 00001620:BE C5 A4 B9 B0 8A BA B2 93 D1 C9 B6 DB AC 89 E6 + + 00001630:CC B7 E8 D2 C0 D1 85 55 CC 75 41 CA 6C 36 C6 6E + + 00001640:3B B5 A4 8E D2 C6 B8 E7 D8 C9 E5 D6 C7 E0 D1 C2 + + 00001650:DA CC BD DB CD C0 D3 C6 B7 BE AF A0 D0 C3 B5 E9 + + 00001660:DE D2 EA E2 D6 C3 BE A9 8B 89 64 61 66 34 65 6D + + 00001670:3E 68 76 45 63 6C 2D 47 5D 0F 43 5C 0C 43 5C 0C + + 00001680:43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 + + 00001690:5B 0D 43 5C 0C 42 5B 0B 43 5C 0C 43 5C 0C 43 5B + + 000016A0:0D 45 5B 0D 45 5B 0C 45 5B 0C 43 5C 0C 42 5B 0B + + 000016B0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 000016C0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000016D0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C + + 000016E0:43 5D 0A 00 3F 5F 0E 3F 5F 0E 3F 60 0C 3F 60 0C + + 000016F0:3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 + + 00001700:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001710:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00001720:40 5D 0D 40 5D 0D 47 5E 12 91 93 61 BC C2 A1 C3 + + 00001730:C4 AB E8 E0 D4 DF B4 93 D4 96 68 DE B2 93 E0 BB + + 00001740:A0 CF 81 50 CD 7A 48 CB 71 3C C8 63 2A D3 9A 75 + + 00001750:E1 D5 C7 DB CB BB D8 C7 B7 D7 C6 B5 D8 C7 B6 D8 + + 00001760:C7 B6 D3 C1 AF C5 B2 9E DB CD BE E9 DE D3 EF E5 + + 00001770:DB F6 EE E4 FA F0 E7 E3 D8 CA BB B0 9A A1 9D 83 + + 00001780:71 74 3B 4A 5E 12 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001790:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C + + 000017A0:0C 42 5B 0B 43 5B 0C 43 5B 0C 43 5C 0C 45 5B 0C + + 000017B0:44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 + + 000017C0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000017D0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000017E0:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 43 5C 0A 00 + + 000017F0:3F 5F 0E 3F 5F 0E 3F 60 0C 3F 60 0C 3F 60 0C 3F + + 00001800:5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001810:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00001820:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001830:5D 0D 4E 60 17 9B 9C 6F BB C2 9E D7 D5 C2 E0 C0 + + 00001840:A6 D7 A0 76 D6 9C 72 D8 A1 7A D4 95 6A D0 82 51 + + 00001850:CD 7A 47 CA 6D 38 D7 A7 88 DB BF AA D9 C9 B8 D3 + + 00001860:C3 B2 D0 BF AC D0 BE AC D1 C0 AE CF BD AA C6 B3 + + 00001870:9F D1 BF AD E2 D5 C7 E6 DC D0 EA DF D4 E9 DE D3 + + 00001880:E4 D8 CC DC CE C0 D1 C0 AF CC BD AA 73 79 3E 50 + + 00001890:5F 17 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 000018A0:0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B + + 000018B0:43 5B 0D 43 5B 0D 43 5C 0C 45 5B 0C 44 5A 0B 44 + + 000018C0:5A 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C + + 000018D0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000018E0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 000018F0:5C 0C 43 5C 0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F + + 00001900:5F 0E 3F 60 0C 3F 60 0C 3F 60 0C 3F 5F 0E 41 5E + + 00001910:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00001920:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001930:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 57 64 + + 00001940:1E A5 A5 7C B8 BE 9B D4 D1 BF E2 C5 AD D8 A2 78 + + 00001950:D7 9E 74 D8 A4 7E D2 8C 5E D0 83 53 CC 74 40 D1 + + 00001960:8D 62 DE D0 C2 DC CE C0 D4 C2 B1 CF BD AB D1 BF + + 00001970:AD D4 C3 B2 D4 C3 B1 CF BE AB D1 BF AD DC CC BC + + 00001980:DE D0 C3 DF D3 C6 DD D0 C3 DC CF C1 DF D3 C5 DA + + 00001990:CC BF D3 C5 B6 90 8D 58 60 6D 27 56 64 1E 43 5C + + 000019A0:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D + + 000019B0:42 5A 0C 43 5B 0D 43 5C 0C 42 5B 0B 43 5B 0D 43 + + 000019C0:5B 0D 43 5C 0C 44 5A 0B 44 5A 0B 44 5A 0B 42 5B + + 000019D0:0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000019E0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 000019F0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001A00:0C 45 5B 0C 45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 60 + + 00001A10:0C 3F 60 0C 3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D + + 00001A20:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001A30:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001A40:0D 40 5D 0D 40 5D 0D 40 5D 0D 62 6B 26 B0 B1 8C + + 00001A50:BB BE A0 E3 DD D0 E8 D7 C8 D8 A2 7A D7 A4 7D D5 + + 00001A60:9C 74 D1 87 57 CE 7C 4A D0 88 5C D7 C2 AF D4 C5 + + 00001A70:B5 D5 C4 B2 D9 C9 B8 DD CD BD DC CC BC DA C9 B9 + + 00001A80:D7 C6 B6 D7 C6 B5 DF D0 C0 D7 C7 B6 D7 C8 B9 D5 + + 00001A90:C7 B9 D9 CB BD E5 DA CD E4 D9 CC E0 D3 C6 D7 CD + + 00001AA0:BD 7C 84 48 5B 6A 1F 5C 67 21 43 5C 0C 43 5C 0C + + 00001AB0:43 5C 0C 43 5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 + + 00001AC0:5B 0D 43 5C 0C 42 5B 0B 43 5B 0D 42 5A 0C 42 5B + + 00001AD0:0B 44 5A 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B + + 00001AE0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001AF0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001B00:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C + + 00001B10:45 5C 0A 00 3F 5F 0E 3F 5F 0E 3F 60 0C 3F 60 0C + + 00001B20:3F 60 0C 3F 5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 + + 00001B30:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001B40:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00001B50:40 5D 0D 41 5D 0D 6D 73 32 B9 BA 9B D6 D1 BF EC + + 00001B60:E3 DA EE E7 DF E1 C0 A5 D7 AB 88 D7 A3 7E DA A7 + + 00001B70:84 DD B1 94 D9 C4 B1 D4 C5 B4 DB CB BB E9 DB CD + + 00001B80:E9 DB CE E3 D5 C6 DE CF BF DC CD BC DF CF C0 E1 + + 00001B90:D1 C2 DF CF C0 DA CA B9 D6 C7 B8 D5 C7 B9 E8 DC + + 00001BA0:D1 E8 DC D1 E4 D8 CC E5 D9 CC B2 AD 93 7D 89 53 + + 00001BB0:6A 77 32 60 6A 24 44 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001BC0:5C 0C 43 5C 0C 43 5B 0D 42 5A 0C 43 5B 0D 43 5C + + 00001BD0:0C 42 5B 0B 42 5A 0C 42 5A 0C 42 5B 0B 44 5A 0B + + 00001BE0:44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 + + 00001BF0:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001C00:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00001C10:43 5C 0C 43 5C 0C 43 5C 0C 45 5B 0C 45 5C 0A 00 + + 00001C20:40 5D 0D 41 5E 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 00001C30:5F 0E 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001C40:0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00001C50:41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 + + 00001C60:5E 0F 77 79 3C CC CA B4 EB E2 D9 ED E4 DB EF E7 + + 00001C70:E0 EF E7 DE DE CC BB DD CD BC E8 DB CD E9 DC CF + + 00001C80:DC CD BD E5 D6 C7 F1 E4 D8 F0 E3 D6 EA DC CE E5 + + 00001C90:D6 C7 E1 D2 C2 DF CF C0 DF CF C0 DD CD BD D9 C8 + + 00001CA0:B8 D7 C6 B5 E0 D3 C6 E6 DB CF EB E0 D5 E1 D5 C8 + + 00001CB0:DF D3 C7 E4 D8 CB A7 A3 88 77 82 4F 77 86 4B 6B + + 00001CC0:71 30 44 5D 0E 41 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001CD0:0C 43 5C 0C 43 5C 0C 43 5B 0D 43 5B 0D 43 5B 0D + + 00001CE0:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A 0B 44 + + 00001CF0:5A 0B 42 5B 0B 42 5B 0B 44 5A 0B 43 5C 0C 43 5C + + 00001D00:0C 43 5D 0A 43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C + + 00001D10:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001D20:5C 0C 43 5C 0C 42 5B 0B 44 5B 09 00 40 5D 0D 41 + + 00001D30:5E 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 41 5E + + 00001D40:0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E + + 00001D50:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001D60:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 47 5F 13 80 7F + + 00001D70:46 DE DA C9 EF E6 DD EE E5 DD F0 E8 E0 F1 E8 E0 + + 00001D80:E2 D2 C3 DE CD BD E3 D3 C3 E3 D4 C5 E2 D3 C5 E6 + + 00001D90:D9 CA E5 D7 C9 E7 DA CB E9 DA CC E5 D6 C8 E2 D3 + + 00001DA0:C4 E0 D1 C2 DA CA B9 D3 C2 B1 CF BD AA CC B9 A6 + + 00001DB0:D6 C7 B8 E1 D5 C9 E7 DB CF DF D3 C6 E0 D3 C7 DE + + 00001DC0:D1 C5 D4 C9 B9 7F 85 5B 75 83 4A 74 78 3A 4A 5F + + 00001DD0:14 41 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00001DE0:42 5B 0B 42 5B 0C 42 5B 0C 43 5B 0C 42 5B 0B 42 + + 00001DF0:5B 0B 42 5B 0B 42 5B 0B 43 5A 0B 43 5A 0B 42 5B + + 00001E00:0B 42 5B 0B 44 5A 0B 43 5C 0C 43 5C 0C 43 5D 0A + + 00001E10:43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00001E20:5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001E30:0C 42 5B 0B 44 5B 09 00 40 5D 0D 41 5E 0E 3F 5F + + 00001E40:0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 41 5E 0E 40 5D 0D + + 00001E50:40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 + + 00001E60:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00001E70:0D 40 5D 0D 40 5D 0D 4B 61 15 8E 8B 57 CF CE B6 + + 00001E80:EA E2 D6 F0 E7 DF F1 E9 E1 F1 E8 E0 E4 D5 C5 E1 + + 00001E90:D1 C0 E0 D0 C0 E0 D0 C2 E4 D5 C6 E3 D4 C5 E3 D4 + + 00001EA0:C5 E5 D6 C8 E8 DB CD EB DD D0 EB DD CF E8 DA CC + + 00001EB0:E0 D1 C2 D7 C6 B5 CE BB A9 C9 B5 A2 D3 C4 B5 D3 + + 00001EC0:C4 B6 DA CD BF E1 D5 C9 E3 D7 CB DD D1 C4 EA DF + + 00001ED0:D4 B7 B4 9C 77 85 4D 76 7D 3E 4F 61 17 41 5C 0C + + 00001EE0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 42 + + 00001EF0:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00001F00:0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5A 0B 43 5A 0B + + 00001F10:44 5A 0B 43 5C 0C 43 5C 0C 43 5D 0A 43 5D 0A 43 + + 00001F20:5D 0A 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00001F30:0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 43 5A 0B + + 00001F40:44 5B 09 00 40 5D 0D 40 5D 0D 3F 5F 0E 3F 5F 0E + + 00001F50:3F 5F 0E 3F 5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00001F60:5D 0D 40 5D 0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D + + 00001F70:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00001F80:40 5D 0D 50 63 1A A3 9F 71 CA C9 B1 E0 D9 CB F1 + + 00001F90:E8 E0 F2 EA E2 F2 E9 E0 E7 D8 C8 E4 D4 C4 E1 D0 + + 00001FA0:C1 E4 D5 C6 DD CD BD D7 C6 B6 DE CF BF E5 D6 C8 + + 00001FB0:EB DE D0 F0 E3 D6 F1 E5 D8 F0 E3 D6 ED DF D3 E9 + + 00001FC0:DB CD E8 DA CC E3 D4 C5 E3 D7 CA E4 D8 CC D9 CB + + 00001FD0:BD D9 CB BD E0 D3 C7 DF D3 C6 E7 DC D0 E1 D8 C8 + + 00001FE0:80 8D 56 7A 82 45 55 64 1B 41 5C 0C 43 5C 0C 43 + + 00001FF0:5C 0C 43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00002000:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002010:42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B 44 5A 0B 43 + + 00002020:5C 0C 43 5C 0C 43 5D 0A 43 5D 0A 43 5D 0A 43 5C + + 00002030:0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00002040:43 5C 0C 43 5C 0C 43 5A 0B 44 5A 0B 44 5B 09 00 + + 00002050:40 5D 0D 40 5D 0D 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F + + 00002060:5F 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 00002070:0D 41 5E 0E 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00002080:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 58 + + 00002090:67 20 B2 AF 88 D8 D4 C5 F0 E7 DE F1 E9 E1 F3 EC + + 000020A0:E4 F3 E9 E1 E9 DA CB E6 D6 C7 E4 D4 C4 E6 D8 C9 + + 000020B0:DF D0 C0 D5 C4 B3 DB CB BA E5 D7 C9 EB DD D0 EF + + 000020C0:E2 D5 F1 E4 D8 F0 E4 D7 ED DF D2 EE E1 D4 E6 D8 + + 000020D0:C9 C1 AE 98 CA B9 A8 E8 DC D1 EC E1 D7 E7 DC D0 + + 000020E0:DD D0 C3 D4 C6 B7 D8 CB BC AE AC 8B 79 87 4D 7B + + 000020F0:84 4A 5C 67 20 41 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00002100:0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002110:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002120:5B 0B 44 5A 0B 44 5A 0B 44 5A 0B 43 5C 0C 43 5C + + 00002130:0C 43 5D 0A 43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C + + 00002140:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 + + 00002150:5B 0B 44 5A 0B 44 5A 0B 44 5B 09 00 40 5D 0D 40 + + 00002160:5D 0D 3F 5F 0E 3F 5F 0E 3F 5F 0E 3F 5F 0E 40 5D + + 00002170:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 41 5E 0E + + 00002180:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00002190:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 64 6C 29 C3 BD + + 000021A0:A0 F4 EC E3 F2 E9 E0 F3 EA E2 F5 EE E6 F3 EA E1 + + 000021B0:EB DC CD E8 D9 CA E5 D5 C6 E4 D4 C5 E3 D3 C3 D9 + + 000021C0:C8 B8 D3 C1 AF DC CC BC EB DD D0 EF E2 D6 F2 E5 + + 000021D0:DA F2 E5 D9 F4 E7 DB EA DC CE C7 B3 A0 B7 A2 8B + + 000021E0:D1 C2 B3 EB E0 D6 E6 DA CF EA E0 D5 EF E4 DB E8 + + 000021F0:DC D1 D0 C5 B4 8A 8F 63 7C 8B 51 79 85 4A 64 69 + + 00002200:27 41 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 42 5B 0B + + 00002210:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002220:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A + + 00002230:0B 44 5A 0B 44 5A 0B 43 5C 0C 43 5C 0C 43 5D 0A + + 00002240:43 5D 0A 43 5D 0A 43 5C 0C 43 5C 0C 43 5C 0C 43 + + 00002250:5C 0C 43 5C 0C 43 5C 0C 42 5B 0B 44 5A 0B 44 5A + + 00002260:0B 44 5A 0B 44 5B 09 00 40 5D 0D 40 5D 0D 3F 5E + + 00002270:0D 3F 5E 0D 3F 5E 0D 3F 5E 0D 40 5D 0D 40 5D 0D + + 00002280:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00002290:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000022A0:0D 3F 5C 0C 40 5C 0D 72 74 35 CC C5 AC F4 EC E4 + + 000022B0:F1 E9 E0 F6 EE E6 F5 EE E6 F2 E9 DE ED DE CF EB + + 000022C0:DC CE E3 D3 C3 D8 C7 B4 DB CB BA DF D0 BF D9 C8 + + 000022D0:B7 D9 C8 B7 ED DE D0 F4 E6 D9 F9 ED E0 FD F0 E4 + + 000022E0:FF F3 E7 E0 CF BD CA B6 A1 C7 B3 9D F3 E7 DC F4 + + 000022F0:EA E0 E7 DD D0 E7 DC D0 E8 DD D2 EF E5 DB F0 E7 + + 00002300:DD A5 A6 81 7C 8A 50 76 83 47 6F 71 31 43 5C 0E + + 00002310:43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002320:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00002330:0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B + + 00002340:43 5A 0B 42 5B 0B 42 5B 0B 43 5C 0A 43 5C 0A 43 + + 00002350:5C 0A 43 5C 0C 43 5C 0C 43 5C 0B 43 5C 0B 43 5C + + 00002360:0C 43 5B 0C 42 5A 0A 43 59 0A 44 5A 0B 44 5A 0B + + 00002370:43 5B 09 00 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 00002380:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00002390:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000023A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C + + 000023B0:43 5E 0F 80 7E 41 D3 CD BA F2 E9 E0 F4 EB E2 F4 + + 000023C0:EA E1 F0 E8 DF E5 D9 CD DD CE BE E4 D5 C7 DC CD + + 000023D0:BF D9 CA BB D9 CA BB DA CC BD D2 C4 B6 CC BF B2 + + 000023E0:CC C1 B5 C8 BD B2 C3 B9 AF C0 B6 AB BA AE A2 AA + + 000023F0:9A 8B A6 95 84 BB AD 9E D7 CE C5 D5 CA BF D3 C6 + + 00002400:B9 DC CF C1 E5 D7 C9 EB DF D2 E6 DC CF 8D 92 67 + + 00002410:7A 87 4D 73 82 45 79 79 39 49 5E 11 43 5C 0C 42 + + 00002420:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00002430:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002440:42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 + + 00002450:5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00002460:0C 43 5C 0C 43 5D 0A 43 5D 0A 43 5C 0C 44 5A 0B + + 00002470:43 59 0A 43 59 0A 44 5A 0B 44 5A 0B 42 5C 09 00 + + 00002480:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00002490:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000024A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000024B0:40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C 45 5F 11 90 + + 000024C0:8A 4F EA E1 D5 E8 DF D7 E7 DF D6 E7 E1 DA E5 E0 + + 000024D0:DB E6 E3 DF EA E8 E5 F0 EE ED F2 F2 F1 F1 F1 F1 + + 000024E0:F0 F0 F0 EB EB EB E3 E4 E4 D7 D7 D8 C2 C3 C4 A8 + + 000024F0:A9 AA 8B 8B 8C 6C 6C 6D 53 54 55 45 45 46 3E 3F + + 00002500:3F 3B 3B 3B 3C 3B 3A 41 40 3F 4A 48 46 5B 57 54 + + 00002510:78 72 6C 9C 94 8B B4 AB A2 A2 9F 86 95 9C 6F 7A + + 00002520:8A 4F 7B 7D 3D 4B 5F 13 43 5C 0C 42 5B 0B 42 5B + + 00002530:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002540:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002550:5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B + + 00002560:0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 00002570:43 5D 0A 43 5D 0A 43 5C 0C 44 5A 0B 43 59 0A 43 + + 00002580:59 0A 44 5A 0B 44 5A 0B 42 5C 09 00 40 5D 0D 40 + + 00002590:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000025A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000025B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000025C0:5D 0D 40 5D 0D 3F 5C 0C 52 64 1D A1 92 80 C5 C5 + + 000025D0:C4 D2 D2 D2 E1 E2 E3 EB EC ED F2 F2 F3 F5 F5 F5 + + 000025E0:F7 F7 F6 F6 F6 F6 F5 F4 F3 F4 F3 F1 F1 EF EE F1 + + 000025F0:EF ED ED EC EA E7 E5 E3 DF DE DC D2 D1 D0 C4 C2 + + 00002600:C0 B7 B5 B2 AB A9 A6 A0 9D 9B 93 90 8D 89 88 87 + + 00002610:7E 7E 7F 72 72 71 6B 6A 6A 69 69 6A 69 6A 6B 6F + + 00002620:71 73 83 86 89 A2 A3 A5 BB BA BA C4 C7 BF AE A4 + + 00002630:81 55 64 1C 43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B + + 00002640:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002650:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A + + 00002660:0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C + + 00002670:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5D 0A 43 + + 00002680:5D 0A 43 5C 0C 44 5A 0B 44 5A 0B 43 59 0A 43 59 + + 00002690:0A 44 5A 0B 42 5C 09 00 40 5D 0D 40 5D 0D 40 5D + + 000026A0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000026B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000026C0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000026D0:0D 3F 5C 0C 75 82 5E 9E A0 A2 C6 C7 C8 DE DE DE + + 000026E0:EA E9 E8 F2 F1 F0 F5 F3 F0 F5 F3 F0 F1 ED E9 EB + + 000026F0:E6 E0 E9 E3 DD E6 E1 DA E0 DB D6 E9 E5 DD F6 F4 + + 00002700:F3 E9 E5 E1 E4 DF DA DC D7 D0 D2 CA C1 D4 CC C4 + + 00002710:DB D4 CC E2 DC D5 D4 CC C3 CF C7 BC F3 EF EB DF + + 00002720:D9 D2 D9 D2 CB DC D7 D1 DB D8 D4 C9 C4 B8 B8 AF + + 00002730:96 C3 BF B7 D0 D0 D0 D0 D1 D2 CF D1 D3 86 8F 6D + + 00002740:43 5C 0C 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002750:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00002760:0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B + + 00002770:42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 + + 00002780:5C 0C 43 5C 0C 43 5C 0C 43 5D 0A 43 5D 0A 44 5A + + 00002790:0B 44 5A 0B 44 5A 0B 43 59 0A 43 59 0A 44 5A 0B + + 000027A0:42 5C 09 00 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000027B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000027C0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000027D0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C + + 000027E0:89 91 7B AD AC AC AD A4 84 A2 97 5E A7 9B 5F EE + + 000027F0:E9 DA FC FC FC F8 F6 F4 EE E9 E4 E5 DE D7 E6 E1 + + 00002800:DB E4 E0 DB B8 AA 7D B7 AD 7C FF FF FF F2 F2 F2 + + 00002810:E5 E1 DD DE D9 D3 D6 CF C8 DB D6 D0 DB D6 D0 D9 + + 00002820:D3 CD D1 CA C2 BE B4 A8 BA AF A3 C6 BD B3 CE C6 + + 00002830:BE D1 CD C7 C5 B8 99 9A 8F 4D 91 88 43 9A 90 4E + + 00002840:A5 99 61 B2 A9 8B CB CB CC 9D A4 90 43 5C 0C 42 + + 00002850:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00002860:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002870:42 5B 0B 42 5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 + + 00002880:5B 0B 42 5B 0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C + + 00002890:0C 43 5C 0C 43 5D 0A 43 5D 0A 44 5A 0B 44 5A 0B + + 000028A0:43 59 0A 43 59 0A 43 59 0A 44 5A 0B 42 5C 09 00 + + 000028B0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000028C0:5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D + + 000028D0:0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000028E0:40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C 90 99 7F 7D + + 000028F0:7C 7C 73 70 69 83 7D 64 93 88 5F A6 9C 78 EA E8 + + 00002900:E4 FB F9 F7 E7 E1 DA E1 D9 D1 D9 D0 BF AB 9F 68 + + 00002910:8D 84 3E 99 8F 4C C8 BB 90 E6 E0 CA F3 F0 EB E9 + + 00002920:E5 E1 E0 DA D4 E6 E2 DE DD D7 D2 CE C7 BF DF DA + + 00002930:D5 E1 DC D7 D5 CE C6 D6 CF C7 CC C3 B4 BC B1 99 + + 00002940:96 8A 54 8C 80 47 90 84 56 8E 83 5D 89 82 6C 9A + + 00002950:97 91 B2 B2 B3 92 9B 80 43 5C 0C 42 5B 0B 42 5B + + 00002960:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002970:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002980:5B 0B 44 5A 0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B + + 00002990:0B 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C + + 000029A0:43 5D 0A 42 5C 09 44 5A 0B 44 5A 0B 43 59 0A 43 + + 000029B0:59 0A 44 5A 0B 44 5A 0B 42 5C 09 00 40 5D 0B 40 + + 000029C0:5D 0B 40 5E 0C 40 5E 0C 40 5E 0C 40 5E 0C 40 5E + + 000029D0:0C 40 5D 0B 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D + + 000029E0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 000029F0:5D 0D 40 5D 0D 3F 5C 0C 49 63 1A 85 94 6B A3 A7 + + 00002A00:9E 9F A1 A3 9E A1 A5 A3 A4 A6 B9 B8 B7 EA E7 E5 + + 00002A10:DF D6 CD CE C8 C2 B6 B0 A3 A8 9F 81 A7 9F 81 A2 + + 00002A20:98 77 9A 8F 66 9A 91 6B A2 9B 84 B5 B4 AB D4 D1 + + 00002A30:CD DE D9 D3 DE D8 D1 D0 C9 C1 D0 CA C4 DF DD DC + + 00002A40:E4 E1 DE CB C8 C6 7E 7A 71 57 52 49 56 53 50 5B + + 00002A50:5C 5E 6E 71 74 86 88 8B A0 A1 A3 A6 AB A0 82 8F + + 00002A60:66 4C 63 18 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B + + 00002A70:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002A80:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 44 5A + + 00002A90:0B 44 5A 0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C + + 00002AA0:43 5C 0C 43 5C 0C 43 5C 0C 43 5C 0C 43 5B 09 43 + + 00002AB0:5B 09 44 5A 09 44 5A 0B 43 59 0A 43 59 0A 43 59 + + 00002AC0:0A 43 59 0A 43 5A 0A 00 40 5D 0D 40 5E 0E 41 5E + + 00002AD0:0E 41 5E 0E 41 5E 0E 41 5E 0E 40 5D 0D 40 5D 0D + + 00002AE0:40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 40 5D 0D 3F + + 00002AF0:5C 0C 3F 5C 0C 3F 5C 0C 3F 5C 0C 40 5D 0D 40 5D + + 00002B00:0D 40 5D 0D 3F 5C 0C 3F 5C 0C 44 60 13 58 70 2E + + 00002B10:73 85 53 84 92 6B 8F 99 7C A6 AC 9A B7 B8 AE B9 + + 00002B20:B9 B8 BB BD BE BA BD BF B8 BB BD B5 B8 BB B0 B3 + + 00002B30:B6 A9 AB AD 9D 9E 9F 8F 8F 90 86 86 86 87 86 86 + + 00002B40:B5 B1 AD DE D8 D1 BB B5 AF 6C 6C 6C 79 79 79 6F + + 00002B50:6F 6F 71 72 71 7A 7C 76 7D 83 73 7C 86 68 7B 86 + + 00002B60:60 6F 7E 4D 57 6B 2A 46 5E 11 43 5C 0C 43 5D 0A + + 00002B70:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 + + 00002B80:5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5B + + 00002B90:0B 42 5B 0B 42 5B 0B 42 5B 0B 42 5A 0B 42 5A 0B + + 00002BA0:42 5B 0B 42 5B 0B 42 5B 0B 42 5B 0B 43 5C 0C 43 + + 00002BB0:5C 0A 43 5C 0A 43 5C 0A 44 5B 09 44 5A 0A 44 5A + + 00002BC0:0A 44 5A 0B 44 5A 0B 43 59 0A 43 59 0A 43 59 0A + + 00002BD0:44 5A 0B 00 3E 5E 0D 3F 5D 0D 3F 5D 0D 40 5E 0E + + 00002BE0:41 5E 0E 40 5D 0D 40 5D 0D 3F 5C 0C 40 5D 0C 40 + + 00002BF0:5D 0C 40 5D 0C 40 5D 0C 3F 5C 0B 3F 5C 0B 3F 5C + + 00002C00:0B 3F 5C 0B 40 5D 0D 40 5D 0D 40 5D 0D 3F 5C 0C + + 00002C10:3F 5C 0C 3F 5C 0C 40 5D 0D 40 5D 0D 40 5D 0D 40 + + 00002C20:5D 0D 40 5D 0D 41 5C 0C 48 62 16 52 69 23 58 6E + + 00002C30:2D 5D 72 34 61 75 3A 64 77 3F 67 79 42 68 7A 44 + + 00002C40:69 7B 46 69 7A 46 68 78 44 66 77 42 64 75 40 8C + + 00002C50:96 6D C0 BE B0 51 62 2B 57 6B 2D 58 6D 2C 51 67 + + 00002C60:22 49 60 15 41 5B 0B 41 5B 0B 41 5B 0B 41 5B 0B + + 00002C70:41 5B 0B 40 5B 0B 40 5B 0B 40 5C 09 42 5B 0A 42 + + 00002C80:5B 0A 42 5B 0A 42 5B 0A 42 5B 0A 42 5B 0A 42 5B + + 00002C90:0A 41 5A 0A 42 5A 0C 42 5A 0C 42 5A 0C 42 5B 0B + + 00002CA0:42 5B 0B 42 5B 0B 42 5B 0A 42 5B 0A 44 5A 0B 44 + + 00002CB0:5A 0B 44 5A 0A 44 5A 0A 44 5A 0A 45 5B 0B 45 5B + + 00002CC0:0B 45 5B 0B 44 5A 09 44 5A 09 44 5A 0B 44 5A 0B + + 00002CD0:44 5A 0B 44 5A 0B 43 59 0A 43 59 0A 43 5B 09 00 + + 00002CE0:3F 5F 0D 3F 5F 0D 3F 5F 0D 3F 5F 0D 40 5E 0D 40 + + 00002CF0:5E 0D 40 5E 0D 40 5E 0D 40 5F 0C 40 5F 0C 40 5F + + 00002D00:0C 40 5F 0C 3F 5E 0B 3F 5E 0B 40 5E 0B 40 5E 0B + + 00002D10:40 5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 + + 00002D20:5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 5D 0C 40 5D + + 00002D30:0C 41 5D 0C 41 5C 0B 41 5C 0B 41 5C 0B 41 5C 0B + + 00002D40:41 5D 0C 41 5D 0C 41 5D 0C 40 5C 0B 40 5C 0B 40 + + 00002D50:5C 0B 40 5C 0B 40 5C 0C 41 5C 0C 41 5C 0C 5A 70 + + 00002D60:2B 41 5C 0C 41 5C 0C 41 5C 0C 41 5C 0C 41 5C 0C + + 00002D70:41 5C 0B 41 5C 0B 41 5C 0B 41 5C 0B 41 5C 0B 41 + + 00002D80:5C 0B 41 5C 0B 41 5D 0B 42 5D 0A 42 5D 0A 42 5D + + 00002D90:0A 42 5D 0A 42 5D 0A 42 5D 0A 42 5D 0A 42 5D 0A + + 00002DA0:42 5C 0B 42 5C 0B 42 5C 0B 42 5C 0B 42 5C 0B 43 + + 00002DB0:5C 0B 43 5D 0A 43 5D 0A 44 5C 0B 44 5C 0B 44 5C + + 00002DC0:0A 44 5C 0A 44 5C 0A 44 5C 0A 44 5C 0A 44 5C 0A + + 00002DD0:43 5B 0A 43 5B 0A 43 5B 0A 43 5B 0A 43 5B 0A 43 + + 00002DE0:5B 0A 43 5B 0A 43 5B 0A 43 5D 09 00 3F 61 0C 40 + + 00002DF0:62 0D 40 62 0D 3F 61 0C 3F 61 0C 3F 61 0C 3F 61 + + 00002E00:0C 3F 61 0C 3F 61 0C 3F 61 0C 3F 61 0C 3F 61 0C + + 00002E10:3F 60 0C 3F 60 0C 40 60 0C 40 60 0C 40 60 0C 40 + + 00002E20:60 0C 3F 5F 0C 3F 5F 0C 3F 5F 0C 40 60 0C 40 60 + + 00002E30:0C 40 60 0C 3F 5F 0B 3F 5F 0B 3F 5F 0C 41 5F 0C + + 00002E40:41 5E 0B 41 5E 0B 42 5F 0C 42 5F 0C 40 60 0C 40 + + 00002E50:60 0C 40 60 0C 3F 5F 0B 3F 5F 0B 3F 5F 0B 3F 5F + + 00002E60:0B 3F 5F 0B 42 5F 0C 42 5F 0C 41 5E 0B 41 5E 0B + + 00002E70:41 5E 0B 41 5E 0B 41 5E 0B 41 5F 0C 41 5E 0B 41 + + 00002E80:5E 0B 41 5E 0B 41 5E 0B 41 5E 0B 41 5F 0B 41 5F + + 00002E90:0B 41 5F 0A 41 5F 0B 41 5F 0B 41 5F 0B 41 5F 0B + + 00002EA0:41 5F 0B 41 5F 0B 41 5F 0B 41 5F 0B 42 5F 0B 42 + + 00002EB0:5F 0B 41 5F 0B 41 5F 0B 41 5F 0B 43 5F 0B 43 5E + + 00002EC0:0A 43 5E 0A 43 5F 0B 43 5F 0B 43 5F 0B 43 5F 0B + + 00002ED0:43 5F 0B 43 5F 0A 43 5F 0A 43 5F 0A 42 5E 09 42 + + 00002EE0:5E 09 42 5E 09 42 5E 09 42 5E 09 42 5E 09 42 5E + + 00002EF0:09 42 5E 09 42 5E 09 00 3F 64 0B 3F 64 0B 3F 64 + + 00002F00:0B 3F 64 0B 3F 64 0B 3F 64 0B 3F 64 0B 3F 64 0B + + 00002F10:3F 64 0C 3F 64 0C 3F 64 0C 3F 62 0C 40 62 0C 40 + + 00002F20:62 0C 40 62 0C 40 62 0C 40 62 0C 40 62 0C 3F 62 + + 00002F30:0C 3F 62 0C 40 63 0C 40 63 0D 40 62 0C 40 62 0C + + 00002F40:3F 62 0B 3F 62 0B 3F 62 0C 40 62 0C 40 62 0C 41 + + 00002F50:62 0C 41 63 0D 40 62 0C 40 63 0A 40 63 0A 40 63 + + 00002F60:0A 3F 62 0C 3F 62 0C 3F 62 0C 3F 62 0C 3F 62 0C + + 00002F70:40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 + + 00002F80:61 0B 40 61 0B 41 62 0C 40 61 0B 40 61 0B 40 61 + + 00002F90:0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B + + 00002FA0:40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 + + 00002FB0:61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 0B 40 61 + + 00002FC0:0B 40 62 09 40 62 09 40 62 09 42 61 09 42 61 09 + + 00002FD0:42 61 09 42 61 09 42 61 09 42 61 09 42 61 09 42 + + 00002FE0:61 09 42 61 09 42 61 09 40 62 09 42 61 09 42 61 + + 00002FF0:09 42 61 09 42 61 09 42 61 09 42 61 09 42 61 09 + + 00003000:42 61 09 00 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F + + 00003010:3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D + + 00003020:60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 0F 3D 60 + + 00003030:0F 3D 60 0F 3D 61 0E 3D 61 0E 3C 60 0D 3C 60 0D + + 00003040:3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D + + 00003050:61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 + + 00003060:0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E 3D 61 0E + + 00003070:3C 60 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E + + 00003080:5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F + + 00003090:0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D + + 000030A0:3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E + + 000030B0:5F 0D 3E 5F 0D 3E 5F 0D 3F 5F 0D 3F 5F 0D 3F 5F + + 000030C0:0D 3F 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D 3E 5F 0D + + 000030D0:3E 60 0B 3D 5F 0A 3E 5F 0A 3E 5F 0A 3F 60 0B 3F + + 000030E0:60 0B 3F 60 0B 3F 60 0B 3F 60 0B 3F 60 0B 3F 60 + + 000030F0:0B 3F 60 0B 3E 60 0B 3E 60 0B 3E 60 0B 3F 60 0B + + 00003100:3F 60 0B 3F 60 0B 3F 5F 0D 3F 5F 0D 3D 5F 0A 00 + +[TABLE] + +**Type (4 bytes)**: 0x0000004C identifies this record type as EMR_BITBLT. + +**Size (4 bytes)**: 0x00002FA8 specifies the size of this record in bytes. + +**Bounds (16 bytes)**: 0x00000000, 0x00000002D, 0x00000059, 0x00000059 specifies the bounding rectangle in logical units. + +**xDest (4 bytes)**: 0x00000000 specifies the logical x-coordinate of the upper-left corner of the destination rectangle. + +**yDest (4 bytes)**: 0x0000002D specifies the logical y-coordinate of the upper-left corner of the destination rectangle. + +**cxDest (4 bytes)**: 0x0000005A specifies the logical width of the destination rectangle. + +**cyDest (4 bytes)**: 0x0000002D specifies the logical height of the destination rectangle. + +[TABLE] + +**BitBlitRasterOperation (4 bytes)**: 0x00CC0020 specifies the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) code from the **Ternary Raster Operation** enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.31). This code defines how the color data of the source rectangle is to be combined with the color data of the destination rectangle to achieve the final color. + +**xSrc (4 bytes)**: 0x00000000 specifies the logical x-coordinate of the upper-left corner of the source rectangle. + +**ySrc (4 bytes)**: 0x00000000 specifies the logical y-coordinate of the upper-left corner of the source rectangle. + +**xformSrc (24 bytes)**: 0x3F800000, 0x00000000, 0x00000000, 0x3F800000, 0x00000000, 0x00000000 specify the [**world-space**](#gt_baadb707-1343-413b-9b36-2496b06e9bd7) to [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) [**transform**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b). For more information about [**coordinate spaces**](#gt_84184077-d0d9-41e0-acaf-6596aa066813), see [\[MSDN-WRLDPGSPC\]](https://go.microsoft.com/fwlink/?LinkId=90169). + +[TABLE] + +**BkColorSrc (4 bytes)**: 0x00FFFFFF specifies the background [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color. + +**UsageSrc (4 bytes)**: 0x00000000 specifies the value of the **Colors** field of the **DeviceIndependentBitmap** object (\[MS-WMF\] section 2.2.2.9) from the [DIBColors](#Section_a5e722e3891a4a67be1aed5a48a7fda1) enumeration (section 2.1.9). + +**offBmiSrc (4 bytes)**: 0x00000064 specifies the offset to the source **DeviceIndependentBitmap** object. + +**cbBmiSrc (4 bytes)**: 0x00000000 specifies the size of the source **DeviceIndependentBitmap** object. + +**offBitsSrc (4 bytes)**: 0x0000008C specifies the offset to the source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) bits. + +**cbBitsSrc (4 bytes)**: 0x00002F1C specifies the size of the source bitmap bits. + +### EMR_SETBKMODE Example + +This section provides an example of an [EMR_SETBKMODE](#Section_7c584a42b6dd47b8a0b6f529133292f4) record (section 2.3.11.11). + +2230. 00003110:12 00 00 00 0C 00 00 00 01 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000012 identifies this record type as EMR_SETBKMODE. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**Mode (4 bytes)**: 0x00000001 specifies the background color value. + +### EMR_EXTCREATEFONTINDIRECTW Example 1 + +This section provides an example of an EMR_EXTCREATEFONTINDIRECTW record (section [2.3.7.8](#Section_7e266b6d32e54201b6878ec40c24cd73)). + +2232. 00003110: 52 00 00 00 + + 00003120:70 01 00 00 02 00 00 00 F3 FF FF FF 00 00 00 00 + + 00003130:4E 0C 00 00 4E 0C 00 00 C8 00 00 00 00 00 00 01 + + 00003140:04 00 00 02 41 00 72 00 69 00 61 00 6C 00 00 00 + + 00003150:00 00 00 00 00 00 00 00 00 00 00 00 0C 45 00 00 + + 00003160:BC 16 E8 FE FE 07 00 00 20 00 CC 00 00 00 00 00 + + 00003170:4C 00 00 00 FE 07 00 00 DA 16 01 B8 FF FF FF FF + + 00003180:00 00 00 00 00 00 00 00 F0 F6 13 00 00 00 00 00 + + 00003190:0E 20 05 27 00 00 00 00 28 00 00 00 00 00 00 00 + + 000031A0:1C 2F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000031B0:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000031C0:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000031D0:00 00 00 00 00 00 00 00 28 00 00 00 FF FF FF 00 + + 000031E0:1C 2F 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000031F0:58 00 00 00 2C 00 00 00 00 00 00 00 00 00 00 00 + + 00003200:00 00 80 3F 00 00 00 00 00 00 00 00 00 00 80 3F + + 00003210:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003220:D0 C5 35 00 00 00 00 00 28 00 00 00 59 00 00 00 + + 00003230:2D 00 00 00 01 00 18 00 00 00 00 00 1C 2F 00 00 + + 00003240:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003250:10 00 90 01 00 00 00 00 25 00 00 00 00 00 00 00 + + 00003260:D3 3F EC FE FE 07 00 00 79 0D 21 11 00 00 00 00 + + 00003270:10 00 90 01 00 00 00 00 00 00 00 00 59 00 00 00 + + 00003280:2D 00 00 00 64 76 00 08 00 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000052 identifies this record type as EMR_EXTCREATEFONTINDIRECTW. + +**Size (4 bytes)**: 0x00000170 specifies the size of this record in bytes. + +**ihFonts (4 bytes)**: 0x00000002 specifies the object index that is assigned to the font. + +**elw (360 bytes)**: To determine the type of logical font object in this field, an algorithm (section 2.3.7.8) is applied, which indicates this is a [LogFontExDv object (section 2.2.15)](#Section_595fcaaebc3741489afe859e81ca7f76). + +[TABLE] + +**Height (4 bytes)**: 0xFFFFFFF3 has an absolute value of 13, which specifies the character height for this font, in logical units. + +**Width (4 bytes)**: 0x00000000 specifies a computed font width. The aspect ratio of the device is matched against the digitization aspect ratio of the font to find the closest match, determined by the absolute value of the difference. + +**Escapement (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between the [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62) of a row of text and the x-axis of the device. + +**Orientation (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between each character's baseline and the x-axis of the device. + +**Weight (4 bytes)**: 0x000000C8 specifies that the [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) of the font is 200, in the range 0 through 1000, from lightest to darkest, with 400 (0x00000190) considered normal. + +**Italic (1 byte)**: 0x00 specifies that the font is not italic. + +**Underline (1 byte)**: 0x00 specifies that the font is not underlined. + +**Strikeout (1 byte)**: 0x00 specifies that the font characters do not have a strike-out graphic. + +**CharSet (1 byte)**: 0x01 specifies the default character set, from the CharacterSet enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.5). + +**OutPrecision (1 byte)**: 0x04 specifies the output precision, which is how closely the output is expected to match the requested font properties, from the OutPrecision enumeration (\[MS-WMF\] section 2.1.1.21). The value 0x04 specifies a [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) font, if there is a choice between multiple fonts with the same name. + +**ClipPrecision (1 byte)**: 0x00 specifies the clipping precision, which is how to clip characters that are partially outside the clipping [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), from the ClipPrecision flags (\[MS-WMF\] section 2.1.2.1). The value 0x00 specifies default clipping behavior. + +**Quality (1 byte)**: 0x00 specifies default output quality, from the FontQuality enumeration (\[MS-WMF\] section 2.1.1.10). + +**PitchAndFamily (1 byte)**: 0x02 specifies a variable-pitch font, and no preference for font family, from the PitchAndFamily object (\[MS-WMF\] section 2.2.2.14). + +**Facename (68 bytes)**: "Arial" specifies the [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) name of the font in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. + +[TABLE] + +**FullName (132 bytes)**: An empty string specifies the font's full name. + +**Style (68 bytes)**: An empty string describes the font's style. + +**Script (68 bytes)**: An empty string describes the font's character set. + +**Signature (4 bytes)**: 0x08007664 specifies the signature of a [DesignVector object (section 2.2.3)](#Section_cdf6681fbf454eec923e08c8be16aaf2). + +**NumAxes (4 bytes)**: 0x00000000 specifies the number of [**font axes**](#gt_5d727201-0a47-44b1-86e5-faf77f0f2463) described in the DesignVector object. + +### EMR_SELECTOBJECT Example 3 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +2257. 00003280: 25 00 00 00 + + 00003290:0C 00 00 00 02 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000025 identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x00000002 specifies the index of an object in the EMF object table. + +### EMR_EXTTEXTOUTW Example + +This section provides an example of an [EMR_EXTTEXTOUTW](#Section_a59a79ac328e492da34de02727af6edf) record (section 2.3.5.8). + +2260. 00003290: 54 00 00 00 A0 00 00 00 + + 000032A0:00 00 00 00 00 00 00 00 FF FF FF FF FF FF FF FF + + 000032B0:01 00 00 00 AB 0A 0D 42 00 00 0D 42 12 00 00 00 + + 000032C0:05 00 00 00 0E 00 00 00 4C 00 00 00 00 00 00 00 + + 000032D0:00 00 00 00 00 00 00 00 FF FF FF FF FF FF FF FF + + 000032E0:68 00 00 00 53 00 69 00 6D 00 70 00 6C 00 65 00 + + 000032F0:20 00 53 00 61 00 6D 00 70 00 6C 00 65 00 00 00 + + 00003300:09 00 00 00 03 00 00 00 0B 00 00 00 07 00 00 00 + + 00003310:03 00 00 00 07 00 00 00 04 00 00 00 09 00 00 00 + + 00003320:07 00 00 00 0B 00 00 00 07 00 00 00 03 00 00 00 + + 00003330:07 00 00 00 09 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000054 identifies this record type as EMR_EXTTEXTOUTW. + +**Size (4 bytes)**: 0x000000A0 specifies the size of this record in bytes. + +**Bounds (16 bytes)**: 0x00000000, 0x00000000, 0xFFFFFFFF, 0xFFFFFFFF values are not used. + +**iGraphicsMode (4 bytes)**: 0x00000001 specifies the current graphics mode. + +**exScale (4 bytes)**: 35.260418 specifies the X scale from page units to .01mm units if graphics mode is **GM_COMPATIBLE**. + +**eyScale (4 bytes)**: 35.250000 specifies the Y scale from page units to .01mm units if graphics mode is **GM_COMPATIBLE**. + +**aemrtext (variable)**: An array of [EmrText](#Section_dd585d0a5d7c4034963a1141af836972) objects (section 2.2.5) that specifies the properties of the strings to be output, and where to find the output strings and spacing values. + +[TABLE] + +**Reference (8 bytes)**: 0x00000012, 0x00000005 specify the coordinates of the reference point used to position the string. + +**Chars (4 bytes)**: 0x0000000E specifies the number of characters in the string. + +**offString (4 bytes)**: 0x0000004C specifies the offset to the string in bytes, from the start of the EMR_EXTTEXTOUTW record. + +**Options (4 bytes)**: 0x00000000 specifies that the **Rectangle** field is not used. + +**Rectangle (16 bytes)**: 0x00000000, 0x00000000, 0xFFFFFFFF, 0xFFFFFFFF values are not used. + +**offDx (4 bytes)**: 0x00000068 specifies the offset to an intercharacter spacing array in bytes, from the start of the EMR_EXTTEXTOUTW record. + +**text (4 bytes)**: "Simple Sample". + +### EMR_EXTCREATEFONTINDIRECTW Example 2 + +This section provides an example of an [EMR_EXTCREATEFONTINDIRECTW](#Section_7e266b6d32e54201b6878ec40c24cd73) record (section 2.3.7.8). + +2271. 00003330: 52 00 00 00 70 01 00 00 + + 00003340:03 00 00 00 F3 FF FF FF 00 00 00 00 4E 0C 00 00 + + 00003350:4E 0C 00 00 C8 00 00 00 00 00 00 00 04 00 00 02 + + 00003360:4D 00 69 00 63 00 72 00 6F 00 73 00 6F 00 66 00 + + 00003370:74 00 20 00 53 00 61 00 6E 00 73 00 20 00 53 00 + + 00003380:65 00 72 00 69 00 66 00 00 00 00 00 00 00 00 00 + + 00003390:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000033A0:00 00 00 00 28 00 00 00 59 00 00 00 2D 00 00 00 + + 000033B0:01 00 18 00 00 00 00 00 1C 2F 00 00 00 00 00 00 + + 000033C0:00 00 00 00 00 00 00 00 00 00 00 00 10 00 90 01 + + 000033D0:00 00 00 00 25 00 00 00 00 00 00 00 D3 3F EC FE + + 000033E0:FE 07 00 00 79 0D 21 11 00 00 00 00 10 00 90 01 + + 000033F0:00 00 00 00 00 00 00 00 59 00 00 00 2D 00 00 00 + + 00003400:64 76 00 08 00 00 00 00 00 00 00 00 00 08 0D 00 + + 00003410:0D 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003420:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003430:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003440:00 00 00 00 92 A0 CD 02 00 00 00 00 CA BE CD 02 + + 00003450:00 00 00 00 00 00 00 00 00 00 00 00 FF FF 5A FE + + 00003460:00 00 00 00 00 00 00 00 00 00 00 00 95 F1 53 FE + + 00003470:FE 07 00 00 BE 06 5A FE FE 07 00 00 87 F2 53 FE + + 00003480:FE 07 00 00 C4 04 5A FE FE 07 00 00 79 0D 21 11 + + 00003490:00 00 00 00 01 00 00 00 00 00 00 00 F0 02 5A FE + + 000034A0:64 76 00 08 00 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000052 identifies this record type as EMR_EXTCREATEFONTINDIRECTW. + +**Size (4 bytes)**: 0x00000170 specifies the size of this record in bytes. + +**ihFonts (4 bytes)**: 0x00000003 specifies the object index that is assigned to the font. + +**elw (360 bytes)**: To determine the type of logical font object in this field, an algorithm (section 2.3.7.8) is applied, which indicates this is a [LogFontExDv object (section 2.2.15)](#Section_595fcaaebc3741489afe859e81ca7f76). + +[TABLE] + +**Height (4 bytes)**: 0xFFFFFFF3 has an absolute value of 13, which specifies the character height for this font in logical units. + +**Width (4 bytes)**: 0x00000000 specifies a computed font width. The aspect ratio of the device is matched against the digitization aspect ratio of the font to find the closest match, determined by the absolute value of the difference. + +**Escapement (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between the [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62) of a row of text and the x-axis of the device. + +**Orientation (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between each character's baseline and the x-axis of the device. + +**Weight (4 bytes)**: 0x000000C8 specifies that the [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) of the font is 200, in the range 0 through 1000, from lightest to darkest, with 400 (0x00000190) considered normal. + +**Italic (1 byte)**: 0x00 specifies that the font is not italic. + +**Underline (1 byte)**: 0x00 specifies that the font is not underlined. + +**Strikeout (1 byte)**: 0x00 specifies that the font characters do not have a strike-out graphic. + +**CharSet (1 byte)**: 0x00 specifies the **ANSI_CHARSET**, as defined in the CharacterSet enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.5). + +**OutPrecision (1 byte)**: 0x04 specifies the output precision, which is how closely the output is expected to match the requested font properties, from the OutPrecision enumeration (\[MS-WMF\] section 2.1.1.21). The value 0x04 specifies a [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) font, if there is a choice between multiple fonts with the same name. + +**ClipPrecision (1 byte)**: 0x00 specifies the clipping precision, which is how to clip characters that are partially outside the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), from the ClipPrecision flags (\[MS-WMF\] section 2.1.2.1). The value 0x00 specifies default clipping behavior. + +**Quality (1 byte)**: 0x00 specifies default output quality, from the FontQuality enumeration (\[MS-WMF\] section 2.1.1.10). + +**PitchAndFamily (1 byte)**: 0x02 specifies a variable-pitch font, and no preference for font family, from the PitchAndFamily object (\[MS-WMF\] section 2.2.2.14). + +**Facename (68 bytes)**: "Microsoft Sans Serif" specifies the [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) name of the font in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. + +[TABLE] + +**FullName (132 bytes)**: An empty string specifies the font's full name. + +**Style (68 bytes)**: An empty string describes the font's style. + +**Script (68 bytes)**: An empty string describes the font's character set. + +**Signature (4 bytes)**: 0x08007664 specifies the signature of a [DesignVector object (section 2.2.3)](#Section_cdf6681fbf454eec923e08c8be16aaf2). + +**NumAxes (4 bytes)**: 0x00000000 specifies the number of [**font axes**](#gt_5d727201-0a47-44b1-86e5-faf77f0f2463) described in the DesignVector object. + +### EMR_SELECTOBJECT Example 4 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +2296. 000034A0: 25 00 00 00 0C 00 00 00 + + 000034B0:03 00 00 00 + +[TABLE] + +**Type (4 bytes)**: Identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: Specifies the size of this record in bytes. + +**ihObject (4 bytes)**: Specifies the index of an object in the EMF object table. + +### EMR_EXTCREATEFONTINDIRECTW Example 3 + +This section provides an example of an EMR_EXTCREATEFONTINDIRECTW record (section [2.3.7.8](#Section_7e266b6d32e54201b6878ec40c24cd73)). + +2299. 000034B0: 52 00 00 00 70 01 00 00 04 00 00 00 + + 000034C0:F2 FF FF FF 00 00 00 00 4E 0C 00 00 4E 0C 00 00 + + 000034D0:C8 00 00 00 00 00 00 00 04 00 00 02 4D 00 69 00 + + 000034E0:63 00 72 00 6F 00 73 00 6F 00 66 00 74 00 20 00 + + 000034F0:53 00 61 00 6E 00 73 00 20 00 53 00 65 00 72 00 + + 00003500:69 00 66 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003510:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003520:C8 F1 13 00 00 00 00 00 10 00 90 01 00 00 00 00 + + 00003530:20 AC CF 02 00 00 00 00 10 00 00 00 06 00 00 00 + + 00003540:06 00 00 00 04 00 00 00 01 00 00 00 01 00 00 00 + + 00003550:01 00 00 00 01 00 00 00 0D 00 00 00 00 00 00 00 + + 00003560:03 00 00 00 00 08 00 00 3B 09 00 00 00 00 00 00 + + 00003570:A0 E8 07 02 00 00 00 00 03 00 00 00 FE 07 00 00 + + 00003580:90 01 00 00 4D 00 69 00 63 00 72 00 6F 00 73 00 + + 00003590:6F 00 66 00 74 00 20 00 53 00 61 00 00 00 73 00 + + 000035A0:20 00 53 00 65 00 72 00 69 00 66 00 00 00 00 00 + + 000035B0:00 00 00 00 00 00 00 00 FF FF 5A FE 00 00 00 00 + + 000035C0:40 02 5A FE FE 07 00 00 9D 04 00 00 00 00 00 00 + + 000035D0:FF FF FF FF FF FF FF FF 01 00 00 00 00 00 00 00 + + 000035E0:20 AC CF 02 00 00 00 00 00 00 07 02 00 00 00 00 + + 000035F0:10 AC CF 02 00 00 00 00 26 36 E3 76 00 00 00 00 + + 00003600:00 00 07 02 00 00 00 00 01 00 00 00 00 27 00 00 + + 00003610:00 00 00 00 00 00 00 00 20 AC CF 02 64 76 00 08 + + 00003620:00 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000052 identifies this record type as EMR_EXTCREATEFONTINDIRECTW. + +**Size (4 bytes)**: 0x00000170 specifies the size of this record in bytes. + +**ihFonts (4 bytes)**: 0x00000004 specifies the object index that is assigned to the font. + +**elw (360 bytes)**: To determine the type of logical font object in this field, an algorithm (section 2.3.7.8) is applied, which indicates this is a LogFontExDv object (section [2.2.15](#Section_595fcaaebc3741489afe859e81ca7f76)). + +[TABLE] + +**Height (4 bytes)**: 0xFFFFFFF2 has an absolute value of 14, which specifies the character height for this font in logical units. + +**Width (4 bytes)**: 0x00000000 specifies a computed font width. The aspect ratio of the device is matched against the digitization aspect ratio of the font to find the closest match, determined by the absolute value of the difference. + +**Escapement (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between the [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62) of a row of text and the x-axis of the device. + +**Orientation (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between each character's baseline and the x-axis of the device. + +**Weight (4 bytes)**: 0x000000C8 specifies that the [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) of the font is 200, in the range 0 through 1000, from lightest to darkest, with 400 (0x00000190) considered normal. + +**Italic (1 byte)**: 0x00 specifies that the font is not italic. + +**Underline (1 byte)**: 0x00 specifies that the font is not underlined. + +**Strikeout (1 byte)**: 0x00 specifies that the font characters do not have a strike-out graphic. + +**CharSet (1 byte)**: 0x00 specifies the **ANSI_CHARSET**, as defined in the CharacterSet enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.5). + +**OutPrecision (1 byte)**: 0x04 specifies the output precision, which is how closely the output is expected to match the requested font properties, from the OutPrecision enumeration (\[MS-WMF\] section 2.1.1.21). The value 0x04 specifies a [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) font, if there is a choice between multiple fonts with the same name. + +**ClipPrecision (1 byte)**: 0x00 specifies the clipping precision, which is how to clip characters that are partially outside the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), from the ClipPrecision flags (\[MS-WMF\] section 2.1.2.1). The value 0x00 specifies default clipping behavior. + +**Quality (1 byte)**: 0x00 specifies default output quality, from the FontQuality enumeration (\[MS-WMF\] section 2.1.1.10). + +**PitchAndFamily (1 byte)**: 0x02 specifies a variable-pitch font, and no preference for font family, from the PitchAndFamily object (\[MS-WMF\] section 2.2.2.14). + +**Facename (68 bytes)**: "Microsoft Sans Serif" specifies the [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) name of the font in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. + +[TABLE] + +**FullName (132 bytes)**: An empty string specifies the font's full name. + +**Style (68 bytes)**: An empty string describes the font's style. + +**Script (68 bytes)**: An empty string describes the font's character set. + +**Signature (4 bytes)**: 0x08007664 specifies the signature of a [DesignVector object (section 2.2.3)](#Section_cdf6681fbf454eec923e08c8be16aaf2). + +**NumAxes (4 bytes)**: 0x00000000 specifies the number of [**font axes**](#gt_5d727201-0a47-44b1-86e5-faf77f0f2463) described in the DesignVector object. + +### EMR_SELECTOBJECT Example 5 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +2324. 00003620: 25 00 00 00 0C 00 00 00 04 00 00 00 + +[TABLE] + +**Type (4 bytes)**: Identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: Specifies the size of this record in bytes. + +**ihObject (4 bytes)**: Specifies the index of an object in the EMF object table. + +### EMR_DELETEOBJECT Example 1 + +This section provides an example of an [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record (section 2.3.8.3). + +2326. 00003630:28 00 00 00 0C 00 00 00 03 00 00 00 + +[TABLE] + +**Type (4 bytes)**: Identifies this record type as EMR_DELETEOBJECT. + +**Size (4 bytes)**: Specifies the size of this record in bytes. + +**ihObject (4 bytes)**: Specifies the index of the object to be deleted. + +### EMR_EXTCREATEFONTINDIRECTW Example 4 + +This section provides an example of an [EMR_EXTCREATEFONTINDIRECTW](#Section_7e266b6d32e54201b6878ec40c24cd73) record (section 2.3.7.8). + +2328. 00003630: 52 00 00 00 + + 00003640:70 01 00 00 03 00 00 00 13 00 00 00 00 00 00 00 + + 00003650:4E 0C 00 00 4E 0C 00 00 C8 00 00 00 00 00 00 00 + + 00003660:04 00 00 02 4D 00 69 00 63 00 72 00 6F 00 73 00 + + 00003670:6F 00 66 00 74 00 20 00 53 00 61 00 6E 00 73 00 + + 00003680:20 00 53 00 65 00 72 00 69 00 66 00 00 00 00 00 + + 00003690:00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000036A0:00 00 00 00 00 00 73 00 20 00 53 00 65 00 72 00 + + 000036B0:69 00 66 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 000036C0:FF FF 5A FE 00 00 00 00 40 02 5A FE FE 07 00 00 + + 000036D0:9D 04 00 00 00 00 00 00 FF FF FF FF FF FF FF FF + + 000036E0:01 00 00 00 00 00 00 00 20 AC CF 02 00 00 00 00 + + 000036F0:00 00 07 02 00 00 00 00 40 02 5A FE FE 07 00 00 + + 00003700:F3 14 00 00 00 00 00 00 F3 14 0A 1E 00 00 00 00 + + 00003710:94 8A E8 FE FE 07 00 00 04 00 00 00 00 00 00 00 + + 00003720:65 58 53 FE 00 00 00 00 00 00 00 00 00 00 00 00 + + 00003730:00 F5 13 00 00 00 00 00 03 01 56 E5 89 1A 00 00 + + 00003740:55 00 00 00 00 00 00 00 00 00 00 00 04 00 00 00 + + 00003750:00 00 00 00 FE 07 00 00 79 0D 21 11 00 00 00 00 + + 00003760:40 02 5A FE 00 00 00 00 26 06 5A FE FE 07 00 00 + + 00003770:08 F5 13 00 00 00 00 00 00 F5 13 00 00 00 00 00 + + 00003780:07 CB 54 FE FE 07 00 00 79 0D 21 11 00 00 00 00 + + 00003790:04 00 00 00 00 00 00 00 24 07 5A FE FE 07 00 00 + + 000037A0:01 00 00 00 64 76 00 08 00 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000052 identifies this record type as EMR_EXTCREATEFONTINDIRECTW. + +**Size (4 bytes)**: 0x00000170 specifies the size of this record in bytes. + +**ihFonts (4 bytes)**: 0x00000003 specifies the object index that is assigned to the font. + +**elw (360 bytes)**: To determine the type of logical font object in this field, an algorithm (section 2.3.7.8) is applied, which indicates this is a [LogFontExDv object (section 2.2.15)](#Section_595fcaaebc3741489afe859e81ca7f76). + +[TABLE] + +**Height (4 bytes)**: 0x00000013 specifies the [**cell height**](#gt_b97118e3-2175-4af5-b1f9-462e57501090) for this font, in logical units. + +**Width (4 bytes)**: 0x00000000 specifies a computed font width. The [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5) of the device is matched against the digitization aspect ratio of the font to find the closest match, determined by the absolute value of the difference. + +**Escapement (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between the [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62) of a row of text and the x-axis of the device. + +**Orientation (4 bytes)**: 0x00000C4E specifies an angle of 315 degrees between each character's baseline and the x-axis of the device. + +**Weight (4 bytes)**: 0x000000C8 specifies that the [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) of the font is 200, in the range 0 through 1000, from lightest to darkest, with 400 (0x00000190) considered normal. + +**Italic (1 byte)**: 0x00 specifies that the font is not italic. + +**Underline (1 byte)**: 0x00 specifies that the font is not underlined. + +**Strikeout (1 byte)**: 0x00 specifies that the font characters do not have a strike-out graphic. + +**CharSet (1 byte)**: 0x00 specifies the **ANSI_CHARSET**, as defined in the CharacterSet enumeration ([\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section 2.1.1.5). + +**OutPrecision (1 byte)**: 0x04 specifies the output precision, which is how closely the output is expected to match the requested font properties, from the OutPrecision enumeration (\[MS-WMF\] section 2.1.1.21). The value 0x04 specifies a [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) font, if there is a choice between multiple fonts with the same name. + +**ClipPrecision (1 byte)**: 0x00 specifies the clipping precision, which is how to clip characters that are partially outside the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), from the ClipPrecision flags (\[MS-WMF\] section 2.1.2.1). The value 0x00 specifies default clipping behavior. + +**Quality (1 byte)**: 0x00 specifies default output quality, from the FontQuality enumeration (\[MS-WMF\] section 2.1.1.10). + +**PitchAndFamily (1 byte)**: 0x02 specifies a variable-pitch font, and no preference for font family, from the PitchAndFamily object (\[MS-WMF\] section 2.2.2.14). + +**Facename (68 bytes)**: "Microsoft Sans Serif" specifies the [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) name of the font in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. + +[TABLE] + +**FullName (132 bytes)**: An empty string specifies the font's full name. + +**Style (68 bytes)**: An empty string describes the font's style. + +**Script (68 bytes)**: An empty string describes the font's character set. + +**Signature (4 bytes)**: 0x08007664 specifies the signature of a [DesignVector object (section 2.2.3)](#Section_cdf6681fbf454eec923e08c8be16aaf2). + +**NumAxes (4 bytes)**: 0x00000000 specifies the number of [**font axes**](#gt_5d727201-0a47-44b1-86e5-faf77f0f2463) described in the DesignVector object. + +### EMR_SELECTOBJECT Example 6 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +2353. 000037A0: 25 00 00 00 + + 000037B0:0c 00 00 00 03 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000025 identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x00000003 specifies the index of an object in the EMF object table. + +### EMR_SELECTOBJECT Example 7 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +2356. 000037B0: 25 00 00 00 0C 00 00 00 + + 000037C0:02 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000025 identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x00000002 specifies the index of an object in the EMF object table. + +### EMR_DELETEOBJECT Example 2 + +This section provides an example of an [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record (section 2.3.8.3). + +2359. 000037C0: 28 00 00 00 0C 00 00 00 04 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000028 identifies this record type as EMR_DELETEOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x00000004 specifies the index of the object to be deleted. + +### EMR_DELETEOBJECT Example 3 + +This section provides an example of an [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record (section 2.3.8.3). + +2361. 000037D0:28 00 00 00 0C 00 00 00 03 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x00000028 identifies this record type as EMR_DELETEOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x00000003 specifies the index of the object to be deleted. + +### EMR_SELECTOBJECT Example 8 + +This section provides an example of an [EMR_SELECTOBJECT](#Section_145b063d5f9641feb7ae1e615b2bc2bf) record (section 2.3.8.5). + +2362. 000037D0: 25 00 00 00 + + 000037E0:0c 00 00 00 0D 00 00 80 + +[TABLE] + +**Type (4 bytes)**: 0x00000025 identifies this record type as EMR_SELECTOBJECT. + +**Size (4 bytes)**: 0x0000000C specifies the size of this record in bytes. + +**ihObject (4 bytes)**: 0x8000000D specifies the index of an object in the EMF object table. + +### EMR_EOF Example + +This section provides an example of an [EMR_EOF](#Section_3f47fde00e6b40c187f3f4129af03aa1) record (section 2.3.4.1). + +2364. 000037E0: 0E 00 00 00 14 00 00 00 + + 000037F0:00 00 00 00 10 00 00 00 14 00 00 00 + +[TABLE] + +**Type (4 bytes)**: 0x0000000E identifies this record type as EMR_EOF. + +**Size (4 bytes)**: 0x00000014 specifies the size of this record in bytes. + +**nPalEntries (4 bytes)**: 0x00000000 specifies the number of [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) entries. + +**offPalEntries (4 bytes)**: 0x00000010 specifies the offset to the palette entries. + +**SizeLast (4 bytes)**: 0x00000014 is the same as the **Size** value. It is the last field in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +# Security Considerations + +This file format enables third parties to send payloads (such as [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d)) to pass through as executable code. + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- Windows NT 3.1 operating system + +- Windows NT 3.5 operating system + +- Windows NT 3.51 operating system + +- Windows NT 4.0 operating system + +- Windows 98 operating system + +- Windows Millennium Edition operating system + +- Windows 2000 operating system + +- Windows XP operating system + +- Windows Server 2003 operating system + +- Windows Vista operating system + +- Windows Server 2008 operating system + +- Windows 7 operating system + +- Windows Server 2008 R2 operating system + +- Windows 8 operating system + +- Windows Server 2012 operating system + +- Windows 8.1 operating system + +- Windows Server 2012 R2 operating system + +- Windows 10 operating system + +- Windows Server 2016 operating system + +- Windows Server operating system + +- Windows Server 2019 operating system + +- Windows Server 2022 operating system + +- Windows 11 operating system + +- Windows Server 2025 operating system + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 1.3.1](#Appendix_A_Target_1): [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) have changed over the years with the evolution of Windows operating systems. They were introduced with 32-bit Windows and replaced the 16-bit [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) metafile [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) as the Windows standard. + +[\<2\> Section 1.4](#Appendix_A_Target_2): Windows applications that use the [**GDI+**](#gt_aad222f8-e733-44f2-a97c-1f903af82448) API [\[MSDN-GDI+\]](https://go.microsoft.com/fwlink/?LinkId=90013) can create EMF metafiles that contain [**EMF+**](#gt_41a5b58b-b050-4001-85ec-d6ed56379ee2) records ([\[MS-EMFPLUS\]](%5bMS-EMFPLUS%5d.pdf#Section_5f92c78964f246b59ed415a9bb0946c6) section 2.3). + +[\<3\> Section 2.1.1](#Appendix_A_Target_3): Windows NT 3.1 is the only Windows version in which [**GDI**](#gt_6c550e84-9a9c-46ef-8716-7260fe29cae3) uses [EMR_POLYTEXTOUTA](#Section_d8b7ac2176b84f9aa7cc05f9d2d5627e) records for text output. All other versions emulate EMR_POLYTEXTOUTA with [EMR_EXTTEXTOUTW](#Section_a59a79ac328e492da34de02727af6edf) records. + +[\<4\> Section 2.1.1](#Appendix_A_Target_4): Windows NT 3.1 is the only Windows version in which GDI uses EMR_POLYTEXTOUTW records for text output. All other versions emulate EMR_POLYTEXTOUTW with EMR_EXTTEXTOUTW records. + +[\<5\> Section 2.1.1](#Appendix_A_Target_5): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_SETICMMODE. + +[\<6\> Section 2.1.1](#Appendix_A_Target_6): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_CREATECOLORSPACE. + +[\<7\> Section 2.1.1](#Appendix_A_Target_7): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_SETCOLORSPACE. + +[\<8\> Section 2.1.1](#Appendix_A_Target_8): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_DELETECOLORSPACE. + +[\<9\> Section 2.1.1](#Appendix_A_Target_9): Windows uses an [EMR_DELETEOBJECT](#Section_6f0f12a3111a478b8251a9505168f9a9) record to delete a logical color space object. + +[\<10\> Section 2.1.1](#Appendix_A_Target_10): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_GLSRECORD. + +[\<11\> Section 2.1.1](#Appendix_A_Target_11): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_GLSBOUNDEDRECORD. + +[\<12\> Section 2.1.1](#Appendix_A_Target_12): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support EMR_PIXELFORMAT. + +[\<13\> Section 2.1.1](#Appendix_A_Target_13): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_COLORCORRECTPALETTE**. + +[\<14\> Section 2.1.1](#Appendix_A_Target_14): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_SETICMPROFILEA**. + +[\<15\> Section 2.1.1](#Appendix_A_Target_15): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_SETICMPROFILEW**. + +[\<16\> Section 2.1.1](#Appendix_A_Target_16): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_ALPHABLEND**. + +[\<17\> Section 2.1.1](#Appendix_A_Target_17): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_SETLAYOUT**. + +[\<18\> Section 2.1.1](#Appendix_A_Target_18): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_TRANSPARENTBLT**. + +[\<19\> Section 2.1.1](#Appendix_A_Target_19): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_GRADIENTFILL**. + +[\<20\> Section 2.1.1](#Appendix_A_Target_20): Windows GDI uses an EMR_EXTTEXTOUTW record (section 2.3.5.8) to perform this function. + +[\<21\> Section 2.1.1](#Appendix_A_Target_21): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_COLORMATCHTOTARGETW**. + +[\<22\> Section 2.1.1](#Appendix_A_Target_22): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_CREATECOLORSPACEW**. + +[\<23\> Section 2.1.11](#Appendix_A_Target_23): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: Do not support the **ETO_GLYPH_INDEX** flag used for bitmap and [**vector fonts**](#gt_4795d9b6-f3e9-4435-874e-bb6882ea1f0f)—in addition to [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) fonts—to indicate that no further language processing is necessary and that GDI processes the string directly. See \[MSDN-GDI+\] for more information. + +[\<24\> Section 2.1.11](#Appendix_A_Target_24): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: Do not support the **ETO_RTLREADING** flag used to indicate right-to-left reading order. + +[\<25\> Section 2.1.11](#Appendix_A_Target_25): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: Do not support the **ETO_NUMERICSLOCAL** flag used to indicate the display of numeric digits appropriate to the locale. + +[\<26\> Section 2.1.11](#Appendix_A_Target_26): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: Do not support the **ETO_NUMERICSLATIN** flag used to indicate the display of numeric digits appropriate to Europe. + +[\<27\> Section 2.1.11](#Appendix_A_Target_27): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: Do not support the **ETO_IGNORELANGUAGE** flag used to indicate that international scripting support is not used, which might cause no text to be output. + +[\<28\> Section 2.1.11](#Appendix_A_Target_28): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, Windows Millennium Edition, Windows NT 4.0, and Windows 2000: Do not support the **ETO_PDY** flag used to indicate that both horizontal and vertical character displacement values are provided. + +[\<29\> Section 2.1.11](#Appendix_A_Target_29): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, Windows Millennium Edition, Windows NT 4.0, and Windows 2000: Do not support the **ETO_REVERSE_INDEX_MAP** flag. + +[\<30\> Section 2.1.16](#Appendix_A_Target_30): **GM_COMPATIBLE** graphics mode is used for compatibility between 16-bit and 32-bit systems. + +[\<31\> Section 2.1.16](#Appendix_A_Target_31): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, Windows Millennium Edition, Windows NT 4.0, and Windows 2000: **GM_ADVANCED** is not supported. + +[\<32\> Section 2.1.18](#Appendix_A_Target_32): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: Do not support [**Image Color Management (ICM)**](#gt_fcd5ee55-57ff-45d6-b51e-2ccba47329e3). + +[\<33\> Section 2.1.31](#Appendix_A_Target_33): On Windows, this is the "Courier" font. + +[\<34\> Section 2.1.31](#Appendix_A_Target_34): On Windows, this is the "MS Sans Serif" font. + +[\<35\> Section 2.1.31](#Appendix_A_Target_35): On Windows, this is the "Tahoma" font and is used to draw menu text and dialog box controls. + +Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows NT 4.0, Windows 98, and Windows Millennium Edition: The system font is "MS Sans Serif". + +[\<36\> Section 2.1.31](#Appendix_A_Target_36): On Windows, this value is considered equivalent to SYSTEM_FONT for the purposes of the screen display of metafiles. + +Windows 98 and Windows Millennium Edition: This value is not supported. + +[\<37\> Section 2.1.31](#Appendix_A_Target_37): On Windows, this [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) consists of the static colors in the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe). + +[\<38\> Section 2.1.31](#Appendix_A_Target_38): On Windows, the default user interface font is "Tahoma". + +Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows NT 4.0, Windows 98, and Windows Millennium Edition: The default user interface font is "MS Sans Serif". + +[\<39\> Section 2.1.31](#Appendix_A_Target_39): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows NT 4.0, Windows 98, and Windows Millennium Edition: The default brush is undefined. + +[\<40\> Section 2.1.31](#Appendix_A_Target_40): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows NT 4.0, Windows 98, and Windows Millennium Edition: The default pen is undefined. + +[\<41\> Section 2.1.32](#Appendix_A_Target_41): Windows also uses the following symbolic names for the StretchMode enumeration; their meanings are exactly the same as the members with the same values. + +2367. \#define BLACKONWHITE 1 + + \#define WHITEONBLACK 2 + + \#define COLORONCOLOR 3 + + \#define HALFTONE 4 + +[\<42\> Section 2.2.2](#Appendix_A_Target_42): Windows 98 and Windows Millennium Edition do not support the [ColorAdjustment](#Section_71d7f4d0b6454de8a5588a2e0fc596cb) object. + +[\<43\> Section 2.2.2](#Appendix_A_Target_43): Windows can generate ColorAdjustment objects with values outside their valid ranges. Such objects are ignored. + +[\<44\> Section 2.2.5](#Appendix_A_Target_44): In Windows implementations, this is the clipping and/or opaquing rectangle that is passed to GDI methods **ExtTextOutA** and **ExtTextOutW**. + +[\<45\> Section 2.2.6](#Appendix_A_Target_45): Windows does not parse the [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) data in an [EpsData object](#Section_a624b402f7aa4cb6b289612c9775f37e); the data is handed off to the graphics [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) if the driver supports PostScript printing. + +[\<46\> Section 2.2.13](#Appendix_A_Target_46): In Windows implementations, the [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5) of the device is matched against the digitization aspect ratios of the available fonts to find the closest match, determined by the absolute value of the difference. + +[\<47\> Section 2.2.13](#Appendix_A_Target_47): Windows uses a [**weight**](#gt_fc6de273-4e8b-4f97-89d0-3dc1b4be9e8d) value of 400 by default. + +| Value | Weight | +|---------------------------|--------| +| Thin | 100 | +| Extra Light (Ultra Light) | 200 | +| Light | 300 | +| Normal (Regular) | 400 | +| Medium | 500 | +| Semi-Bold (Demi-Bold) | 600 | +| Bold | 700 | +| Extra Bold (Ultra Bold) | 800 | +| Heavy (Black) | 900 | + +[\<48\> Section 2.2.22](#Appendix_A_Target_48): Windows implementations do not support this flag. + +[\<49\> Section 2.2.22](#Appendix_A_Target_49): Windows can use this flag to indicate that the pixel format specified by this structure is supported by GDI. See \[MSDN-GDI+\] for more information. + +Windows can also use this flag to specify single-buffering for the pixel buffer. + +[\<50\> Section 2.2.22](#Appendix_A_Target_50): Windows uses this flag to indicate that the pixel pixel format is supported by GDI. + +[\<51\> Section 2.2.22](#Appendix_A_Target_51): Windows uses this with [**OpenGL**](#gt_216becb9-a800-4a44-8206-2ec2231c9c67) drawing only. + +Windows NT 3.1, Windows NT 3.51, Windows NT 4.0, Windows 98, Windows 2000, Windows Millennium Edition, Windows XP, and Windows Server 2003 do not support this flag. + +[\<52\> Section 2.2.22](#Appendix_A_Target_52): Windows does not support [**alpha**](#gt_134d5688-b046-4a5b-a74e-c0c11fc04eb3) bitplanes. + +[\<53\> Section 2.2.22](#Appendix_A_Target_53): Windows does not support alpha bitplanes. + +[\<54\> Section 2.2.22](#Appendix_A_Target_54): Windows does not support alpha bitplanes. + +[\<55\> Section 2.2.27](#Appendix_A_Target_55): In this case, Windows uses the logical font that is currently selected in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[\<56\> Section 2.3.1.1](#Appendix_A_Target_56): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_ALPHABLEND**. + +[\<57\> Section 2.3.1.3](#Appendix_A_Target_57): Windows might set this to a non-zero value. + +[\<58\> Section 2.3.1.8](#Appendix_A_Target_58): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_TRANSPARENTBLT**. + +[\<59\> Section 2.3.1.8](#Appendix_A_Target_59): Windows uses the [EMR_ALPHABLEND](#Section_34e07d4faee64b63a4bb96996ad47669) record (section 2.3.1.1) to specify a block transfer of a 32 bits-per-pixel [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) with alpha transparency. + +[\<60\> Section 2.3.3.1](#Appendix_A_Target_60): Windows NT 3.1, Windows NT 3.51, and Windows NT 4.0 ignore EMR_COMMENT records. + +[\<61\> Section 2.3.3.4.3](#Appendix_A_Target_61): On playback, the first graphics format recognized by Windows is used to render the image. + +[\<62\> Section 2.3.4.2](#Appendix_A_Target_62): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: EMF header extension 1 is not supported. + +[\<63\> Section 2.3.4.2](#Appendix_A_Target_63): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, Windows Millennium Edition, Windows NT 4.0, and Windows 2000: EMF header extension 2 is not supported. + +[\<64\> Section 2.3.5.7](#Appendix_A_Target_64): Windows GDI emulates [EMR_EXTTEXTOUTA](#Section_6b582a713c294fc6a0f41f8a313739a1) with an EMR_EXTTEXTOUTW record. + +[\<65\> Section 2.3.5.10](#Appendix_A_Target_65): The Windows playback implementation computes the bounding [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) from the sum of all the rectangles specified by the **RegionData** object in the **RgnData** field. + +[\<66\> Section 2.3.5.11](#Appendix_A_Target_66): The Windows playback implementation computes the bounding region from the sum of all the rectangles specified by **RgnData** field. + +[\<67\> Section 2.3.5.12](#Appendix_A_Target_67): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support EMR_GRADIENTFILL. + +[\<68\> Section 2.3.5.12](#Appendix_A_Target_68): Windows uses true colors in 24-bits-per-pixel (bpp) and 32-bpp formats, and [**dithering**](#gt_0540a76e-7353-4f83-a800-377d1fb00903) in 4-bpp, 8-bpp, and 16-bpp formats. + +[\<69\> Section 2.3.5.14](#Appendix_A_Target_69): The Windows playback implementation computes the bounding region from the sum of all the rectangles specified by the **RgnData** field. + +[\<70\> Section 2.3.5.32](#Appendix_A_Target_70): Windows NT 3.1 is the only Windows version in which GDI uses EMR_POLYTEXTOUTA records for text output. All other versions emulate EMR_POLYTEXTOUTA with EMR_EXTTEXTOUTW records. + +[\<71\> Section 2.3.5.33](#Appendix_A_Target_71): Windows NT 3.1 is the only Windows version in which GDI uses [EMR_POLYTEXTOUTW](#Section_381015eb29a7477493ada210697f5972) records for text output. All other versions emulate EMR_POLYTEXTOUTW with EMR_EXTTEXTOUTW records. + +[\<72\> Section 2.3.7.2](#Appendix_A_Target_72): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support **EMR_CREATECOLORSPACE**. + +[\<73\> Section 2.3.7.3](#Appendix_A_Target_73): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support **EMR_CREATECOLORSPACEW**. + +[\<74\> Section 2.3.7.8](#Appendix_A_Target_74): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 metafiles contain a LogFont object in this field. + +[\<75\> Section 2.3.7.8](#Appendix_A_Target_75): On Microsoft Windows, if the size of the **elw** field is less than the size of a **LogFontPanose** object, Windows GDI copies the data from the **elw** field into a zero-initialized **LogFontPanose** object and processes this new **LogFontPanose** object as input instead. + +[\<76\> Section 2.3.8.1](#Appendix_A_Target_76): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_COLORCORRECTPALETTE**. + +[\<77\> Section 2.3.8.2](#Appendix_A_Target_77): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support **EMR_DELETECOLORSPACE**. + +[\<78\> Section 2.3.8.4](#Appendix_A_Target_78): Windows GDI does not perform parameter validation on this value, which can lead to the generation of EMF metafiles that contain invalid EMR_RESIZEPALETTE records. Windows ignores such invalid records when processing metafiles. + +[\<79\> Section 2.3.8.7](#Appendix_A_Target_79): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support **EMR_SETCOLORSPACE**. + +[\<80\> Section 2.3.9](#Appendix_A_Target_80): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 98, and Windows Millennium Edition: OpenGL records are not supported. + +[\<81\> Section 2.3.11.1](#Appendix_A_Target_81): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_COLORMATCHTOTARGETW**. + +[\<82\> Section 2.3.11.1](#Appendix_A_Target_82): On Windows NT 4.0, Windows 2000, Windows XP, and Windows Server 2003, [**WCS**](#gt_e4f9c4a4-c195-43d0-b189-f9727ec8a2b3) is not enabled in the playback device context before applying the current color transform. + +[\<83\> Section 2.3.11.3](#Appendix_A_Target_83): The Windows playback implementation computes the bounding rectangle of the region from the sum of all the rectangles specified by the **RegionData** object. + +[\<84\> Section 2.3.11.5](#Appendix_A_Target_84): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support **EMR_PIXELFORMAT**. + +[\<85\> Section 2.3.11.14](#Appendix_A_Target_85): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 do not support **EMR_SETICMMODE**. + +[\<86\> Section 2.3.11.15](#Appendix_A_Target_86): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_SETICMPROFILEA**. + +[\<87\> Section 2.3.11.16](#Appendix_A_Target_87): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_SETICMPROFILEW**. + +[\<88\> Section 2.3.11.17](#Appendix_A_Target_88): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 do not support **EMR_SETLAYOUT**. + +[\<89\> Section 2.3.11.20](#Appendix_A_Target_89): Only Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 support **EMR_SETMAPPERFLAGS**. + +[\<90\> Section 2.3.11.21](#Appendix_A_Target_90): Windows GDI accepts a FLOAT value for the [**miter length**](#gt_7d78ab9f-9531-4993-b140-8c2bb6e82220) limit value. + +[\<91\> Section 2.3.11.27](#Appendix_A_Target_91): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows NT 4.0, Windows 98, and Windows Millennium Edition do not support the EMR_SETTEXTJUSTIFICATION record type. + +[\<92\> Section 3.1.1.2.1](#Appendix_A_Target_92): During metafile playback, before a clipping region is defined an EMF record, Windows uses a default based on the type of [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388). in the following table, the referenced functions are described in [\[MSDN-WindowsGDI\]](https://go.microsoft.com/fwlink/?LinkId=94735) unless stated otherwise. + +[TABLE] + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [5](#Section_f5148c7c30c54d95bf1bb449c1f8f53d) Appendix A: Product Behavior | Added Windows Server 2025 to the list of applicable products. | Major | + +# Index + +A + +[Applicability](#applicability-statement) 20 + +[ArcDirection enumeration](#arcdirection-enumeration) 28 + +[ArmStyle enumeration](#armstyle-enumeration) 29 + +B + +[BackgroundMode enumeration](#backgroundmode-enumeration) 29 + +[BitFIX28_4 Object](#bitfix28_4-object) 49 + +[BitFIX28_4 packet](#bitfix28_4-object) 49 + +[BitmapRecordTypes packet](#bitmap-record-types) 75 + +[Byte ordering](#byte-ordering) 19 + +[Byte ordering example](#byte-ordering-1) 217 + +C + +[Change tracking](#change-tracking) 278 + +[ClippingRecordTypes packet](#clipping-record-types) 102 + +[ColorAdjustment enumeration](#coloradjustment-enumeration) 30 + +[ColorAdjustment Object](#coloradjustment-object) 49 + +[ColorAdjustment packet](#coloradjustment-object) 49 + +[ColorMatchToTarget enumeration](#colormatchtotarget-enumeration) 30 + +[ColorSpace enumeration](#colorspace-enumeration) 30 + +[CommentRecordTypes packet](#comment-record-types) 107 + +[Common data types and fields](#structures) 21 + +[Contrast enumeration](#contrast-enumeration) 31 + +[ControlRecordTypes packet](#control-record-types) 115 + +D + +[Data types and fields - common](#structures) 21 + +[DesignVector Object](#designvector-object) 51 + +[DesignVector packet](#designvector-object) 51 + +Details + +[common data types and fields](#structures) 21 + +[DIBColors enumeration](#dibcolors-enumeration) 31 + +[Drawing Record Types](#drawing-record-types) 124 + +[DrawingRecordTypes packet](#drawing-record-types) 124 + +E + +[EMF metafile example](#emf-metafile-example) 218 + +[EMF Metafile Example example](#emf-metafile-example) 218 + +[EMF Metafile Playback example](#emf-metafile-playback) 212 + +[EmfMetafileHeader packet](#emfmetafileheader-record) 120 + +[EmfMetafileHeader Record](#emfmetafileheader-record) 120 + +[EmfMetafileHeaderExtension1 packet](#emfmetafileheaderextension1-record) 121 + +[EmfMetafileHeaderExtension1 Record](#emfmetafileheaderextension1-record) 121 + +[EmfMetafileHeaderExtension2 packet](#emfmetafileheaderextension2-record) 122 + +[EmfMetafileHeaderExtension2 Record](#emfmetafileheaderextension2-record) 122 + +[EMR_ALPHABLEND packet](#emr_alphablend-record) 77 + +[EMR_ALPHABLEND record](#emr_alphablend-record) 77 + +[EMR_ANGLEARC packet](#emr_anglearc-record) 128 + +[EMR_ANGLEARC Record](#emr_anglearc-record) 128 + +[EMR_ARC packet](#emr_arc-record) 129 + +[EMR_ARC Record](#emr_arc-record) 129 + +[EMR_ARCTO packet](#emr_arcto-record) 130 + +[EMR_ARCTO Record](#emr_arcto-record) 130 + +EMR_BITBLT example ([section 3.2.4](#emr_bitblt-example-1) 235, [section 3.2.6](#emr_bitblt-example-2) 237) + +[EMR_BITBLT packet](#emr_bitblt-record) 82 + +[EMR_BITBLT Record](#emr_bitblt-record) 82 + +[EMR_CHORD packet](#emr_chord-record) 131 + +[EMR_CHORD Record](#emr_chord-record) 131 + +[EMR_COLORCORRECTPALETTE packet](#emr_colorcorrectpalette-record) 179 + +[EMR_COLORCORRECTPALETTE record](#emr_colorcorrectpalette-record) 179 + +[EMR_COLORMATCHTOTARGETW packet](#emr_colormatchtotargetw-record) 191 + +[EMR_COLORMATCHTOTARGETW record](#emr_colormatchtotargetw-record) 191 + +[EMR_COMMENT packet](#emr_comment-record) 108 + +[EMR_COMMENT Record](#emr_comment-record) 108 + +[EMR_COMMENT_BEGINGROUP packet](#emr_comment_begingroup-record) 111 + +[EMR_COMMENT_BEGINGROUP Record](#emr_comment_begingroup-record) 111 + +[EMR_COMMENT_EMFPLUS packet](#emr_comment_emfplus-record) 109 + +[EMR_COMMENT_EMFPLUS Record](#emr_comment_emfplus-record) 109 + +[EMR_COMMENT_EMFSPOOL packet](#emr_comment_emfspool-record) 109 + +[EMR_COMMENT_EMFSPOOL Record](#emr_comment_emfspool-record) 109 + +[EMR_COMMENT_ENDGROUP packet](#emr_comment_endgroup-record) 112 + +[EMR_COMMENT_ENDGROUP Record](#emr_comment_endgroup-record) 112 + +[EMR_COMMENT_MULTIFORMATS packet](#emr_comment_multiformats-record) 113 + +[EMR_COMMENT_MULTIFORMATS Record](#emr_comment_multiformats-record) 113 + +[EMR_COMMENT_PUBLIC packet](#emr_comment_public-record-types) 110 + +[EMR_COMMENT_PUBLIC Record Types](#emr_comment_public-record-types) 110 + +[EMR_COMMENT_WINDOWS_METAFILE packet](#emr_comment_windows_metafile-record) 114 + +[EMR_COMMENT_WINDOWS_METAFILE Record](#emr_comment_windows_metafile-record) 114 + +[EMR_CREATEBRUSHINDIRECT example](#emr_createbrushindirect-example) 233 + +[EMR_CREATEBRUSHINDIRECT packet](#emr_createbrushindirect-record) 168 + +[EMR_CREATEBRUSHINDIRECT Record](#emr_createbrushindirect-record) 168 + +[EMR_CREATECOLORSPACE packet](#emr_createcolorspace-record) 169 + +[EMR_CREATECOLORSPACE record](#emr_createcolorspace-record) 169 + +[EMR_CREATECOLORSPACEW packet](#emr_createcolorspacew-record) 169 + +[EMR_CREATECOLORSPACEW record](#emr_createcolorspacew-record) 169 + +[EMR_CREATEDIBPATTERNBRUSHPT packet](#emr_createdibpatternbrushpt-record) 170 + +[EMR_CREATEDIBPATTERNBRUSHPT Record](#emr_createdibpatternbrushpt-record) 170 + +[EMR_CREATEMONOBRUSH packet](#emr_createmonobrush-record) 172 + +[EMR_CREATEMONOBRUSH Record](#emr_createmonobrush-record) 172 + +[EMR_CREATEPALETTE packet](#emr_createpalette-record) 173 + +[EMR_CREATEPALETTE Record](#emr_createpalette-record) 173 + +[EMR_CREATEPEN packet](#emr_createpen-record) 174 + +[EMR_CREATEPEN Record](#emr_createpen-record) 174 + +[EMR_DELETECOLORSPACE packet](#emr_deletecolorspace-record) 180 + +[EMR_DELETECOLORSPACE record](#emr_deletecolorspace-record) 180 + +EMR_DELETEOBJECT example ([section 3.2.15](#emr_deleteobject-example-1) 263, [section 3.2.19](#emr_deleteobject-example-2) 268, [section 3.2.20](#emr_deleteobject-example-3) 268) + +[EMR_DELETEOBJECT packet](#emr_deleteobject-record) 180 + +[EMR_DELETEOBJECT Record](#emr_deleteobject-record) 180 + +[EMR_DRAWESCAPE packet](#emr_drawescape-record) 164 + +[EMR_DRAWESCAPE Record](#emr_drawescape-record) 164 + +[EMR_ELLIPSE packet](#emr_ellipse-record) 132 + +[EMR_ELLIPSE Record](#emr_ellipse-record) 132 + +[EMR_EOF example](#emr_eof-example) 269 + +[EMR_EOF packet](#emr_eof-record) 116 + +[EMR_EOF Record](#emr_eof-record) 116 + +[EMR_EXCLUDECLIPRECT packet](#emr_excludecliprect-record) 104 + +[EMR_EXCLUDECLIPRECT Record](#emr_excludecliprect-record) 104 + +EMR_EXTCREATEFONTINDIRECTW example ([section 3.2.8](#emr_extcreatefontindirectw-example-1) 251, [section 3.2.11](#emr_extcreatefontindirectw-example-2) 256, [section 3.2.13](#emr_extcreatefontindirectw-example-3) 260, [section 3.2.16](#emr_extcreatefontindirectw-example-4) 264) + +[EMR_EXTCREATEFONTINDIRECTW packet](#emr_extcreatefontindirectw-record) 175 + +[EMR_EXTCREATEFONTINDIRECTW Record](#emr_extcreatefontindirectw-record) 175 + +[EMR_EXTCREATEPEN packet](#emr_extcreatepen-record) 176 + +[EMR_EXTCREATEPEN Record](#emr_extcreatepen-record) 176 + +[EMR_EXTESCAPE packet](#emr_extescape-record) 165 + +[EMR_EXTESCAPE Record](#emr_extescape-record) 165 + +[EMR_EXTFLOODFILL packet](#emr_extfloodfill-record) 132 + +[EMR_EXTFLOODFILL Record](#emr_extfloodfill-record) 132 + +[EMR_EXTSELECTCLIPRGN packet](#emr_extselectcliprgn-record) 105 + +[EMR_EXTSELECTCLIPRGN Record](#emr_extselectcliprgn-record) 105 + +[EMR_EXTTEXTOUTA packet](#emr_exttextouta-record) 133 + +[EMR_EXTTEXTOUTA record](#emr_exttextouta-record) 133 + +[EMR_EXTTEXTOUTW example](#emr_exttextoutw-example) 255 + +[EMR_EXTTEXTOUTW packet](#emr_exttextoutw-record) 134 + +[EMR_EXTTEXTOUTW Record](#emr_exttextoutw-record) 134 + +[EMR_FILLPATH packet](#emr_fillpath-record) 135 + +[EMR_FILLPATH Record](#emr_fillpath-record) 135 + +[EMR_FILLRGN packet](#emr_fillrgn-record) 135 + +[EMR_FILLRGN Record](#emr_fillrgn-record) 135 + +[EMR_FORCEUFIMAPPING packet](#emr_forceufimapping-record) 192 + +[EMR_FORCEUFIMAPPING Record](#emr_forceufimapping-record) 192 + +[EMR_FRAMERGN packet](#emr_framergn-record) 136 + +[EMR_FRAMERGN Record](#emr_framergn-record) 136 + +[EMR_GLSBOUNDEDRECORD packet](#emr_glsboundedrecord-record) 185 + +[EMR_GLSBOUNDEDRECORD record](#emr_glsboundedrecord-record) 185 + +[EMR_GLSRECORD packet](#emr_glsrecord-record) 185 + +[EMR_GLSRECORD record](#emr_glsrecord-record) 185 + +[EMR_GRADIENTFILL packet](#emr_gradientfill-record) 137 + +[EMR_GRADIENTFILL record](#emr_gradientfill-record) 137 + +[EMR_HEADER example](#emr_header-example) 231 + +[EMR_HEADER packet](#emr_header-record-types) 117 + +[EMR_HEADER Record Types](#emr_header-record-types) 117 + +[EMR_INTERSECTCLIPRECT packet](#emr_intersectcliprect-record) 105 + +[EMR_INTERSECTCLIPRECT Record](#emr_intersectcliprect-record) 105 + +[EMR_INVERTRGN packet](#emr_invertrgn-record) 192 + +[EMR_INVERTRGN Record](#emr_invertrgn-record) 192 + +[EMR_LINETO packet](#emr_lineto-record) 139 + +[EMR_LINETO Record](#emr_lineto-record) 139 + +[EMR_MASKBLT packet](#emr_maskblt-record) 84 + +[EMR_MASKBLT Record](#emr_maskblt-record) 84 + +[EMR_MODIFYWORLDTRANSFORM packet](#emr_modifyworldtransform-record) 210 + +[EMR_MODIFYWORLDTRANSFORM Record](#emr_modifyworldtransform-record) 210 + +[EMR_MOVETOEX packet](#emr_movetoex-record) 193 + +[EMR_MOVETOEX Record](#emr_movetoex-record) 193 + +[EMR_NAMEDESCAPE packet](#emr_namedescape-record) 165 + +[EMR_NAMEDESCAPE Record](#emr_namedescape-record) 165 + +[EMR_OFFSETCLIPRGN packet](#emr_offsetcliprgn-record) 106 + +[EMR_OFFSETCLIPRGN Record](#emr_offsetcliprgn-record) 106 + +[EMR_PAINTRGN packet](#emr_paintrgn-record) 140 + +[EMR_PAINTRGN Record](#emr_paintrgn-record) 140 + +[EMR_PIE packet](#emr_pie-record) 140 + +[EMR_PIE Record](#emr_pie-record) 140 + +[EMR_PIXELFORMAT packet](#emr_pixelformat-record) 194 + +[EMR_PIXELFORMAT record](#emr_pixelformat-record) 194 + +[EMR_PLGBLT packet](#emr_plgblt-record) 88 + +[EMR_PLGBLT Record](#emr_plgblt-record) 88 + +[EMR_POLYBEZIER packet](#emr_polybezier-record) 141 + +[EMR_POLYBEZIER Record](#emr_polybezier-record) 141 + +[EMR_POLYBEZIER16 packet](#emr_polybezier16-record) 142 + +[EMR_POLYBEZIER16 Record](#emr_polybezier16-record) 142 + +[EMR_POLYBEZIERTO packet](#emr_polybezierto-record) 143 + +[EMR_POLYBEZIERTO Record](#emr_polybezierto-record) 143 + +[EMR_POLYBEZIERTO16 packet](#emr_polybezierto16-record) 144 + +[EMR_POLYBEZIERTO16 Record](#emr_polybezierto16-record) 144 + +[EMR_POLYDRAW packet](#emr_polydraw-record) 145 + +[EMR_POLYDRAW Record](#emr_polydraw-record) 145 + +[EMR_POLYDRAW16 packet](#emr_polydraw16-record) 146 + +[EMR_POLYDRAW16 Record](#emr_polydraw16-record) 146 + +[EMR_POLYGON packet](#emr_polygon-record) 147 + +[EMR_POLYGON Record](#emr_polygon-record) 147 + +[EMR_POLYGON16 packet](#emr_polygon16-record) 148 + +[EMR_POLYGON16 Record](#emr_polygon16-record) 148 + +[EMR_POLYLINE packet](#emr_polyline-record) 149 + +[EMR_POLYLINE Record](#emr_polyline-record) 149 + +[EMR_POLYLINE16 packet](#emr_polyline16-record) 150 + +[EMR_POLYLINE16 Record](#emr_polyline16-record) 150 + +[EMR_POLYLINETO packet](#emr_polylineto-record) 150 + +[EMR_POLYLINETO Record](#emr_polylineto-record) 150 + +[EMR_POLYLINETO16 packet](#emr_polylineto16-record) 151 + +[EMR_POLYLINETO16 Record](#emr_polylineto16-record) 151 + +[EMR_POLYPOLYGON packet](#emr_polypolygon-record) 152 + +[EMR_POLYPOLYGON Record](#emr_polypolygon-record) 152 + +[EMR_POLYPOLYGON16 packet](#emr_polypolygon16-record) 153 + +[EMR_POLYPOLYGON16 Record](#emr_polypolygon16-record) 153 + +[EMR_POLYPOLYLINE packet](#emr_polypolyline-record) 154 + +[EMR_POLYPOLYLINE Record](#emr_polypolyline-record) 154 + +[EMR_POLYPOLYLINE16 packet](#emr_polypolyline16-record) 156 + +[EMR_POLYPOLYLINE16 Record](#emr_polypolyline16-record) 156 + +[EMR_POLYTEXTOUTA packet](#emr_polytextouta-record) 156 + +[EMR_POLYTEXTOUTA record](#emr_polytextouta-record) 156 + +[EMR_POLYTEXTOUTW packet](#emr_polytextoutw-record) 158 + +[EMR_POLYTEXTOUTW record](#emr_polytextoutw-record) 158 + +[EMR_RECTANGLE packet](#emr_rectangle-record) 159 + +[EMR_RECTANGLE Record](#emr_rectangle-record) 159 + +[EMR_RESIZEPALETTE packet](#emr_resizepalette-record) 181 + +[EMR_RESIZEPALETTE Record](#emr_resizepalette-record) 181 + +[EMR_RESTOREDC packet](#emr_restoredc-record) 194 + +[EMR_RESTOREDC Record](#emr_restoredc-record) 194 + +[EMR_ROUNDRECT packet](#emr_roundrect-record) 159 + +[EMR_ROUNDRECT Record](#emr_roundrect-record) 159 + +[EMR_SCALEVIEWPORTEXTEX packet](#emr_scaleviewportextex-record) 195 + +[EMR_SCALEVIEWPORTEXTEX Record](#emr_scaleviewportextex-record) 195 + +[EMR_SCALEWINDOWEXTEX packet](#emr_scalewindowextex-record) 195 + +[EMR_SCALEWINDOWEXTEX Record](#emr_scalewindowextex-record) 195 + +[EMR_SELECTCLIPPATH packet](#emr_selectclippath-record) 106 + +[EMR_SELECTCLIPPATH Record](#emr_selectclippath-record) 106 + +EMR_SELECTOBJECT example ([section 3.2.3](#emr_selectobject-example-1) 234, [section 3.2.5](#emr_selectobject-example-2) 237, [section 3.2.9](#emr_selectobject-example-3) 254, [section 3.2.12](#emr_selectobject-example-4) 259, [section 3.2.14](#emr_selectobject-example-5) 263, [section 3.2.17](#emr_selectobject-example-6) 267, [section 3.2.18](#emr_selectobject-example-7) 267, [section 3.2.21](#emr_selectobject-example-8) 268) + +[EMR_SELECTOBJECT packet](#emr_selectobject-record) 181 + +[EMR_SELECTOBJECT Record](#emr_selectobject-record) 181 + +[EMR_SELECTPALETTE packet](#emr_selectpalette-record) 182 + +[EMR_SELECTPALETTE Record](#emr_selectpalette-record) 182 + +[EMR_SETARCDIRECTION packet](#emr_setarcdirection-record) 196 + +[EMR_SETARCDIRECTION Record](#emr_setarcdirection-record) 196 + +[EMR_SETBKCOLOR packet](#emr_setbkcolor-record) 197 + +[EMR_SETBKCOLOR Record](#emr_setbkcolor-record) 197 + +[EMR_SETBKMODE example](#emr_setbkmode-example) 251 + +[EMR_SETBKMODE packet](#emr_setbkmode-record) 197 + +[EMR_SETBKMODE Record](#emr_setbkmode-record) 197 + +[EMR_SETBRUSHORGEX packet](#emr_setbrushorgex-record) 198 + +[EMR_SETBRUSHORGEX Record](#emr_setbrushorgex-record) 198 + +[EMR_SETCOLORADJUSTMENT packet](#emr_setcoloradjustment-record) 198 + +[EMR_SETCOLORADJUSTMENT Record](#emr_setcoloradjustment-record) 198 + +[EMR_SETCOLORSPACE packet](#emr_setcolorspace-record) 182 + +[EMR_SETCOLORSPACE record](#emr_setcolorspace-record) 182 + +[EMR_SETDIBITSTODEVICE packet](#emr_setdibitstodevice-record) 92 + +[EMR_SETDIBITSTODEVICE Record](#emr_setdibitstodevice-record) 92 + +[EMR_SETICMMODE packet](#emr_seticmmode-record) 199 + +[EMR_SETICMMODE record](#emr_seticmmode-record) 199 + +[EMR_SETICMPROFILEA packet](#emr_seticmprofilea-record) 199 + +[EMR_SETICMPROFILEA record](#emr_seticmprofilea-record) 199 + +[EMR_SETICMPROFILEW packet](#emr_seticmprofilew-record) 200 + +[EMR_SETICMPROFILEW record](#emr_seticmprofilew-record) 200 + +[EMR_SETLAYOUT packet](#emr_setlayout-record) 201 + +[EMR_SETLAYOUT record](#emr_setlayout-record) 201 + +[EMR_SETLINKEDUFIS packet](#emr_setlinkedufis-record) 202 + +[EMR_SETLINKEDUFIS Record](#emr_setlinkedufis-record) 202 + +[EMR_SETMAPMODE packet](#emr_setmapmode-record) 202 + +[EMR_SETMAPMODE Record](#emr_setmapmode-record) 202 + +[EMR_SETMAPPERFLAGS packet](#emr_setmapperflags-record) 203 + +[EMR_SETMAPPERFLAGS record](#emr_setmapperflags-record) 203 + +[EMR_SETMITERLIMIT packet](#emr_setmiterlimit-record) 203 + +[EMR_SETMITERLIMIT Record](#emr_setmiterlimit-record) 203 + +[EMR_SETPALETTEENTRIES packet](#emr_setpaletteentries-record) 183 + +[EMR_SETPALETTEENTRIES Record](#emr_setpaletteentries-record) 183 + +[EMR_SETPIXELV packet](#emr_setpixelv-record) 160 + +[EMR_SETPIXELV Record](#emr_setpixelv-record) 160 + +[EMR_SETPOLYFILLMODE packet](#emr_setpolyfillmode-record) 204 + +[EMR_SETPOLYFILLMODE Record](#emr_setpolyfillmode-record) 204 + +[EMR_SETROP2 packet](#emr_setrop2-record) 204 + +[EMR_SETROP2 Record](#emr_setrop2-record) 204 + +[EMR_SETSTRETCHBLTMODE packet](#emr_setstretchbltmode-record) 205 + +[EMR_SETSTRETCHBLTMODE Record](#emr_setstretchbltmode-record) 205 + +[EMR_SETTEXTALIGN packet](#emr_settextalign-record) 205 + +[EMR_SETTEXTALIGN Record](#emr_settextalign-record) 205 + +[EMR_SETTEXTCOLOR record](#emr_settextcolor-record) 206 + +[EMR_SETTEXTJUSTIFICATION packet](#emr_settextjustification-record) 206 + +[EMR_SETVIEWPORTEXTEX packet](#emr_setviewportextex-record) 207 + +[EMR_SETVIEWPORTEXTEX Record](#emr_setviewportextex-record) 207 + +[EMR_SETVIEWPORTORGEX packet](#emr_setviewportorgex-record) 207 + +[EMR_SETVIEWPORTORGEX Record](#emr_setviewportorgex-record) 207 + +[EMR_SETWINDOWEXTEX packet](#emr_setwindowextex-record) 208 + +[EMR_SETWINDOWEXTEX Record](#emr_setwindowextex-record) 208 + +[EMR_SETWINDOWORGEX packet](#emr_setwindoworgex-record) 208 + +[EMR_SETWINDOWORGEX Record](#emr_setwindoworgex-record) 208 + +[EMR_SETWORLDTRANSFORM packet](#emr_setworldtransform-record) 211 + +[EMR_SETWORLDTRANSFORM Record](#emr_setworldtransform-record) 211 + +[EMR_SMALLTEXTOUT packet](#emr_smalltextout-record) 161 + +[EMR_SMALLTEXTOUT Record](#emr_smalltextout-record) 161 + +[EMR_STRETCHBLT packet](#emr_stretchblt-record) 94 + +[EMR_STRETCHBLT Record](#emr_stretchblt-record) 94 + +[EMR_STRETCHDIBITS packet](#emr_stretchdibits-record) 97 + +[EMR_STRETCHDIBITS Record](#emr_stretchdibits-record) 97 + +[EMR_STROKEANDFILLPATH packet](#emr_strokeandfillpath-record) 162 + +[EMR_STROKEANDFILLPATH Record](#emr_strokeandfillpath-record) 162 + +[EMR_STROKEPATH packet](#emr_strokepath-record) 163 + +[EMR_STROKEPATH Record](#emr_strokepath-record) 163 + +[EMR_TRANSPARENTBLT packet](#emr_transparentblt-record) 100 + +[EMR_TRANSPARENTBLT record](#emr_transparentblt-record) 100 + +[EmrComment enumeration](#emrcomment-enumeration) 32 + +[EmrFormat Object](#emrformat-object) 51 + +[EmrFormat packet](#emrformat-object) 51 + +[EmrText Object](#emrtext-object) 52 + +[EmrText packet](#emrtext-object) 52 + +[Enumerations](#emf-enumerations) 21 + +[EpsData Object](#epsdata-object) 54 + +[EpsData packet](#epsdata-object) 54 + +[EscapeRecordTypes packet](#escape-record-types) 163 + +Examples + +[byte ordering example](#byte-ordering-1) 217 + +[EMF Metafile Example](#emf-metafile-example) 218 + +[EMF Metafile Playback](#emf-metafile-playback) 212 + +EMR_BITBLT example ([section 3.2.4](#emr_bitblt-example-1) 235, [section 3.2.6](#emr_bitblt-example-2) 237) + +[EMR_CREATEBRUSHINDIRECT example](#emr_createbrushindirect-example) 233 + +EMR_DELETEOBJECT example ([section 3.2.15](#emr_deleteobject-example-1) 263, [section 3.2.19](#emr_deleteobject-example-2) 268, [section 3.2.20](#emr_deleteobject-example-3) 268) + +[EMR_EOF example](#emr_eof-example) 269 + +EMR_EXTCREATEFONTINDIRECTW example ([section 3.2.8](#emr_extcreatefontindirectw-example-1) 251, [section 3.2.11](#emr_extcreatefontindirectw-example-2) 256, [section 3.2.13](#emr_extcreatefontindirectw-example-3) 260, [section 3.2.16](#emr_extcreatefontindirectw-example-4) 264) + +[EMR_EXTTEXTOUTW example](#emr_exttextoutw-example) 255 + +[EMR_HEADER example](#emr_header-example) 231 + +EMR_SELECTOBJECT example ([section 3.2.3](#emr_selectobject-example-1) 234, [section 3.2.5](#emr_selectobject-example-2) 237, [section 3.2.9](#emr_selectobject-example-3) 254, [section 3.2.12](#emr_selectobject-example-4) 259, [section 3.2.14](#emr_selectobject-example-5) 263, [section 3.2.17](#emr_selectobject-example-6) 267, [section 3.2.18](#emr_selectobject-example-7) 267, [section 3.2.21](#emr_selectobject-example-8) 268) + +[EMR_SETBKMODE example](#emr_setbkmode-example) 251 + +[metafile design examples](#emf-metafile-playback) 212 + +[ExtTextOutOptions enumeration](#exttextoutoptions-enumeration) 32 + +F + +[FamilyType enumeration](#familytype-enumeration) 33 + +[Fields - vendor-extensible](#vendor-extensible-fields) 20 + +[FloodFill enumeration](#floodfill-enumeration) 34 + +[FormatSignature enumeration](#formatsignature-enumeration) 34 + +G + +[Glossary](#glossary) 10 + +[GradientFill enumeration](#gradientfill-enumeration) 34 + +[GradientRectangle Object](#gradientrectangle-object) 55 + +[GradientRectangle packet](#gradientrectangle-object) 55 + +[GradientTriangle Object](#gradienttriangle-object) 55 + +[GradientTriangle packet](#gradienttriangle-object) 55 + +[GraphicsMode enumeration](#graphicsmode-enumeration) 35 + +H + +[HatchStyle enumeration](#hatchstyle-enumeration) 36 + +[Header Object](#header-object) 56 + +[Header packet](#header-object) 56 + +[HeaderExtension1 Object](#headerextension1-object) 57 + +[HeaderExtension1 packet](#headerextension1-object) 57 + +[HeaderExtension2 Object](#headerextension2-object) 58 + +[HeaderExtension2 packet](#headerextension2-object) 58 + +I + +[ICMMode enumeration](#icmmode-enumeration) 36 + +[Illuminant enumeration](#illuminant-enumeration) 36 + +[Implementer - security considerations](#security-considerations) 270 + +[Informative references](#informative-references) 17 + +[Introduction](#introduction) 10 + +L + +[Letterform enumeration](#letterform-enumeration) 37 + +[Localization](#versioning-and-localization) 20 + +[LogBrushEx Object](#logbrushex-object) 58 + +[LogBrushEx packet](#logbrushex-object) 58 + +[LogFont Object](#logfont-object) 59 + +[LogFont packet](#logfont-object) 59 + +[LogFontEx Object](#logfontex-object) 61 + +[LogFontEx packet](#logfontex-object) 61 + +[LogFontExDv Object](#logfontexdv-object) 62 + +[LogFontExDv packet](#logfontexdv-object) 62 + +[LogFontPanose Object](#logfontpanose-object) 62 + +[LogFontPanose packet](#logfontpanose-object) 62 + +[LogPalette Object](#logpalette-object) 64 + +[LogPalette packet](#logpalette-object) 64 + +[LogPaletteEntry Object](#logpaletteentry-object) 64 + +[LogPaletteEntry packet](#logpaletteentry-object) 64 + +[LogPen Object](#logpen-object) 65 + +[LogPen packet](#logpen-object) 65 + +[LogPenEx Object](#logpenex-object) 65 + +[LogPenEx packet](#logpenex-object) 65 + +M + +[MapMode enumeration](#mapmode-enumeration) 38 + +[Metafile design examples](#emf-metafile-playback) 212 + +[Metafile structure](#metafile-structure) 17 + +[MetafileVersion enumeration](#metafileversion-enumeration) 39 + +[MidLine enumeration](#midline-enumeration) 39 + +[ModifyWorldTransformMode enumeration](#modifyworldtransformmode-enumeration) 40 + +[MR_SETTEXTCOLOR packet](#emr_settextcolor-record) 206 + +N + +[Normative references](#normative-references) 16 + +O + +[ObjectCreationRecordTypes packet](#object-creation-record-types) 166 + +[ObjectManipulationRecordTypes packet](#object-manipulation-record-types) 177 + +[Objects](#emf-objects) 49 + +[OpenGLRecordTypes packet](#opengl-record-types) 184 + +[Overview (synopsis)](#overview) 17 + +P + +[Panose Object](#panose-object) 67 + +[Panose packet](#panose-object) 67 + +[Path Bracket Record Types](#path-bracket-record-types) 186 + +[PathBracketRecordTypes packet](#path-bracket-record-types) 186 + +[PenStyle enumeration](#penstyle-enumeration) 40 + +[PixelFormatDescriptor Object](#pixelformatdescriptor-object) 68 + +[PixelFormatDescriptor packet](#pixelformatdescriptor-object) 68 + +[Point enumeration](#point-enumeration) 41 + +[Point28_4 Object](#point28_4-object) 71 + +[Point28_4 packet](#point28_4-object) 71 + +[PolygonFillMode enumeration](#polygonfillmode-enumeration) 42 + +[Product behavior](#appendix-a-product-behavior) 271 + +[Proportion enumeration](#proportion-enumeration) 42 + +R + +[RecordType enumeration](#recordtype-enumeration) 21 + +[References](#references) 16 + +[informative](#informative-references) 17 + +[normative](#normative-references) 16 + +[RegionData Object](#regiondata-object) 71 + +[RegionData packet](#regiondata-object) 71 + +[RegionDataHeader Object](#regiondataheader-object) 72 + +[RegionDataHeader packet](#regiondataheader-object) 72 + +[RegionMode enumeration](#regionmode-enumeration) 43 + +[Relationship to other protocols](#relationship-to-protocols-and-other-structures) 19 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 19 + +S + +[Security](#security-considerations) 270 + +[Security - implementer considerations](#security-considerations) 270 + +[SerifType enumeration](#seriftype-enumeration) 43 + +[StateRecordTypes packet](#state-record-types) 187 + +[StockObject enumeration](#stockobject-enumeration) 44 + +[StretchMode enumeration](#stretchmode-enumeration) 47 + +[StrokeVariation enumeration](#strokevariation-enumeration) 47 + +Structures + +[Drawing Record Types](#drawing-record-types) 124 + +[enumerations](#emf-enumerations) 21 + +[objects](#emf-objects) 49 + +[overview](#structures) 21 + +[Path Bracket Record Types](#path-bracket-record-types) 186 + +T + +[Tracking changes](#change-tracking) 278 + +[TransformRecordTypes packet](#transform-record-types) 209 + +[TriVertex Object](#trivertex-object) 72 + +[TriVertex packet](#trivertex-object) 72 + +U + +[UniversalFontId Object](#universalfontid-object) 73 + +[UniversalFontId packet](#universalfontid-object) 73 + +V + +[Vendor-extensible fields](#vendor-extensible-fields) 20 + +[Versioning](#versioning-and-localization) 20 + +W + +[Weight enumeration](#weight-enumeration) 48 + +X + +[XForm Object](#xform-object) 74 + +[XForm packet](#xform-object) 74 + +[XHeight enumeration](#xheight-enumeration) 48 diff --git a/docs/standards/doc/ms-odraw.md b/docs/standards/doc/ms-odraw.md new file mode 100644 index 0000000..2b9f123 --- /dev/null +++ b/docs/standards/doc/ms-odraw.md @@ -0,0 +1,19834 @@ +**\[MS-ODRAW\]:** + +**Office Drawing Binary File Format** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 6/27/2008 | 1.0 | New | First release | +| 1/16/2009 | 1.01 | Minor | Updated the Intellectual Property Rights Notice | +| 7/13/2009 | 1.02 | Major | Revised and edited the technical content | +| 8/28/2009 | 1.03 | Editorial | Revised and edited the technical content | +| 11/6/2009 | 1.04 | Editorial | Revised and edited the technical content | +| 2/19/2010 | 2.0 | Major | Updated and revised the technical content | +| 3/31/2010 | 2.01 | Editorial | Revised and edited the technical content | +| 4/30/2010 | 2.02 | Editorial | Revised and edited the technical content | +| 6/7/2010 | 2.03 | Editorial | Revised and edited the technical content | +| 6/29/2010 | 2.04 | Editorial | Changed language and formatting in the technical content. | +| 7/23/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/27/2010 | 2.05 | Editorial | Changed language and formatting in the technical content. | +| 11/15/2010 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/17/2010 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/18/2011 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/10/2011 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/20/2012 | 3.0 | Major | Significantly changed the technical content. | +| 4/11/2012 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/16/2012 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/8/2012 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/11/2013 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/30/2013 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/18/2013 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/10/2014 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/30/2014 | 3.1 | Minor | Clarified the meaning of the technical content. | +| 7/31/2014 | 3.2 | Minor | Clarified the meaning of the technical content. | +| 10/30/2014 | 3.3 | Minor | Clarified the meaning of the technical content. | +| 3/16/2015 | 4.0 | Major | Significantly changed the technical content. | +| 9/4/2015 | 5.0 | Major | Significantly changed the technical content. | +| 7/15/2016 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/14/2016 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/17/2016 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/18/2017 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/19/2017 | 5.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/27/2018 | 6.0 | Major | Significantly changed the technical content. | +| 8/28/2018 | 7.0 | Major | Significantly changed the technical content. | +| 8/18/2020 | 7.1 | Minor | Clarified the meaning of the technical content. | +| 11/17/2020 | 8.0 | Major | Significantly changed the technical content. | +| 2/16/2021 | 8.1 | Minor | Clarified the meaning of the technical content. | +| 4/22/2021 | 9.0 | Major | Significantly changed the technical content. | +| 8/17/2021 | 10.0 | Major | Significantly changed the technical content. | +| 5/17/2022 | 10.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/20/2024 | 10.1 | Minor | Clarified the meaning of the technical content. | +| 4/16/2024 | 11.0 | Major | Significantly changed the technical content. | +| 8/20/2024 | 12.0 | Major | Significantly changed the technical content. | +| 11/12/2024 | 12.1 | Minor | Clarified the meaning of the technical content. | +| 2/18/2025 | 12.2 | Minor | Clarified the meaning of the technical content. | +| 5/20/2025 | 12.3 | Minor | Clarified the meaning of the technical content. | +| 8/19/2025 | 12.4 | Minor | Clarified the meaning of the technical content. | + +Table of Contents + +[1 Introduction [17](#introduction)](#introduction) + +[1.1 Glossary [17](#glossary)](#glossary) + +[1.2 References [21](#references)](#references) + +[1.2.1 Normative References [21](#normative-references)](#normative-references) + +[1.2.2 Informative References [22](#informative-references)](#informative-references) + +[1.3 Structure Overview (Synopsis) [22](#structure-overview-synopsis)](#structure-overview-synopsis) + +[1.3.1 Records [23](#records)](#records) + +[1.3.2 Record Headers [24](#record-headers)](#record-headers) + +[1.3.3 Containers [24](#containers)](#containers) + +[1.3.4 Properties [24](#properties)](#properties) + +[1.3.5 Bit Format [24](#bit-format)](#bit-format) + +[1.3.6 Extended Colors [24](#extended-colors)](#extended-colors) + +[1.4 Relationship to Protocols and Other Structures [25](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [25](#applicability-statement)](#applicability-statement) + +[1.6 Versioning and Localization [25](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [26](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [27](#structures)](#structures) + +[2.1 Custom OfficeArt Types [27](#custom-officeart-types)](#custom-officeart-types) + +[2.1.1 MSODGID [27](#msodgid)](#msodgid) + +[2.1.2 MSOSPID [27](#msospid)](#msospid) + +[2.1.3 FRID [27](#frid)](#frid) + +[2.1.4 MSOFO [27](#msofo)](#msofo) + +[2.2 OfficeArt Record Types [27](#officeart-record-types)](#officeart-record-types) + +[2.2.1 OfficeArtRecordHeader [27](#officeartrecordheader)](#officeartrecordheader) + +[2.2.2 OfficeArtCOLORREF [28](#officeartcolorref)](#officeartcolorref) + +[2.2.3 MSOSHADE [31](#msoshade)](#msoshade) + +[2.2.4 MSOTINT [31](#msotint)](#msotint) + +[2.2.5 MSOCOLORMODUNDEFINED [31](#msocolormodundefined)](#msocolormodundefined) + +[2.2.6 MSOTINTSHADE [31](#msotintshade)](#msotintshade) + +[2.2.7 OfficeArtFOPTE [32](#officeartfopte)](#officeartfopte) + +[2.2.8 OfficeArtFOPTEOPID [32](#officeartfopteopid)](#officeartfopteopid) + +[2.2.9 OfficeArtFOPT [34](#officeartfopt)](#officeartfopt) + +[2.2.10 OfficeArtSecondaryFOPT [41](#officeartsecondaryfopt)](#officeartsecondaryfopt) + +[2.2.11 OfficeArtTertiaryFOPT [42](#officearttertiaryfopt)](#officearttertiaryfopt) + +[2.2.12 OfficeArtDggContainer [50](#officeartdggcontainer)](#officeartdggcontainer) + +[2.2.13 OfficeArtDgContainer [51](#officeartdgcontainer)](#officeartdgcontainer) + +[2.2.14 OfficeArtSpContainer [52](#officeartspcontainer)](#officeartspcontainer) + +[2.2.15 OfficeArtInlineSpContainer [55](#officeartinlinespcontainer)](#officeartinlinespcontainer) + +[2.2.16 OfficeArtSpgrContainer [55](#officeartspgrcontainer)](#officeartspgrcontainer) + +[2.2.17 OfficeArtSpgrContainerFileBlock [56](#officeartspgrcontainerfileblock)](#officeartspgrcontainerfileblock) + +[2.2.18 OfficeArtSolverContainer [56](#officeartsolvercontainer)](#officeartsolvercontainer) + +[2.2.19 OfficeArtSolverContainerFileBlock [57](#officeartsolvercontainerfileblock)](#officeartsolvercontainerfileblock) + +[2.2.20 OfficeArtBStoreContainer [57](#officeartbstorecontainer)](#officeartbstorecontainer) + +[2.2.21 OfficeArtBStoreDelay [58](#officeartbstoredelay)](#officeartbstoredelay) + +[2.2.22 OfficeArtBStoreContainerFileBlock [58](#officeartbstorecontainerfileblock)](#officeartbstorecontainerfileblock) + +[2.2.23 OfficeArtBlip [58](#officeartblip)](#officeartblip) + +[2.2.24 OfficeArtBlipEMF [59](#officeartblipemf)](#officeartblipemf) + +[2.2.25 OfficeArtBlipWMF [60](#officeartblipwmf)](#officeartblipwmf) + +[2.2.26 OfficeArtBlipPICT [61](#officeartblippict)](#officeartblippict) + +[2.2.27 OfficeArtBlipJPEG [62](#officeartblipjpeg)](#officeartblipjpeg) + +[2.2.28 OfficeArtBlipPNG [64](#officeartblippng)](#officeartblippng) + +[2.2.29 OfficeArtBlipDIB [65](#officeartblipdib)](#officeartblipdib) + +[2.2.30 OfficeArtBlipTIFF [66](#officeartbliptiff)](#officeartbliptiff) + +[2.2.31 OfficeArtMetafileHeader [67](#officeartmetafileheader)](#officeartmetafileheader) + +[2.2.32 OfficeArtFBSE [68](#officeartfbse)](#officeartfbse) + +[2.2.33 OfficeArtFDGSL [69](#officeartfdgsl)](#officeartfdgsl) + +[2.2.34 OfficeArtFCalloutRule [70](#officeartfcalloutrule)](#officeartfcalloutrule) + +[2.2.35 OfficeArtFArcRule [71](#officeartfarcrule)](#officeartfarcrule) + +[2.2.36 OfficeArtFConnectorRule [72](#officeartfconnectorrule)](#officeartfconnectorrule) + +[2.2.37 OfficeArtFPSPL [73](#officeartfpspl)](#officeartfpspl) + +[2.2.38 OfficeArtFSPGR [73](#officeartfspgr)](#officeartfspgr) + +[2.2.39 OfficeArtChildAnchor [74](#officeartchildanchor)](#officeartchildanchor) + +[2.2.40 OfficeArtFSP [75](#officeartfsp)](#officeartfsp) + +[2.2.41 OfficeArtFRITContainer [76](#officeartfritcontainer)](#officeartfritcontainer) + +[2.2.42 OfficeArtFRIT [77](#officeartfrit)](#officeartfrit) + +[2.2.43 OfficeArtColorMRUContainer [77](#officeartcolormrucontainer)](#officeartcolormrucontainer) + +[2.2.44 MSOCR [78](#msocr)](#msocr) + +[2.2.45 OfficeArtSplitMenuColorContainer [78](#officeartsplitmenucolorcontainer)](#officeartsplitmenucolorcontainer) + +[2.2.46 OfficeArtIDCL [79](#officeartidcl)](#officeartidcl) + +[2.2.47 OfficeArtFDGG [79](#officeartfdgg)](#officeartfdgg) + +[2.2.48 OfficeArtFDGGBlock [80](#officeartfdggblock)](#officeartfdggblock) + +[2.2.49 OfficeArtFDG [81](#officeartfdg)](#officeartfdg) + +[2.2.50 MSOSHADETYPE [81](#msoshadetype)](#msoshadetype) + +[2.2.51 IMsoArray [82](#imsoarray)](#imsoarray) + +[2.2.52 IMsoInkData [83](#imsoinkdata)](#imsoinkdata) + +[2.2.53 MSOPATHINFO [83](#msopathinfo)](#msopathinfo) + +[2.2.54 MSOPATHESCAPEINFO [83](#msopathescapeinfo)](#msopathescapeinfo) + +[2.2.55 POINT [84](#point)](#point) + +[2.2.56 RECT [84](#rect)](#rect) + +[2.2.57 ADJH [85](#adjh)](#adjh) + +[2.2.58 SG [88](#sg)](#sg) + +[2.2.59 TABLEFLAGS [91](#tableflags)](#tableflags) + +[2.2.60 IHlink [91](#ihlink)](#ihlink) + +[2.2.61 MSOSHADECOLOR [92](#msoshadecolor)](#msoshadecolor) + +[2.3 Properties [92](#properties-1)](#properties-1) + +[2.3.1 OfficeArtRGFOPTE [95](#officeartrgfopte)](#officeartrgfopte) + +[2.3.2 Shape [96](#shape)](#shape) + +[2.3.2.1 hspMaster [96](#hspmaster)](#hspmaster) + +[2.3.2.2 cxstyle [96](#cxstyle)](#cxstyle) + +[2.3.2.3 bWMode [97](#bwmode)](#bwmode) + +[2.3.2.4 bWModePureBW [97](#bwmodepurebw)](#bwmodepurebw) + +[2.3.2.5 bWModeBW [98](#bwmodebw)](#bwmodebw) + +[2.3.2.6 idDiscussAnchor [98](#iddiscussanchor)](#iddiscussanchor) + +[2.3.2.7 dgmLayout [99](#dgmlayout)](#dgmlayout) + +[2.3.2.8 dgmNodeKind [99](#dgmnodekind)](#dgmnodekind) + +[2.3.2.9 dgmLayoutMRU [101](#dgmlayoutmru)](#dgmlayoutmru) + +[2.3.2.10 equationXML [102](#equationxml)](#equationxml) + +[2.3.2.11 equationXML_complex [102](#equationxml_complex)](#equationxml_complex) + +[2.3.2.12 Shape Boolean Properties [103](#shape-boolean-properties)](#shape-boolean-properties) + +[2.3.3 Callout [105](#callout)](#callout) + +[2.3.3.1 unused832 [105](#unused832)](#unused832) + +[2.3.3.2 dxyCalloutGap [105](#dxycalloutgap)](#dxycalloutgap) + +[2.3.3.3 spcoa [106](#spcoa)](#spcoa) + +[2.3.3.4 spcod [107](#spcod)](#spcod) + +[2.3.3.5 dxyCalloutDropSpecified [108](#dxycalloutdropspecified)](#dxycalloutdropspecified) + +[2.3.3.6 dxyCalloutLengthSpecified [109](#dxycalloutlengthspecified)](#dxycalloutlengthspecified) + +[2.3.3.7 Callout Boolean Properties [109](#callout-boolean-properties)](#callout-boolean-properties) + +[2.3.4 Group Shape [111](#group-shape)](#group-shape) + +[2.3.4.1 wzName [111](#wzname)](#wzname) + +[2.3.4.2 wzName_complex [112](#wzname_complex)](#wzname_complex) + +[2.3.4.3 wzDescription [112](#wzdescription)](#wzdescription) + +[2.3.4.4 wzDescription_complex [112](#wzdescription_complex)](#wzdescription_complex) + +[2.3.4.5 pihlShape [113](#pihlshape)](#pihlshape) + +[2.3.4.6 pihlShape_complex [113](#pihlshape_complex)](#pihlshape_complex) + +[2.3.4.7 pWrapPolygonVertices [114](#pwrappolygonvertices)](#pwrappolygonvertices) + +[2.3.4.8 pWrapPolygonVertices_complex [114](#pwrappolygonvertices_complex)](#pwrappolygonvertices_complex) + +[2.3.4.9 dxWrapDistLeft [114](#dxwrapdistleft)](#dxwrapdistleft) + +[2.3.4.10 dyWrapDistTop [115](#dywrapdisttop)](#dywrapdisttop) + +[2.3.4.11 dxWrapDistRight [116](#dxwrapdistright)](#dxwrapdistright) + +[2.3.4.12 dyWrapDistBottom [116](#dywrapdistbottom)](#dywrapdistbottom) + +[2.3.4.13 lidRegroup [117](#lidregroup)](#lidregroup) + +[2.3.4.14 unused906 [117](#unused906)](#unused906) + +[2.3.4.15 wzTooltip [118](#wztooltip)](#wztooltip) + +[2.3.4.16 wzTooltip_complex [118](#wztooltip_complex)](#wztooltip_complex) + +[2.3.4.17 wzScript [119](#wzscript)](#wzscript) + +[2.3.4.18 wzScript_complex [119](#wzscript_complex)](#wzscript_complex) + +[2.3.4.19 posh [119](#posh)](#posh) + +[2.3.4.20 posrelh [120](#posrelh)](#posrelh) + +[2.3.4.21 posv [132](#posv)](#posv) + +[2.3.4.22 posrelv [133](#posrelv)](#posrelv) + +[2.3.4.23 pctHR [145](#pcthr)](#pcthr) + +[2.3.4.24 alignHR [146](#alignhr)](#alignhr) + +[2.3.4.25 dxHeightHR [148](#dxheighthr)](#dxheighthr) + +[2.3.4.26 dxWidthHR [148](#dxwidthhr)](#dxwidthhr) + +[2.3.4.27 wzScriptExtAttr [149](#wzscriptextattr)](#wzscriptextattr) + +[2.3.4.28 wzScriptExtAttr_complex [149](#wzscriptextattr_complex)](#wzscriptextattr_complex) + +[2.3.4.29 scriptLang [150](#scriptlang)](#scriptlang) + +[2.3.4.30 wzScriptLangAttr [150](#wzscriptlangattr)](#wzscriptlangattr) + +[2.3.4.31 wzScriptLangAttr_complex [151](#wzscriptlangattr_complex)](#wzscriptlangattr_complex) + +[2.3.4.32 borderTopColor [151](#bordertopcolor)](#bordertopcolor) + +[2.3.4.33 borderLeftColor [152](#borderleftcolor)](#borderleftcolor) + +[2.3.4.34 borderBottomColor [152](#borderbottomcolor)](#borderbottomcolor) + +[2.3.4.35 borderRightColor [153](#borderrightcolor)](#borderrightcolor) + +[2.3.4.36 tableProperties [153](#tableproperties)](#tableproperties) + +[2.3.4.37 tableRowProperties [154](#tablerowproperties)](#tablerowproperties) + +[2.3.4.38 tableRowProperties_complex [154](#tablerowproperties_complex)](#tablerowproperties_complex) + +[2.3.4.39 wzWebBot [155](#wzwebbot)](#wzwebbot) + +[2.3.4.40 wzWebBot_complex [155](#wzwebbot_complex)](#wzwebbot_complex) + +[2.3.4.41 metroBlob [156](#metroblob)](#metroblob) + +[2.3.4.42 metroBlob_complex [156](#metroblob_complex)](#metroblob_complex) + +[2.3.4.43 dhgt [156](#dhgt)](#dhgt) + +[2.3.4.44 Group Shape Boolean Properties [157](#group-shape-boolean-properties)](#group-shape-boolean-properties) + +[2.3.5 Group Shape 2 [160](#group-shape-2)](#group-shape-2) + +[2.3.5.1 pctHoriz [160](#pcthoriz)](#pcthoriz) + +[2.3.5.2 pctVert [160](#pctvert)](#pctvert) + +[2.3.5.3 pctHorizPos [161](#pcthorizpos)](#pcthorizpos) + +[2.3.5.4 pctVertPos [162](#pctvertpos)](#pctvertpos) + +[2.3.5.5 sizerelh [162](#sizerelh)](#sizerelh) + +[2.3.5.6 sizerelv [163](#sizerelv)](#sizerelv) + +[2.3.6 Geometry [164](#geometry)](#geometry) + +[2.3.6.1 geoLeft [164](#geoleft)](#geoleft) + +[2.3.6.2 geoTop [164](#geotop)](#geotop) + +[2.3.6.3 geoRight [165](#georight)](#georight) + +[2.3.6.4 geoBottom [166](#geobottom)](#geobottom) + +[2.3.6.5 shapePath [166](#shapepath)](#shapepath) + +[2.3.6.6 pVertices [167](#pvertices)](#pvertices) + +[2.3.6.7 pVertices_complex [168](#pvertices_complex)](#pvertices_complex) + +[2.3.6.8 pSegmentInfo [168](#psegmentinfo)](#psegmentinfo) + +[2.3.6.9 pSegmentInfo_complex [169](#psegmentinfo_complex)](#psegmentinfo_complex) + +[2.3.6.10 adjustValue [169](#adjustvalue)](#adjustvalue) + +[2.3.6.11 adjust2Value [170](#adjust2value)](#adjust2value) + +[2.3.6.12 adjust3Value [170](#adjust3value)](#adjust3value) + +[2.3.6.13 adjust4Value [171](#adjust4value)](#adjust4value) + +[2.3.6.14 adjust5Value [172](#adjust5value)](#adjust5value) + +[2.3.6.15 adjust6Value [172](#adjust6value)](#adjust6value) + +[2.3.6.16 adjust7Value [173](#adjust7value)](#adjust7value) + +[2.3.6.17 adjust8Value [174](#adjust8value)](#adjust8value) + +[2.3.6.18 pConnectionSites [174](#pconnectionsites)](#pconnectionsites) + +[2.3.6.19 pConnectionSites_complex [175](#pconnectionsites_complex)](#pconnectionsites_complex) + +[2.3.6.20 pConnectionSitesDir [175](#pconnectionsitesdir)](#pconnectionsitesdir) + +[2.3.6.21 pConnectionSitesDir_complex [176](#pconnectionsitesdir_complex)](#pconnectionsitesdir_complex) + +[2.3.6.22 xLimo [176](#xlimo)](#xlimo) + +[2.3.6.23 yLimo [177](#ylimo)](#ylimo) + +[2.3.6.24 pAdjustHandles [179](#padjusthandles)](#padjusthandles) + +[2.3.6.25 pAdjustHandles_complex [180](#padjusthandles_complex)](#padjusthandles_complex) + +[2.3.6.26 pGuides [180](#pguides)](#pguides) + +[2.3.6.27 pGuides_complex [180](#pguides_complex)](#pguides_complex) + +[2.3.6.28 pInscribe [181](#pinscribe)](#pinscribe) + +[2.3.6.29 pInscribe_complex [181](#pinscribe_complex)](#pinscribe_complex) + +[2.3.6.30 cxk [182](#cxk)](#cxk) + +[2.3.6.31 Geometry Boolean Properties [183](#geometry-boolean-properties)](#geometry-boolean-properties) + +[2.3.7 Fill Style [184](#fill-style)](#fill-style) + +[2.3.7.1 fillType [184](#filltype)](#filltype) + +[2.3.7.2 fillColor [185](#fillcolor)](#fillcolor) + +[2.3.7.3 fillOpacity [186](#fillopacity)](#fillopacity) + +[2.3.7.4 fillBackColor [187](#fillbackcolor)](#fillbackcolor) + +[2.3.7.5 fillBackOpacity [187](#fillbackopacity)](#fillbackopacity) + +[2.3.7.6 fillCrMod [188](#fillcrmod)](#fillcrmod) + +[2.3.7.7 fillBlip [188](#fillblip)](#fillblip) + +[2.3.7.8 fillBlip_complex [189](#fillblip_complex)](#fillblip_complex) + +[2.3.7.9 fillBlipName [189](#fillblipname)](#fillblipname) + +[2.3.7.10 fillBlipName_complex [190](#fillblipname_complex)](#fillblipname_complex) + +[2.3.7.11 fillBlipFlags [190](#fillblipflags)](#fillblipflags) + +[2.3.7.12 fillWidth [191](#fillwidth)](#fillwidth) + +[2.3.7.13 fillHeight [191](#fillheight)](#fillheight) + +[2.3.7.14 fillAngle [192](#fillangle)](#fillangle) + +[2.3.7.15 fillFocus [193](#fillfocus)](#fillfocus) + +[2.3.7.16 fillToLeft [194](#filltoleft)](#filltoleft) + +[2.3.7.17 fillToTop [195](#filltotop)](#filltotop) + +[2.3.7.18 fillToRight [195](#filltoright)](#filltoright) + +[2.3.7.19 fillToBottom [196](#filltobottom)](#filltobottom) + +[2.3.7.20 fillRectLeft [196](#fillrectleft)](#fillrectleft) + +[2.3.7.21 fillRectTop [197](#fillrecttop)](#fillrecttop) + +[2.3.7.22 fillRectRight [198](#fillrectright)](#fillrectright) + +[2.3.7.23 fillRectBottom [198](#fillrectbottom)](#fillrectbottom) + +[2.3.7.24 fillDztype [199](#filldztype)](#filldztype) + +[2.3.7.25 fillShadePreset [199](#fillshadepreset)](#fillshadepreset) + +[2.3.7.26 fillShadeColors [200](#fillshadecolors)](#fillshadecolors) + +[2.3.7.27 fillShadeColors_complex [200](#fillshadecolors_complex)](#fillshadecolors_complex) + +[2.3.7.28 fillOriginX [201](#filloriginx)](#filloriginx) + +[2.3.7.29 fillOriginY [201](#filloriginy)](#filloriginy) + +[2.3.7.30 fillShapeOriginX [202](#fillshapeoriginx)](#fillshapeoriginx) + +[2.3.7.31 fillShapeOriginY [203](#fillshapeoriginy)](#fillshapeoriginy) + +[2.3.7.32 fillShadeType [203](#fillshadetype)](#fillshadetype) + +[2.3.7.33 fillColorExt [204](#fillcolorext)](#fillcolorext) + +[2.3.7.34 reserved415 [204](#reserved415)](#reserved415) + +[2.3.7.35 fillColorExtMod [205](#fillcolorextmod)](#fillcolorextmod) + +[2.3.7.36 reserved417 [205](#reserved417)](#reserved417) + +[2.3.7.37 fillBackColorExt [206](#fillbackcolorext)](#fillbackcolorext) + +[2.3.7.38 reserved419 [206](#reserved419)](#reserved419) + +[2.3.7.39 fillBackColorExtMod [207](#fillbackcolorextmod)](#fillbackcolorextmod) + +[2.3.7.40 reserved421 [207](#reserved421)](#reserved421) + +[2.3.7.41 reserved422 [208](#reserved422)](#reserved422) + +[2.3.7.42 reserved423 [208](#reserved423)](#reserved423) + +[2.3.7.43 Fill Style Boolean Properties [209](#fill-style-boolean-properties)](#fill-style-boolean-properties) + +[2.3.8 Line Style [210](#line-style)](#line-style) + +[2.3.8.1 lineColor [210](#linecolor)](#linecolor) + +[2.3.8.2 lineOpacity [211](#lineopacity)](#lineopacity) + +[2.3.8.3 lineBackColor [212](#linebackcolor)](#linebackcolor) + +[2.3.8.4 lineCrMod [212](#linecrmod)](#linecrmod) + +[2.3.8.5 lineType [213](#linetype)](#linetype) + +[2.3.8.6 lineFillBlip [213](#linefillblip)](#linefillblip) + +[2.3.8.7 lineFillBlip_complex [214](#linefillblip_complex)](#linefillblip_complex) + +[2.3.8.8 lineFillBlipName [214](#linefillblipname)](#linefillblipname) + +[2.3.8.9 lineFillBlipName_complex [215](#linefillblipname_complex)](#linefillblipname_complex) + +[2.3.8.10 lineFillBlipFlags [215](#linefillblipflags)](#linefillblipflags) + +[2.3.8.11 lineFillWidth [216](#linefillwidth)](#linefillwidth) + +[2.3.8.12 lineFillHeight [216](#linefillheight)](#linefillheight) + +[2.3.8.13 lineFillDztype [217](#linefilldztype)](#linefilldztype) + +[2.3.8.14 lineWidth [217](#linewidth)](#linewidth) + +[2.3.8.15 lineMiterLimit [218](#linemiterlimit)](#linemiterlimit) + +[2.3.8.16 lineStyle [219](#linestyle)](#linestyle) + +[2.3.8.17 lineDashing [220](#linedashing)](#linedashing) + +[2.3.8.18 lineDashStyle [220](#linedashstyle)](#linedashstyle) + +[2.3.8.19 lineDashStyle_complex [221](#linedashstyle_complex)](#linedashstyle_complex) + +[2.3.8.20 lineStartArrowhead [221](#linestartarrowhead)](#linestartarrowhead) + +[2.3.8.21 lineEndArrowhead [222](#lineendarrowhead)](#lineendarrowhead) + +[2.3.8.22 lineStartArrowWidth [222](#linestartarrowwidth)](#linestartarrowwidth) + +[2.3.8.23 lineStartArrowLength [223](#linestartarrowlength)](#linestartarrowlength) + +[2.3.8.24 lineEndArrowWidth [223](#lineendarrowwidth)](#lineendarrowwidth) + +[2.3.8.25 lineEndArrowLength [224](#lineendarrowlength)](#lineendarrowlength) + +[2.3.8.26 lineJoinStyle [225](#linejoinstyle)](#linejoinstyle) + +[2.3.8.27 lineEndCapStyle [225](#lineendcapstyle)](#lineendcapstyle) + +[2.3.8.28 lineColorExt [226](#linecolorext)](#linecolorext) + +[2.3.8.29 reserved474 [226](#reserved474)](#reserved474) + +[2.3.8.30 lineColorExtMod [227](#linecolorextmod)](#linecolorextmod) + +[2.3.8.31 reserved476 [227](#reserved476)](#reserved476) + +[2.3.8.32 lineBackColorExt [228](#linebackcolorext)](#linebackcolorext) + +[2.3.8.33 reserved478 [228](#reserved478)](#reserved478) + +[2.3.8.34 lineBackColorExtMod [229](#linebackcolorextmod)](#linebackcolorextmod) + +[2.3.8.35 reserved480 [229](#reserved480)](#reserved480) + +[2.3.8.36 reserved481 [230](#reserved481)](#reserved481) + +[2.3.8.37 reserved482 [230](#reserved482)](#reserved482) + +[2.3.8.38 Line Style Boolean Properties [231](#line-style-boolean-properties)](#line-style-boolean-properties) + +[2.3.9 Left Line Style [233](#left-line-style)](#left-line-style) + +[2.3.9.1 lineLeftColor [233](#lineleftcolor)](#lineleftcolor) + +[2.3.9.2 lineLeftOpacity [233](#lineleftopacity)](#lineleftopacity) + +[2.3.9.3 lineLeftBackColor [234](#lineleftbackcolor)](#lineleftbackcolor) + +[2.3.9.4 lineLeftCrMod [234](#lineleftcrmod)](#lineleftcrmod) + +[2.3.9.5 lineLeftType [235](#linelefttype)](#linelefttype) + +[2.3.9.6 lineLeftFillBlip [236](#lineleftfillblip)](#lineleftfillblip) + +[2.3.9.7 lineLeftFillBlip_complex [236](#lineleftfillblip_complex)](#lineleftfillblip_complex) + +[2.3.9.8 lineLeftFillBlipName [237](#lineleftfillblipname)](#lineleftfillblipname) + +[2.3.9.9 lineLeftFillBlipName_complex [237](#lineleftfillblipname_complex)](#lineleftfillblipname_complex) + +[2.3.9.10 lineLeftFillBlipFlags [238](#lineleftfillblipflags)](#lineleftfillblipflags) + +[2.3.9.11 lineLeftFillWidth [238](#lineleftfillwidth)](#lineleftfillwidth) + +[2.3.9.12 lineLeftFillHeight [239](#lineleftfillheight)](#lineleftfillheight) + +[2.3.9.13 lineLeftFillDztype [239](#lineleftfilldztype)](#lineleftfilldztype) + +[2.3.9.14 lineLeftWidth [240](#lineleftwidth)](#lineleftwidth) + +[2.3.9.15 lineLeftMiterLimit [241](#lineleftmiterlimit)](#lineleftmiterlimit) + +[2.3.9.16 lineLeftStyle [241](#lineleftstyle)](#lineleftstyle) + +[2.3.9.17 lineLeftDashing [242](#lineleftdashing)](#lineleftdashing) + +[2.3.9.18 lineLeftDashStyle [242](#lineleftdashstyle)](#lineleftdashstyle) + +[2.3.9.19 lineLeftDashStyle_complex [243](#lineleftdashstyle_complex)](#lineleftdashstyle_complex) + +[2.3.9.20 lineLeftStartArrowhead [243](#lineleftstartarrowhead)](#lineleftstartarrowhead) + +[2.3.9.21 lineLeftEndArrowhead [244](#lineleftendarrowhead)](#lineleftendarrowhead) + +[2.3.9.22 lineLeftStartArrowWidth [244](#lineleftstartarrowwidth)](#lineleftstartarrowwidth) + +[2.3.9.23 lineLeftStartArrowLength [245](#lineleftstartarrowlength)](#lineleftstartarrowlength) + +[2.3.9.24 lineLeftEndArrowWidth [245](#lineleftendarrowwidth)](#lineleftendarrowwidth) + +[2.3.9.25 lineLeftEndArrowLength [246](#lineleftendarrowlength)](#lineleftendarrowlength) + +[2.3.9.26 lineLeftJoinStyle [246](#lineleftjoinstyle)](#lineleftjoinstyle) + +[2.3.9.27 lineLeftEndCapStyle [247](#lineleftendcapstyle)](#lineleftendcapstyle) + +[2.3.9.28 lineLeftColorExt [248](#lineleftcolorext)](#lineleftcolorext) + +[2.3.9.29 reserved1370 [248](#reserved1370)](#reserved1370) + +[2.3.9.30 lineLeftColorExtMod [249](#lineleftcolorextmod)](#lineleftcolorextmod) + +[2.3.9.31 reserved1372 [249](#reserved1372)](#reserved1372) + +[2.3.9.32 lineLeftBackColorExt [250](#lineleftbackcolorext)](#lineleftbackcolorext) + +[2.3.9.33 reserved1374 [250](#reserved1374)](#reserved1374) + +[2.3.9.34 lineLeftBackColorExtMod [251](#lineleftbackcolorextmod)](#lineleftbackcolorextmod) + +[2.3.9.35 reserved1376 [251](#reserved1376)](#reserved1376) + +[2.3.9.36 reserved1377 [252](#reserved1377)](#reserved1377) + +[2.3.9.37 reserved1378 [252](#reserved1378)](#reserved1378) + +[2.3.9.38 Left Line Style Boolean Properties [253](#left-line-style-boolean-properties)](#left-line-style-boolean-properties) + +[2.3.10 Top Line Style [255](#top-line-style)](#top-line-style) + +[2.3.10.1 lineTopColor [255](#linetopcolor)](#linetopcolor) + +[2.3.10.2 lineTopOpacity [256](#linetopopacity)](#linetopopacity) + +[2.3.10.3 lineTopBackColor [256](#linetopbackcolor)](#linetopbackcolor) + +[2.3.10.4 lineTopCrMod [257](#linetopcrmod)](#linetopcrmod) + +[2.3.10.5 lineTopType [257](#linetoptype)](#linetoptype) + +[2.3.10.6 lineTopFillBlip [258](#linetopfillblip)](#linetopfillblip) + +[2.3.10.7 lineTopFillBlip_complex [259](#linetopfillblip_complex)](#linetopfillblip_complex) + +[2.3.10.8 lineTopFillBlipName [259](#linetopfillblipname)](#linetopfillblipname) + +[2.3.10.9 lineTopFillBlipName_complex [260](#linetopfillblipname_complex)](#linetopfillblipname_complex) + +[2.3.10.10 lineTopFillBlipFlags [260](#linetopfillblipflags)](#linetopfillblipflags) + +[2.3.10.11 lineTopFillWidth [261](#linetopfillwidth)](#linetopfillwidth) + +[2.3.10.12 lineTopFillHeight [261](#linetopfillheight)](#linetopfillheight) + +[2.3.10.13 lineTopFillDztype [262](#linetopfilldztype)](#linetopfilldztype) + +[2.3.10.14 lineTopWidth [262](#linetopwidth)](#linetopwidth) + +[2.3.10.15 lineTopMiterLimit [263](#linetopmiterlimit)](#linetopmiterlimit) + +[2.3.10.16 lineTopStyle [263](#linetopstyle)](#linetopstyle) + +[2.3.10.17 lineTopDashing [264](#linetopdashing)](#linetopdashing) + +[2.3.10.18 lineTopDashStyle [265](#linetopdashstyle)](#linetopdashstyle) + +[2.3.10.19 lineTopDashStyle_complex [265](#linetopdashstyle_complex)](#linetopdashstyle_complex) + +[2.3.10.20 lineTopStartArrowhead [266](#linetopstartarrowhead)](#linetopstartarrowhead) + +[2.3.10.21 lineTopEndArrowhead [266](#linetopendarrowhead)](#linetopendarrowhead) + +[2.3.10.22 lineTopStartArrowWidth [267](#linetopstartarrowwidth)](#linetopstartarrowwidth) + +[2.3.10.23 lineTopStartArrowLength [267](#linetopstartarrowlength)](#linetopstartarrowlength) + +[2.3.10.24 lineTopEndArrowWidth [268](#linetopendarrowwidth)](#linetopendarrowwidth) + +[2.3.10.25 lineTopEndArrowLength [268](#linetopendarrowlength)](#linetopendarrowlength) + +[2.3.10.26 lineTopJoinStyle [269](#linetopjoinstyle)](#linetopjoinstyle) + +[2.3.10.27 lineTopEndCapStyle [269](#linetopendcapstyle)](#linetopendcapstyle) + +[2.3.10.28 lineTopColorExt [270](#linetopcolorext)](#linetopcolorext) + +[2.3.10.29 reserved1434 [270](#reserved1434)](#reserved1434) + +[2.3.10.30 lineTopColorExtMod [271](#linetopcolorextmod)](#linetopcolorextmod) + +[2.3.10.31 reserved1436 [272](#reserved1436)](#reserved1436) + +[2.3.10.32 lineTopBackColorExt [272](#linetopbackcolorext)](#linetopbackcolorext) + +[2.3.10.33 reserved1438 [273](#reserved1438)](#reserved1438) + +[2.3.10.34 lineTopBackColorExtMod [273](#linetopbackcolorextmod)](#linetopbackcolorextmod) + +[2.3.10.35 reserved1440 [274](#reserved1440)](#reserved1440) + +[2.3.10.36 reserved1441 [274](#reserved1441)](#reserved1441) + +[2.3.10.37 reserved1442 [275](#reserved1442)](#reserved1442) + +[2.3.10.38 Top Line Style Boolean Properties [275](#top-line-style-boolean-properties)](#top-line-style-boolean-properties) + +[2.3.11 Right Line Style [278](#right-line-style)](#right-line-style) + +[2.3.11.1 lineRightColor [278](#linerightcolor)](#linerightcolor) + +[2.3.11.2 lineRightOpacity [278](#linerightopacity)](#linerightopacity) + +[2.3.11.3 lineRightBackColor [279](#linerightbackcolor)](#linerightbackcolor) + +[2.3.11.4 lineRightCrMod [279](#linerightcrmod)](#linerightcrmod) + +[2.3.11.5 lineRightType [280](#linerighttype)](#linerighttype) + +[2.3.11.6 lineRightFillBlip [280](#linerightfillblip)](#linerightfillblip) + +[2.3.11.7 lineRightFillBlip_complex [281](#linerightfillblip_complex)](#linerightfillblip_complex) + +[2.3.11.8 lineRightFillBlipName [282](#linerightfillblipname)](#linerightfillblipname) + +[2.3.11.9 lineRightFillBlipName_complex [282](#linerightfillblipname_complex)](#linerightfillblipname_complex) + +[2.3.11.10 lineRightFillBlipFlags [282](#linerightfillblipflags)](#linerightfillblipflags) + +[2.3.11.11 lineRightFillWidth [283](#linerightfillwidth)](#linerightfillwidth) + +[2.3.11.12 lineRightFillHeight [284](#linerightfillheight)](#linerightfillheight) + +[2.3.11.13 lineRightFillDztype [284](#linerightfilldztype)](#linerightfilldztype) + +[2.3.11.14 lineRightWidth [285](#linerightwidth)](#linerightwidth) + +[2.3.11.15 lineRightMiterLimit [285](#linerightmiterlimit)](#linerightmiterlimit) + +[2.3.11.16 lineRightStyle [286](#linerightstyle)](#linerightstyle) + +[2.3.11.17 lineRightDashing [286](#linerightdashing)](#linerightdashing) + +[2.3.11.18 lineRightDashStyle [287](#linerightdashstyle)](#linerightdashstyle) + +[2.3.11.19 lineRightDashStyle_complex [288](#linerightdashstyle_complex)](#linerightdashstyle_complex) + +[2.3.11.20 lineRightStartArrowhead [288](#linerightstartarrowhead)](#linerightstartarrowhead) + +[2.3.11.21 lineRightEndArrowhead [288](#linerightendarrowhead)](#linerightendarrowhead) + +[2.3.11.22 lineRightStartArrowWidth [289](#linerightstartarrowwidth)](#linerightstartarrowwidth) + +[2.3.11.23 lineRightStartArrowLength [290](#linerightstartarrowlength)](#linerightstartarrowlength) + +[2.3.11.24 lineRightEndArrowWidth [290](#linerightendarrowwidth)](#linerightendarrowwidth) + +[2.3.11.25 lineRightEndArrowLength [291](#linerightendarrowlength)](#linerightendarrowlength) + +[2.3.11.26 lineRightJoinStyle [291](#linerightjoinstyle)](#linerightjoinstyle) + +[2.3.11.27 lineRightEndCapStyle [292](#linerightendcapstyle)](#linerightendcapstyle) + +[2.3.11.28 lineRightColorExt [292](#linerightcolorext)](#linerightcolorext) + +[2.3.11.29 reserved1498 [293](#reserved1498)](#reserved1498) + +[2.3.11.30 lineRightColorExtMod [293](#linerightcolorextmod)](#linerightcolorextmod) + +[2.3.11.31 reserved1500 [294](#reserved1500)](#reserved1500) + +[2.3.11.32 lineRightBackColorExt [294](#linerightbackcolorext)](#linerightbackcolorext) + +[2.3.11.33 reserved1502 [295](#reserved1502)](#reserved1502) + +[2.3.11.34 lineRightBackColorExtMod [295](#linerightbackcolorextmod)](#linerightbackcolorextmod) + +[2.3.11.35 reserved1504 [296](#reserved1504)](#reserved1504) + +[2.3.11.36 reserved1505 [297](#reserved1505)](#reserved1505) + +[2.3.11.37 reserved1506 [297](#reserved1506)](#reserved1506) + +[2.3.11.38 Right Line Style Boolean Properties [298](#right-line-style-boolean-properties)](#right-line-style-boolean-properties) + +[2.3.12 Bottom Line Style [300](#bottom-line-style)](#bottom-line-style) + +[2.3.12.1 lineBottomColor [300](#linebottomcolor)](#linebottomcolor) + +[2.3.12.2 lineBottomOpacity [301](#linebottomopacity)](#linebottomopacity) + +[2.3.12.3 lineBottomBackColor [301](#linebottombackcolor)](#linebottombackcolor) + +[2.3.12.4 lineBottomCrMod [302](#linebottomcrmod)](#linebottomcrmod) + +[2.3.12.5 lineBottomType [302](#linebottomtype)](#linebottomtype) + +[2.3.12.6 lineBottomFillBlip [303](#linebottomfillblip)](#linebottomfillblip) + +[2.3.12.7 lineBottomFillBlip_complex [304](#linebottomfillblip_complex)](#linebottomfillblip_complex) + +[2.3.12.8 lineBottomFillBlipName [304](#linebottomfillblipname)](#linebottomfillblipname) + +[2.3.12.9 lineBottomFillBlipName_complex [305](#linebottomfillblipname_complex)](#linebottomfillblipname_complex) + +[2.3.12.10 lineBottomFillBlipFlags [305](#linebottomfillblipflags)](#linebottomfillblipflags) + +[2.3.12.11 lineBottomFillWidth [305](#linebottomfillwidth)](#linebottomfillwidth) + +[2.3.12.12 lineBottomFillHeight [306](#linebottomfillheight)](#linebottomfillheight) + +[2.3.12.13 lineBottomFillDztype [307](#linebottomfilldztype)](#linebottomfilldztype) + +[2.3.12.14 lineBottomWidth [307](#linebottomwidth)](#linebottomwidth) + +[2.3.12.15 lineBottomMiterLimit [308](#linebottommiterlimit)](#linebottommiterlimit) + +[2.3.12.16 lineBottomStyle [308](#linebottomstyle)](#linebottomstyle) + +[2.3.12.17 lineBottomDashing [309](#linebottomdashing)](#linebottomdashing) + +[2.3.12.18 lineBottomDashStyle [309](#linebottomdashstyle)](#linebottomdashstyle) + +[2.3.12.19 lineBottomDashStyle_complex [310](#linebottomdashstyle_complex)](#linebottomdashstyle_complex) + +[2.3.12.20 lineBottomStartArrowhead [310](#linebottomstartarrowhead)](#linebottomstartarrowhead) + +[2.3.12.21 lineBottomEndArrowhead [311](#linebottomendarrowhead)](#linebottomendarrowhead) + +[2.3.12.22 lineBottomStartArrowWidth [311](#linebottomstartarrowwidth)](#linebottomstartarrowwidth) + +[2.3.12.23 lineBottomStartArrowLength [312](#linebottomstartarrowlength)](#linebottomstartarrowlength) + +[2.3.12.24 lineBottomEndArrowWidth [313](#linebottomendarrowwidth)](#linebottomendarrowwidth) + +[2.3.12.25 lineBottomEndArrowLength [313](#linebottomendarrowlength)](#linebottomendarrowlength) + +[2.3.12.26 lineBottomJoinStyle [314](#linebottomjoinstyle)](#linebottomjoinstyle) + +[2.3.12.27 lineBottomEndCapStyle [314](#linebottomendcapstyle)](#linebottomendcapstyle) + +[2.3.12.28 lineBottomColorExt [315](#linebottomcolorext)](#linebottomcolorext) + +[2.3.12.29 reserved1562 [315](#reserved1562)](#reserved1562) + +[2.3.12.30 lineBottomColorExtMod [316](#linebottomcolorextmod)](#linebottomcolorextmod) + +[2.3.12.31 reserved1564 [316](#reserved1564)](#reserved1564) + +[2.3.12.32 lineBottomBackColorExt [317](#linebottombackcolorext)](#linebottombackcolorext) + +[2.3.12.33 reserved1566 [317](#reserved1566)](#reserved1566) + +[2.3.12.34 lineBottomBackColorExtMod [318](#linebottombackcolorextmod)](#linebottombackcolorextmod) + +[2.3.12.35 reserved1568 [318](#reserved1568)](#reserved1568) + +[2.3.12.36 reserved1569 [319](#reserved1569)](#reserved1569) + +[2.3.12.37 reserved1570 [320](#reserved1570)](#reserved1570) + +[2.3.12.38 Bottom Line Style Boolean Properties [320](#bottom-line-style-boolean-properties)](#bottom-line-style-boolean-properties) + +[2.3.13 Shadow Style [322](#shadow-style)](#shadow-style) + +[2.3.13.1 shadowType [323](#shadowtype)](#shadowtype) + +[2.3.13.2 shadowColor [323](#shadowcolor)](#shadowcolor) + +[2.3.13.3 shadowHighlight [324](#shadowhighlight)](#shadowhighlight) + +[2.3.13.4 shadowCrMod [324](#shadowcrmod)](#shadowcrmod) + +[2.3.13.5 shadowOpacity [325](#shadowopacity)](#shadowopacity) + +[2.3.13.6 shadowOffsetX [325](#shadowoffsetx)](#shadowoffsetx) + +[2.3.13.7 shadowOffsetY [326](#shadowoffsety)](#shadowoffsety) + +[2.3.13.8 shadowSecondOffsetX [326](#shadowsecondoffsetx)](#shadowsecondoffsetx) + +[2.3.13.9 shadowSecondOffsetY [327](#shadowsecondoffsety)](#shadowsecondoffsety) + +[2.3.13.10 shadowOriginX [328](#shadoworiginx)](#shadoworiginx) + +[2.3.13.11 shadowOriginY [328](#shadoworiginy)](#shadoworiginy) + +[2.3.13.12 shadowColorExt [329](#shadowcolorext)](#shadowcolorext) + +[2.3.13.13 reserved531 [329](#reserved531)](#reserved531) + +[2.3.13.14 shadowColorExtMod [330](#shadowcolorextmod)](#shadowcolorextmod) + +[2.3.13.15 reserved533 [330](#reserved533)](#reserved533) + +[2.3.13.16 shadowHighlightExt [331](#shadowhighlightext)](#shadowhighlightext) + +[2.3.13.17 reserved535 [332](#reserved535)](#reserved535) + +[2.3.13.18 shadowHighlightExtMod [332](#shadowhighlightextmod)](#shadowhighlightextmod) + +[2.3.13.19 reserved537 [333](#reserved537)](#reserved537) + +[2.3.13.20 reserved538 [333](#reserved538)](#reserved538) + +[2.3.13.21 reserved539 [334](#reserved539)](#reserved539) + +[2.3.13.22 shadowSoftness [334](#shadowsoftness)](#shadowsoftness) + +[2.3.13.23 Shadow Style Boolean Properties [335](#shadow-style-boolean-properties)](#shadow-style-boolean-properties) + +[2.3.14 Perspective Style [336](#perspective-style)](#perspective-style) + +[2.3.14.1 perspectiveType [336](#perspectivetype)](#perspectivetype) + +[2.3.14.2 perspectiveOffsetX [337](#perspectiveoffsetx)](#perspectiveoffsetx) + +[2.3.14.3 perspectiveOffsetY [337](#perspectiveoffsety)](#perspectiveoffsety) + +[2.3.14.4 perspectiveScaleXToX [338](#perspectivescalextox)](#perspectivescalextox) + +[2.3.14.5 perspectiveScaleYToX [338](#perspectivescaleytox)](#perspectivescaleytox) + +[2.3.14.6 perspectiveScaleXToY [339](#perspectivescalextoy)](#perspectivescalextoy) + +[2.3.14.7 perspectiveScaleYToY [340](#perspectivescaleytoy)](#perspectivescaleytoy) + +[2.3.14.8 perspectivePerspectiveX [340](#perspectiveperspectivex)](#perspectiveperspectivex) + +[2.3.14.9 perspectivePerspectiveY [341](#perspectiveperspectivey)](#perspectiveperspectivey) + +[2.3.14.10 perspectiveWeight [341](#perspectiveweight)](#perspectiveweight) + +[2.3.14.11 perspectiveOriginX [342](#perspectiveoriginx)](#perspectiveoriginx) + +[2.3.14.12 perspectiveOriginY [342](#perspectiveoriginy)](#perspectiveoriginy) + +[2.3.14.13 Perspective Style Boolean Properties [343](#perspective-style-boolean-properties)](#perspective-style-boolean-properties) + +[2.3.15 3D Object [344](#d-object)](#d-object) + +[2.3.15.1 c3DSpecularAmt [344](#c3dspecularamt)](#c3dspecularamt) + +[2.3.15.2 c3DDiffuseAmt [344](#c3ddiffuseamt)](#c3ddiffuseamt) + +[2.3.15.3 c3DShininess [345](#c3dshininess)](#c3dshininess) + +[2.3.15.4 c3DEdgeThickness [345](#c3dedgethickness)](#c3dedgethickness) + +[2.3.15.5 c3DExtrudeForward [346](#c3dextrudeforward)](#c3dextrudeforward) + +[2.3.15.6 c3DExtrudeBackward [346](#c3dextrudebackward)](#c3dextrudebackward) + +[2.3.15.7 reserved646 [347](#reserved646)](#reserved646) + +[2.3.15.8 c3DExtrusionColor [347](#c3dextrusioncolor)](#c3dextrusioncolor) + +[2.3.15.9 c3DCrMod [348](#c3dcrmod)](#c3dcrmod) + +[2.3.15.10 c3DExtrusionColorExt [349](#c3dextrusioncolorext)](#c3dextrusioncolorext) + +[2.3.15.11 reserved650 [349](#reserved650)](#reserved650) + +[2.3.15.12 c3DExtrusionColorExtMod [350](#c3dextrusioncolorextmod)](#c3dextrusioncolorextmod) + +[2.3.15.13 reserved652 [350](#reserved652)](#reserved652) + +[2.3.15.14 reserved653 [351](#reserved653)](#reserved653) + +[2.3.15.15 3D-Object Boolean Properties [351](#d-object-boolean-properties)](#d-object-boolean-properties) + +[2.3.16 3D Style [352](#d-style)](#d-style) + +[2.3.16.1 c3DYRotationAngle [353](#c3dyrotationangle)](#c3dyrotationangle) + +[2.3.16.2 c3DXRotationAngle [353](#c3dxrotationangle)](#c3dxrotationangle) + +[2.3.16.3 c3DRotationAxisX [354](#c3drotationaxisx)](#c3drotationaxisx) + +[2.3.16.4 c3DRotationAxisY [355](#c3drotationaxisy)](#c3drotationaxisy) + +[2.3.16.5 c3DRotationAxisZ [355](#c3drotationaxisz)](#c3drotationaxisz) + +[2.3.16.6 c3DRotationAngle [356](#c3drotationangle)](#c3drotationangle) + +[2.3.16.7 c3DRotationCenterX [356](#c3drotationcenterx)](#c3drotationcenterx) + +[2.3.16.8 c3DRotationCenterY [357](#c3drotationcentery)](#c3drotationcentery) + +[2.3.16.9 c3DRotationCenterZ [357](#c3drotationcenterz)](#c3drotationcenterz) + +[2.3.16.10 c3DRenderMode [358](#c3drendermode)](#c3drendermode) + +[2.3.16.11 c3DTolerance [359](#c3dtolerance)](#c3dtolerance) + +[2.3.16.12 c3DXViewpoint [359](#c3dxviewpoint)](#c3dxviewpoint) + +[2.3.16.13 c3DYViewpoint [360](#c3dyviewpoint)](#c3dyviewpoint) + +[2.3.16.14 c3DZViewpoint [360](#c3dzviewpoint)](#c3dzviewpoint) + +[2.3.16.15 c3DOriginX [361](#c3doriginx)](#c3doriginx) + +[2.3.16.16 c3DOriginY [361](#c3doriginy)](#c3doriginy) + +[2.3.16.17 c3DSkewAngle [362](#c3dskewangle)](#c3dskewangle) + +[2.3.16.18 c3DSkewAmount [363](#c3dskewamount)](#c3dskewamount) + +[2.3.16.19 c3DAmbientIntensity [363](#c3dambientintensity)](#c3dambientintensity) + +[2.3.16.20 c3DKeyX [364](#c3dkeyx)](#c3dkeyx) + +[2.3.16.21 c3DKeyY [364](#c3dkeyy)](#c3dkeyy) + +[2.3.16.22 c3DKeyZ [365](#c3dkeyz)](#c3dkeyz) + +[2.3.16.23 c3DKeyIntensity [365](#c3dkeyintensity)](#c3dkeyintensity) + +[2.3.16.24 c3DFillX [366](#c3dfillx)](#c3dfillx) + +[2.3.16.25 c3DFillY [366](#c3dfilly)](#c3dfilly) + +[2.3.16.26 c3DFillZ [367](#c3dfillz)](#c3dfillz) + +[2.3.16.27 c3DFillIntensity [368](#c3dfillintensity)](#c3dfillintensity) + +[2.3.16.28 3D-Style Boolean Properties [368](#d-style-boolean-properties)](#d-style-boolean-properties) + +[2.3.17 Diagram [370](#diagram)](#diagram) + +[2.3.17.1 dgmt [370](#dgmt)](#dgmt) + +[2.3.17.2 dgmStyle [370](#dgmstyle)](#dgmstyle) + +[2.3.17.3 pRelationTbl [385](#prelationtbl)](#prelationtbl) + +[2.3.17.4 pRelationTbl_complex [385](#prelationtbl_complex)](#prelationtbl_complex) + +[2.3.17.5 dgmScaleX [385](#dgmscalex)](#dgmscalex) + +[2.3.17.6 dgmScaleY [386](#dgmscaley)](#dgmscaley) + +[2.3.17.7 dgmDefaultFontSize [387](#dgmdefaultfontsize)](#dgmdefaultfontsize) + +[2.3.17.8 dgmConstrainBounds [387](#dgmconstrainbounds)](#dgmconstrainbounds) + +[2.3.17.9 dgmConstrainBounds_complex [388](#dgmconstrainbounds_complex)](#dgmconstrainbounds_complex) + +[2.3.17.10 dgmBaseTextScale [388](#dgmbasetextscale)](#dgmbasetextscale) + +[2.3.17.11 Diagram Boolean Properties [389](#diagram-boolean-properties)](#diagram-boolean-properties) + +[2.3.18 Transform [390](#transform)](#transform) + +[2.3.18.1 left [390](#left)](#left) + +[2.3.18.2 top [390](#top)](#top) + +[2.3.18.3 right [391](#right)](#right) + +[2.3.18.4 bottom [391](#bottom)](#bottom) + +[2.3.18.5 rotation [392](#rotation)](#rotation) + +[2.3.18.6 gvPage [392](#gvpage)](#gvpage) + +[2.3.18.7 Transform Boolean Properties [393](#transform-boolean-properties)](#transform-boolean-properties) + +[2.3.19 Relative Transform [394](#relative-transform)](#relative-transform) + +[2.3.19.1 relLeft [394](#relleft)](#relleft) + +[2.3.19.2 relTop [394](#reltop)](#reltop) + +[2.3.19.3 relRight [395](#relright)](#relright) + +[2.3.19.4 relBottom [396](#relbottom)](#relbottom) + +[2.3.19.5 relRotation [396](#relrotation)](#relrotation) + +[2.3.19.6 gvRelPage [397](#gvrelpage)](#gvrelpage) + +[2.3.19.7 Relative Transform Boolean Properties [397](#relative-transform-boolean-properties)](#relative-transform-boolean-properties) + +[2.3.20 Protection [398](#protection)](#protection) + +[2.3.20.1 Protection Boolean Properties [398](#protection-boolean-properties)](#protection-boolean-properties) + +[2.3.21 Text [400](#text)](#text) + +[2.3.21.1 lTxid [400](#ltxid)](#ltxid) + +[2.3.21.2 dxTextLeft [401](#dxtextleft)](#dxtextleft) + +[2.3.21.3 dyTextTop [401](#dytexttop)](#dytexttop) + +[2.3.21.4 dxTextRight [402](#dxtextright)](#dxtextright) + +[2.3.21.5 dyTextBottom [402](#dytextbottom)](#dytextbottom) + +[2.3.21.6 WrapText [403](#wraptext)](#wraptext) + +[2.3.21.7 unused134 [403](#unused134)](#unused134) + +[2.3.21.8 anchorText [404](#anchortext)](#anchortext) + +[2.3.21.9 txflTextFlow [404](#txfltextflow)](#txfltextflow) + +[2.3.21.10 cdirFont [405](#cdirfont)](#cdirfont) + +[2.3.21.11 hspNext [405](#hspnext)](#hspnext) + +[2.3.21.12 txdir [406](#txdir)](#txdir) + +[2.3.21.13 unused140 [407](#unused140)](#unused140) + +[2.3.21.14 unused141 [407](#unused141)](#unused141) + +[2.3.21.15 Text Boolean Properties [408](#text-boolean-properties)](#text-boolean-properties) + +[2.3.22 Geometry Text [409](#geometry-text)](#geometry-text) + +[2.3.22.1 gtextUNICODE [409](#gtextunicode)](#gtextunicode) + +[2.3.22.2 gtextUNICODE_complex [409](#gtextunicode_complex)](#gtextunicode_complex) + +[2.3.22.3 gtextAlign [410](#gtextalign)](#gtextalign) + +[2.3.22.4 gtextSize [411](#gtextsize)](#gtextsize) + +[2.3.22.5 gtextSpacing [412](#gtextspacing)](#gtextspacing) + +[2.3.22.6 gtextFont [413](#gtextfont)](#gtextfont) + +[2.3.22.7 gtextFont_complex [413](#gtextfont_complex)](#gtextfont_complex) + +[2.3.22.8 gtextCSSFont [413](#gtextcssfont)](#gtextcssfont) + +[2.3.22.9 gtextCSSFont_complex [414](#gtextcssfont_complex)](#gtextcssfont_complex) + +[2.3.22.10 Geometry Text Boolean Properties [414](#geometry-text-boolean-properties)](#geometry-text-boolean-properties) + +[2.3.23 Blip [418](#blip)](#blip) + +[2.3.23.1 cropFromTop [419](#cropfromtop)](#cropfromtop) + +[2.3.23.2 cropFromBottom [419](#cropfrombottom)](#cropfrombottom) + +[2.3.23.3 cropFromLeft [420](#cropfromleft)](#cropfromleft) + +[2.3.23.4 cropFromRight [420](#cropfromright)](#cropfromright) + +[2.3.23.5 pib [421](#pib)](#pib) + +[2.3.23.6 pib_complex [422](#pib_complex)](#pib_complex) + +[2.3.23.7 pibName [422](#pibname)](#pibname) + +[2.3.23.8 pibName_complex [423](#pibname_complex)](#pibname_complex) + +[2.3.23.9 pibFlags [423](#pibflags)](#pibflags) + +[2.3.23.10 pictureTransparent [423](#picturetransparent)](#picturetransparent) + +[2.3.23.11 pictureContrast [424](#picturecontrast)](#picturecontrast) + +[2.3.23.12 pictureBrightness [424](#picturebrightness)](#picturebrightness) + +[2.3.23.13 pictureId [425](#pictureid)](#pictureid) + +[2.3.23.14 pictureDblCrMod [426](#picturedblcrmod)](#picturedblcrmod) + +[2.3.23.15 pictureFillCrMod [426](#picturefillcrmod)](#picturefillcrmod) + +[2.3.23.16 pictureLineCrMod [427](#picturelinecrmod)](#picturelinecrmod) + +[2.3.23.17 pibPrint [427](#pibprint)](#pibprint) + +[2.3.23.18 pibPrint_complex [428](#pibprint_complex)](#pibprint_complex) + +[2.3.23.19 pibPrintName [428](#pibprintname)](#pibprintname) + +[2.3.23.20 pibPrintName_complex [429](#pibprintname_complex)](#pibprintname_complex) + +[2.3.23.21 pibPrintFlags [429](#pibprintflags)](#pibprintflags) + +[2.3.23.22 movie [430](#movie)](#movie) + +[2.3.23.23 movie_complex [430](#movie_complex)](#movie_complex) + +[2.3.23.24 pictureTransparentExt [431](#picturetransparentext)](#picturetransparentext) + +[2.3.23.25 reserved278 [431](#reserved278)](#reserved278) + +[2.3.23.26 pictureTransparentExtMod [432](#picturetransparentextmod)](#picturetransparentextmod) + +[2.3.23.27 reserved280 [432](#reserved280)](#reserved280) + +[2.3.23.28 reserved281 [433](#reserved281)](#reserved281) + +[2.3.23.29 pictureRecolor [433](#picturerecolor)](#picturerecolor) + +[2.3.23.30 pictureRecolorExt [434](#picturerecolorext)](#picturerecolorext) + +[2.3.23.31 reserved284 [434](#reserved284)](#reserved284) + +[2.3.23.32 pictureRecolorExtMod [435](#picturerecolorextmod)](#picturerecolorextmod) + +[2.3.23.33 reserved286 [435](#reserved286)](#reserved286) + +[2.3.23.34 reserved287 [436](#reserved287)](#reserved287) + +[2.3.23.35 Blip Boolean Properties [437](#blip-boolean-properties)](#blip-boolean-properties) + +[2.3.24 Unknown HTML [438](#unknown-html)](#unknown-html) + +[2.3.24.1 wzLineId [438](#wzlineid)](#wzlineid) + +[2.3.24.2 wzLineId_complex [439](#wzlineid_complex)](#wzlineid_complex) + +[2.3.24.3 wzFillId [439](#wzfillid)](#wzfillid) + +[2.3.24.4 wzFillId_complex [440](#wzfillid_complex)](#wzfillid_complex) + +[2.3.24.5 wzPictureId [440](#wzpictureid)](#wzpictureid) + +[2.3.24.6 wzPictureId_complex [440](#wzpictureid_complex)](#wzpictureid_complex) + +[2.3.24.7 wzPathId [441](#wzpathid)](#wzpathid) + +[2.3.24.8 wzPathId_complex [441](#wzpathid_complex)](#wzpathid_complex) + +[2.3.24.9 wzShadowId [442](#wzshadowid)](#wzshadowid) + +[2.3.24.10 wzShadowId_complex [442](#wzshadowid_complex)](#wzshadowid_complex) + +[2.3.24.11 wzPerspectiveId [442](#wzperspectiveid)](#wzperspectiveid) + +[2.3.24.12 wzPerspectiveId_complex [443](#wzperspectiveid_complex)](#wzperspectiveid_complex) + +[2.3.24.13 wzGtextId [443](#wzgtextid)](#wzgtextid) + +[2.3.24.14 wzGtextId_complex [444](#wzgtextid_complex)](#wzgtextid_complex) + +[2.3.24.15 wzFormulaeId [444](#wzformulaeid)](#wzformulaeid) + +[2.3.24.16 wzFormulaeId_complex [445](#wzformulaeid_complex)](#wzformulaeid_complex) + +[2.3.24.17 wzHandlesId [445](#wzhandlesid)](#wzhandlesid) + +[2.3.24.18 wzHandlesId_complex [446](#wzhandlesid_complex)](#wzhandlesid_complex) + +[2.3.24.19 wzCalloutId [446](#wzcalloutid)](#wzcalloutid) + +[2.3.24.20 wzCalloutId_complex [447](#wzcalloutid_complex)](#wzcalloutid_complex) + +[2.3.24.21 wzLockId [447](#wzlockid)](#wzlockid) + +[2.3.24.22 wzLockId_complex [447](#wzlockid_complex)](#wzlockid_complex) + +[2.3.24.23 wzTextId [448](#wztextid)](#wztextid) + +[2.3.24.24 wzTextId_complex [448](#wztextid_complex)](#wztextid_complex) + +[2.3.24.25 wzThreeDId [449](#wzthreedid)](#wzthreedid) + +[2.3.24.26 wzThreeDId_complex [449](#wzthreedid_complex)](#wzthreedid_complex) + +[2.3.24.27 Unknown HTML Boolean Properties [450](#unknown-html-boolean-properties)](#unknown-html-boolean-properties) + +[2.3.25 Web Component [450](#web-component)](#web-component) + +[2.3.25.1 webComponentWzHtml [451](#webcomponentwzhtml)](#webcomponentwzhtml) + +[2.3.25.2 webComponentWzHtml_complex [451](#webcomponentwzhtml_complex)](#webcomponentwzhtml_complex) + +[2.3.25.3 webComponentWzName [451](#webcomponentwzname)](#webcomponentwzname) + +[2.3.25.4 webComponentWzName_complex [452](#webcomponentwzname_complex)](#webcomponentwzname_complex) + +[2.3.25.5 webComponentWzUrl [452](#webcomponentwzurl)](#webcomponentwzurl) + +[2.3.25.6 webComponentWzUrl_complex [453](#webcomponentwzurl_complex)](#webcomponentwzurl_complex) + +[2.3.25.7 Web Component Boolean Properties [453](#web-component-boolean-properties)](#web-component-boolean-properties) + +[2.3.26 Ink [454](#ink)](#ink) + +[2.3.26.1 pInkData [454](#pinkdata)](#pinkdata) + +[2.3.26.2 pInkData_complex [455](#pinkdata_complex)](#pinkdata_complex) + +[2.3.26.3 Ink Boolean Properties [455](#ink-boolean-properties)](#ink-boolean-properties) + +[2.3.27 Signature Line [456](#signature-line)](#signature-line) + +[2.3.27.1 wzSigSetupId [456](#wzsigsetupid)](#wzsigsetupid) + +[2.3.27.2 wzSigSetupId_complex [457](#wzsigsetupid_complex)](#wzsigsetupid_complex) + +[2.3.27.3 wzSigSetupProvId [457](#wzsigsetupprovid)](#wzsigsetupprovid) + +[2.3.27.4 wzSigSetupProvId_complex [458](#wzsigsetupprovid_complex)](#wzsigsetupprovid_complex) + +[2.3.27.5 wzSigSetupSuggSigner [458](#wzsigsetupsuggsigner)](#wzsigsetupsuggsigner) + +[2.3.27.6 wzSigSetupSuggSigner_complex [459](#wzsigsetupsuggsigner_complex)](#wzsigsetupsuggsigner_complex) + +[2.3.27.7 wzSigSetupSuggSigner2 [459](#wzsigsetupsuggsigner2)](#wzsigsetupsuggsigner2) + +[2.3.27.8 wzSigSetupSuggSigner2_complex [460](#wzsigsetupsuggsigner2_complex)](#wzsigsetupsuggsigner2_complex) + +[2.3.27.9 wzSigSetupSuggSignerEmail [460](#wzsigsetupsuggsigneremail)](#wzsigsetupsuggsigneremail) + +[2.3.27.10 wzSigSetupSuggSignerEmail_complex [461](#wzsigsetupsuggsigneremail_complex)](#wzsigsetupsuggsigneremail_complex) + +[2.3.27.11 wzSigSetupSignInst [461](#wzsigsetupsigninst)](#wzsigsetupsigninst) + +[2.3.27.12 wzSigSetupSignInst_complex [461](#wzsigsetupsigninst_complex)](#wzsigsetupsigninst_complex) + +[2.3.27.13 wzSigSetupAddlXml [462](#wzsigsetupaddlxml)](#wzsigsetupaddlxml) + +[2.3.27.14 wzSigSetupAddlXml_complex [462](#wzsigsetupaddlxml_complex)](#wzsigsetupaddlxml_complex) + +[2.3.27.15 wzSigSetupProvUrl [463](#wzsigsetupprovurl)](#wzsigsetupprovurl) + +[2.3.27.16 wzSigSetupProvUrl_complex [463](#wzsigsetupprovurl_complex)](#wzsigsetupprovurl_complex) + +[2.3.27.17 Signature Line Boolean Properties [464](#signature-line-boolean-properties)](#signature-line-boolean-properties) + +[2.4 Enumerations [465](#enumerations)](#enumerations) + +[2.4.1 MSOBLIPTYPE [465](#msobliptype)](#msobliptype) + +[2.4.2 MSODGCID [465](#msodgcid)](#msodgcid) + +[2.4.3 MSOWRAPMODE [487](#msowrapmode)](#msowrapmode) + +[2.4.4 MSOANCHOR [487](#msoanchor)](#msoanchor) + +[2.4.5 MSOTXFL [490](#msotxfl)](#msotxfl) + +[2.4.6 MSOCDIR [491](#msocdir)](#msocdir) + +[2.4.7 MSOTXDIR [491](#msotxdir)](#msotxdir) + +[2.4.8 MSOBLIPFLAGS [492](#msoblipflags)](#msoblipflags) + +[2.4.9 MSOSHAPEPATH [492](#msoshapepath)](#msoshapepath) + +[2.4.10 MSOCXK [492](#msocxk)](#msocxk) + +[2.4.11 MSOFILLTYPE [493](#msofilltype)](#msofilltype) + +[2.4.12 MSODZTYPE [495](#msodztype)](#msodztype) + +[2.4.13 MSOLINETYPE [496](#msolinetype)](#msolinetype) + +[2.4.14 MSOLINESTYLE [496](#msolinestyle)](#msolinestyle) + +[2.4.15 MSOLINEDASHING [497](#msolinedashing)](#msolinedashing) + +[2.4.16 MSOLINEEND [498](#msolineend)](#msolineend) + +[2.4.17 MSOLINEENDWIDTH [498](#msolineendwidth)](#msolineendwidth) + +[2.4.18 MSOLINEENDLENGTH [499](#msolineendlength)](#msolineendlength) + +[2.4.19 MSOLINEJOIN [499](#msolinejoin)](#msolinejoin) + +[2.4.20 MSOLINECAP [500](#msolinecap)](#msolinecap) + +[2.4.21 MSOSHADOWTYPE [500](#msoshadowtype)](#msoshadowtype) + +[2.4.22 MSOXFORMTYPE [502](#msoxformtype)](#msoxformtype) + +[2.4.23 MSO3DRENDERMODE [502](#mso3drendermode)](#mso3drendermode) + +[2.4.24 MSOSPT [502](#msospt)](#msospt) + +[2.4.25 MSOCXSTYLE [535](#msocxstyle)](#msocxstyle) + +[2.4.26 MSOBWMODE [536](#msobwmode)](#msobwmode) + +[2.4.27 MSODGMT [536](#msodgmt)](#msodgmt) + +[2.4.28 MSODGSLK [538](#msodgslk)](#msodgslk) + +[2.4.29 MSODGMLO [538](#msodgmlo)](#msodgmlo) + +[2.4.30 MSOPATHTYPE [540](#msopathtype)](#msopathtype) + +[2.4.31 MSOPATHESCAPE [541](#msopathescape)](#msopathescape) + +[2.5 Algorithms [543](#algorithms)](#algorithms) + +[2.5.1 Data for VtHyperlink [543](#data-for-vthyperlink)](#data-for-vthyperlink) + +[3 Structure Examples [544](#structure-examples)](#structure-examples) + +[3.1 Diagram [544](#diagram-1)](#diagram-1) + +[3.1.1 DrawingContainer [545](#drawingcontainer)](#drawingcontainer) + +[3.1.2 OfficeArtFDG [545](#officeartfdg-1)](#officeartfdg-1) + +[3.1.3 OfficeArtSpgrContainer [546](#officeartspgrcontainer-1)](#officeartspgrcontainer-1) + +[3.1.4 OfficeArtSpContainer [578](#officeartspcontainer-1)](#officeartspcontainer-1) + +[3.1.5 OfficeArtSolverContainer [580](#officeartsolvercontainer-1)](#officeartsolvercontainer-1) + +[3.2 Shape Properties [581](#shape-properties)](#shape-properties) + +[3.2.1 Shape Type Properties [582](#shape-type-properties)](#shape-type-properties) + +[3.2.2 Shape Primary Options [583](#shape-primary-options)](#shape-primary-options) + +[3.2.3 Shape Text Properties [588](#shape-text-properties)](#shape-text-properties) + +[4 Security Considerations [591](#security-considerations)](#security-considerations) + +[5 Appendix A: Product Behavior [592](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [599](#change-tracking)](#change-tracking) + +[7 Index [600](#index)](#index) + +# Introduction + +This document specifies the Office Drawing Binary File Format Structure, which enables the use of graphical elements in certain applications. + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **absolute space**: An area of a drawing that occupies an entire document or page. The value for absolute space is typically expressed in [**English Metric Units (EMUs)**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), but it can be defined by the host application. +> +> **Active Server Pages (ASP)**: A server-side scripting engine that was developed by Microsoft and is designed to dynamically generate a webpage. +> +> **adjust handle**: A user interface control that is located on an object frame and is used to increase or decrease the size of that object. +> +> **anchor**: A set of qualifiers and quantifiers that specifies the location of an element or object within a document. These values are typically relative to another element or known location in the document, such as the edge of a page or margin. +> +> **atom**: A unit of information that cannot be divided into smaller parts, and is accepted or rejected in its entirety. See also Atom Publishing Protocol (AtomPub). +> +> **background shape**: A graphical drawing object that is covered or obstructed by other shapes in the foreground. +> +> **binary large image or picture (BLIP)**: A binary data structure that stores information about a metafile image or bitmap picture. +> +> **bounding rectangle**: A frame that encompasses an object. A bounding rectangle is not rotated and, therefore, always aligns along the x and y axes. +> +> **callout**: A set of characters that describes or emphasizes an element of a drawing or image and is connected to that drawing or image by a line. +> +> **child**: An object that is immediately below the current object in a hierarchy. +> +> **CMYK**: A color space used for commercial printing and most color computer printers. In theory, cyan, magenta, and yellow (CMY) can print all colors, but inks are not pure and black comes out muddy. The black (K) ink is required for quality black-and-white printing. +> +> **color scheme**: A table of color values that enables colors to be referenced by an index value in the table instead of a color value. See also color palette. +> +> **comment**: An annotation that is associated with a cell, text, or other object to provide context-specific information or reviewer feedback. +> +> **connection point**: A point on a shape where another drawing object can be connected. +> +> **connection site**: A location on a shape where a connector is attached. +> +> **connector**: A line that is used to connect two or more shapes and that remains connected to those shapes. +> +> **content management system**: A system that manages the collaboration, creation, modification, archiving, restoration, and removal of objects from a formal repository on behalf of a web server. +> +> **crop**: In graphics editing, the process of trimming the vertical or horizontal edges of a specified object. +> +> **device-independent bitmap (DIB)**: A file format that was designed to help ensure that bitmap graphics that were created by using one application can be loaded and displayed in another application exactly as they appeared in the originating application. +> +> **diagram**: A drawing that is used to present relationships between abstract ideas and data, such as an organizational chart or a Venn diagram. +> +> **dialog sheet**: A single logical container that is used to create a custom dialog box. +> +> **digital signature**: A message authenticator that is typically derived from a cryptographic operation by using an asymmetric algorithm and private key. When a symmetric algorithm is used for this purpose, the authenticator is typically referred to as a Message Authentication Code (MAC). +> +> **drawing**: A collection of drawing objects, such as shapes, curves, or WordArt, that are viewed together as a single image. +> +> **drawing group**: A collection of images that are designated by the user as a single group of images and manipulated as a single [**drawing object**](#gt_51dfe494-9c84-4a0e-9d53-06068c5ce3ac). +> +> **drawing object**: A shape, curve, line, WordArt, or other type of graphical object that can be inserted into a document. +> +> **drawing plane**: A geometric plane in a three-dimensional space. +> +> **drawing space**: An area of the [**absolute space**](#gt_7684e2eb-af09-40e0-89ff-5eb118a210b5) that is being drawn, after all of the rotation and scaling is complete. For example, a shadow is typically drawn relative to a shape, and is therefore in the drawing space of that shape. The value for drawing space is expressed in [**English Metric Units (EMUs)**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). See also [**absolute space**](#gt_7684e2eb-af09-40e0-89ff-5eb118a210b5). +> +> **edit points**: A set of movable points in a shape, line, or curve that define the path of that geometry. +> +> **English Metric Unit (EMU)**: A measurement in computer typography. There are 635 EMUs per twip, 6,350 EMUs per half-point, 12,700 EMUs per point, and 914,400 EMUs per inch. These units are used to translate on-screen layouts to printed layouts for specified printer hardware. +> +> **enhanced metafile format (EMF)**: A file format that supports the device-independent definitions of images. +> +> **gamma correction**: In digital imaging, the process of changing the brightness, contrast, or color balance of an image by assigning new values (different colors) to gray or color tones. +> +> **geometry space**: An arbitrarily defined coordinate system for shape geometry. Any coordinate references to a shape use this coordinate system. All connection sites, [**adjust handles**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), and vertices of a shape are defined in geometry space. +> +> **geometry text**: A type of text that follows the geometry of the shape, rather than being contained within the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shape. +> +> **gradient vector**: A vector that indicates the direction of a gradient fill. The gradient vector is perpendicular to the bands of color. +> +> **group**: A process of combining similar elements into a set in accordance with logical criteria. It is frequently used to combine sets of data from Online Analytical Processing (OLAP) databases or PivotTable reports. +> +> **group shape**: A shape that contains a group of shapes. +> +> **horizontal rule**: A line that is printed above or below an element to set off that item from the remainder of the page or to improve the appearance of the page. +> +> **hyperlink**: A relationship between two [**anchors**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997), as described in [\[RFC1866\]](https://go.microsoft.com/fwlink/?LinkId=90296). +> +> **Hypertext Markup Language (HTML)**: An application of the Standard Generalized Markup Language (SGML) that uses tags to mark elements in a document, as described in [\[HTML\]](https://go.microsoft.com/fwlink/?LinkId=89880). +> +> **ink**: A process of entering text in handwritten form. Instead of converting handwritten text to typed text, ink is converted to an object and displayed exactly as it was written. +> +> **ink shape**: A shape that contains strokes of ink. +> +> **inside margin**: A side or top margin of a document on which the document is bound. +> +> **internal resource tag**: A number associated with an internal resource. +> +> **join style**: A style that specifies how the ends of connected lines are joined. +> +> **Joint Photographic Experts Group (JPEG)**: A raster graphics file format for displaying high-resolution color graphics. JPEG graphics apply a user-specified compression scheme that can significantly reduce the file sizes of photo-realistic color graphics. A higher level of compression results in lower quality, whereas a lower level of compression results in higher quality. JPEG-format files have a .jpg or .jpeg file name extension. +> +> **labeling policy**: A policy that supports the addition of labels to a list item. +> +> **line end decoration**: An arrowhead, square, circle, or other small shape that is attached to the end of a line in a drawing. +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **Macintosh PICT**: An abbreviated term for Macintosh Picture format, a graphics file format that is associated with Macintosh applications. +> +> **master**: A slide view, page, or shape that defines the formatting for all slides, pages, or shapes in a presentation. Each presentation has a master for each key component: slides, title slides, speaker notes, and audience handouts. +> +> **master shape**: A shape definition that specifies the default properties for all instances of that shape within a document. +> +> **master unit**: A unit of linear measurement that is equal to 1/576 inch. +> +> **Object Linking and Embedding (OLE)**: A technology for transferring and sharing information between applications by inserting a file or part of a file into a compound document. The inserted file can be either embedded or linked. See also embedded object and linked object. +> +> **OLE object**: An object that supports the [**Object Linking and Embedding (OLE)**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) protocol. +> +> **outside margin**: A side or top margin of a document that is opposite the side where the document is bound. +> +> **page element**: Any basic element that exists on a page, such as the page itself, the margin, the text block, or an individual character. +> +> **perspective transform**: A transform that is applied to an image or diagram so that it shows the same objects from a different point of view. +> +> **picture bullet**: A list bullet that displays a picture instead of a standard character bullet. +> +> **placeholder**: A character or symbol that is used in place of an actual value, text, or object. The actual value that the placeholder represents is unknown or unavailable at the current time, or is not displayed for security reasons. +> +> **point**: A unit of measurement for fonts and spacing. A point is equal to 1/72 of an inch. +> +> **Portable Network Graphics (PNG)**: A bitmap graphics file format that uses lossless data compression and supports variable transparency of images (alpha channels) and control of image brightness on different computers (gamma correction). PNG-format files have a .png file name extension. +> +> **red-green-blue (RGB)**: A color model that describes color information in terms of the red (R), green (G), and blue (B) intensities in a color. +> +> **regroup identifier**: A unique index that is used to determine which shapes were previously grouped together. +> +> **right-to-left**: A reading and display order that is optimized for right-to-left languages. +> +> **rule**: A condition or action, or a set of conditions or actions, that performs tasks automatically based on events and values. +> +> **scheme color**: One of the colors that is defined in a set of specified colors for a document. If an object is filled with a scheme color, its color changes when another color scheme is selected for that document. +> +> **script anchor**: The visual representation of a script on a webpage that is open in a Microsoft Office application. Different script anchors are used to represent scripts that are written in different scripting languages. By default, script anchors are not displayed. +> +> **shape**: A collection of qualifiers, such as names, and quantifiers, such as coordinates, that is used to represent a geometric object. A shape can be contained in a document, file structure, run-time structure, or other medium. +> +> **sigma transfer function**: A mathematical process which improves the signal-to-noise ratio of a data series. +> +> **signature line**: A location in a document where a visible digital signature can be inserted. +> +> **slide**: A frame that contains text, shapes, pictures, or other content. A slide is a digital equivalent to a traditional film slide. +> +> **Tagged Image File Format (TIFF)**: A high-resolution, tag-based graphics format. TIFF is used for the universal interchange of digital graphics. +> +> **text run**: A string of characters that represents a discrete span of text with the same formatting properties. +> +> **toolbar control identifier (TCID)**: An integer that identifies a specific control on a toolbar. +> +> **tooltip**: A window displaying text that is created when the mouse is moved over a window or notification icon. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **Uniform Resource Locator (URL)**: A string of characters in a standardized format that identifies a document or resource on the World Wide Web. The format is as specified in [\[RFC1738\]](https://go.microsoft.com/fwlink/?LinkId=90287). +> +> **UTF-8**: A byte-oriented standard for encoding Unicode characters, defined in the Unicode standard. Unless specified otherwise, this term refers to the UTF-8 encoding form specified in \[UNICODE5.0.0/2007\] section 3.9. +> +> **Vector Markup Language (VML)**: A system of marking up or tagging two-dimensional vector graphics for publication on the World Wide Web. VML graphics are scalable and editable, and typically require less disk space and less time to download. +> +> **web component**: Any component, such as a bitmap, image, Java applet, or ActiveX control, that can be inserted into a webpage. +> +> **Windows metafile format (WMF)**: A file format used by Windows that supports the definition of images, including a format for clip art in word-processing documents. +> +> **wrap polygon**: A shape that is built from a pattern of points and segments, and delineates an area that is associated with a graphic. A wrap polygon enables a word processing or other type of application to break lines of text automatically to stay outside of the boundaries set by the polygon, or to display text behind or in front of the polygon. +> +> **XML**: The Extensible Markup Language, as described in [\[XML1.0\]](https://go.microsoft.com/fwlink/?LinkId=90599). +> +> **YCCK**: A variant of the \[YCbCr color space\] containing an additional K channel (black), which is required for quality black-and-white printing. +> +> **z-order**: The rendering order of an object on a z axis. +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[CSS-LEVEL2\] Bos, B., Celik, T., Hickson, I., and Lie, H., "Cascading Style Sheets Level 2 Revision 1 (CSS2.1) Specification: W3C Candidate Recommendation", July 2007, [http://www.w3.org/TR/2007/CR-CSS21-20070719/](https://go.microsoft.com/fwlink/?LinkId=114090) + +\[ISO/IEC29500-2:2012\] ISO/IEC, "Information technology -- Document description and processing languages -- Office Open XML File Formats -- Part 2: Open Packaging Conventions", ISO/IEC 29500-2:2012, [http://www.iso.org/iso/home/store/catalogue_ics/catalogue_detail_ics.htm?csnumber=61796](https://go.microsoft.com/fwlink/?LinkID=330448) + +\[ISO/IEC29500-4:2011\] ISO/IEC, "Information technology -- Document description and processing languages -- Office Open XML File Formats -- Part 4: Transitional Migration Features", ISO/IEC 29500-4:2011, 2011, [http://www.iso.org/iso/home/store/catalogue_ics/catalogue_detail_ics.htm?csnumber=59578](https://go.microsoft.com/fwlink/?LinkId=330293) + +\[ISO/IEC29500-4:2012\] ISO/IEC, "Information technology -- Document description and processing languages -- Office Open XML File Formats -- Part 4: Transitional Migration Features", ISO/IEC 29500-4:2012, [http://www.iso.org/iso/home/store/catalogue_ics/catalogue_detail_ics.htm?csnumber=61798](https://go.microsoft.com/fwlink/?LinkID=330450) + +\[MC-ISF\] Microsoft Corporation, "Ink Serialized Format (ISF) Specification", 2007, [http://download.microsoft.com/download/0/B/E/0BE8BDD7-E5E8-422A-ABFD-4342ED7AD886/InkSerializedFormat(ISF)Specification.pdf](https://go.microsoft.com/fwlink/?LinkId=114456) + +\[MS-DOC\] Microsoft Corporation, "[Word (.doc) Binary File Format](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22)". + +\[MS-OSHARED\] Microsoft Corporation, "[Office Common Data Types and Objects Structures](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d)". + +\[MS-PPT\] Microsoft Corporation, "[PowerPoint (.ppt) Binary File Format](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662)". + +\[MS-XLS\] Microsoft Corporation, "[Excel Binary File Format (.xls) Structure](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06)". + +\[RFC1320\] Rivest, R., "The MD4 Message-Digest Algorithm", RFC 1320, April 1992, [https://www.rfc-editor.org/info/rfc1320](https://go.microsoft.com/fwlink/?LinkId=90274) + +\[RFC1950\] Deutsch, P., and Gailly, J-L., "ZLIB Compressed Data Format Specification version 3.3", RFC 1950, May 1996, [http://www.ietf.org/rfc/rfc1950.txt](https://go.microsoft.com/fwlink/?LinkId=90301) + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +### Informative References + +\[MS-OGRAPH\] Microsoft Corporation, "[Office Graph Binary File Format](%5bMS-OGRAPH%5d.pdf#Section_b12c26e854314b8d8904ba55716e492d)". + +\[MSDN-GetSysColor\] Microsoft Corporation, "GetSysColor Function", [http://msdn.microsoft.com/en-us/library/ms724371(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=120479) + +## Structure Overview (Synopsis) + +Certain applications use the Office Drawing Binary File Format Structure to represent [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) elements and their associated formatting. Typically, these elements are represented as [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that are contained within drawings or [**diagrams**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4), but the elements can also include form controls and tables. This file format is also known as OfficeArt. + +The host application stores the OfficeArt data as a series of records, many of which contain additional records. The host application, which determines where to store the OfficeArt data, can also define and store additional records—to provide the details that are needed to position the drawing elements in the host document or to render any associated text. To allow the OfficeArt records to be parsed without detailed knowledge of each record type, each record has a common header that contains the record type and additional data. + +OfficeArt uses an object container hierarchy, which is illustrated by the following figure. + +![Object container hierarchy](media/image1.bin "Object container hierarchy") + +Figure 1: Object container hierarchy + +At the root of the hierarchy is a [**drawing group**](#gt_329c715f-dc26-4866-a759-0d622aa92e92) object. Each client document has one drawing group. A drawing group contains drawings. A drawing contains shapes, which are the objects that populate a page. Adjacent to the drawings in a drawing group is a collection that contains the [**binary large images or pictures (BLIPs)**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that are used by the drawings. OfficeArt stores pictures in a separate collection so that they can be incrementally loaded and saved and so that the duplication of picture data will be reduced. + +Associated with each shape is a piece of client data that stores the [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997), text, and [**Object Linking and Embedding (OLE)**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) data of the shape as well as host-specific properties. The host application specifies the format of this structure. A separate structure, called a property table, stores the properties of the shape. A property table consists of a list of identifier-value pairs, where each identifier represents a property. + +Each drawing group has a shape property table that stores the defaults for new shapes. + +Each drawing has a collection of [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) that govern the shapes in the drawing. + +Note that drawings are not saved inside drawing groups but in separate, top-level containers. This scheme enables host applications to save drawing group information with per-document information and to save drawing information with per-sheet, per-[**slide**](#gt_dd8a2def-ebde-4fc7-b420-6e837b2059cc), or per-page information. + +The remainder of this section describes the Office Drawing Binary File Format Structure in more detail. + +### Records + +The OfficeArt file stream consists of a series of records that share a common header structure. Records can be categorized into two groups: [**atoms**](#gt_e0c68b3f-d976-411b-a247-7cef57e73728) and containers. + +An atom is a record that contains information about an OfficeArt object and is kept inside a container. + +A container is a record that contains atoms and other containers in a logical and organized way. + +Each record, whether atom or container, has a common header. A container consists of just the common header, whereas an atom consists of the common header followed by record-specific data. + +A group of records that each end in the word *FileBlock* indicates an abstract form of concrete records that might be in a collection. The containing record stores an array of *FileBlock* records that each represent an instance of a different record type, as determined by a field within the record header of the *FileBlock* record. + +### Record Headers + +All records share a common header that describes the record data. This header contains the record type, the record length, and if the record is an atom, a version identifier. Although every record type has an instance property, not every record type uses this field. When used, the instance property specifies either the number of objects in the container record or a specific identifier that is used by the record. + +Because the header specifies the record length, it is possible to parse an OfficeArt record stream without knowledge of the actual contents of each record. It is expected that parsers of the Office Drawing Binary File Format Structure will skip over record types that are unknown to the reader. In addition, parsers need to expect that records can come in any order in a container. On the other hand, parsers can expect that the container hierarchy will not change. For example, it is unnecessary to consider a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) record that contains a [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) record. + +When the data is written to a client file, the host application stores client-specific records in the OfficeArt stream to preserve the client features and behaviors. For more information, see section [1.4](#Section_c64ed4fe247644cf908acc0812b3bca6). + +### Containers + +A container consists of a record header, which is followed by the contained records. A container needs to precede all atoms because the container specifies how the contained atoms are to be applied to the [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) data. For example, a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) container and a [**drawing group**](#gt_329c715f-dc26-4866-a759-0d622aa92e92) container each contain a collection of properties. The container designates that the properties are either individual shape properties or document default properties. + +### Properties + +Because the Office Drawing Binary File Format Structure contains [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) data, it is heavily populated with properties that are specific to [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). These shape properties are contained in a set of sparsely populated arrays. Each array contains a specific block of properties and contains only those properties for which the value differs from the default. If a property is specified to be ignored or is omitted from the file, it is assumed to have the default value. + +If any property appears in a property block more than once, the last occurrence is assumed to be the correct property, and the value in the last occurrence overrides any previously set value. + +### Bit Format + +Records are tightly packed without alignment. OfficeArt data is stored in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) format. + +### Extended Colors + +Each property that is related to color has two associated extended-color properties, which can be used to define the main color more precisely. If neither extended-color property is set, the main color property contains the full color definition. Otherwise, the first extended-color property specifies the base color, and the second extended-color property specifies a tint or shade modification that is applied to the first extended-color property. In this case, the main color property contains the flattened [**red-green-blue (RGB)**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color that is computed by applying specified tint or shade modification to the specified base color. If the values of the main color property and the extended-color properties are inconsistent, the value of the main color property can be used and those of the extended-color properties discarded. For more information, see section [2.2.2](#officeartcolorref). + +## Relationship to Protocols and Other Structures + +The Office Drawing Binary File Format Structure is dependent on the structures that are defined in the following references: + +- [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) + +- [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) + +- [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) + +- [\[MS-OGRAPH\]](%5bMS-OGRAPH%5d.pdf#Section_b12c26e854314b8d8904ba55716e492d) + +These structures determine how the OfficeArt data is saved to disk and where that data will reside. Additionally, images are stored within the file in standard raster formats. The **OfficeArtBStoreContainerFileBlock** record, which is defined in section [2.2.22](#officeartbstorecontainerfileblock), specifies which image types are supported within the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) store. + +The host application defines a certain group of records within the OfficeArt stream as client records. These records hold information that the host application needs to position the [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) in the host document or to contain the host text. + +The host application supplies OfficeArt text to provide the same functionality as the application’s native text. Some host applications also apply rules to the [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) or diagrams to assist with positioning those shapes or diagrams or to store additional data for other host-specific needs. + +For more information, see \[MS-DOC\], \[MS-XLS\], \[MS-PPT\], and \[MS-OGRAPH\]. + +## Applicability Statement + +This document specifies a persistence format for [**drawings**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). These drawings typically contain geometric primitives, also known as [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), that might contain formatting elements such as fills, line styles, pictures, and three-dimensional (3-D) transformations. These shapes also support text as specified by the host application. + +This persistence format provides interoperability with applications that create or read documents conforming to this structure.  + +## Versioning and Localization + +This document covers versioning issues in the following areas: + +**Structure versions:** All of the custom OfficeArt types, as defined in section [2.1](#Section_8f659d49f0e44e13bf31fd355b7c1a95), and OfficeArt record types, as defined in section [2.2](#Section_359f321f7c48471fb6b7ab8f11d63687), are supported by all versions of the OfficeArt file format, but this is not true for all of the properties. For more information, see section [2.3](#Section_0471a23e13794ff8ae7694386c166fa6). + +**Localization:** The OfficeArt file format does not use localized user text strings. This file format does use properties to represent text orientation and flow, as needed. For more information, see sections [2.3.21.9](#txfltextflow), [2.3.21.10](#cdirfont), and [2.3.21.12](#txdir). All the units of measure that are described in this document are either application defined, explicitly specified, or consistent across all locales. The OfficeArt file format does not define any time formats, calendar formats, or monetary units. + +## Vendor-Extensible Fields + +A vendor or third party can add data to the OfficeArt file format by defining a new record that has a record header for which the record type is outside the range 0xF000 through 0xFFFF. When a record type is encountered outside this range, the record MAY be skipped. For the record to be skipped, the record length field also needs to represent the size of the record so that the reader can determine how far ahead to jump to continue parsing the file. Any vendor-defined record MUST have a valid record header, as specified in the **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), for the record to be skipped as an unknown record type. Similarly, if a vendor or third party needs to add additional properties, a new record type needs to be defined to contain these properties. The existing OPT tables are as follows: + +- **OfficeArtFOPT**, as defined in section [2.2.9](#officeartfopt). + +- **OfficeArtSecondaryFOPT**, as defined in section [2.2.10](#officeartsecondaryfopt). + +- **OfficeArtTertiaryFOPT**, as defined in section [2.2.11](#officearttertiaryfopt). + +Avoid adding new properties to one of these existing OPT tables with a previously unused value in the **opid** field. These values might be claimed by a later version of OfficeArt and would then cause collisions with the vendor data. If a property has an unrecognized **opid.opid** field, a vendor can ignore the property. + +A vendor cannot acquire a record number that is guaranteed to be uniquely its own. Therefore, vendor-defined records risk causing conflicts with records that are defined by other vendors or third parties. + +A vendor can choose to infer the text orientation and flow either from the character context (by inspecting the characters and determining the correct orientation and flow from the [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character set) or from the system locale settings. + +# Structures + +## Custom OfficeArt Types + +### MSODGID + +*Referenced by: [OfficeArtIDCL](#officeartidcl)* + +The **MSODGID** data type designates an unsigned integer that specifies the identifier of a [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). + +### MSOSPID + +*Referenced by: [hspMaster](#hspmaster), [hspNext](#hspnext), [OfficeArtFArcRule](#officeartfarcrule), [OfficeArtFCalloutRule](#officeartfcalloutrule), [OfficeArtFConnectorRule](#officeartfconnectorrule), [OfficeArtFDG](#officeartfdg), [OfficeArtFDGG](#officeartfdgg), [OfficeArtFDGSL](#officeartfdgsl), [OfficeArtFPSPL](#officeartfpspl), [OfficeArtFSP](#officeartfsp)* + +The **MSOSPID** data type designates an unsigned integer that specifies the identifier of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +### FRID + +*Referenced by: [OfficeArtFRIT](#officeartfrit)* + +The **FRID** data type designates an unsigned integer that specifies the identifier of a [**group shape**](#gt_b2238184-3c83-4e64-babb-08b02a9138db) that has been ungrouped. + +### MSOFO + +*Referenced by: [OfficeArtFBSE](#officeartfbse)* + +The **MSOFO** data type designates an unsigned integer that specifies an offset into a file. + +## OfficeArt Record Types + +### OfficeArtRecordHeader + +*Referenced by: [OfficeArtBlipDIB](#officeartblipdib), [OfficeArtBlipEMF](#officeartblipemf), [OfficeArtBlipJPEG](#officeartblipjpeg), [OfficeArtBlipPICT](#officeartblippict), [OfficeArtBlipPNG](#officeartblippng), [OfficeArtBlipTIFF](#officeartbliptiff), [OfficeArtBlipWMF](#officeartblipwmf), [OfficeArtBStoreContainer](#officeartbstorecontainer), [OfficeArtChildAnchor](#officeartchildanchor), [OfficeArtColorMRUContainer](#officeartcolormrucontainer), [OfficeArtDgContainer](#officeartdgcontainer), [OfficeArtDggContainer](#officeartdggcontainer), [OfficeArtFArcRule](#officeartfarcrule), [OfficeArtFBSE](#officeartfbse), [OfficeArtFCalloutRule](#officeartfcalloutrule), [OfficeArtFConnectorRule](#officeartfconnectorrule), [OfficeArtFDG](#officeartfdg), [OfficeArtFDGGBlock](#officeartfdggblock), [OfficeArtFDGSL](#officeartfdgsl), [OfficeArtFOPT](#officeartfopt), [OfficeArtFPSPL](#officeartfpspl), [OfficeArtFRITContainer](#officeartfritcontainer), [OfficeArtFSP](#officeartfsp), [OfficeArtFSPGR](#officeartfspgr), [OfficeArtSecondaryFOPT](#officeartsecondaryfopt), [OfficeArtSolverContainer](#officeartsolvercontainer), [OfficeArtSpContainer](#officeartspcontainer), [OfficeArtSpgrContainer](#officeartspgrcontainer), [OfficeArtSplitMenuColorContainer](#officeartsplitmenucolorcontainer), [OfficeArtTertiaryFOPT](#officearttertiaryfopt)* + +The **OfficeArtRecordHeader** record specifies the common record header for all the OfficeArt records. + +[TABLE] + +**recVer (4 bits):** An unsigned integer that specifies the version if the record is an [**atom**](#gt_e0c68b3f-d976-411b-a247-7cef57e73728). If the record is a container, this field MUST contain 0xF. + +**recInstance (12 bits):** An unsigned integer that differentiates an atom from the other atoms that are contained in the record. + +**recType (2 bytes):** An unsigned integer that specifies the type of the record. This value MUST be from 0xF000 through 0xFFFF, inclusive. + +**recLen (4 bytes):** An unsigned integer that specifies the length, in bytes, of the record. If the record is an atom, this value specifies the length of the atom, excluding the header. If the record is a container, this value specifies the sum of the lengths of the atoms that the record contains, plus the length of the record header for each atom. + +### OfficeArtCOLORREF + +*Referenced by: [borderBottomColor](#borderbottomcolor), [borderLeftColor](#borderleftcolor), [borderRightColor](#borderrightcolor), [borderTopColor](#bordertopcolor), [c3DCrMod](#c3dcrmod), [c3DExtrusionColor](#c3dextrusioncolor), [c3DExtrusionColorExt](#c3dextrusioncolorext), [fillBackColor](#fillbackcolor), [fillBackColorExt](#fillbackcolorext), [fillColor](#fillcolor), [fillColorExt](#fillcolorext), [fillCrMod](#fillcrmod), [lineBackColor](#linebackcolor), [lineBackColorExt](#linebackcolorext), [lineBottomBackColor](#linebottombackcolor), [lineBottomBackColorExt](#linebottombackcolorext), [lineBottomColor](#linebottomcolor), [lineBottomColorExt](#linebottomcolorext), [lineBottomCrMod](#linebottomcrmod), [lineColor](#linecolor), [lineColorExt](#linecolorext), [lineCrMod](#linecrmod), [lineLeftBackColor](#lineleftbackcolor), [lineLeftBackColorExt](#lineleftbackcolorext), [lineLeftColor](#lineleftcolor), [lineLeftColorExt](#lineleftcolorext), [lineLeftCrMod](#lineleftcrmod), [lineRightBackColor](#linerightbackcolor), [lineRightBackColorExt](#linerightbackcolorext), [lineRightColor](#linerightcolor), [lineRightColorExt](#linerightcolorext), [lineRightCrMod](#linerightcrmod), [lineTopBackColor](#linetopbackcolor), [lineTopBackColorExt](#linetopbackcolorext), [lineTopColor](#linetopcolor), [lineTopColorExt](#linetopcolorext), [lineTopCrMod](#linetopcrmod), [MSOSHADECOLOR](#msoshadecolor), [pictureDblCrMod](#picturedblcrmod), [pictureFillCrMod](#picturefillcrmod), [pictureLineCrMod](#picturelinecrmod), [pictureRecolor](#picturerecolor), [pictureRecolorExt](#picturerecolorext), [pictureTransparent](#picturetransparent), [pictureTransparentExt](#picturetransparentext), [reserved1370](#reserved1370), [reserved1374](#reserved1374), [reserved1377](#reserved1377), [reserved1378](#reserved1378), [reserved1434](#reserved1434), [reserved1438](#reserved1438), [reserved1441](#reserved1441), [reserved1442](#reserved1442), [reserved1498](#reserved1498), [reserved1502](#reserved1502), [reserved1505](#reserved1505), [reserved1506](#reserved1506), [reserved1562](#reserved1562), [reserved1566](#reserved1566), [reserved1569](#reserved1569), [reserved1570](#reserved1570), [reserved278](#reserved278), [reserved281](#reserved281), [reserved284](#reserved284), [reserved287](#reserved287), [reserved415](#reserved415), [reserved419](#reserved419), [reserved422](#reserved422), [reserved423](#reserved423), [reserved474](#reserved474), [reserved478](#reserved478), [reserved481](#reserved481), [reserved482](#reserved482), [reserved531](#reserved531), [reserved535](#reserved535), [reserved538](#reserved538), [reserved539](#reserved539), [reserved650](#reserved650), [reserved653](#reserved653), [shadowColor](#shadowcolor), [shadowColorExt](#shadowcolorext), [shadowCrMod](#shadowcrmod), [shadowHighlight](#shadowhighlight), [shadowHighlightExt](#shadowhighlightext)* + +The **OfficeArtCOLORREF** structure specifies a color. The high 8 bits MAY be set to 0xFF, in which case the color MUST be ignored. + +The **color** properties that are specified in the following table have a set of extended-color properties. The **color** property specifies the main color. The **colorExt** and **colorExtMod** properties specify the extended colors that can be used to define the main color more precisely. + +| color | colorExt | colorExtMod | +|----|----|----| +| **fillColor** (section 2.3.7.2) | **fillColorExt** (section 2.3.7.33) | **fillColorExtMod** (section [2.3.7.35](#fillcolorextmod)) | +| **fillBackColor** (section 2.3.7.4) | **fillBackColorExt** (section 2.3.7.37) | **fillBackColorExtMod** (section [2.3.7.39](#fillbackcolorextmod)) | +| **lineColor** (section 2.3.8.1) | **lineColorExt** (section 2.3.8.28) | **lineColorExtMod** (section [2.3.8.30](#linecolorextmod)) | +| **lineBackColor** (section 2.3.8.3) | **lineBackColorExt** (section 2.3.8.32) | **lineBackColorExtMod** (section [2.3.8.34](#linebackcolorextmod)) | +| **lineLeftColor** (section 2.3.9.1) | **lineLeftColorExt** (section 2.3.9.28) | **lineLeftColorExtMod** (section [2.3.9.30](#lineleftcolorextmod)) | +| **lineLeftBackColor** (section 2.3.9.3) | **lineLeftBackColorExt** (section 2.3.9.32) | **lineLeftBackColorExtMod** (section [2.3.9.34](#lineleftbackcolorextmod)) | +| **lineRightColor** (section 2.3.11.1) | **lineRightColorExt** (section 2.3.11.28) | **lineRightColorExtMod** (section [2.3.11.30](#linerightcolorextmod)) | +| **lineRightBackColor** (section 2.3.11.3) | **lineRightBackColorExt** (section 2.3.11.32) | **lineRightBackColorExtMod** (section [2.3.11.34](#linerightbackcolorextmod)) | +| **lineTopColor** (section 2.3.10.1) | **lineTopColorExt** (section 2.3.10.28) | **lineTopColorExtMod** (section [2.3.10.30](#linetopcolorextmod)) | +| **lineTopBackColor** (section 2.3.10.3) | **lineTopBackColorExt** (section 2.3.10.32) | **lineTopBackColorExtMod** (section [2.3.10.34](#linetopbackcolorextmod)) | +| **lineBottomColor** (section 2.3.12.1) | **lineBottomColorExt** (section 2.3.12.28) | **lineBottomColorExtMod** (section [2.3.12.30](#linebottomcolorextmod)) | +| **lineBottomBackColor** (section 2.3.12.3) | **lineBottomBackColorExt** (section 2.3.12.32) | **lineBottomBackColorExtMod** (section [2.3.12.34](#linebottombackcolorextmod)) | +| **shadowColor** (section 2.3.13.2) | **shadowColorExt** (section 2.3.13.12) | **shadowColorExtMod** (section [2.3.13.14](#shadowcolorextmod)) | +| **shadowHighlight** (section 2.3.13.3) | **shadowHighlightExt** (section 2.3.13.16) | **shadowHighlightExtMod** (section [2.3.13.18](#shadowhighlightextmod)) | +| **c3DExtrusionColor** (section 2.3.15.8) | **c3DExtrusionColorExt** (section 2.3.15.10) | **c3DExtrusionColorExtMod** (section [2.3.15.12](#c3dextrusioncolorextmod)) | +| **pictureRecolor** (section 2.3.23.29) | **pictureRecolorExt** (section 2.3.23.30) | **pictureRecolorExtMod** (section [2.3.23.32](#picturerecolorextmod)) | +| **pictureTransparent** (section 2.3.23.10) | **pictureTransparentExt** (section 2.3.23.24) | **pictureTransparentExtMod** (section [2.3.23.26](#picturetransparentextmod)) | + +If neither extended-color property is set, the main **color** property contains the full color definition. Otherwise, the **colorExt** property specifies the base color, and the **colorExtMod** property specifies a tint or shade modification that is applied to the **colorExt** property. In this case, the main **color** property contains the flattened [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color that is computed by applying the specified tint or shade modification to the specified base color. + +[TABLE] + +**A - unused1 (1 bit):** A bit that is undefined and MUST be ignored. + +**B - unused2 (1 bit):** A bit that is undefined and MUST be ignored. + +**C - unused3 (1 bit):** A bit that is undefined and MUST be ignored. + +**D - fSysIndex (1 bit):** A bit that specifies whether the system [**color scheme**](#gt_b0feeac6-f711-4ed7-b8c6-3a490734a9e5) will be used to determine the color. A value of 0x1 specifies that **green** and **red** will be treated as an unsigned 16-bit index into the system color table. Values less than 0x00F0 map directly to system colors. For more information, see [\[MSDN-GetSysColor\]](https://go.microsoft.com/fwlink/?LinkId=120479). + +The following table specifies values that have special meaning. + +| Value | Meaning | +|----|----| +| 0x00F0 | Use the fill color of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). | +| 0x00F1 | If the shape contains a line, use the line color of the shape. Otherwise, use the fill color. | +| 0x00F2 | Use the line color of the shape. | +| 0x00F3 | Use the shadow color of the shape. | +| 0x00F4 | Use the current, or last-used, color. | +| 0x00F5 | Use the fill background color of the shape. | +| 0x00F6 | Use the line background color of the shape. | +| 0x00F7 | If the shape contains a fill, use the fill color of the shape. Otherwise, use the line color. | + +The following table specifies values that indicate special procedural properties that are used to modify the color components of another color. These values are combined with those in the preceding table or with a user-specified color. The first six values are mutually exclusive. + +[TABLE] + +**E - fSchemeIndex (1 bit):** A bit that specifies whether the current application-defined color scheme will be used to determine the color. A value of 0x1 specifies that **red** will be treated as an index into the current color scheme table. If this value is 0x1, **green** and **blue** MUST be 0x00. + +**F - fSystemRGB (1 bit):** A bit that specifies whether the color is a standard RGB color. The following table specifies the meaning of each value for this field. + +| Value | Meaning | +|-------|------------------------------------------------------| +| 0x0 | The RGB color MAY use halftone dithering to display. | +| 0x1 | The color MUST be a solid color. | + +**G - fPaletteRGB (1 bit):** A bit that specifies whether the current palette will be used to determine the color. A value of 0x1 specifies that **red, green**, and **blue** contain an RGB value that will be matched in the current color palette. This color MUST be solid. + +**H - fPaletteIndex (1 bit):** A bit that specifies whether the current palette will be used to determine the color. A value of 0x1 specifies that **green** and **red** will be treated as an unsigned 16-bit index into the current color palette. This color MAY[\<1\>](#Appendix_A_1) be dithered. If this value is 0x1, **blue** MUST be 0x00. + +**blue (1 byte):** An unsigned integer that specifies the intensity of the blue color channel. A value of 0x00 has the minimum blue intensity. A value of 0xFF has the maximum blue intensity. + +**green (1 byte):** An unsigned integer that specifies the intensity of the green color channel. A value of 0x00 has the minimum green intensity. A value of 0xFF has the maximum green intensity. + +**red (1 byte):** An unsigned integer that specifies the intensity of the red color channel. A value of 0x00 has the minimum red intensity. A value of 0xFF has the maximum red intensity. + +### MSOSHADE + +*Referenced by: [MSOTINTSHADE](#msotintshade)* + +The **MSOSHADE** record specifies a shade color modification that can be used to darken a color. + +[TABLE] + +**reserved1 (16 bits):** A value that MUST be 0x01F4 and MUST be ignored. + +**amount (8 bits):** An unsigned integer that specifies the amount with which to darken the color. A value of 0xFF specifies that the color is not to be darkened. A value of 0x00 specifies that the color is to be fully darkened. + +**reserved2 (8 bits):** A value that MUST be 0x10 and MUST be ignored. + +### MSOTINT + +*Referenced by: [MSOTINTSHADE](#msotintshade)* + +The **MSOTINT** record specifies a tint color modification that can be used to lighten a color. + +[TABLE] + +**reserved1 (16 bits):** A value that MUST be 0x02F4 and MUST be ignored. + +**amount (8 bits):** An unsigned integer that specifies the amount with which to lighten the color. A value of 0xFF specifies that the color is not to be lightened. A value of 0x00 specifies that the color is to be fully lightened. + +**reserved2 (8 bits):** A value that MUST be 0x10 and MUST be ignored. + +### MSOCOLORMODUNDEFINED + +*Referenced by: [MSOTINTSHADE](#msotintshade)* + +The **MSOCOLORMODUNDEFINED** record MUST be ignored. + +[TABLE] + +**reserved1 (4 bytes):** A value that MUST be 0x20000000 and MUST be ignored. + +### MSOTINTSHADE + +*Referenced by: [c3DExtrusionColorExtMod](#c3dextrusioncolorextmod), [fillBackColorExtMod](#fillbackcolorextmod), [fillColorExtMod](#fillcolorextmod), [lineBackColorExtMod](#linebackcolorextmod), [lineBottomBackColorExtMod](#linebottombackcolorextmod), [lineBottomColorExtMod](#linebottomcolorextmod), [lineColorExtMod](#linecolorextmod), [lineLeftBackColorExtMod](#lineleftbackcolorextmod), [lineLeftColorExtMod](#lineleftcolorextmod), [lineRightBackColorExtMod](#linerightbackcolorextmod), [lineRightColorExtMod](#linerightcolorextmod), [lineTopBackColorExtMod](#linetopbackcolorextmod), [lineTopColorExtMod](#linetopcolorextmod), [pictureRecolorExtMod](#picturerecolorextmod), [pictureTransparentExtMod](#picturetransparentextmod), [shadowColorExtMod](#shadowcolorextmod), [shadowHighlightExtMod](#shadowhighlightextmod)* + +The **MSOTINTSHADE** record specifies an **MSOCOLORMODUNDEFINED**, as defined in section [2.2.5](#msocolormodundefined), an **MSOSHADE**, as defined in section [2.2.3](#msoshade), or an **MSOTINT**, as defined in section [2.2.4](#msotint), record. The type and meaning are dictated by the value of the following code snippet: + +1. (((DWORD)MSOTINTSHADE) & 0x00000300) \>\> 8 + +The following table specifies the valid values. + +| Value | Type | +|------------|--------------------------| +| 0x00000000 | **MSOCOLORMODUNDEFINED** | +| 0x00000001 | **MSOSHADE** | +| 0x00000002 | **MSOTINT** | + +### OfficeArtFOPTE + +The **OfficeArtFOPTE** record specifies an entry in a property table. An entry consists of an identifier and a value. Some property values, such as [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) strings, do not fit in 32 bits. For these properties, the **fComplex** bit is set, and the size of the data is saved in the **op** field. The data of the complex properties follows the array of property table entries in the property table. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header information for this property. + +**op (4 bytes):** A signed integer that specifies the value for this property. + +### OfficeArtFOPTEOPID + +*Referenced by: [3D-Object Boolean Properties](#d-object-boolean-properties), [3D-Style Boolean Properties](#d-style-boolean-properties), [adjust2Value](#adjust2value), [adjust3Value](#adjust3value), [adjust4Value](#adjust4value), [adjust5Value](#adjust5value), [adjust6Value](#adjust6value), [adjust7Value](#adjust7value), [adjust8Value](#adjust8value), [adjustValue](#adjustvalue), [alignHR](#alignhr), [anchorText](#anchortext), [Blip Boolean Properties](#blip-boolean-properties), [borderBottomColor](#borderbottomcolor), [borderLeftColor](#borderleftcolor), [borderRightColor](#borderrightcolor), [borderTopColor](#bordertopcolor), [bottom](#bottom), [Bottom Line Style Boolean Properties](#bottom-line-style-boolean-properties), [bWMode](#bwmode), [bWModeBW](#bwmodebw), [bWModePureBW](#bwmodepurebw), [c3DAmbientIntensity](#c3dambientintensity), [c3DCrMod](#c3dcrmod), [c3DDiffuseAmt](#c3ddiffuseamt), [c3DEdgeThickness](#c3dedgethickness), [c3DExtrudeBackward](#c3dextrudebackward), [c3DExtrudeForward](#c3dextrudeforward), [c3DExtrusionColor](#c3dextrusioncolor), [c3DExtrusionColorExt](#c3dextrusioncolorext), [c3DExtrusionColorExtMod](#c3dextrusioncolorextmod), [c3DFillIntensity](#c3dfillintensity), [c3DFillX](#c3dfillx), [c3DFillY](#c3dfilly), [c3DFillZ](#c3dfillz), [c3DKeyIntensity](#c3dkeyintensity), [c3DKeyX](#c3dkeyx), [c3DKeyY](#c3dkeyy), [c3DKeyZ](#c3dkeyz), [c3DOriginX](#c3doriginx), [c3DOriginY](#c3doriginy), [c3DRenderMode](#c3drendermode), [c3DRotationAngle](#c3drotationangle), [c3DRotationAxisX](#c3drotationaxisx), [c3DRotationAxisY](#c3drotationaxisy), [c3DRotationAxisZ](#c3drotationaxisz), [c3DRotationCenterX](#c3drotationcenterx), [c3DRotationCenterY](#c3drotationcentery), [c3DRotationCenterZ](#c3drotationcenterz), [c3DShininess](#c3dshininess), [c3DSkewAmount](#c3dskewamount), [c3DSkewAngle](#c3dskewangle), [c3DSpecularAmt](#c3dspecularamt), [c3DTolerance](#c3dtolerance), [c3DXRotationAngle](#c3dxrotationangle), [c3DXViewpoint](#c3dxviewpoint), [c3DYRotationAngle](#c3dyrotationangle), [c3DYViewpoint](#c3dyviewpoint), [c3DZViewpoint](#c3dzviewpoint), [Callout Boolean Properties](#callout-boolean-properties), [cdirFont](#cdirfont), [cropFromBottom](#cropfrombottom), [cropFromLeft](#cropfromleft), [cropFromRight](#cropfromright), [cropFromTop](#cropfromtop), [cxk](#cxk), [cxstyle](#cxstyle), [dgmBaseTextScale](#dgmbasetextscale), [dgmConstrainBounds](#dgmconstrainbounds), [dgmDefaultFontSize](#dgmdefaultfontsize), [dgmLayout](#dgmlayout), [dgmLayoutMRU](#dgmlayoutmru), [dgmNodeKind](#dgmnodekind), [dgmScaleX](#dgmscalex), [dgmScaleY](#dgmscaley), [dgmStyle](#dgmstyle), [dgmt](#dgmt), [dhgt](#dhgt), [Diagram Boolean Properties](#diagram-boolean-properties), [dxHeightHR](#dxheighthr), [dxTextLeft](#dxtextleft), [dxTextRight](#dxtextright), [dxWidthHR](#dxwidthhr), [dxWrapDistLeft](#dxwrapdistleft), [dxWrapDistRight](#dxwrapdistright), [dxyCalloutDropSpecified](#dxycalloutdropspecified), [dxyCalloutGap](#dxycalloutgap), [dxyCalloutLengthSpecified](#dxycalloutlengthspecified), [dyTextBottom](#dytextbottom), [dyTextTop](#dytexttop), [dyWrapDistBottom](#dywrapdistbottom), [dyWrapDistTop](#dywrapdisttop), [equationXML](#equationxml), [Fill Style Boolean Properties](#fill-style-boolean-properties), [fillAngle](#fillangle), [fillBackColor](#fillbackcolor), [fillBackColorExt](#fillbackcolorext), [fillBackColorExtMod](#fillbackcolorextmod), [fillBackOpacity](#fillbackopacity), [fillBlip](#fillblip), [fillBlipFlags](#fillblipflags), [fillBlipName](#fillblipname), [fillColor](#fillcolor), [fillColorExt](#fillcolorext), [fillColorExtMod](#fillcolorextmod), [fillCrMod](#fillcrmod), [fillDztype](#filldztype), [fillFocus](#fillfocus), [fillHeight](#fillheight), [fillOpacity](#fillopacity), [fillOriginX](#filloriginx), [fillOriginY](#filloriginy), [fillRectBottom](#fillrectbottom), [fillRectLeft](#fillrectleft), [fillRectRight](#fillrectright), [fillRectTop](#fillrecttop), [fillShadeColors](#fillshadecolors), [fillShadePreset](#fillshadepreset), [fillShadeType](#fillshadetype), [fillShapeOriginX](#fillshapeoriginx), [fillShapeOriginY](#fillshapeoriginy), [fillToBottom](#filltobottom), [fillToLeft](#filltoleft), [fillToRight](#filltoright), [fillToTop](#filltotop), [fillType](#filltype), [fillWidth](#fillwidth), [geoBottom](#geobottom), [geoLeft](#geoleft), [Geometry Boolean Properties](#geometry-boolean-properties), [Geometry Text Boolean Properties](#geometry-text-boolean-properties), [geoRight](#georight), [geoTop](#geotop), [Group Shape Boolean Properties](#group-shape-boolean-properties), [gtextAlign](#gtextalign), [gtextCSSFont](#gtextcssfont), [gtextFont](#gtextfont), [gtextSize](#gtextsize), [gtextSpacing](#gtextspacing), [gtextUNICODE](#gtextunicode), [gvPage](#gvpage), [gvRelPage](#gvrelpage), [hspMaster](#hspmaster), [hspNext](#hspnext), [idDiscussAnchor](#iddiscussanchor), [Ink Boolean Properties](#ink-boolean-properties), [left](#left), [Left Line Style Boolean Properties](#left-line-style-boolean-properties), [lidRegroup](#lidregroup), [Line Style Boolean Properties](#line-style-boolean-properties), [lineBackColor](#linebackcolor), [lineBackColorExt](#linebackcolorext), [lineBackColorExtMod](#linebackcolorextmod), [lineBottomBackColor](#linebottombackcolor), [lineBottomBackColorExt](#linebottombackcolorext), [lineBottomBackColorExtMod](#linebottombackcolorextmod), [lineBottomColor](#linebottomcolor), [lineBottomColorExt](#linebottomcolorext), [lineBottomColorExtMod](#linebottomcolorextmod), [lineBottomCrMod](#linebottomcrmod), [lineBottomDashing](#linebottomdashing), [lineBottomDashStyle](#linebottomdashstyle), [lineBottomEndArrowhead](#linebottomendarrowhead), [lineBottomEndArrowLength](#linebottomendarrowlength), [lineBottomEndArrowWidth](#linebottomendarrowwidth), [lineBottomEndCapStyle](#linebottomendcapstyle), [lineBottomFillBlip](#linebottomfillblip), [lineBottomFillBlipFlags](#linebottomfillblipflags), [lineBottomFillBlipName](#linebottomfillblipname), [lineBottomFillDztype](#linebottomfilldztype), [lineBottomFillHeight](#linebottomfillheight), [lineBottomFillWidth](#linebottomfillwidth), [lineBottomJoinStyle](#linebottomjoinstyle), [lineBottomMiterLimit](#linebottommiterlimit), [lineBottomOpacity](#linebottomopacity), [lineBottomStartArrowhead](#linebottomstartarrowhead), [lineBottomStartArrowLength](#linebottomstartarrowlength), [lineBottomStartArrowWidth](#linebottomstartarrowwidth), [lineBottomStyle](#linebottomstyle), [lineBottomType](#linebottomtype), [lineBottomWidth](#linebottomwidth), [lineColor](#linecolor), [lineColorExt](#linecolorext), [lineColorExtMod](#linecolorextmod), [lineCrMod](#linecrmod), [lineDashing](#linedashing), [lineDashStyle](#linedashstyle), [lineEndArrowhead](#lineendarrowhead), [lineEndArrowLength](#lineendarrowlength), [lineEndArrowWidth](#lineendarrowwidth), [lineEndCapStyle](#lineendcapstyle), [lineFillBlip](#linefillblip), [lineFillBlipFlags](#linefillblipflags), [lineFillBlipName](#linefillblipname), [lineFillDztype](#linefilldztype), [lineFillHeight](#linefillheight), [lineFillWidth](#linefillwidth), [lineJoinStyle](#linejoinstyle), [lineLeftBackColor](#lineleftbackcolor), [lineLeftBackColorExt](#lineleftbackcolorext), [lineLeftBackColorExtMod](#lineleftbackcolorextmod), [lineLeftColor](#lineleftcolor), [lineLeftColorExt](#lineleftcolorext), [lineLeftColorExtMod](#lineleftcolorextmod), [lineLeftCrMod](#lineleftcrmod), [lineLeftDashing](#lineleftdashing), [lineLeftDashStyle](#lineleftdashstyle), [lineLeftEndArrowhead](#lineleftendarrowhead), [lineLeftEndArrowLength](#lineleftendarrowlength), [lineLeftEndArrowWidth](#lineleftendarrowwidth), [lineLeftEndCapStyle](#lineleftendcapstyle), [lineLeftFillBlip](#lineleftfillblip), [lineLeftFillBlipFlags](#lineleftfillblipflags), [lineLeftFillBlipName](#lineleftfillblipname), [lineLeftFillDztype](#lineleftfilldztype), [lineLeftFillHeight](#lineleftfillheight), [lineLeftFillWidth](#lineleftfillwidth), [lineLeftJoinStyle](#lineleftjoinstyle), [lineLeftMiterLimit](#lineleftmiterlimit), [lineLeftOpacity](#lineleftopacity), [lineLeftStartArrowhead](#lineleftstartarrowhead), [lineLeftStartArrowLength](#lineleftstartarrowlength), [lineLeftStartArrowWidth](#lineleftstartarrowwidth), [lineLeftStyle](#lineleftstyle), [lineLeftType](#linelefttype), [lineLeftWidth](#lineleftwidth), [lineMiterLimit](#linemiterlimit), [lineOpacity](#lineopacity), [lineRightBackColor](#linerightbackcolor), [lineRightBackColorExt](#linerightbackcolorext), [lineRightBackColorExtMod](#linerightbackcolorextmod), [lineRightColor](#linerightcolor), [lineRightColorExt](#linerightcolorext), [lineRightColorExtMod](#linerightcolorextmod), [lineRightCrMod](#linerightcrmod), [lineRightDashing](#linerightdashing), [lineRightDashStyle](#linerightdashstyle), [lineRightEndArrowhead](#linerightendarrowhead), [lineRightEndArrowLength](#linerightendarrowlength), [lineRightEndArrowWidth](#linerightendarrowwidth), [lineRightEndCapStyle](#linerightendcapstyle), [lineRightFillBlip](#linerightfillblip), [lineRightFillBlipFlags](#linerightfillblipflags), [lineRightFillBlipName](#linerightfillblipname), [lineRightFillDztype](#linerightfilldztype), [lineRightFillHeight](#linerightfillheight), [lineRightFillWidth](#linerightfillwidth), [lineRightJoinStyle](#linerightjoinstyle), [lineRightMiterLimit](#linerightmiterlimit), [lineRightOpacity](#linerightopacity), [lineRightStartArrowhead](#linerightstartarrowhead), [lineRightStartArrowLength](#linerightstartarrowlength), [lineRightStartArrowWidth](#linerightstartarrowwidth), [lineRightStyle](#linerightstyle), [lineRightType](#linerighttype), [lineRightWidth](#linerightwidth), [lineStartArrowhead](#linestartarrowhead), [lineStartArrowLength](#linestartarrowlength), [lineStartArrowWidth](#linestartarrowwidth), [lineStyle](#linestyle), [lineTopBackColor](#linetopbackcolor), [lineTopBackColorExt](#linetopbackcolorext), [lineTopBackColorExtMod](#linetopbackcolorextmod), [lineTopColor](#linetopcolor), [lineTopColorExt](#linetopcolorext), [lineTopColorExtMod](#linetopcolorextmod), [lineTopCrMod](#linetopcrmod), [lineTopDashing](#linetopdashing), [lineTopDashStyle](#linetopdashstyle), [lineTopEndArrowhead](#linetopendarrowhead), [lineTopEndArrowLength](#linetopendarrowlength), [lineTopEndArrowWidth](#linetopendarrowwidth), [lineTopEndCapStyle](#linetopendcapstyle), [lineTopFillBlip](#linetopfillblip), [lineTopFillBlipFlags](#linetopfillblipflags), [lineTopFillBlipName](#linetopfillblipname), [lineTopFillDztype](#linetopfilldztype), [lineTopFillHeight](#linetopfillheight), [lineTopFillWidth](#linetopfillwidth), [lineTopJoinStyle](#linetopjoinstyle), [lineTopMiterLimit](#linetopmiterlimit), [lineTopOpacity](#linetopopacity), [lineTopStartArrowhead](#linetopstartarrowhead), [lineTopStartArrowLength](#linetopstartarrowlength), [lineTopStartArrowWidth](#linetopstartarrowwidth), [lineTopStyle](#linetopstyle), [lineTopType](#linetoptype), [lineTopWidth](#linetopwidth), [lineType](#linetype), [lineWidth](#linewidth), [lTxid](#ltxid), [metroBlob](#metroblob), [movie](#movie), [OfficeArtFOPTE](#officeartfopte), [pAdjustHandles](#padjusthandles), [pConnectionSites](#pconnectionsites), [pConnectionSitesDir](#pconnectionsitesdir), [pctHoriz](#pcthoriz), [pctHorizPos](#pcthorizpos), [pctHR](#pcthr), [pctVert](#pctvert), [pctVertPos](#pctvertpos), [Perspective Style Boolean Properties](#perspective-style-boolean-properties), [perspectiveOffsetX](#perspectiveoffsetx), [perspectiveOffsetY](#perspectiveoffsety), [perspectiveOriginX](#perspectiveoriginx), [perspectiveOriginY](#perspectiveoriginy), [perspectivePerspectiveX](#perspectiveperspectivex), [perspectivePerspectiveY](#perspectiveperspectivey), [perspectiveScaleXToX](#perspectivescalextox), [perspectiveScaleXToY](#perspectivescalextoy), [perspectiveScaleYToX](#perspectivescaleytox), [perspectiveScaleYToY](#perspectivescaleytoy), [perspectiveType](#perspectivetype), [perspectiveWeight](#perspectiveweight), [pGuides](#pguides), [pib](#pib), [pibFlags](#pibflags), [pibName](#pibname), [pibPrint](#pibprint), [pibPrintFlags](#pibprintflags), [pibPrintName](#pibprintname), [pictureBrightness](#picturebrightness), [pictureContrast](#picturecontrast), [pictureDblCrMod](#picturedblcrmod), [pictureFillCrMod](#picturefillcrmod), [pictureId](#pictureid), [pictureLineCrMod](#picturelinecrmod), [pictureRecolor](#picturerecolor), [pictureRecolorExt](#picturerecolorext), [pictureRecolorExtMod](#picturerecolorextmod), [pictureTransparent](#picturetransparent), [pictureTransparentExt](#picturetransparentext), [pictureTransparentExtMod](#picturetransparentextmod), [pihlShape](#pihlshape), [pInkData](#pinkdata), [pInscribe](#pinscribe), [posh](#posh), [posrelh](#posrelh), [posrelv](#posrelv), [posv](#posv), [pRelationTbl](#prelationtbl), [Protection Boolean Properties](#protection-boolean-properties), [pSegmentInfo](#psegmentinfo), [pVertices](#pvertices), [pWrapPolygonVertices](#pwrappolygonvertices), [Relative Transform Boolean Properties](#relative-transform-boolean-properties), [relBottom](#relbottom), [relLeft](#relleft), [relRight](#relright), [relRotation](#relrotation), [relTop](#reltop), [reserved1370](#reserved1370), [reserved1372](#reserved1372), [reserved1374](#reserved1374), [reserved1376](#reserved1376), [reserved1377](#reserved1377), [reserved1378](#reserved1378), [reserved1434](#reserved1434), [reserved1436](#reserved1436), [reserved1438](#reserved1438), [reserved1440](#reserved1440), [reserved1441](#reserved1441), [reserved1442](#reserved1442), [reserved1498](#reserved1498), [reserved1500](#reserved1500), [reserved1502](#reserved1502), [reserved1504](#reserved1504), [reserved1505](#reserved1505), [reserved1506](#reserved1506), [reserved1562](#reserved1562), [reserved1564](#reserved1564), [reserved1566](#reserved1566), [reserved1568](#reserved1568), [reserved1569](#reserved1569), [reserved1570](#reserved1570), [reserved278](#reserved278), [reserved280](#reserved280), [reserved281](#reserved281), [reserved284](#reserved284), [reserved286](#reserved286), [reserved287](#reserved287), [reserved415](#reserved415), [reserved417](#reserved417), [reserved419](#reserved419), [reserved421](#reserved421), [reserved422](#reserved422), [reserved423](#reserved423), [reserved474](#reserved474), [reserved476](#reserved476), [reserved478](#reserved478), [reserved480](#reserved480), [reserved481](#reserved481), [reserved482](#reserved482), [reserved531](#reserved531), [reserved533](#reserved533), [reserved535](#reserved535), [reserved537](#reserved537), [reserved538](#reserved538), [reserved539](#reserved539), [reserved646](#reserved646), [reserved650](#reserved650), [reserved652](#reserved652), [reserved653](#reserved653), [right](#right), [Right Line Style Boolean Properties](#right-line-style-boolean-properties), [rotation](#rotation), [scriptLang](#scriptlang), [Shadow Style Boolean Properties](#shadow-style-boolean-properties), [shadowColor](#shadowcolor), [shadowColorExt](#shadowcolorext), [shadowColorExtMod](#shadowcolorextmod), [shadowCrMod](#shadowcrmod), [shadowHighlight](#shadowhighlight), [shadowHighlightExt](#shadowhighlightext), [shadowHighlightExtMod](#shadowhighlightextmod), [shadowOffsetX](#shadowoffsetx), [shadowOffsetY](#shadowoffsety), [shadowOpacity](#shadowopacity), [shadowOriginX](#shadoworiginx), [shadowOriginY](#shadoworiginy), [shadowSecondOffsetX](#shadowsecondoffsetx), [shadowSecondOffsetY](#shadowsecondoffsety), [shadowSoftness](#shadowsoftness), [shadowType](#shadowtype), [Shape Boolean Properties](#shape-boolean-properties), [shapePath](#shapepath), [Signature Line Boolean Properties](#signature-line-boolean-properties), [sizerelh](#sizerelh), [sizerelv](#sizerelv), [spcoa](#spcoa), [spcod](#spcod), [tableProperties](#tableproperties), [tableRowProperties](#tablerowproperties), [Text Boolean Properties](#text-boolean-properties), [top](#top), [Top Line Style Boolean Properties](#top-line-style-boolean-properties), [Transform Boolean Properties](#transform-boolean-properties), [txdir](#txdir), [txflTextFlow](#txfltextflow), [Unknown HTML Boolean Properties](#unknown-html-boolean-properties), [unused134](#unused134), [unused140](#unused140), [unused141](#unused141), [unused832](#unused832), [unused906](#unused906), [Web Component Boolean Properties](#web-component-boolean-properties), [webComponentWzHtml](#webcomponentwzhtml), [webComponentWzName](#webcomponentwzname), [webComponentWzUrl](#webcomponentwzurl), [WrapText](#wraptext), [wzCalloutId](#wzcalloutid), [wzDescription](#wzdescription), [wzFillId](#wzfillid), [wzFormulaeId](#wzformulaeid), [wzGtextId](#wzgtextid), [wzHandlesId](#wzhandlesid), [wzLineId](#wzlineid), [wzLockId](#wzlockid), [wzName](#wzname), [wzPathId](#wzpathid), [wzPerspectiveId](#wzperspectiveid), [wzPictureId](#wzpictureid), [wzScript](#wzscript), [wzScriptExtAttr](#wzscriptextattr), [wzScriptLangAttr](#wzscriptlangattr), [wzShadowId](#wzshadowid), [wzSigSetupAddlXml](#wzsigsetupaddlxml), [wzSigSetupId](#wzsigsetupid), [wzSigSetupProvId](#wzsigsetupprovid), [wzSigSetupProvUrl](#wzsigsetupprovurl), [wzSigSetupSignInst](#wzsigsetupsigninst), [wzSigSetupSuggSigner](#wzsigsetupsuggsigner), [wzSigSetupSuggSigner2](#wzsigsetupsuggsigner2), [wzSigSetupSuggSignerEmail](#wzsigsetupsuggsigneremail), [wzTextId](#wztextid), [wzThreeDId](#wzthreedid), [wzTooltip](#wztooltip), [wzWebBot](#wzwebbot), [xLimo](#xlimo), [yLimo](#ylimo)* + +The **OfficeArtFOPTEOPID** record specifies the header for an entry in a property table. + +[TABLE] + +**opid (14 bits):** An unsigned integer that specifies the identifier of the property in this entry. + +**A - fBid (1 bit):** A bit that specifies whether the value in the **op** field is a [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) identifier. If this value equals 0x1, the value in the **op** field specifies the BLIP identifier in the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). If **fComplex** equals 0x1, this bit MUST be ignored. + +**B - fComplex (1 bit):** A bit that specifies whether this property is a complex property. If this value equals 0x1, the **op** field specifies the size of the data for this property, rather than the property data itself. + +### OfficeArtFOPT + +*Referenced by: [OfficeArtDggContainer](#officeartdggcontainer), [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtFOPT** record specifies a table of **OfficeArtRGFOPTE** records, as defined in section [2.3.1](#officeartrgfopte). The following properties SHOULD be specified in this table: + +- [Blip:Blip Boolean Properties](#blip-boolean-properties) + +- [Blip:cropFromBottom](#cropfrombottom) + +- [Blip:cropFromLeft](#cropfromleft) + +- [Blip:cropFromRight](#cropfromright) + +- [Blip:cropFromTop](#cropfromtop) + +- [Blip:pib](#pib) + +- [Blip:pibFlags](#pibflags) + +- [Blip:pibName](#pibname) + +- [Blip:pibPrint](#pibprint) + +- [Blip:pibPrintFlags](#pibprintflags) + +- [Blip:pibPrintName](#pibprintname) + +- [Blip:pictureBrightness](#picturebrightness) + +- [Blip:pictureContrast](#picturecontrast) + +- [Blip:pictureDblCrMod](#picturedblcrmod) + +- [Blip:pictureFillCrMod](#picturefillcrmod) + +- [Blip:pictureId](#pictureid) + +- [Blip:pictureLineCrMod](#picturelinecrmod) + +- [Blip:pictureTransparent](#picturetransparent) + +- [Callout:Callout Boolean Properties](#callout-boolean-properties) + +- [Callout:dxyCalloutDropSpecified](#dxycalloutdropspecified) + +- [Callout:dxyCalloutGap](#dxycalloutgap) + +- [Callout:dxyCalloutLengthSpecified](#dxycalloutlengthspecified) + +- [Callout:spcoa](#spcoa) + +- [Callout:spcod](#spcod) + +- [FillStyle:Fill Style Boolean Properties](#fill-style-boolean-properties) + +- [FillStyle:fillAngle](#fillangle) + +- [FillStyle:fillBackColor](#fillbackcolor) + +- [FillStyle:fillBackOpacity](#fillbackopacity) + +- [FillStyle:fillBlip](#fillblip) + +- [FillStyle:fillBlipFlags](#fillblipflags) + +- [FillStyle:fillBlipName](#fillblipname) + +- [FillStyle:fillColor](#fillcolor) + +- [FillStyle:fillCrMod](#fillcrmod) + +- [FillStyle:fillDztype](#filldztype) + +- [FillStyle:fillFocus](#fillfocus) + +- [FillStyle:fillHeight](#fillheight) + +- [FillStyle:fillOpacity](#fillopacity) + +- [FillStyle:fillOriginX](#filloriginx) + +- [FillStyle:fillOriginY](#filloriginy) + +- [FillStyle:fillRectBottom](#fillrectbottom) + +- [FillStyle:fillRectLeft](#fillrectleft) + +- [FillStyle:fillRectRight](#fillrectright) + +- [FillStyle:fillRectTop](#fillrecttop) + +- [FillStyle:fillShadeColors](#fillshadecolors) + +- [FillStyle:fillShadePreset](#fillshadepreset) + +- [FillStyle:fillShadeType](#fillshadetype) + +- [FillStyle:fillShapeOriginX](#fillshapeoriginx) + +- [FillStyle:fillShapeOriginY](#fillshapeoriginy) + +- [FillStyle:fillToBottom](#filltobottom) + +- [FillStyle:fillToLeft](#filltoleft) + +- [FillStyle:fillToRight](#filltoright) + +- [FillStyle:fillToTop](#filltotop) + +- [FillStyle:fillType](#filltype) + +- [FillStyle:fillWidth](#fillwidth) + +- [Geometry:adjust2Value](#adjust2value) + +- [Geometry:adjust3Value](#adjust3value) + +- [Geometry:adjust4Value](#adjust4value) + +- [Geometry:adjust5Value](#adjust5value) + +- [Geometry:adjust6Value](#adjust6value) + +- [Geometry:adjust7Value](#adjust7value) + +- [Geometry:adjust8Value](#adjust8value) + +- [Geometry:adjustValue](#adjustvalue) + +- [Geometry:cxk](#cxk) + +- [Geometry:geoBottom](#geobottom) + +- [Geometry:geoLeft](#geoleft) + +- [Geometry:Geometry Boolean Properties](#geometry-boolean-properties) + +- [Geometry:geoRight](#georight) + +- [Geometry:geoTop](#geotop) + +- [Geometry:pAdjustHandles](#padjusthandles) + +- [Geometry:pConnectionSites](#pconnectionsites) + +- [Geometry:pConnectionSitesDir](#pconnectionsitesdir) + +- [Geometry:pGuides](#pguides) + +- [Geometry:pInscribe](#pinscribe) + +- [Geometry:pSegmentInfo](#psegmentinfo) + +- [Geometry:pVertices](#pvertices) + +- [Geometry:shapePath](#shapepath) + +- [Geometry:xLimo](#xlimo) + +- [Geometry:yLimo](#ylimo) + +- [GeoText:Geometry Text Boolean Properties](#geometry-text-boolean-properties) + +- [GeoText:gtextAlign](#gtextalign) + +- [GeoText:gtextFont](#gtextfont) + +- [GeoText:gtextSize](#gtextsize) + +- [GeoText:gtextSpacing](#gtextspacing) + +- [GeoText:gtextUNICODE](#gtextunicode) + +- [GroupShape:dyWrapDistBottom](#dywrapdistbottom) + +- [GroupShape:dxWrapDistLeft](#dxwrapdistleft) + +- [GroupShape:dxWrapDistRight](#dxwrapdistright) + +- [GroupShape:dyWrapDistTop](#dywrapdisttop) + +- [GroupShape:Group Shape Boolean Properties](#group-shape-boolean-properties) + +- [GroupShape:lidRegroup](#lidregroup) + +- [GroupShape:pihlShape](#pihlshape) + +- [GroupShape:pWrapPolygonVertices](#pwrappolygonvertices) + +- [GroupShape:wzDescription](#wzdescription) + +- [GroupShape:wzName](#wzname) + +- [LineStyle:Line Style Boolean Properties](#line-style-boolean-properties) + +- [LineStyle:lineBackColor](#linebackcolor) + +- [LineStyle:lineColor](#linecolor) + +- [LineStyle:lineCrMod](#linecrmod) + +- [LineStyle:lineDashing](#linedashing) + +- [LineStyle:lineDashStyle](#linedashstyle) + +- [LineStyle:lineEndCapStyle](#lineendcapstyle) + +- [LineStyle:lineEndArrowhead](#lineendarrowhead) + +- [LineStyle:lineEndArrowLength](#lineendarrowlength) + +- [LineStyle:lineEndArrowWidth](#lineendarrowwidth) + +- [LineStyle:lineFillBlip](#linefillblip) + +- [LineStyle:lineFillBlipFlags](#linefillblipflags) + +- [LineStyle:lineFillBlipName](#linefillblipname) + +- [LineStyle:lineFillDztype](#linefilldztype) + +- [LineStyle:lineFillHeight](#linefillheight) + +- [LineStyle:lineOpacity](#lineopacity) + +- [LineStyle:lineFillWidth](#linefillwidth) + +- [LineStyle:lineJoinStyle](#linejoinstyle) + +- [LineStyle:lineMiterLimit](#linemiterlimit) + +- [LineStyle:lineStartArrowhead](#linestartarrowhead) + +- [LineStyle:lineStartArrowLength](#linestartarrowlength) + +- [LineStyle:lineStartArrowWidth](#linestartarrowwidth) + +- [LineStyle:lineStyle](#linestyle) + +- [LineStyle:lineWidth](#linewidth) + +- [LineStyle:lineType](#linetype) + +- [PerspectiveStyle:Perspective Style Boolean Properties](#perspective-style-boolean-properties) + +- [PerspectiveStyle:perspectiveOffsetX](#perspectiveoffsetx) + +- [PerspectiveStyle:perspectiveOffsetY](#perspectiveoffsety) + +- [PerspectiveStyle:perspectiveOriginX](#perspectiveoriginx) + +- [PerspectiveStyle:perspectiveOriginY](#perspectiveoriginy) + +- [PerspectiveStyle:perspectivePerspectiveX](#perspectiveperspectivex) + +- [PerspectiveStyle:perspectivePerspectiveY](#perspectiveperspectivey) + +- [PerspectiveStyle:perspectiveScaleXToX](#perspectivescalextox) + +- [PerspectiveStyle:perspectiveScaleXToY](#perspectivescalextoy) + +- [PerspectiveStyle:perspectiveScaleYToX](#perspectivescaleytox) + +- [PerspectiveStyle:perspectiveScaleYToY](#perspectivescaleytoy) + +- [PerspectiveStyle:perspectiveType](#perspectivetype) + +- [PerspectiveStyle:perspectiveWeight](#perspectiveweight) + +- [Protection:Protection Boolean Properties](#protection-boolean-properties) + +- [RelXfrm:gvRelPage](#gvrelpage) + +- [RelXfrm:Relative Transform Boolean Properties](#relative-transform-boolean-properties) + +- [RelXfrm:relBottom](#relbottom) + +- [RelXfrm:relLeft](#relleft) + +- [RelXfrm:relRight](#relright) + +- [RelXfrm:relRotation](#relrotation) + +- [RelXfrm:relTop](#reltop) + +- [ShadowStyle:Shadow Style Boolean Properties](#shadow-style-boolean-properties) + +- [ShadowStyle:shadowColor](#shadowcolor) + +- [ShadowStyle:shadowCrMod](#shadowcrmod) + +- [ShadowStyle:shadowHighlight](#shadowhighlight) + +- [ShadowStyle:shadowOffsetX](#shadowoffsetx) + +- [ShadowStyle:shadowOffsetY](#shadowoffsety) + +- [ShadowStyle:shadowOpacity](#shadowopacity) + +- [ShadowStyle:shadowOriginX](#shadoworiginx) + +- [ShadowStyle:shadowOriginY](#shadoworiginy) + +- [ShadowStyle:shadowSecondOffsetX](#shadowsecondoffsetx) + +- [ShadowStyle:shadowSecondOffsetY](#shadowsecondoffsety) + +- [ShadowStyle:shadowType](#shadowtype) + +- [Shape:bWMode](#bwmode) + +- [Shape:bWModeBW](#bwmodebw) + +- [Shape:bWModePureBW](#bwmodepurebw) + +- [Shape:hspMaster](#hspmaster) + +- [Shape:cxstyle](#cxstyle) + +- [Shape:Shape Boolean Properties](#shape-boolean-properties) + +- [Text:anchorText](#anchortext) + +- [Text:dyTextBottom](#dytextbottom) + +- [Text:dxTextLeft](#dxtextleft) + +- [Text:dxTextRight](#dxtextright) + +- [Text:dyTextTop](#dytexttop) + +- [Text:lTxid](#ltxid) + +- [Text:WrapText](#wraptext) + +- [Text:txflTextFlow](#txfltextflow) + +- [Text:cdirFont](#cdirfont) + +- [Text:hspNext](#hspnext) + +- [Text:Text Boolean Properties](#text-boolean-properties) + +- [Text:txdir](#txdir) + +- [3DObject:c3DCrMod](#c3dcrmod) + +- [3DObject:c3DDiffuseAmt](#c3ddiffuseamt) + +- [3DObject:c3DEdgeThickness](#c3dedgethickness) + +- [3DObject:c3DExtrudeBackward](#c3dextrudebackward) + +- [3DObject:c3DExtrudeForward](#c3dextrudeforward) + +- [3DObject:c3DExtrusionColor](#c3dextrusioncolor) + +- [3DObject:c3DShininess](#c3dshininess) + +- [3DObject:c3DSpecularAmt](#c3dspecularamt) + +- [3DObject:3D-Object Boolean Properties](#d-object-boolean-properties) + +- [3DStyle:c3DAmbientIntensity](#c3dambientintensity) + +- [3DStyle:c3DFillIntensity](#c3dfillintensity) + +- [3DStyle:c3DFillX](#c3dfillx) + +- [3DStyle:c3DFillY](#c3dfilly) + +- [3DStyle:c3DFillZ](#c3dfillz) + +- [3DStyle:c3DKeyIntensity](#c3dkeyintensity) + +- [3DStyle:c3DKeyX](#c3dkeyx) + +- [3DStyle:c3DKeyY](#c3dkeyy) + +- [3DStyle:c3DKeyZ](#c3dkeyz) + +- [3DStyle:c3DOriginX](#c3doriginx) + +- [3DStyle:c3DOriginY](#c3doriginy) + +- [3DStyle:c3DRenderMode](#c3drendermode) + +- [3DStyle:c3DRotationAngle](#c3drotationangle) + +- [3DStyle:c3DRotationAxisX](#c3drotationaxisx) + +- [3DStyle:c3DRotationAxisY](#c3drotationaxisy) + +- [3DStyle:c3DRotationAxisZ](#c3drotationaxisz) + +- [3DStyle:c3DYRotationAngle](#c3dyrotationangle) + +- [3DStyle:c3DXRotationAngle](#c3dxrotationangle) + +- [3DStyle:c3DRotationCenterX](#c3drotationcenterx) + +- [3DStyle:c3DRotationCenterY](#c3drotationcentery) + +- [3DStyle:c3DRotationCenterZ](#c3drotationcenterz) + +- [3DStyle:c3DSkewAmount](#c3dskewamount) + +- [3DStyle:c3DSkewAngle](#c3dskewangle) + +- [3DStyle:c3DTolerance](#c3dtolerance) + +- [3DStyle:c3DXViewpoint](#c3dxviewpoint) + +- [3DStyle:c3DYViewpoint](#c3dyviewpoint) + +- [3DStyle:c3DZViewpoint](#c3dzviewpoint) + +- [3DStyle: 3D-Style Boolean Properties](#d-style-boolean-properties) + +- [Xfrm:bottom](#bottom) + +- [Xfrm:gvPage](#gvpage) + +- [Xfrm:left](#left) + +- [Xfrm:right](#right) + +- [Xfrm:rotation](#rotation) + +- [Xfrm:top](#top) + +- [Xfrm:Transform Boolean Properties](#transform-boolean-properties) + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x3. | +| **rh.recInstance** | An unsigned integer that specifies the number of properties in the table. | +| **rh.recType** | A value that MUST be 0xF00B. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain property records. This value equals the number of properties multiplied by the size of the **OfficeArtFOPTE** type, as defined in section [2.2.7](#officeartfopte), plus the size of the complex property data. | + +**fopt (variable):** The **OfficeArtRGFOPTE** property, as defined in section 2.3.1, table that specifies the record data. + +### OfficeArtSecondaryFOPT + +*Referenced by: [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtSecondaryFOPT** record specifies a table of **OfficeArtRGFOPTE** records, as defined in section [2.3.1](#officeartrgfopte). The [Blip:movie](#movie) property can be specified in this table. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields.: + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x3. | +| **rh.recInstance** | An unsigned integer that specifies the number of properties in the table. | +| **rh.recType** | A value that MUST be 0xF121. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain property records. This value equals the number of properties multiplied by the size of the **OfficeArtFOPTE** type, as defined in section [2.2.7](#officeartfopte), plus the size of the complex property data. | + +**fopt (variable):** The **OfficeArtRGFOPTE** record, as defined in section 2.3.1, table that specifies the property data. + +### OfficeArtTertiaryFOPT + +*Referenced by: [OfficeArtDggContainer](#officeartdggcontainer), [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtTertiaryFOPT** record specifies a table of **OfficeArtRGFOPTE** records, as defined in section [2.3.1](#officeartrgfopte). This table SHOULD specify the following properties: + +- [Blip:Blip Boolean Properties](#blip-boolean-properties) + +- [Blip:pictureRecolor](#picturerecolor) + +- [Blip:pictureRecolorExt](#picturerecolorext) + +- [Blip:pictureRecolorExtMod](#picturerecolorextmod) + +- [Blip:pictureTransparentExt](#picturetransparentext) + +- [Blip:pictureTransparentExtMod](#picturetransparentextmod) + +- [Diagram:dgmBaseTextScale](#dgmbasetextscale) + +- [Diagram:dgmConstrainBounds](#dgmconstrainbounds) + +- [Diagram:dgmDefaultFontSize](#dgmdefaultfontsize) + +- [Diagram:dgmScaleX](#dgmscalex) + +- [Diagram:dgmScaleY](#dgmscaley) + +- [Diagram:dgmStyle](#dgmstyle) + +- [Diagram:dgmt](#dgmt) + +- [Diagram:Diagram Boolean Properties](#diagram-boolean-properties) + +- [Diagram:pRelationTbl](#prelationtbl) + +- [Geometry:Geometry Boolean Properties](#geometry-boolean-properties) + +- [GeoText:gtextCSSFont](#gtextcssfont) + +- [GroupShape:alignHR](#alignhr) + +- [GroupShape:borderBottomColor](#borderbottomcolor) + +- [GroupShape:borderLeftColor](#borderleftcolor) + +- [GroupShape:borderRightColor](#borderrightcolor) + +- [GroupShape:borderTopColor](#bordertopcolor) + +- [GroupShape:dhgt](#dhgt) + +- [GroupShape:dxHeightHR](#dxheighthr) + +- [GroupShape:dxWidthHR](#dxwidthhr) + +- [GroupShape:Group Shape Boolean Properties](#group-shape-boolean-properties) + +- [GroupShape:metroBlob](#metroblob) + +- [GroupShape:pctHR](#pcthr) + +- [GroupShape:posh](#posh) + +- [GroupShape:posrelh](#posrelh) + +- [GroupShape:posrelv](#posrelv) + +- [GroupShape:posv](#posv) + +- [GroupShape:scriptLang](#scriptlang) + +- [GroupShape:tableProperties](#tableproperties) + +- [GroupShape:tableRowProperties](#tablerowproperties) + +- [GroupShape:wzScript](#wzscript) + +- [GroupShape:wzScriptExtAttr](#wzscriptextattr) + +- [GroupShape:wzScriptLangAttr](#wzscriptlangattr) + +- [GroupShape:wzTooltip](#wztooltip) + +- [GroupShape:wzWebBot](#wzwebbot) + +- [GroupShape2:pctHoriz](#pcthoriz) + +- [GroupShape2:pctHorizPos](#pcthorizpos) + +- [GroupShape2:pctVert](#pctvert) + +- [GroupShape2:pctVertPos](#pctvertpos) + +- [GroupShape2:sizerelh](#sizerelh) + +- [GroupShape2:sizerelv](#sizerelv) + +- [FillStyle:fillBackColorExt](#fillbackcolorext) + +- [FillStyle:fillBackColorExtMod](#fillbackcolorextmod) + +- [FillStyle:fillColorExt](#fillcolorext) + +- [FillStyle:fillColorExtMod](#fillcolorextmod) + +- [FillStyle:Fill Style Boolean Properties](#fill-style-boolean-properties) + +- [Ink:Ink Boolean Properties](#ink-boolean-properties) + +- [Ink:pInkData](#pinkdata) + +- [LineBottomStyle:Bottom Line Style Boolean Properties](#bottom-line-style-boolean-properties) + +- [LineBottomStyle:lineBottomBackColor](#linebottombackcolor) + +- [LineBottomStyle:lineBottomBackColorExt](#linebottombackcolorext) + +- [LineBottomStyle:lineBottomBackColorExtMod](#linebottombackcolorextmod) + +- [LineBottomStyle:lineBottomColor](#linebottomcolor) + +- [LineBottomStyle:lineBottomColorExt](#linebottomcolorext) + +- [LineBottomStyle:lineBottomColorExtMod](#linebottomcolorextmod) + +- [LineBottomStyle:lineBottomCrMod](#linebottomcrmod) + +- [LineBottomStyle:lineBottomFillBlip](#linebottomfillblip) + +- [LineBottomStyle:lineBottomFillBlipFlags](#linebottomfillblipflags) + +- [LineBottomStyle:lineBottomFillBlipName](#linebottomfillblipname) + +- [LineBottomStyle:lineBottomFillDztype](#linebottomfilldztype) + +- [LineBottomStyle:lineBottomFillHeight](#linebottomfillheight) + +- [LineBottomStyle:lineBottomDashing](#linebottomdashing) + +- [LineBottomStyle:lineBottomDashStyle](#linebottomdashstyle) + +- [LineBottomStyle:lineBottomEndArrowhead](#linebottomendarrowhead) + +- [LineBottomStyle:lineBottomEndArrowLength](#linebottomendarrowlength) + +- [LineBottomStyle:lineBottomEndArrowWidth](#linebottomendarrowwidth) + +- [LineBottomStyle:lineBottomEndCapStyle](#linebottomendcapstyle) + +- [LineBottomStyle:lineBottomJoinStyle](#linebottomjoinstyle) + +- [LineBottomStyle:lineBottomMiterLimit](#linebottommiterlimit) + +- [LineBottomStyle:lineBottomFillWidth](#linebottomfillwidth) + +- [LineBottomStyle:lineBottomOpacity](#linebottomopacity) + +- [LineBottomStyle:lineBottomStartArrowhead](#linebottomstartarrowhead) + +- [LineBottomStyle:lineBottomStartArrowLength](#linebottomstartarrowlength) + +- [LineBottomStyle:lineBottomStartArrowWidth](#linebottomstartarrowwidth) + +- [LineBottomStyle:lineBottomStyle](#linebottomstyle) + +- [LineBottomStyle:lineBottomType](#linebottomtype) + +- [LineBottomStyle:lineBottomWidth](#linebottomwidth) + +- [LineLeftStyle:Left Line Style Boolean Properties](#left-line-style-boolean-properties) + +- [LineLeftStyle:lineLeftBackColor](#lineleftbackcolor) + +- [LineLeftStyle:lineLeftBackColorExt](#lineleftbackcolorext) + +- [LineLeftStyle:lineLeftBackColorExtMod](#lineleftbackcolorextmod) + +- [LineLeftStyle:lineLeftColor](#lineleftcolor) + +- [LineLeftStyle:lineLeftColorExt](#lineleftcolorext) + +- [LineLeftStyle:lineLeftColorExtMod](#lineleftcolorextmod) + +- [LineLeftStyle:lineLeftCrMod](#lineleftcrmod) + +- [LineLeftStyle:lineLeftDashing](#lineleftdashing) + +- [LineLeftStyle:lineLeftDashStyle](#lineleftdashstyle) + +- [LineLeftStyle:lineLeftEndArrowhead](#lineleftendarrowhead) + +- [LineLeftStyle:lineLeftEndArrowLength](#lineleftendarrowlength) + +- [LineLeftStyle:lineLeftEndArrowWidth](#lineleftendarrowwidth) + +- [LineLeftStyle:lineLeftEndCapStyle](#lineleftendcapstyle) + +- [LineLeftStyle:lineLeftFillBlip](#lineleftfillblip) + +- [LineLeftStyle:lineLeftFillBlipFlags](#lineleftfillblipflags) + +- [LineLeftStyle:lineLeftFillBlipName](#lineleftfillblipname) + +- [LineLeftStyle:lineLeftFillDztype](#lineleftfilldztype) + +- [LineLeftStyle:lineLeftFillHeight](#lineleftfillheight) + +- [LineLeftStyle:lineLeftMiterLimit](#lineleftmiterlimit) + +- [LineLeftStyle:lineLeftFillWidth](#lineleftfillwidth) + +- [LineLeftStyle:lineLeftJoinStyle](#lineleftjoinstyle) + +- [LineLeftStyle:lineLeftOpacity](#lineleftopacity) + +- [LineLeftStyle:lineLeftStartArrowhead](#lineleftstartarrowhead) + +- [LineLeftStyle:lineLeftStartArrowLength](#lineleftstartarrowlength) + +- [LineLeftStyle:lineLeftStartArrowWidth](#lineleftstartarrowwidth) + +- [LineLeftStyle:lineLeftStyle](#lineleftstyle) + +- [LineLeftStyle:lineLeftType](#linelefttype) + +- [LineLeftStyle:lineLeftWidth](#lineleftwidth) + +- [LineRightStyle:lineRightBackColor](#linerightbackcolor) + +- [LineRightStyle:lineRightBackColorExt](#linerightbackcolorext) + +- [LineRightStyle:lineRightBackColorExtMod](#linerightbackcolorextmod) + +- [LineRightStyle:lineRightColor](#linerightcolor) + +- [LineRightStyle:lineRightColorExt](#linerightcolorext) + +- [LineRightStyle:lineRightColorExtMod](#linerightcolorextmod) + +- [LineRightStyle:lineRightCrMod](#linerightcrmod) + +- [LineRightStyle:lineRightDashing](#linerightdashing) + +- [LineRightStyle:lineRightDashStyle](#linerightdashstyle) + +- [LineRightStyle:lineRightEndArrowhead](#linerightendarrowhead) + +- [LineRightStyle:lineRightEndArrowLength](#linerightendarrowlength) + +- [LineRightStyle:lineRightEndArrowWidth](#linerightendarrowwidth) + +- [LineRightStyle:lineRightEndCapStyle](#linerightendcapstyle) + +- [LineRightStyle:lineRightFillBlip](#linerightfillblip) + +- [LineRightStyle:lineRightFillBlipFlags](#linerightfillblipflags) + +- [LineRightStyle:lineRightFillBlipName](#linerightfillblipname) + +- [LineRightStyle:lineRightFillDztype](#linerightfilldztype) + +- [LineRightStyle:lineRightFillHeight](#linerightfillheight) + +- [LineRightStyle:lineRightFillWidth](#linerightfillwidth) + +- [LineRightStyle:lineRightJoinStyle](#linerightjoinstyle) + +- [LineRightStyle:lineRightMiterLimit](#linerightmiterlimit) + +- [LineRightStyle:lineRightOpacity](#linerightopacity) + +- [LineRightStyle:lineRightStartArrowhead](#linerightstartarrowhead) + +- [LineRightStyle:lineRightStartArrowLength](#linerightstartarrowlength) + +- [LineRightStyle:lineRightStartArrowWidth](#linerightstartarrowwidth) + +- [LineRightStyle:lineRightStyle](#linerightstyle) + +- [LineRightStyle:lineRightType](#linerighttype) + +- [LineRightStyle:lineRightWidth](#linerightwidth) + +- [LineRightStyle:Right Line Style Boolean Properties](#right-line-style-boolean-properties) + +- [LineStyle:lineBackColorExt](#linebackcolorext) + +- [LineStyle:lineBackColorExtMod](#linebackcolorextmod) + +- [LineStyle:lineColorExt](#linecolorext) + +- [LineStyle:lineColorExtMod](#linecolorextmod) + +- [LineStyle:Line Style Boolean Properties](#line-style-boolean-properties) + +- [LineTopStyle:lineTopBackColor](#linetopbackcolor) + +- [LineTopStyle:lineTopBackColorExt](#linetopbackcolorext) + +- [LineTopStyle:lineTopBackColorExtMod](#linetopbackcolorextmod) + +- [LineTopStyle:lineTopColor](#linetopcolor) + +- [LineTopStyle:lineTopColorExt](#linetopcolorext) + +- [LineTopStyle:lineTopColorExtMod](#linetopcolorextmod) + +- [LineTopStyle:lineTopCrMod](#linetopcrmod) + +- [LineTopStyle:lineTopDashing](#linetopdashing) + +- [LineTopStyle:lineTopDashStyle](#linetopdashstyle) + +- [LineTopStyle:lineTopEndArrowhead](#linetopendarrowhead) + +- [LineTopStyle:lineTopEndArrowLength](#linetopendarrowlength) + +- [LineTopStyle:lineTopEndArrowWidth](#linetopendarrowwidth) + +- [LineTopStyle:lineTopFillBlip](#linetopfillblip) + +- [LineTopStyle:lineTopFillBlipFlags](#linetopfillblipflags) + +- [LineTopStyle:lineTopFillBlipName](#linetopfillblipname) + +- [LineTopStyle:lineTopFillDztype](#linetopfilldztype) + +- [LineTopStyle:lineTopFillHeight](#linetopfillheight) + +- [LineTopStyle:lineTopFillWidth](#linetopfillwidth) + +- [LineTopStyle:lineTopJoinStyle](#linetopjoinstyle) + +- [LineTopStyle:lineTopMiterLimit](#linetopmiterlimit) + +- [LineTopStyle:lineTopStartArrowhead](#linetopstartarrowhead) + +- [LineTopStyle:lineTopStartArrowLength](#linetopstartarrowlength) + +- [LineTopStyle:lineTopStartArrowWidth](#linetopstartarrowwidth) + +- [LineTopStyle:lineTopEndCapStyle](#linetopendcapstyle) + +- [LineTopStyle:lineTopOpacity](#linetopopacity) + +- [LineTopStyle:lineTopStyle](#linetopstyle) + +- [LineTopStyle:lineTopType](#linetoptype) + +- [LineTopStyle:lineTopWidth](#linetopwidth) + +- [LineTopStyle:Top Line Style Boolean Properties](#top-line-style-boolean-properties) + +- [Protection:Protection Boolean Properties](#protection-boolean-properties) + +- [ShadowStyle:shadowColorExt](#shadowcolorext) + +- [ShadowStyle:shadowColorExtMod](#shadowcolorextmod) + +- [ShadowStyle:shadowHighlightExt](#shadowhighlightext) + +- [ShadowStyle:shadowHighlightExtMod](#shadowhighlightextmod) + +- [Shape:dgmLayout](#dgmlayout) + +- [Shape:dgmLayoutMRU](#dgmlayoutmru) + +- [Shape:dgmNodeKind](#dgmnodekind) + +- [Shape:equationXML](#equationxml) + +- [Shape:idDiscussAnchor](#iddiscussanchor) + +- [Shape:Shape Boolean Properties](#shape-boolean-properties) + +- [3DObject:c3DExtrusionColorExt](#c3dextrusioncolorext) + +- [3DObject:c3DExtrusionColorExtMod](#c3dextrusioncolorextmod) + +- [UnknownHTML:Unknown HTML Boolean Properties](#unknown-html-boolean-properties) + +- [UnknownHTML:wzCalloutId](#wzcalloutid) + +- [UnknownHTML:wzFillId](#wzfillid) + +- [UnknownHTML:wzFormulaeId](#wzformulaeid) + +- [UnknownHTML:wzGtextId](#wzgtextid) + +- [UnknownHTML:wzHandlesId](#wzhandlesid) + +- [UnknownHTML:wzLineId](#wzlineid) + +- [UnknownHTML:wzLockId](#wzlockid) + +- [UnknownHTML:wzPathId](#wzpathid) + +- [UnknownHTML:wzPerspectiveId](#wzperspectiveid) + +- [UnknownHTML:wzPictureId](#wzpictureid) + +- [UnknownHTML:wzShadowId](#wzshadowid) + +- [UnknownHTML:wzTextId](#wztextid) + +- [UnknownHTML:wzThreeDId](#wzthreedid) + +- [WebComponent:webComponentWzHtml](#webcomponentwzhtml) + +- [WebComponent:webComponentWzName](#webcomponentwzname) + +- [WebComponent:webComponentWzUrl](#webcomponentwzurl) + +- [WebComponent:Web Component Boolean Properties](#web-component-boolean-properties) + +- [SignatureLine:Signature Line Boolean Properties](#signature-line-boolean-properties) + +- [SignatureLine:wzSigSetupAddlXml](#wzsigsetupaddlxml) + +- [SignatureLine:wzSigSetupProvUrl](#wzsigsetupprovurl) + +- [SignatureLine:wzSigSetupId](#wzsigsetupid) + +- [SignatureLine:wzSigSetupProvId](#wzsigsetupprovid) + +- [SignatureLine:wzSigSetupSignInst](#wzsigsetupsigninst) + +- [SignatureLine:wzSigSetupSuggSigner](#wzsigsetupsuggsigner) + +- [SignatureLine:wzSigSetupSuggSigner2](#wzsigsetupsuggsigner2) + +- [SignatureLine:wzSigSetupSuggSignerEmail](#wzsigsetupsuggsigneremail) + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x3. | +| **rh.recInstance** | An unsigned integer that specifies the number of properties in the table. | +| **rh.recType** | A value that MUST be 0xF122. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain property records. This value equals the number of properties multiplied by the size of the **OfficeArtFOPTE** type, as defined in section [2.2.7](#officeartfopte), plus the size of the complex property data. | + +**fopt (variable):** The **OfficeArtRGFOPTE** record, as defined in section 2.3.1, table that specifies the property data. + +### OfficeArtDggContainer + +The **OfficeArtDggContainer** record type specifies the container for all the OfficeArt file records that contain document-wide data. [\<2\>](#Appendix_A_2) + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0xF. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF000. | +| **rh.recLen** | An unsigned integer specifying the number of bytes following the header that contain document-wide file records. | + +**drawingGroup (variable):** An **OfficeArtFDGGBlock** record, as defined in section [2.2.48](#officeartfdggblock), that specifies document-wide information about all the [**drawings**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) that are saved in the file. + +**blipStore (variable):** An **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer), that specifies the container for all the [**BLIPs**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that are used in all the drawings in the parent document. + +**drawingPrimaryOptions (variable):** An **OfficeArtFOPT** record, as defined in section [2.2.9](#officeartfopt), that specifies the default properties for all [**drawing objects**](#gt_51dfe494-9c84-4a0e-9d53-06068c5ce3ac) that are contained in all the drawings in the parent document. + +**drawingTertiaryOptions (variable):** An **OfficeArtTertiaryFOPT** record, as defined in section [2.2.11](#officearttertiaryfopt), that specifies the default properties for all the drawing objects that are contained in all the drawings in the parent document. + +**colorMRU (variable):** An **OfficeArtColorMRUContainer** record, as defined in section [2.2.43](#officeartcolormrucontainer), that specifies the most recently used custom colors. + +**splitColors (variable):** An **OfficeArtSplitMenuColorContainer** record, as defined in section [2.2.45](#officeartsplitmenucolorcontainer), that specifies a container for the colors that were most recently used to format [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +### OfficeArtDgContainer + +The **OfficeArtDgContainer** record specifies the container for all the file records for the objects in a [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0xF. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF002. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain drawing-wide file records. | + +**drawingData (16 bytes):** An **OfficeArtFDG** record, as defined in section [2.2.49](#officeartfdg), that specifies the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) count, drawing identifier, and shape identifier of the last shape in this drawing. + +**regroupItems (variable):** An optional **OfficeArtFRITContainer** record, as defined in section [2.2.41](#officeartfritcontainer), that specifies a container for the table of [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) identifiers for regrouping ungrouped shapes. + +**groupShape (variable):** An **OfficeArtSpgrContainer** record, as defined in section [2.2.16](#officeartspgrcontainer), that specifies a container for groups of shapes. + +**shape (variable):** An **OfficeArtSpContainer** record, as defined in section [2.2.14](#officeartspcontainer), that specifies a container for the shapes that are not contained in a group. + +**solvers1 (variable):** An **OfficeArtSolverContainer** record, as defined in section [2.2.18](#officeartsolvercontainer), that specifies a container for the [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) that are applicable to the shapes contained in this drawing. + +**deletedShapes (variable):** An optional array of **OfficeArtSpgrContainerFileBlock** records, as defined in section [2.2.17](#officeartspgrcontainerfileblock), that specifies the deleted shapes. For more information, see section [2.2.37](#officeartfpspl). The array continues if the **rh.recType** field of the **OfficeArtSpgrContainerFileBlock** record, as defined in section 2.2.17, equals 0xF003 or 0xF004. This array MAY[\<3\>](#Appendix_A_3) exist. + +**solvers2 (variable):** An **OfficeArtSolverContainer** record, as defined in section 2.2.18, that specifies a container for additional rules that are applicable to the shapes contained in this drawing. + +### OfficeArtSpContainer + +*Referenced by: [OfficeArtDgContainer](#officeartdgcontainer), [OfficeArtInlineSpContainer](#officeartinlinespcontainer), [OfficeArtSpgrContainerFileBlock](#officeartspgrcontainerfileblock)* + +The **OfficeArtSpContainer** record specifies a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) container. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader) that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0xF. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF004. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain shape records. | + +**shapeGroup (24 bytes):** An optional **OfficeArtFSPGR** record, as defined in section [2.2.38](#officeartfspgr), that specifies the coordinate system of the [**group shape**](#gt_b2238184-3c83-4e64-babb-08b02a9138db). The [**anchors**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997) of the [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) shape are expressed in this coordinate system. This record’s container MUST be a group shape. + +**shapeProp (16 bytes):** An **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), that specifies an instance of a shape. + +**deletedShape (12 bytes):** An optional **OfficeArtFPSPL** record, as defined in section [2.2.37](#officeartfpspl), that specifies the former hierarchical position of the containing object. This record’s container MUST be a deleted shape. For more information, see **OfficeArtFPSPL**. + +**shapePrimaryOptions (variable):** An **OfficeArtFOPT** record, as defined in section [2.2.9](#officeartfopt), that specifies the properties of this shape that do not contain default values. + +**shapeSecondaryOptions1 (variable):** An optional **OfficeArtSecondaryFOPT** record, as defined in section [2.2.10](#officeartsecondaryfopt), that specifies the properties of this shape that do not contain default values. + +**shapeTertiaryOptions1 (variable):** An optional **OfficeArtTertiaryFOPT** record, as defined in section [2.2.11](#officearttertiaryfopt), that specifies the properties of this shape that do not contain default values. + +**childAnchor (24 bytes):** An optional **OfficeArtChildAnchor** record, as defined in section [2.2.39](#officeartchildanchor), that specifies the anchor for this shape. This record’s container MUST be a member of a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) of shapes. + +**clientAnchor (variable):** An optional **OfficeArtClientAnchor** ([\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) section 2.7.1 or [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.9.168) record as specified by the host application. + +**clientData (variable):** An **OfficeArtClientData** (\[MS-PPT\] section 2.7.3 or \[MS-DOC\] section 2.9.169) record as specified by the host application. + +**clientTextbox (variable):** An **OfficeArtClientTextbox** (\[MS-PPT\] section 2.9.76 or \[MS-DOC\] section 2.9.170) record as specified by the host application. + +**shapeSecondaryOptions2 (variable):** An optional **OfficeArtSecondaryFOPT** record that specifies the properties of this shape that do not contain default values. This field MUST NOT exist if **shapeSecondaryOptions1** exists. + +**shapeTertiaryOptions2 (variable):** An optional **OfficeArtTertiaryFOPT** record, as defined in section 2.2.11, that specifies the properties of this shape that do not contain default values. This field MUST NOT exist if **shapeTertiaryOptions1** exists. + +### OfficeArtInlineSpContainer + +The **OfficeArtInlineSpContainer** record specifies a container for inline [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This record SHOULD[\<4\>](#Appendix_A_4) be ignored. + +[TABLE] + +**shape (variable):** An **OfficeArtSpContainer** record, as defined in section [2.2.14](#officeartspcontainer), that specifies an instance of a shape. + +**rgfb (variable):** An array of **OfficeArtBStoreContainerFileBlock** records, as defined in section [2.2.22](#officeartbstorecontainerfileblock), that specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) data. The array continues if the **rh.recType** field of the **OfficeArtBStoreContainerFileBlock** record equals either 0xF007 or a value from 0xF018 through 0xF117, inclusive. + +BLIP properties contained in **shape.shapePrimaryOptions** or **shape.shapeTertiaryOptions1** are stored in this array in the order they are encountered, and the property values **OfficeArtFOPTE.opid.fBid**, **OfficeArtFOPTE.opid.fComplex**, and **OfficeArtFOPTE.op** MUST be ignored. + +### OfficeArtSpgrContainer + +*Referenced by: [OfficeArtDgContainer](#officeartdgcontainer), [OfficeArtSpgrContainerFileBlock](#officeartspgrcontainerfileblock)* + +The **OfficeArtSpgrContainer** record specifies a container for [**groups**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) of [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The group container contains a variable number of shape containers and other group containers. Each group is a shape. The first container MUST be an **OfficeArtSpContainer** record, as defined in section [2.2.14](#officeartspcontainer), which MUST contain shape information for the group. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0xF. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF003. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain group or shape container records. This value MUST be the size, in bytes, of **rgfb**. | + +**rgfb (variable):** An array of **OfficeArtSpgrContainerFileBlock** records, as defined in section 2.2.17, that specifies the groups or shapes that are contained within this group. + +### OfficeArtSpgrContainerFileBlock + +*Referenced by: [OfficeArtDgContainer](#officeartdgcontainer), [OfficeArtSpgrContainer](#officeartspgrcontainer)* + +The **OfficeArtSpgrContainerFileBlock** record specifies a file block that contains a record specifying [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) or [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) data. The **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), of the contained record specifies the type of record. The following table lists the possible record types. + +| Value | Meaning | +|----|----| +| 0xF004 | **OfficeArtSpContainer** record, as defined in section [2.2.14](#officeartspcontainer). | +| 0xF003 | **OfficeArtSpgrContainer** record, as defined in section 2.2.16. | + +### OfficeArtSolverContainer + +*Referenced by: [OfficeArtDgContainer](#officeartdgcontainer)* + +The **OfficeArtSolverContainer** record specifies a container for the [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) that are applicable to the [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) contained in an **OfficeArtDgContainer** record, as defined in section 2.2.13. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0xF. | +| **rh.recInstance** | An unsigned integer that specifies the number of contained **OfficeArtSolverContainerFileBlock** records, as defined in section [2.2.19](#officeartsolvercontainerfileblock). | +| **rh.recType** | A value that MUST be 0xF005. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain **OfficeArtSolverContainerFileBlock** records, as defined in section 2.2.19. This value MUST be the size, in bytes, of **rgfb**. | + +**rgfb (variable):** An array of **OfficeArtSolverContainerFileBlock** records, as defined in section 2.2.19, specifying a collection of rules that are applicable to the shapes contained in an **OfficeArtDgContainer** record, as defined in section 2.2.13. + +### OfficeArtSolverContainerFileBlock + +*Referenced by: [OfficeArtSolverContainer](#officeartsolvercontainer)* + +The **OfficeArtSolverContainerFileBlock** record specifies a file block that contains a record specifying [**rule**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) data. The **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), of the contained record specifies the type of record. The following table lists the possible record types. + +| Value | Meaning | +|----|----| +| 0xF012 | **OfficeArtFConnectorRule**, as defined in section [2.2.36](#officeartfconnectorrule). | +| 0xF014 | **OfficeArtFArcRule**, as defined in section [2.2.35](#officeartfarcrule). | +| 0xF017 | **OfficeArtFCalloutRule**, as defined in section [2.2.34](#officeartfcalloutrule). | + +### OfficeArtBStoreContainer + +*Referenced by: [OfficeArtDggContainer](#officeartdggcontainer)* + +The **OfficeArtBStoreContainer** record specifies the container for all the [**BLIPs**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that are used in all the [**drawings**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) associated with the parent **OfficeArtDggContainer** record, as defined in section 2.2.12. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0xF. | +| **rh.recInstance** | An unsigned integer that specifies the number of contained **OfficeArtBStoreContainerFileBlock** records, as defined in section [2.2.22](#officeartbstorecontainerfileblock). | +| **rh.recType** | A value that MUST be 0xF001. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain **OfficeArtBStoreContainerFileBlock** records. This value MUST be the size, in bytes, of **rgfb**. | + +**rgfb (variable):** An array of **OfficeArtBStoreContainerFileBlock** records that specifies the BLIP data. + +### OfficeArtBStoreDelay + +The **OfficeArtBStoreDelay** record specifies the delay-loaded container of [**BLIPs**](#gt_f9c3c085-93c6-49a8-9043-591902711956) in the host application. No **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), exists for this container. + +[TABLE] + +**rgfb (variable):** An array of **OfficeArtBStoreContainerFileBlock** records, as defined in section [2.2.22](#officeartbstorecontainerfileblock), that specifies BLIP data. The array continues if the **rh.recType** field of the **OfficeArtBStoreContainerFileBlock** record equals either 0xF007 or a value from 0xF018 through 0xF117, inclusive. + +### OfficeArtBStoreContainerFileBlock + +*Referenced by: [OfficeArtBStoreContainer](#officeartbstorecontainer), [OfficeArtBStoreDelay](#officeartbstoredelay), [OfficeArtInlineSpContainer](#officeartinlinespcontainer)* + +The **OfficeArtBStoreContainerFileBlock** record specifies a file block that contains a record specifying [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) data. The **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), of the contained record specifies the type of record. The following table lists the possible record types. + +| Value | Meaning | +|----|----| +| 0xF007 | **OfficeArtFBSE** record, as defined in section [2.2.32](#officeartfbse). | +| 0xF018–0xF117 | **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip). | + +### OfficeArtBlip + +*Referenced by: [fillBlip_complex](#fillblip_complex), [lineBottomFillBlip_complex](#linebottomfillblip_complex), [lineFillBlip_complex](#linefillblip_complex), [lineLeftFillBlip_complex](#lineleftfillblip_complex), [lineRightFillBlip_complex](#linerightfillblip_complex), [lineTopFillBlip_complex](#linetopfillblip_complex), [OfficeArtBStoreContainerFileBlock](#officeartbstorecontainerfileblock), [OfficeArtFBSE](#officeartfbse), [pib_complex](#pib_complex), [pibPrint_complex](#pibprint_complex)* + +The **OfficeArtBlip** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data. The **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), specifies the type of BLIP record that is contained. The following table lists the possible record types. + +| Value | Meaning | +|----|----| +| 0xF01A | **OfficeArtBlipEMF**, as defined in section [2.2.24](#officeartblipemf). | +| 0xF01B | **OfficeArtBlipWMF**, as defined in section [2.2.25](#officeartblipwmf). | +| 0xF01C | **OfficeArtBlipPICT**, as defined in section [2.2.26](#officeartblippict). | +| 0xF01D | **OfficeArtBlipJPEG**, as defined in section [2.2.27](#officeartblipjpeg). | +| 0xF01E | **OfficeArtBlipPNG**, as defined in section [2.2.28](#officeartblippng). | +| 0xF01F | **OfficeArtBlipDIB**, as defined in section [2.2.29](#officeartblipdib). | +| 0xF029 | **OfficeArtBlipTIFF**, as defined in section [2.2.30](#officeartbliptiff). | +| 0xF02A | **OfficeArtBlipJPEG**, as defined in section 2.2.27.[\<5\>](#Appendix_A_5) | + +### OfficeArtBlipEMF + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipEMF** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the [**enhanced metafile format (EMF)**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36). + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value of 0x3D4 to specify one Unique ID (UID), or a value of 0x3D5 to specify two UIDs. | +| **rh.recType** | A value that MUST be 0xF01A. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of the **BLIPFileData** field plus 50 if **recInstance** equals 0x3D4, or the size of **BLIPFileData** plus 66 if **recInstance** equals 0x3D5. | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals 0x3D5. If this value is not 0, **rgbUid1** MUST be ignored. + +**metafileHeader (34 bytes):** An **OfficeArtMetafileHeader** record, as defined in section [2.2.31](#officeartmetafileheader), that specifies how to process the metafile in **BLIPFileData**. + +**BLIPFileData (variable):** A variable-length field that specifies the EMF data. + +### OfficeArtBlipWMF + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipWMF** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the Windows Metafile Format (WMF). + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value of 0x216 to specify one UID, or a value of 0x217 to specify two UIDs. | +| **rh.recType** | A value that MUST be 0xF01B. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **BLIPFileData** plus 50 if **recInstance** equals 0x216, or the size of **BLIPFileData** plus 66 if **recInstance** equals 0x217. | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals 0x217. If this value exists, **rgbUid1** MUST be ignored. + +**metafileHeader (34 bytes):** An **OfficeArtMetafileHeader** record, as defined in section [2.2.31](#officeartmetafileheader), that specifies how to process the metafile in **BLIPFileData**. + +**BLIPFileData (variable):** A variable-length field that specifies the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) data. + +### OfficeArtBlipPICT + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipPICT** record specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the [**Macintosh PICT**](#gt_467e07ae-91a8-4af9-9094-61d8e4400dae) format. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value of 0x542 to specify one UID, or a value of 0x543 to specify two UIDs. | +| **rh.recType** | A value that MUST be 0xF01C. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **BLIPFileData** plus 50 if **recInstance** equals 0x542, or the size of **BLIPFileData** plus 66 if **recInstance** equals 0x543. | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals 0x543. If this value exists, **rgbUid1** MUST be ignored. + +**metafileHeader (34 bytes):** An **OfficeArtMetafileHeader** record, as defined in section [2.2.31](#officeartmetafileheader), that specifies how to process the metafile in **BLIPFileData**. + +**BLIPFileData (variable):** A variable-length field that specifies the Macintosh PICT data. + +### OfficeArtBlipJPEG + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipJPEG** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the [**Joint Photographic Experts Group (JPEG)**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) format. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that is specified in the following table. | +| **rh.recType** | A value that MUST be 0xF01D. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **BLIPFileData** plus 17 if **recInstance** equals either 0x46A or 0x6E2, or the size of **BLIPFileData** plus 33 if **recInstance** equals either 0x46B or 0x6E3. | + +| Value of recInstance | Meaning | Number of unique identifiers | +|----------------------|--------------------------|------------------------------| +| 0x46A | JPEG in RGB color space | 1 | +| 0x46B | JPEG in RGB color space | 2 | +| 0x6E2 | JPEG in CMYK color space | 1 | +| 0x6E3 | JPEG in CMYK color space | 2 | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals either 0x46B or 0x6E3. If this value is specified, **rgbUid1** MUST be ignored. + +**tag (1 byte):** An unsigned integer that specifies an application-defined [**internal resource tag**](#gt_99235ecb-ad85-4d4a-adcb-6c67d30219a9). This value MUST be 0xFF for external files. + +**BLIPFileData (variable):** A variable-length field that specifies the JPEG data. + +### OfficeArtBlipPNG + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipPNG** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the **[Portable Network Graphics (PNG)](#gt_212c87ce-40ba-4311-be2a-494f1a116604)** format. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value of 0x6E0 to specify one UID, or a value of 0x6E1 to specify two UIDs. | +| **rh.recType** | A value that MUST be 0xF01E. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **BLIPFileData** plus 17 if **recInstance** equals 0x6E0, or the size of **BLIPFileData** plus 33 if **recInstance** equals 0x6E1. | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals 0x6E1. If this value exists, **rgbUid1** MUST be ignored. + +**tag (1 byte):** An unsigned integer that specifies an application-defined [**internal resource tag**](#gt_99235ecb-ad85-4d4a-adcb-6c67d30219a9). This value MUST be 0xFF for external files. + +**BLIPFileData (variable):** A variable-length field that specifies the PNG data. + +### OfficeArtBlipDIB + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipDIB** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the **[device-independent bitmap (DIB)](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091)** format. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value of 0x7A8 to specify one UID, or a value of 0x7A9 to specify two UIDs. | +| **rh.recType** | A value that MUST be 0xF01F. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **BLIPFileData** plus 17 if **recInstance** equals 0x7A8, or the size of **BLIPFileData** plus 33 if **recInstance** equals 0x7A9. | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals 0x7A9. If this value exists, **rgbUid1** MUST be ignored. + +**tag (1 byte):** An unsigned integer that specifies an application-defined [**internal resource tag**](#gt_99235ecb-ad85-4d4a-adcb-6c67d30219a9). This value MUST be 0xFF for external files. + +**BLIPFileData (variable):** A variable-length field that specifies the DIB data. + +### OfficeArtBlipTIFF + +*Referenced by: [OfficeArtBlip](#officeartblip)* + +The **OfficeArtBlipTIFF** record specifies [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) file data for the [**TIFF**](#gt_eddadea9-c278-4d16-9279-f222df2cb735) format. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value of 0x6E4 to specify one UID, or a value of 0x6E5 to specify two UIDs. | +| **rh.recType** | A value that MUST be 0xF029. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **BLIPFileData** plus 17 if **recInstance** equals 0x6E4, or the size of **BLIPFileData** plus 33 if **recInstance** equals 0x6E5. | + +**rgbUid1 (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the uncompressed **BLIPFileData**. + +**rgbUid2 (16 bytes):** An MD4 message digest, as specified in \[RFC1320\], that specifies the unique identifier of the uncompressed **BLIPFileData**. This field only exists if **recInstance** equals 0x6E5. If this value exists, **rgbUid1** MUST be ignored. + +**tag (1 byte):** An unsigned integer that specifies an application-defined [**internal resource tag**](#gt_99235ecb-ad85-4d4a-adcb-6c67d30219a9). This value MUST be 0xFF for external files. + +**BLIPFileData (variable):** A variable-length field that specifies the TIFF data. + +### OfficeArtMetafileHeader + +*Referenced by: [OfficeArtBlipEMF](#officeartblipemf), [OfficeArtBlipPICT](#officeartblippict), [OfficeArtBlipWMF](#officeartblipwmf)* + +The **OfficeArtMetafileHeader** record specifies how to process a metafile. + +[TABLE] + +**cbSize (4 bytes):** An unsigned integer that specifies the uncompressed size, in bytes, of the metafile. + +**rcBounds (16 bytes):** A **RECT** structure, as defined in section [2.2.56](#rect), that specifies the clipping region of the metafile. + +**ptSize (8 bytes):** A **POINT** structure, as defined in section [2.2.55](#point), that specifies the size, in [**English Metric Units (EMUs)**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), in which to render the metafile. + +**cbSave (4 bytes):** An unsigned integer that specifies the compressed size, in bytes, of the metafile. + +**compression (1 byte):** An unsigned integer that specifies the compression method that was used. A value of 0x00 specifies the DEFLATE compression method, as specified in [\[RFC1950\]](https://go.microsoft.com/fwlink/?LinkId=90301). A value of 0xFE specifies no compression. + +**filter (1 byte):** An unsigned integer that MUST be 0xFE. + +### OfficeArtFBSE + +*Referenced by: [OfficeArtBStoreContainerFileBlock](#officeartbstorecontainerfileblock)* + +The **OfficeArtFBSE** record specifies a File [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) Store Entry (FBSE) that contains information about the BLIP. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x2. | +| **rh.recInstance** | An **MSOBLIPTYPE** enumeration value, as defined in section [2.4.1](#msobliptype), that specifies the BLIP type and MUST match either **btWin32** or **btMacOS**. | +| **rh.recType** | A value that MUST be 0xF007. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header. This value MUST be the size of **nameData** plus 36 if the BLIP is not embedded in this record, or the size of **nameData** plus **size** plus 36 if the BLIP is embedded in this record. | + +**btWin32 (1 byte):** An **MSOBLIPTYPE** enumeration value, as defined in section 2.4.1, that specifies the Windows BLIP type. If the **btMacOS** value is supported by the Windows operating system, this value MUST match **btMacOS**. If the values of **btWin32** and **btMacOS** are different, the BLIP that matches **rh.recInstance** MUST be present and the other MAY be present. + +**btMacOS (1 byte):** An **MSOBLIPTYPE** enumeration value, as defined in section 2.4.1, that specifies the Macintosh BLIP type. If the **btWin32** value is supported by the Macintosh operating system, this value MUST match **btWin32**. If the values of **btWin32** and **btMacOS** are different, the BLIP that matches **rh.recInstance** MUST be present and the other MAY be present. + +**rgbUid (16 bytes):** An MD4 message digest, as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274), that specifies the unique identifier of the pixel data in the BLIP. + +**tag (2 bytes):** An unsigned integer that specifies an application-defined [**internal resource tag**](#gt_99235ecb-ad85-4d4a-adcb-6c67d30219a9). This value MUST be 0xFF for external files. + +**size (4 bytes):** An unsigned integer that specifies the size, in bytes, of the BLIP in the stream. + +**cRef (4 bytes):** An unsigned integer that specifies the number of references to the BLIP. A value of 0x00000000 specifies an empty slot in the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). + +**foDelay (4 bytes):** An **MSOFO** structure, as defined in section [2.1.4](#msofo), that specifies the file offset into the associated **OfficeArtBStoreDelay** record, as defined in section [2.2.21](#officeartbstoredelay), (delay stream). A value of 0xFFFFFFFF specifies that the file is not in the delay stream, and in this case, **cRef** MUST be 0x00000000. + +**unused1 (1 byte):** A value that is undefined and MUST be ignored. + +**cbName (1 byte):** An unsigned integer that specifies the length, in bytes, of the **nameData** field, including the terminating NULL character. This value MUST be an even number and less than or equal to 0xFE. If the value is 0x00, **nameData** will not be written. + +**unused2 (1 byte):** A value that is undefined and MUST be ignored. + +**unused3 (1 byte):** A value that is undefined and MUST be ignored. + +**nameData (variable):** A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) null-terminated string that specifies the name of the BLIP. + +**embeddedBlip (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), specifying the BLIP file data that is embedded in this record. If this value is not 0, **foDelay** MUST be ignored. + +### OfficeArtFDGSL + +The **OfficeArtFDGSL** record specifies both the selected [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) and the shape that is in focus in the [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). This record SHOULD[\<6\>](#Appendix_A_6) be ignored. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|------------------------------------------------| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF119. | +| **rh.recLen** | A value that is undefined and MUST be ignored. | + +**cpsp (4 bytes):** A value that is undefined and MUST be ignored. + +**dgslk (4 bytes):** An **MSODGSLK** enumeration value, as defined in section [2.4.28](#msodgslk), that specifies the selection mode. + +**spidFocus (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), specifying the identifier of the shape that is in focus. + +**shapeList (variable):** An array of **MSOSPID** elements, as defined in section 2.1.2, that specify the identifiers of the selected shapes. The number of elements is specified by the following formula: + +> (size of record data, as specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.1.4, - 20) / 4 + +### OfficeArtFCalloutRule + +*Referenced by: [OfficeArtSolverContainerFileBlock](#officeartsolvercontainerfileblock)* + +The **OfficeArtFCalloutRule** record specifies a [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a) [**rule**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f). One callout rule MUST exist per callout [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF017. | +| **rh.recLen** | A value that MUST be 0x00000008. | + +**ruid (4 bytes):** An unsigned integer that specifies the identifier of this callout rule. + +**spid (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies the identifier of the callout shape. + +### OfficeArtFArcRule + +*Referenced by: [OfficeArtSolverContainerFileBlock](#officeartsolvercontainerfileblock)* + +The **OfficeArtFArcRule** record specifies an arc [**rule**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f). Each arc **[shape](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e)** MUST correspond to a unique arc rule. This record SHOULD[\<7\>](#Appendix_A_7) be persisted. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF014. | +| **rh.recLen** | A value that MUST be 0x00000008. | + +**ruid (4 bytes):** An unsigned integer that specifies the identifier of this arc rule. + +**spid (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies the identifier of the arc shape. + +### OfficeArtFConnectorRule + +*Referenced by: [OfficeArtSolverContainerFileBlock](#officeartsolvercontainerfileblock)* + +The **OfficeArtFConnectorRule** record specifies the connection between two [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that exists via a [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape. This record MAY[\<8\>](#Appendix_A_8) be ignored. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x1. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF012. | +| **rh.recLen** | A value that MUST be 0x00000018. | + +**ruid (4 bytes):** An unsigned integer that specifies the identifier of this [**rule**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f). + +**spidA (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies the identifier of the shape where the connector shape starts. + +**spidB (4 bytes):** An **MSOSPID** structure, as defined in section 2.1.2, that specifies the identifier of the shape where the connector shape ends. + +**spidC (4 bytes):** An **MSOSPID** structure, as defined in section 2.1.2, that specifies the identifier of the connector shape. + +**cptiA (4 bytes):** An unsigned integer that specifies the **[connection site](#gt_57020094-5e23-4456-b71c-58b8be42b92d)** index of the shape where the connector shape starts. If the shape is available, this value MUST be within its range of valid connection site indexes. Otherwise, this value is ignored. + +**cptiB (4 bytes):** An unsigned integer that specifies the connection site index of the shape where the connector shape ends. If the shape is available, this value MUST be within its range of valid connection site indexes. Otherwise, this value is ignored. + +### OfficeArtFPSPL + +*Referenced by: [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtFPSPL** record specifies the former hierarchical position of the containing object that is either a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) or a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) of shapes. This record MUST be present only if the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), of the containing **OfficeArtSpContainer**, as defined in section 2.2.14, has a value of 0x1 for **fDeleted** and a value of 0x0 for **fChild**. This record’s containing object was formerly subsequent or antecedent to the object that is referenced by **spid**, as a member of the container directly containing that object. This record MAY[\<9\>](#Appendix_A_9) be used in some documents. If **spid** equals zero or specifies the containing shape, this record MUST be ignored. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF11D. | +| **rh.recLen** | A value that MUST be 0x00000004. | + +**spid (30 bits):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies another shape or group of shapes that is contained in the same **OfficeArtDgContainer** record, as defined in section [2.2.13](#officeartdgcontainer). This other object contains an **OfficeArtFSP** record, as defined in section 2.2.40, with an equivalently valued **spid** field. + +**A - reserved1 (1 bit):** A value that MUST be zero and MUST be ignored. + +**B - fLast (1 bit):** A bit that specifies the ordering of this record’s containing object and the object that is specified by **spid**. The following table specifies the meaning of each value for this bit. + +| Value | Meaning | +|----|----| +| 0 | This record’s containing object was formerly antecedent to the object that is referenced by **spid**, in the container directly containing that object. | +| 1 | This record’s containing object was formerly subsequent to the object that is referenced by **spid**, in the container directly containing that object. | + +### OfficeArtFSPGR + +*Referenced by: [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtFSPGR** record specifies the coordinate system of the [**group shape**](#gt_b2238184-3c83-4e64-babb-08b02a9138db) that the [**anchors**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997) of the [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) are expressed in. This record is present only for group shapes. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x1. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF009. | +| **rh.recLen** | A value that MUST be 0x00000010. | + +**xLeft (4 bytes):** A signed integer that specifies the left boundary of the coordinate system of the [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +**yTop (4 bytes):** A signed integer that specifies the top boundary of the coordinate system of the group. + +**xRight (4 bytes):** A signed integer that specifies the right boundary of the coordinate system of the group. + +**yBottom (4 bytes):** A signed integer that specifies the bottom boundary of the coordinate system of the group. + +### OfficeArtChildAnchor + +*Referenced by: [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtChildAnchor** record specifies four signed integers that specify the [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997) for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that contains this record. For this record to exist, the containing shape MUST be a member of a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) of shapes. The four integers specify the offset from the origin of the coordinate system that is specified by the **OfficeArtFSPGR** record, as defined in section [2.2.38](#officeartfspgr), contained in the same **OfficeArtSpgrContainer** record, as defined in section [2.2.16](#officeartspgrcontainer), that contains this record. The integers are in units of the coordinate system that is specified by the **OfficeArtFSPGR**. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF00F. | +| **rh.recLen** | A value that MUST be 0x00000010. | + +**xLeft (4 bytes):** A signed integer that specifies the left offset for the shape that contains this record. + +**yTop (4 bytes):** A signed integer that specifies the top offset for the shape that contains this record. + +**xRight (4 bytes):** A signed integer that specifies the right offset for the shape that contains this record. + +**yBottom (4 bytes):** A signed integer that specifies the bottom offset for the shape that contains this record. + +### OfficeArtFSP + +*Referenced by: [OfficeArtSpContainer](#officeartspcontainer)* + +The **OfficeArtFSP** record specifies an instance of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The record header contains the shape type, and the record itself contains the shape identifier and a set of bits that further define the shape. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x2. | +| **rh.recInstance** | A signed value that specifies the shape type and that MUST be an **MSOSPT** enumeration value, as defined in section [2.4.24](#msospt). | +| **rh.recType** | A value that MUST be 0xF00A. | +| **rh.recLen** | A value that MUST be 0x00000008. | + +**spid (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies the identifier of this shape. + +**A - fGroup (1 bit):** A bit that specifies whether this shape is a [**group shape**](#gt_b2238184-3c83-4e64-babb-08b02a9138db). + +**B - fChild (1 bit):** A bit that specifies whether this shape is a child shape. + +**C - fPatriarch (1 bit):** A bit that specifies whether this shape is the topmost group shape. Each [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) contains one topmost group shape. + +**D - fDeleted (1 bit):** A bit that specifies whether this shape has been deleted. + +**E - fOleShape (1 bit):** A bit that specifies whether this shape is an [**OLE object**](#gt_cdff9514-a3fb-4897-941d-4e99193a0096). + +**F - fHaveMaster (1 bit):** A bit that specifies whether this shape has a valid [**master**](#gt_7bc43fab-2908-4fdd-b933-2f6429802521) in the **hspMaster** property, as defined in section [2.3.2.1](#hspmaster). + +**G - fFlipH (1 bit):** A bit that specifies whether this shape is horizontally flipped. + +**H - fFlipV (1 bit):** A bit that specifies whether this shape is vertically flipped. + +**I - fConnector (1 bit):** A bit that specifies whether this shape is a [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape. + +**J - fHaveAnchor (1 bit):** A bit that specifies whether this shape has an [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997). + +**K - fBackground (1 bit):** A bit that specifies whether this shape is a [**background shape**](#gt_35f68e44-a7fb-4b81-863a-a8ab1db2b016). + +**L - fHaveSpt (1 bit):** A bit that specifies whether this shape has a shape type property. + +**unused1 (20 bits):** A value that is undefined and MUST be ignored. + +### OfficeArtFRITContainer + +*Referenced by: [OfficeArtDgContainer](#officeartdgcontainer)* + +The **OfficeArtFRITContainer** record specifies a container for the table of [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) identifiers that are used for regrouping ungrouped [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | An unsigned integer that specifies the number of contained **OfficeArtFRIT** records, as defined in section [2.2.42](#officeartfrit). | +| **rh.recType** | A value that MUST be 0xF118. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain **OfficeArtFRIT** records. This value MUST be the size, in bytes, of **rgfrit**. | + +**rgfrit (variable):** An array of **OfficeArtFRIT** records, as defined in section 2.2.42, that specifies the table of group identifiers. The size of the array MUST equal the value of **rh.recInstance**. + +### OfficeArtFRIT + +*Referenced by: [OfficeArtFRITContainer](#officeartfritcontainer)* + +The **OfficeArtFRIT** record specifies the last two [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) identifiers that are used to facilitate regrouping ungrouped [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**fridNew (2 bytes):** A **FRID** structure, as defined in section [2.1.3](#frid), specifying the last group identifier of the shape before ungrouping. The value of **fridNew** MUST be greater than the value of **fridOld**. + +**fridOld (2 bytes):** A **FRID** structure, as defined in section 2.1.3, specifying the second-to-last group identifier of the shape before ungrouping. This value MUST be 0x0000 if a second-to-last group does not exist. + +### OfficeArtColorMRUContainer + +*Referenced by: [OfficeArtDggContainer](#officeartdggcontainer)* + +The **OfficeArtColorMRUContainer** record specifies the most recently used custom colors. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | An unsigned integer that specifies the number of contained **MSOCR** records, as defined in section [2.2.44](#msocr). | +| **rh.recType** | A value that MUST be 0xF11A. | +| **rh.recLen** | An unsigned integer that specifies the number of bytes following the header that contain **MSOCR** records. This value MUST be the size, in bytes, of **rgmsocr**. | + +**rgmsocr (variable):** An array of **MSOCR** elements, as defined in section 2.2.44, that specifies the most recently used custom colors. + +### MSOCR + +*Referenced by: [OfficeArtColorMRUContainer](#officeartcolormrucontainer), [OfficeArtSplitMenuColorContainer](#officeartsplitmenucolorcontainer)* + +The **MSOCR** record specifies either the [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color or the [**scheme color**](#gt_66e6e544-43bf-4c9a-aa20-c1d3ca78c13f) index. + +[TABLE] + +**red (1 byte):** An unsigned byte that specifies the intensity of the red color channel. A value of 0x00 specifies no red color. A value of 0xFF specifies full red intensity. + +**green (1 byte):** An unsigned byte that specifies the intensity of the green color channel. A value of 0x00 specifies no green color. A value of 0xFF specifies full green intensity. + +**blue (1 byte):** An unsigned byte that specifies the intensity of the blue color channel. A value of 0x00 specifies no blue color. A value of 0xFF specifies full blue intensity. + +**A - unused1 (3 bits):** A value that is undefined and MUST be ignored. + +**B - fSchemeIndex (1 bit):** A bit that specifies whether the current [**color scheme**](#gt_b0feeac6-f711-4ed7-b8c6-3a490734a9e5) will be used to determine the color. A value of 0x1 specifies that **red** is an index into the current scheme color table. If this value is 0x1, **green** and **blue** MUST be 0x00. + +**unused2 (4 bits):** A value that is undefined and MUST be ignored. + +### OfficeArtSplitMenuColorContainer + +*Referenced by: [OfficeArtDggContainer](#officeartdggcontainer)* + +The **OfficeArtSplitMenuColorContainer** record specifies a container for the colors that were most recently used to format [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|--------------------|----------------------------------| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x004. | +| **rh.recType** | A value that MUST be 0xF11E. | +| **rh.recLen** | A value that MUST be 0x00000010. | + +**smca (variable):** An array of **MSOCR** records, as defined in section [2.2.44](#msocr), that specifies the colors that were most recently used to format shapes. The number of elements in the array MUST be four. The elements specify, in order, the fill color, the line color, the shadow color, and the 3-D color. + +### OfficeArtIDCL + +*Referenced by: [OfficeArtFDGGBlock](#officeartfdggblock)* + +The **OfficeArtIDCL** record specifies a file identifier cluster, which is used to group [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) identifiers within a [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). + +[TABLE] + +**dgid (4 bytes):** An **MSODGID** structure, as defined in section [2.1.1](#msodgid), specifying the drawing identifier that owns this identifier cluster. + +**cspidCur (4 bytes):** An unsigned integer that, if less than 0x00000400, specifies the largest shape identifier that is currently assigned in this cluster, or that otherwise specifies that no shapes can be added to the drawing. + +### OfficeArtFDGG + +*Referenced by: [OfficeArtFDGGBlock](#officeartfdggblock)* + +The **OfficeArtFDGG** record specifies document-wide information about all of the [**drawings**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) that have been saved in the file. + +[TABLE] + +**spidMax (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), specifying the current maximum [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) identifier that is used in any drawing. This value MUST be less than 0x03FFD7FF. + +**cidcl (4 bytes):** An unsigned integer that specifies the number of **OfficeArtIDCL** records, as defined in section [2.2.46](#officeartidcl), + 1. This value MUST be less than 0x0FFFFFFF. + +**cspSaved (4 bytes):** An unsigned integer specifying the total number of shapes that have been saved in all of the drawings. + +**cdgSaved (4 bytes):** An unsigned integer specifying the total number of drawings that have been saved in the file. + +### OfficeArtFDGGBlock + +*Referenced by: [OfficeArtDggContainer](#officeartdggcontainer)* + +The **OfficeArtFDGGBlock** record specifies document-wide information about all of the [**drawings**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) that have been saved in the file. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that MUST be 0x000. | +| **rh.recType** | A value that MUST be 0xF006. | +| **rh.recLen** | A value that MUST be 0x00000010 + ((**head.cidcl** - 1) \* 0x00000008) | + +**head (16 bytes):** An **OfficeArtFDGG** record, as defined in section [2.2.47](#officeartfdgg), that specifies document-wide information. + +**Rgidcl (variable):** An array of **OfficeArtIDCL** elements, as defined in section [2.2.46](#officeartidcl), specifying file identifier clusters that are used in the drawing. The number of elements in the array is specified by (**head.cidcl** – 1). + +### OfficeArtFDG + +*Referenced by: [OfficeArtDgContainer](#officeartdgcontainer)* + +The **OfficeArtFDG** record specifies the number of [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), the [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) identifier, and the shape identifier of the last shape in a drawing. + +[TABLE] + +**rh (8 bytes):** An **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), that specifies the header for this record. The following table specifies the subfields. + +| Field | Meaning | +|----|----| +| **rh.recVer** | A value that MUST be 0x0. | +| **rh.recInstance** | A value that specifies the drawing identifier and that MUST be less than or equal to 0xFFE. | +| **rh.recType** | A value that MUST be 0xF008. | +| **rh.recLen** | A value that MUST be 0x00000008. | + +**csp (4 bytes):** An unsigned integer that specifies the number of shapes in this drawing. + +**spidCur (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies the shape identifier of the last shape in this drawing. + +### MSOSHADETYPE + +*Referenced by: [fillShadeType](#fillshadetype)* + +The **MSOSHADETYPE** record specifies the interpolation of colors between the color/position values that are stated for the fill. The values can be combined to produce compound effects. + +[TABLE] + +**A - msoshadeNone (1 bit):** A bit that specifies whether color correction will be performed after interpolation. A value of 0x1 specifies that no color correction will be performed after interpolation. + +**B - msoshadeGamma (1 bit):** A bit that specifies whether [**gamma correction**](#gt_60eaec33-bd4f-4e71-93e6-4ef382aa80f9) will be applied after interpolation. + +**C - msoshadeSigma (1 bit):** A bit that specifies whether a [**sigma transfer function**](#gt_ec439672-c396-41e2-ae26-39964fa0e281) will be applied after interpolation. + +**D - msoshadeBand (1 bit):** A bit that specifies whether a flat band will be added at the start of the interpolation. + +**E - msoshadeOneColor (1 bit):** A bit that specifies whether only one color will be used for the fill color. + +**unused1 (27 bits):** A value that is undefined and MUST be ignored. + +### IMsoArray + +*Referenced by: [dgmConstrainBounds_complex](#dgmconstrainbounds_complex), [fillShadeColors_complex](#fillshadecolors_complex), [lineBottomDashStyle_complex](#linebottomdashstyle_complex), [lineDashStyle_complex](#linedashstyle_complex), [lineLeftDashStyle_complex](#lineleftdashstyle_complex), [lineRightDashStyle_complex](#linerightdashstyle_complex), [lineTopDashStyle_complex](#linetopdashstyle_complex), [pAdjustHandles_complex](#padjusthandles_complex), [pConnectionSites_complex](#pconnectionsites_complex), [pConnectionSitesDir_complex](#pconnectionsitesdir_complex), [pInscribe_complex](#pinscribe_complex), [pRelationTbl_complex](#prelationtbl_complex), [pSegmentInfo_complex](#psegmentinfo_complex), [pVertices_complex](#pvertices_complex), [pWrapPolygonVertices_complex](#pwrappolygonvertices_complex), [tableRowProperties_complex](#tablerowproperties_complex)* + +The **IMsoArray** record specifies an array that contains elements of a specific size. + +[TABLE] + +**nElems (2 bytes):** An unsigned integer that specifies the number of array elements that are contained in this record. + +**nElemsAlloc (2 bytes):** An unsigned integer that specifies the maximum number of array elements that this record can contain. This value MUST be greater than or equal to **nElems**. + +**cbElem (2 bytes):** An unsigned integer that specifies the size, in bytes, of each element in the **data** array. If this value equals 0xFFF0, this record contains an array of truncated 8-byte elements. In this case, only the four low-order bytes of each element are recorded. The four high-order bytes equal 0x00000000, and the four low-order bytes of each element are contained in **data**. + +**data (variable):** An array that contains **nElems** elements, each of which is **cbElem** bytes in size. The total size of **data** thus equals (**cbElem** \* **nElems**) bytes. If **cbElem** equals 0xFFF0, each element is 4 bytes in size, and the total size of **data** equals (4 \* **nElems**) bytes. + +### IMsoInkData + +*Referenced by: [pInkData_complex](#pinkdata_complex)* + +The **IMsoInkData** record specifies the [**ink**](#gt_9fcdd1d5-3563-49b9-8a2e-bf696fb08fd0) data for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**CLSID_InkDisp (16 bytes):** A GUID that MUST be {937C1A34-151D-4610-9CA6-A8CC9BDB5D83}. + +**cbBlob (4 bytes):** An unsigned integer specifying the number of bytes that are contained in **data**. + +**data (variable):** A variable-length field that specifies serialized ink data, as specified in [\[MC-ISF\]](%5bMC-ISF%5d.pdf). + +### MSOPATHINFO + +The **MSOPATHINFO** record specifies how a series of **POINT** values, as defined in section [2.2.55](#point), are to be interpreted to construct a path. + +[TABLE] + +**type (3 bits):** An **MSOPATHTYPE** enumeration value, as defined in section [2.4.30](#msopathtype), that specifies how the path is to be drawn. If this field contains an escape value, this record is treated as an **MSOPATHESCAPEINFO** record, as defined in section [2.2.54](#msopathescapeinfo). + +**segments (13 bits):** An unsigned integer that specifies the number of segments to process. + +### MSOPATHESCAPEINFO + +The **MSOPATHESCAPEINFO** record specifies how a path is constructed. This record is used in conjunction with **MSOPATHINFO** record, as defined in section [2.2.53](#msopathinfo), and an array of **POINT** data, as defined in section [2.2.55](#point), to build a path. + +[TABLE] + +**type (3 bits):** An **MSOPATHTYPE** enumeration value, as defined in section [2.4.30](#msopathtype), that specifies how the path is to be drawn. If this field does not contain an escape value, this record is treated as an **MSOPATHINFO** record, as defined in section 2.2.53. + +**escape (5 bits):** An **MSOPATHESCAPE** enumeration value, as defined in section [2.4.31](#msopathescape), that specifies how path information is interpreted and segments joined. + +**segments (8 bits):** An unsigned integer that specifies the number of segments to process. + +### POINT + +*Referenced by: [OfficeArtMetafileHeader](#officeartmetafileheader)* + +The **POINT** record specifies a two-dimensional (2-D) point. + +[TABLE] + +**x (4 bytes):** A signed integer that specifies the x-coordinate of this point. The coordinate system that is used for this value is dependent on the scenario in which it is used. + +**y (4 bytes):** A signed integer that specifies the y-coordinate of this point. The coordinate system that is used for this value is dependent on the scenario in which it is used. + +### RECT + +*Referenced by: [OfficeArtMetafileHeader](#officeartmetafileheader)* + +The **RECT** record specifies a 2-D rectangle. + +[TABLE] + +**left (4 bytes):** A signed integer that specifies the x-coordinate of the top-left point of this rectangle. The coordinate system that is used for this value is dependent on the scenario in which it is used. + +**top (4 bytes):** A signed integer that specifies the y-coordinate of the top-left point of this rectangle. The coordinate system that is used for this value is dependent on the scenario in which it is used. + +**right (4 bytes):** A signed integer that specifies the x-coordinate of the bottom-right point of this rectangle. The coordinate system that is used for this value is dependent on the scenario in which it is used. + +**bottom (4 bytes):** A signed integer that specifies the y-coordinate of the bottom-right point of this rectangle. The coordinate system that is used for this value is dependent on the scenario in which it is used. + +### ADJH + +The **ADJH** record specifies a single [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b) that a user can employ to manipulate the geometry of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**A - fahInverseX (1 bit):** A bit that specifies whether the x-coordinate of this adjust handle is inverted according to the following formula: + +> x_(new) = right - x_(old) + +where **right** means the right coordinate of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) as specified by the [geoRight](#georight) property of this shape. Note that all the values are specified in the geometry space. + +**B - fahInverseY (1 bit):** A bit that specifies whether the y-coordinate of this adjust handle is inverted according to the following formula: + +> y_(new) = bottom – y_(old) + +where **bottom** means the bottom coordinate of the bounding rectangle of the geometry space as specified by the [geoBottom](#geobottom) property of this shape. Note that all the values are specified in the geometry space. + +**C - fahSwitchPosition (1 bit):** A bit that specifies whether the x- and y-coordinates of this adjust handle are swapped if the shape is taller than it is wide. + +**D - fahPolar (1 bit):** A bit that specifies whether the coordinates of this adjust handle are polar coordinate values rather than Cartesian coordinate values. The following table specifies the meaning of each value for this bit. + +| **Value** | **Meaning** | +|----|----| +| 0x0 | The coordinates of this adjust handle are Cartesian coordinate values. | +| 0x1 | The x-coordinate of this adjust handle specifies the radius in geometry space units; the y-coordinate specifies the angle, in degrees, as a value of type **FixedPoint** (as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6); and (**xRange**,**yRange**) specifies the origin of the polar coordinate system in geometry space. The value of **fahMap** MUST NOT equal 0x1. | + +**E - fahMap (1 bit):** A bit that specifies whether the position of the adjust handle is mapped from the entire range of the geometry space of this shape to the range that is specified by the values of **xRange** and **yRange**. If this value equals 0x1, **fahPolar** MUST NOT equal 0x1. + +**F - fahPin (1 bit):** A bit that specifies whether the position of this adjust handle is constrained to exist within the rectangle that is specified by **xMin**, **xMax**, **yMin**, and **yMax**. + +**G - fahUnused (1 bit):** A value that is undefined and MUST be ignored. + +**H - fahxMin (1 bit):** A bit that specifies whether **xMin** is interpreted as an index into the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex), for this shape rather than as a constant value. + +**I - fahxMax (1 bit):** A bit that specifies whether **xMax** is interpreted as an index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape rather than as a constant value. + +**J - fahyMin (1 bit):** A bit that specifies whether **yMin** is interpreted as an index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape rather than as a constant value. + +**K - fahyMax (1 bit):** A bit that specifies whether **yMax** is interpreted as an index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape rather than as a constant value. + +**L - fahxRange (1 bit):** A bit that specifies whether **xRange** is interpreted as an index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape rather than as a constant value. + +**M - fahyRange (1 bit):** A bit that specifies whether **yRange** is interpreted as an index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape rather than as a constant value. + +**N - fahPolarPin (1 bit):** A bit that specifies whether the x-coordinate of this adjust handle is constrained to exist within the range that is specified by **xMin** and **xMax**, inclusive. + +**unused1 (18 bits):** A value that is undefined and MUST be ignored. + +**apX (4 bytes):** An unsigned integer that specifies the positioning of the x-coordinate of this adjust handle. The following table specifies the allowed values. + +| Value | Positioning | +|----|----| +| 0x00000000 | Position the x-coordinate of this adjust handle on the left perimeter of this shape. | +| 0x00000001 | Position the x-coordinate of this adjust handle on the right perimeter of this shape. | +| 0x00000002 | Position the x-coordinate of this adjust handle along the horizontal center of this shape. | +| 0x00000003–0x00000082 | Position the x-coordinate of this adjust handle according to an entry in the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape. The zero-based index into the **pGuides_complex** array is derived by subtracting 0x00000003 from the value. | +| 0x00000100 | Position the x-coordinate of this adjust handle according to the value of the **adjustValue** property, as defined in section [2.3.6.10](#adjustvalue), of this shape. | +| 0x00000101 | Position the x-coordinate of this adjust handle according to the value of the **adjust2Value** property, as defined in section [2.3.6.11](#adjust2value), of this shape. | +| 0x00000102 | Position the x-coordinate of this adjust handle according to the value of the **adjust3Value** property, as defined in section [2.3.6.12](#adjust3value), of this shape. | +| 0x00000103 | Position the x-coordinate of this adjust handle according to the value of the **adjust4Value** property, as defined in section [2.3.6.13](#adjust4value), of this shape. | +| 0x00000104 | Position the x-coordinate of this adjust handle according to the value of the **adjust5Value** property, as defined in section [2.3.6.14](#adjust5value), of this shape. | +| 0x00000105 | Position the x-coordinate of this adjust handle according to the value of the **adjust6Value** property, as defined in section [2.3.6.15](#adjust6value), of this shape. | +| 0x00000106 | Position the x-coordinate of this adjust handle according to the value of the **adjust7Value** property, as defined in section [2.3.6.16](#adjust7value), of this shape. | +| 0x00000107 | Position the x-coordinate of this adjust handle according to the value of the **adjust8Value** property, as defined in section [2.3.6.17](#adjust8value), of this shape. | + +**apY (4 bytes):** An unsigned integer that specifies the positioning of the y-coordinate of this adjust handle. The following table specifies the allowed values. + +| Value | Positioning | +|----|----| +| 0x00000000 | Position the y-coordinate of this adjust handle on the top perimeter of this shape. | +| 0x00000001 | Position the y-coordinate of this adjust handle on the bottom perimeter of this shape. | +| 0x00000002 | Position the y-coordinate of this adjust handle along the vertical center of this shape. | +| 0x00000003–0x00000082 | Position the y-coordinate of this adjust handle according to an entry in the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape. The zero-based index into the **pGuides_complex** array is derived by subtracting 0x00000003 from the value. | +| 0x00000100 | Position the y-coordinate of this adjust handle according to the value of the **adjustValue** property, as defined in section 2.3.6.10, of this shape. | +| 0x00000101 | Position the y-coordinate of this adjust handle according to the value of the **adjust2Value** property, as defined in section 2.3.6.11, of this shape. | +| 0x00000102 | Position the y-coordinate of this adjust handle according to the value of the **adjust3Value** property, as defined in section 2.3.6.12, of this shape. | +| 0x00000103 | Position the y-coordinate of this adjust handle according to the value of the **adjust4Value** property, as defined in section 2.3.6.13, of this shape. | +| 0x00000104 | Position the y-coordinate of this adjust handle according to the value of the **adjust5Value** property, as defined in section 2.3.6.14, of this shape. | +| 0x00000105 | Position the y-coordinate of this adjust handle according to the value of the **adjust6Value** property, as defined in section 2.3.6.15, of this shape. | +| 0x00000106 | Position the y-coordinate of this adjust handle according to the value of the **adjust7Value** property, as defined in section 2.3.6.16, of this shape. | +| 0x00000107 | Position the y-coordinate of this adjust handle according to the value of the **adjust8Value** property, as defined in section 2.3.6.17, of this shape. | + +**xRange (4 bytes):** A signed integer that specifies the x-coordinate of a value that is used to control the position of this adjust handle. If **fahxRange** equals 0x0, the value is used directly. If **fahxRange** equals 0x1, 0x00000003 is subtracted from the value, and the result is used as a zero-based index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape to calculate the actual value. + +**yRange (4 bytes):** A signed integer that specifies the y-coordinate of a value that is used to control the position of this adjust handle. If **fahyRange** equals 0x0, the value is used directly. If **fahyRange** equals 0x1, 0x00000003 is subtracted from the value, and the result is used as a zero-based index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape to calculate the actual value. + +**xMin (4 bytes):** A signed integer that specifies the x-coordinate of a value that is used to control the position of this adjust handle. If **fahxMin** equals 0x0, the value is used directly. If **fahxMin** equals 0x1, 0x00000003 is subtracted from the value, and the result is used as a zero-based index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape to calculate the actual value. + +**xMax (4 bytes):** A signed integer that specifies the x-coordinate of a value that is used to control the position of this adjust handle. If **fahxMax** equals 0x0, the value is used directly. If **fahxMax** equals 0x1, 0x00000003 is subtracted from the value, and the result is used as a zero-based index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape to calculate the actual value. + +**yMin (4 bytes):** A signed integer that specifies the y-coordinate of a value that is used to control the position of this adjust handle. If **fahyMin** equals 0x0, the value is used directly. If **fahyMin** equals 0x1, 0x00000003 is subtracted from the value, and the result is used as a zero-based index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape to calculate the actual value. + +**yMax (4 bytes):** A signed integer that specifies the y-coordinate of a value that is used to control the position of this adjust handle. If **fahyMax** equals 0x0, the value is used directly. If **fahyMax** equals 0x1, 0x00000003 is subtracted from the value, and the result is used as a zero-based index into the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape to calculate the actual value. + +### SG + +*Referenced by: [pGuides_complex](#pguides_complex)* + +The **SG** record specifies a formula that is used to calculate a value for use in the **pGuides_complex** property, as defined in section 2.3.6.27, of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Formulas are used to calculate values involved in the geometry of a shape so that a user can adjust some of those values and so that the entire geometry of the shape can adjust appropriately as a result. + +[TABLE] + +**sgf (13 bits):** A set of bits that specifies the formula to use to calculate the value for the guide represented by this record. The formulas specify a combination of **param1**, **param2**, and **param3** values, although not every formula uses all three of the parameters. The following table lists the values for this field along with the formulas that they represent. + +[TABLE] + +**A - fCalculatedParam1 (1 bit):** A bit that specifies whether this record’s **param1** value is a constant or is calculated from another property or formula. The following table specifies the meaning of each value for this bit. + +| Value | Meaning | +|-------|------------------------------------------------------------| +| 0x0 | **param1** is a constant. | +| 0x1 | **param1** is calculated from another property or formula. | + +**B - fCalculatedParam2 (1 bit):** A bit that specifies whether this record’s **param2** value is a constant or is calculated from another property or formula. The following table specifies the meaning of each value for this bit. + +| Value | Meaning | +|-------|------------------------------------------------------------| +| 0x0 | **param2** is a constant. | +| 0x1 | **param2** is calculated from another property or formula. | + +**C - fCalculatedParam3 (1 bit):** A bit that specifies whether this record’s **param3** value is a constant or is calculated from another property or formula. The following table specifies the meaning of each value for this bit. + +| Value | Meaning | +|-------|------------------------------------------------------------| +| 0x0 | **param3** is a constant. | +| 0x1 | **param3** is calculated from another property or formula. | + +**param1 (16 bits):** A value that is used to calculate the result of this formula. If **fCalculatedParam1** equals 0x0, this value is an unsigned integer constant. If **fCalculatedParam1** equals 0x1, this value specifies a property or formula to use when calculating the result. The following table specifies the allowed values. + +| Value | Calculation | +|----|----| +| 0x0140 | The x-coordinate of the center of the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) of this shape. | +| 0x0141 | The y-coordinate of the center of the geometry space of this shape. | +| 0x0142 | The width of the geometry space of this shape. | +| 0x0143 | The height of the geometry space of this shape. | +| 0x0147 | The value of the **adjustValue** property, as defined in section [2.3.6.10](#adjustvalue), of this shape. | +| 0x0148 | The value of the **adjust2Value** property, as defined in section [2.3.6.11](#adjust2value), of this shape. | +| 0x0149 | The value of the **adjust3Value** property, as defined in section [2.3.6.12](#adjust3value), of this shape. | +| 0x014A | The value of the **adjust4Value** property, as defined in section [2.3.6.13](#adjust4value), of this shape. | +| 0x014B | The value of the **adjust5Value** property, as defined in section [2.3.6.14](#adjust5value), of this shape. | +| 0x014C | The value of the **adjust6Value** property, as defined in section [2.3.6.15](#adjust6value), of this shape. | +| 0x014D | The value of the **adjust7Value** property, as defined in section [2.3.6.16](#adjust7value), of this shape. | +| 0x014E | The value of the **adjust8Value** property, as defined in section [2.3.6.17](#adjust8value), of this shape. | +| 0x0153 | The value of the **xLimo** property, as defined in section [2.3.6.22](#xlimo). | +| 0x0154 | The value of the **yLimo** property, as defined in section [2.3.6.23](#ylimo). | +| 0x01FC | The value of the **fLine** bit from the [Line Style Boolean Properties](#line-style-boolean-properties) of this shape. | +| 0x0400–0x047F | A value that is calculated from another **SG** entry in the **pGuides_complex** array, as defined in section 2.3.6.27, for this shape. The index into the array equals the value minus 0x0400. The index MUST be less than the size of the **pGuides_complex** array, and it MUST be less than the index of this record in that same array. | +| 0x04F7 | The width, in pixels, of a line in this shape. | +| 0x04F8 | The width, in pixels, of this shape. | +| 0x04F9 | The height, in pixels, of this shape. | +| 0x04FC | The width, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of this shape. | +| 0x04FD | The height, in EMUs, of this shape. | +| 0x04FE | The width, in EMUs, of this shape divided by 2. | +| 0x04FF | The height, in EMUs, of this shape divided by 2. | + +**param2 (16 bits):** A value that is used to calculate the result of this formula. If **fCalculatedParam2** equals 0, this value is an unsigned integer constant. If **fCalculatedParam2** equals 1, this value specifies a property or formula according to the table that is documented for **param1**. + +**param3 (16 bits):** A value that is used to calculate the result of this formula. If **fCalculatedParam3** equals 0, this value is an unsigned integer constant. If **fCalculatedParam3** equals 1, this value specifies a property or formula according to the table that is documented for **param1**. + +### TABLEFLAGS + +The **TABLEFLAGS** record specifies a collection of bits for a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) of [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that specifies a table. + +[TABLE] + +**A - fIsTable (1 bit):** A bit that specifies whether this group of shapes specifies a table. + +**B - fIsTablePlaceholder (1 bit):** A bit that specifies whether this table is a [**placeholder**](#gt_25caffec-4e4b-4192-a04d-edcd14f0ec5f). This bit SHOULD be ignored if the **fIsTable** bit equals 0x0. + +**C - fIsTableRTL (1 bit):** A bit that specifies whether the text in this table is [**right-to-left**](#gt_91359688-7863-4e88-b507-f57b3dada5ec) text. This bit SHOULD be ignored if the **fIsTable** bit equals 0x0. + +**unused1 (29 bits):** A value that is undefined and MUST be ignored. + +### IHlink + +*Referenced by: [pihlShape_complex](#pihlshape_complex)* + +The **IHlink** record specifies a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e). + +[TABLE] + +**CLSID_StdHlink (16 bytes):** A GUID that MUST be {79eac9d0-baf9-11ce-8c82-00aa004ba90b}. + +**hyperlink (variable):** A variable-length field that specifies a serialized hyperlink object, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.3.7.1. + +### MSOSHADECOLOR + +The **MSOSHADECOLOR** record specifies an intermediate color in the gradient fill and its relative position along the [**gradient vector**](#gt_c3738f35-d919-4f1b-a5cc-09407a7f2c15). + +[TABLE] + +**color (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies what color to use in this point. The color in the specified position is pure. Before and after this position the color can be in transition (or pure, depending on whether this is the last position or not). + +**position (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the relative position along the gradient. The value MUST be from 0.0 through 1.0, inclusive. A value of 0.0 specifies the start of the gradient. A value of 1.0 specifies the end of the gradient. + +## Properties + +Three property blocks— **OfficeArtFOPT** record, as defined in section [2.2.9](#officeartfopt), **OfficeArtSecondaryFOPT** record, as defined in section [2.2.10](#officeartsecondaryfopt), and **OfficeArtTertiaryFOPT** record, as defined in section [2.2.11](#officearttertiaryfopt), are associated with each [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) instance. The **OfficeArtSpContainer** record, as defined in section [2.2.14](#officeartspcontainer), contains each of these property blocks. The **OfficeArtFOPT** and **OfficeArtTertiaryFOPT** property blocks, which are saved with the [**drawing group**](#gt_329c715f-dc26-4866-a759-0d622aa92e92) **OfficeArtDggContainer**, as defined in section [2.2.12](#officeartdggcontainer), establish new defaults for every shape in the file. For example, if the fill color for the drawing group is set to red, any shape in any [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) that persists in the file without its own fill color will use red. If no fill color exists in either the document properties or the shape, the default fill color will be used. + +If the **fComplex** flag of a property equals 0x1, that property has more data than will fit in the four bytes associated with the simple property types. In this case, the **op** field contains the number of bytes that follow the **OfficeArtRGFOPTE** records, as defined in section [2.3.1](#officeartrgfopte), and that contain the property data. + +The structures that are specified in this section are supported at the file level by the applications, but not every application writes every property to the binary file. An application that does not fully support a property can load and save that property unchanged, which is the case for any property introduced in a later version of an application that is opened by an earlier version of the same application. Scenarios also exist in which a later version of an application supports a deprecated property or value by converting it to another property or value and then removing the deprecated one. + +The following properties SHOULD[\<10\>](#Appendix_A_10) be supported: + +- [GeometryText:gtextCSSFont](#gtextcssfont) + +- [Blip:movie](#movie) + +- The following [Blip Boolean Properties](#blip-boolean-properties): + + - **Blip:fRewind** + + - **Blip:fLooping** + +- [Shape:idDiscussAnchor](#iddiscussanchor) + +- [GroupShape:wzTooltip](#wztooltip) + +- [GroupShape:wzScript](#wzscript) + +- [GroupShape:posh](#posh) + +- [GroupShape:posrelh](#posrelh) + +- [GroupShape:posv](#posv) + +- [GroupShape:posrelv](#posrelv) + +- [GroupShape:pctHR](#pcthr) + +- [GroupShape:alignHR](#alignhr) + +- [GroupShape:dxHeightHR](#dxheighthr) + +- [GroupShape:dxWidthHR](#dxwidthhr) + +- [GroupShape:wzScriptExtAttr](#wzscriptextattr) + +- [GroupShape:scriptLang](#scriptlang) + +- [GroupShape:wzScriptLangAttr](#wzscriptlangattr) + +- [GroupShape:borderTopColor](#bordertopcolor) + +- [GroupShape:borderLeftColor](#borderleftcolor) + +- [GroupShape:borderBottomColor](#borderbottomcolor) + +- [GroupShape:borderRightColor](#borderrightcolor) + +- [GroupShape:tableProperties](#tableproperties) + +- [GroupShape:tableRowProperties](#tablerowproperties) + +- The following [Group Shape Boolean Properties](#group-shape-boolean-properties): + + - **GroupShape:fLayoutInCell** + + - **GroupShape:fIsBullet** + + - **GroupShape:fStandardHR** + + - **GroupShape:fNoshadeHR** + + - **GroupShape:fHorizRule** + + - **GroupShape:fUserDrawn** + + - **GroupShape:fAllowOverlap** + + - **GroupShape:fReallyHidden** + + - **GroupShape:fScriptAnchor** + +- [UnknownHTML](#Section_1a1ff877cdff42fbb22642304abfc5bf) + +The following property SHOULD[\<11\>](#Appendix_A_11) be supported: + +- [Line Style:fLineOpaqueBackColor](#line-style-boolean-properties) + +The following properties SHOULD[\<12\>](#Appendix_A_12) be supported: + +- The following [Shape Boolean Properties](#shape-boolean-properties): + + - Shape:fFlipHOverride + + - Shape:fFlipVOverride + +- [Diagram:dgmBaseTextScale](#dgmbasetextscale) + +- [Ink:pInkData](#pinkdata) + +- The following [Ink Boolean Properties](#ink-boolean-properties): + + - Ink:fInkAnnotation + + - Ink:fHitTestInk + + - Ink:fRenderShape + + - Ink:fRenderInk + +The following properties SHOULD[\<13\>](#Appendix_A_13) be supported: + +- [Shape:equationXML](#equationxml) + +- The following **Shape Boolean Properties**: + + - Shape:fPolicyLabel + + - Shape:fPolicyBarcode + +- [GroupShape:metroBlob](#metroblob) + +- [GroupShape:dhgt](#dhgt) + +- [SignatureLine:wzSigSetupId](#wzsigsetupid) + +- [SignatureLine:wzSigSetupProvId](#wzsigsetupprovid) + +- [SignatureLine:wzSigSetupSuggSigner](#wzsigsetupsuggsigner) + +- [SignatureLine:wzSigSetupSuggSigner2](#wzsigsetupsuggsigner2) + +- [SignatureLine:wzSigSetupSuggSignerEmail](#wzsigsetupsuggsigneremail) + +- [SignatureLine:wzSigSetupSignInst](#wzsigsetupsigninst) + +- [SignatureLine:wzSigSetupAddlXml](#wzsigsetupaddlxml) + +- [SignatureLine:wzSigSetupProvUrl](#wzsigsetupprovurl) + +- The following [Signature Line Boolean Properties](#signature-line-boolean-properties): + + - SignatureLine:fSigSetupShowSignDate + + - SignatureLine:fSigSetupAllowComments + + - SignatureLine:fSigSetupSignInstSet + + - SignatureLine:fIsSignatureLine + +- [GroupShape2:pctHoriz](#pcthoriz) + +- [GroupShape2:pctVert](#pctvert) + +- [GroupShape2:pctHorizPos](#pcthorizpos) + +- [GroupShape2:pctVertPos](#pctvertpos) + +- [GroupShape2:sizerelh](#sizerelh) + +- [GroupShape2:sizerelv](#sizerelv) + +The following property SHOULD[\<14\>](#Appendix_A_14) be supported: + +- [ShadowStyle:shadowSoftness](#shadowsoftness) + +### OfficeArtRGFOPTE + +*Referenced by: [OfficeArtFOPT](#officeartfopt), [OfficeArtSecondaryFOPT](#officeartsecondaryfopt), [OfficeArtTertiaryFOPT](#officearttertiaryfopt)* + +The **OfficeArtRGFOPTE** record specifies a property table, which consists of an array of fixed-size property table entries, followed by a variable-length field of complex data. + +[TABLE] + +**rgfopte (variable):** An array of **OfficeArtFOPTE** records, as defined in section [2.2.7](#officeartfopte), that specifies property table entries. + +**complexData (variable):** A field of complex data for properties that have the [fComplex](#officeartfopteopid) bit set to 0x1. The complex data is stored immediately following **rgfopte**. + +### Shape + +The **Shape** property set specifies attributes that apply to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) but not to a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) of shapes. + +#### hspMaster + +The **hspMaster** property specifies the [**master shape**](#gt_10cc4e9a-da75-47e6-9971-e8f22670983c) for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0301. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**hspMaster (4 bytes):** An **MSOSPID** structure, as defined in section [2.1.2](#msospid), that specifies the identifier of the master shape for the shape. The default value for this property is 0x00000000. + +#### cxstyle + +The **cxstyle** property specifies the [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) style for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0303. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cxstyle (4 bytes):** An **MSOCXSTYLE** enumeration value, as defined in section [2.4.25](#msocxstyle), that specifies the connector style for this shape. This property SHOULD be ignored if the **fConnector** bit of the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for this shape equals 0x0.The default value for this property is **msocxstyleNone**. + +#### bWMode + +The **bWMode** property specifies how a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) will render in black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0304. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**bWMode (4 bytes):** An **MSOBWMODE** enumeration value, as defined in section [2.4.26](#msobwmode), that specifies how the shape will render in black-and-white display mode. If the value is **msobwAutomatic**, the **bWModePureBW** property, as defined in section [2.3.2.4](#bwmodepurebw), SHOULD be used when rendering in pure black-and-white display mode, and the **bWModeBW** property, as defined in section [2.3.2.5](#bwmodebw), SHOULD be used when rendering in grey scale black-and-white display mode. The default value for this property is **msobwAutomatic**. + +#### bWModePureBW + +The **bWModePureBW** property specifies how a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) will render in pure black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0305. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**bWModePureBW (4 bytes):** An **MSOBWMODE** enumeration value, as defined in section [2.4.26](#msobwmode), that specifies how the shape will render in pure black-and-white display mode. If the value of the **bWMode** property, as defined in section [2.3.2.3](#bwmode), is not **msobwAutomatic**, this property SHOULD be ignored. The default value for this property is **msobwAutomatic**. + +#### bWModeBW + +The **bWModeBW** property specifies how a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) will render in normal black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0306. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**bWModeBW (4 bytes):** An **MSOBWMODE** enumeration value, as defined in section [2.4.26](#msobwmode), that specifies how the shape will render in normal black-and-white display mode. If the value of the **bWMode** property, as defined in section [2.3.2.3](#bwmode), is not **msobwAutomatic**, this property SHOULD be ignored. The default value for this property is **msobwAutomatic**. + +#### idDiscussAnchor + +The **idDiscussAnchor** property specifies whether a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is an [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997) for discussion [**comments**](#gt_c8a897b9-522f-4b7a-8df6-40b65ac09f4d). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0307. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**idDiscussAnchor (4 bytes):** An integer that MAY[\<15\>](#Appendix_A_15) be used to specify that this shape is an anchor for discussion comments. If the value is 0x00000001, the shape is an anchor for discussion comments. If it is any other value, it SHOULD be ignored. The default value for this property is 0x00000000. + +#### dgmLayout + +The **dgmLayout** property specifies the [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) node layout for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0309. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmLayout (4 bytes):** An **MSODGMLO** enumeration value, as defined in section [2.4.29](#msodgmlo), that specifies the diagram layout for the shape. This property SHOULD be ignored if this shape is not a node in a diagram. The default value for this property is 0x000000FF. + +#### dgmNodeKind + +The **dgmNodeKind** property specifies a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) node type for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x030A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmNodeKind (4 bytes):** An integer specifying the type of node that the shape represents in a diagram. This property SHOULD be ignored if the shape is not a node in a diagram. The default value for this property is 0xFFFFFFFF. + +The following table lists the possible values and shows the nodes that they represent. + +[TABLE] + +#### dgmLayoutMRU + +The **dgmLayoutMRU** property specifies the most recently used [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) layout for the child shapes of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x030B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmLayoutMRU (4 bytes):** An **MSODGMLO** enumeration value, as defined in section [2.4.29](#msodgmlo), that specifies the most recently used diagram layout for the child shapes of this shape. This property SHOULD be ignored if the shape is not a node in a diagram. The default value for this property is 0x000000FF. + +#### equationXML + +The **equationXML** property specifies alternative mathematical content for an image. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x030C. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **equationXML_complex** property, as defined in section [2.3.2.11](#equationxml_complex), exists. If the value equals 0x1, **equationXML_complex** MUST exist. | + +**equationXML (4 bytes):** The number of bytes of data in the **equationXML_complex** property, as defined in section 2.3.2.11. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### equationXML_complex + +The **equationXML_complex** property specifies additional data for the **equationXML** property, as defined in section [2.3.2.10](#equationxml). If the **opid.fComplex** bit of **equationXML** equals 0x1, this property MUST exist. + +[TABLE] + +**equationXML_complex (variable):** An optional [**XML**](#gt_982b7f8e-d516-4fd5-8d5e-1a836081ed85) string encoded with [**UTF-8**](#gt_409411c4-b4ed-4ab6-b0ee-6d7815f85a35) in the Office Open XML Math format, as specified in [\[ISO/IEC29500-4:2012\]](https://go.microsoft.com/fwlink/?LinkID=330450), that MAY[\<16\>](#Appendix_A_16) be used as alternative content for an image. + +#### Shape Boolean Properties + +The **Shape Boolean Properties** specify a 32-bit field of Boolean properties for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for these properties. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x033F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (4 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**C - fUsefPolicyLabel (1 bit):** A bit that specifies whether the **fPolicyLabel** bit is set. A value of 0x0 specifies that the **fPolicyLabel** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**D - fUsefPolicyBarcode (1 bit):** A bit that specifies whether the **fPolicyBarcode** bit is set. A value of 0x0 specifies that the **fPolicyBarcode** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefFlipHOverride (1 bit):** A bit that specifies whether the **fFlipHOverride** bit is set. A value of 0x0 specifies that the **fFlipHOverride** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - fUsefFlipVOverride (1 bit):** A bit that specifies whether the **fFlipVOverride** bit is set. A value of 0x0 specifies that the **fFlipVOverride** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**G - fUsefOleIcon (1 bit):** A bit that specifies whether the **fOleIcon** bit is set. A value of 0x0 specifies that the **fOleIcon** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefPreferRelativeResize (1 bit):** A bit that specifies whether the **fPreferRelativeResize** bit is set. A value of 0x0 specifies that the **fPreferRelativeResize** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefLockShapeType (1 bit):** A bit that specifies whether the **fLockShapeType** bit is set. A value of 0x0 specifies that the **fLockShapeType** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefInitiator (1 bit):** A bit that specifies whether the **fInitiator** bit is set. A value of 0x0 specifies that the **fInitiator** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**K - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**L - fUsefBackground (1 bit):** A bit that specifies whether the **fBackground** bit is set. A value of 0x0 specifies that the **fBackground** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused5 (4 bits):** A value that is undefined and MUST be ignored. + +**M - unused6 (1 bit):** A value that is undefined and MUST be ignored. + +**N - unused7 (1 bit):** A value that is undefined and MUST be ignored. + +**O - fPolicyLabel (1 bit):** A bit that MAY[\<17\>](#Appendix_A_17) be used to specify whether this object is an image of a label that identifies the containing document as part of a [**labeling policy**](#gt_a5d2d223-089b-4c5c-8885-7a57e04395a6) in a [**content management system**](#gt_8265634f-8937-416a-8e21-220744453d2e). If **fUsefPolicyLabel** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**P - fPolicyBarcode (1 bit):** A bit that MAY[\<18\>](#Appendix_A_18) be used to specify whether this object is a barcode image that identifies the containing document as part of a content management system. If **fUsefPolicyBarcode** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**Q - fFlipHOverride (1 bit):** A bit that acts as an override for the **fFlipH** bit of the **Transform Boolean Properties** in the **OfficeArtFSP** of the containing **OfficeArtSpContainer**. If this value equals 0x1, it SHOULD[\<19\>](#Appendix_A_19) be used instead of **fFlipH**. If **fUsefFlipHOverride** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**R - fFlipVOverride (1 bit):** A bit that acts as an override for the **fFlipV** bit of the [Transform Boolean Properties](#transform-boolean-properties) in the **OfficeArtFSP** of the containing **OfficeArtSpContainer**. If this value equals 0x1, it SHOULD[\<20\>](#Appendix_A_20) be used instead of **fFlipV**. If **fUsefFlipVOverride** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**S - fOleIcon (1 bit):** A bit that specifies whether this [**OLE object**](#gt_cdff9514-a3fb-4897-941d-4e99193a0096) will be displayed as an icon. If the **fOleShape** bit in the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), of the containing **OfficeArtSpContainer** record, as defined in section [2.2.14](#officeartspcontainer), equals 0x0, this bit MUST be ignored. If **fUsefOleIcon** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**T - fPreferRelativeResize (1 bit):** A bit that specifies whether the application's user interface for resizing this shape SHOULD express the size relative to the original size rather than to the current size. If **fUsefPreferRelativeResize** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**U - fLockShapeType (1 bit):** A bit that specifies whether the shape type is locked. If **fUsefLockShapeType** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**V - fInitiator (1 bit):** A bit that specifies whether this shape SHOULD be processed by a [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) engine. If **fUsefInitiator** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**W - reserved1 (1 bit):** A value that is undefined and MUST be ignored. + +**X - fBackground (1 bit):** A bit that specifies whether this shape is the [**background shape**](#gt_35f68e44-a7fb-4b81-863a-a8ab1db2b016) of a [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). If **fUsefBackground** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Callout + +The **Callout** property set specifies the visual attributes of a [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a) [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### unused832 + +The **unused832** property is undefined and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0340. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused832 (4 bytes):** A value that is undefined and MUST be ignored. + +#### dxyCalloutGap + +The **dxyCalloutGap** property specifies the distance from the box of this [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a) to the first point of this callout. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table further specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0341. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxyCalloutGap (4 bytes):** A signed integer that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), from the callout box to the first vertex of the callout, as shown in the following figure. This value SHOULD be in the range from 0x00000000 through 0x0132F53F. The default value for this property is 0x00001DB0. + +![The gap between the callout box and the first vertex of the callout](media/image9.bin "The gap between the callout box and the first vertex of the callout") + +Figure 2: The gap between the callout box and the first vertex of the callout + +#### spcoa + +The **spcoa** property specifies the connection angle of this [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0342. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**spcoa (4 bytes):** An enumeration value that specifies the connection angle of this callout, according to the following table. If the **rh.recInstance** field in the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for this callout [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is set to [msosptCallout90](#msospt), msosptAccentCallout90, msosptBorderCallout90, or msosptAccentBorderCallout90, this value MUST equal **msospcoaAny**. The default value for this property is **msospcoaAny**. + +| Name | Value | Description | +|----|----|----| +| **msospcoaAny** | 0x00000000 | The callout is drawn according to its list of vertices. | +| **msospcoa30** | 0x00000001 | The callout is drawn at a 30-degree angle. | +| **msospcoa45** | 0x00000002 | The callout is drawn at a 45-degree angle. | +| **msospcoa60** | 0x00000003 | The callout is drawn at a 60-degree angle. | +| **msospcoa90** | 0x00000004 | The callout is drawn vertically. | +| **msospcoa0** | 0x00000005 | The callout is drawn horizontally. | + +#### spcod + +The **spcod** property specifies where this [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a) connects to the callout box. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0343. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**spcod (4 bytes):** An enumeration value that specifies the connection position according to the following table. + +| Name | Value | Description | +|----|----|----| +| **msospcodTop** | 0x00000000 | This callout connects to the top of the callout box. | +| **msospcodCenter** | 0x00000001 | This callout connects to the callout box at the midpoint of its top and bottom coordinates. | +| **msospcodBottom** | 0x00000002 | This callout connects to the bottom of the callout box. | +| **msospcodSpecified** | 0x00000003 | This callout connects to the callout box as defined by the **dxyCalloutDropSpecified** property, as defined in section [2.3.3.5](#dxycalloutdropspecified). | + +If the **rh.recInstance** field of the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for this callout [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is set to [msosptCallout90](#msospt), msosptAccentCallout90, msosptBorderCallout90, or msosptAccentBorderCallout90, the top and bottom of the callout box are defined along the same dimensions as the line segment of the callout. The bottom of the callout is the end with a variable position, as shown in the following figure. The default value for this property is **msospcodSpecified**. + +![The bottom and the top of the callout](media/image10.bin "The bottom and the top of the callout") + +Figure 3: The bottom and the top of the callout + +#### dxyCalloutDropSpecified + +The **dxyCalloutDropSpecified** property specifies the distance between this [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a) and the callout box. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0344. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxyCalloutDropSpecified (4 bytes):** A signed integer that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), between the callout and the top of the callout box. This value SHOULD be in the range from 0x00000000 through 0x0132F53F and MUST be ignored unless the **spcod** property, as defined in section [2.3.3.4](#spcod), equals **msospcodSpecified**. The default value for this property is 0x0001BE7C. + +#### dxyCalloutLengthSpecified + +The **dxyCalloutLengthSpecified** property specifies the length of this [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0345. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxyCalloutLengthSpecified (4 bytes):** A signed integer that specifies the length, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the first callout segment, as shown in the following figure. This value SHOULD be in the range from 0x00000000 through 0x0132F53F and MUST be ignored unless the **fCalloutLengthSpecified** bit of [Callout Boolean Properties](#callout-boolean-properties) equals 0x1. The default value for this property is 0x00000000. + +![The first segment of the callout](media/image11.bin "The first segment of the callout") + +Figure 4: The first segment of the callout + +#### Callout Boolean Properties + +The **Callout Boolean Properties** specify a 32-bit field of Boolean properties for a [**callout**](#gt_e79ccf0f-b3e8-4f9f-bb85-086c1002c83a) [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x037F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (9 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefCallout (1 bit):** A bit that specifies whether the **fCallout** bit is set. A value of 0x0 specifies that the **fCallout** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**B - fUsefCalloutAccentBar (1 bit):** A bit that specifies whether the **fCalloutAccentBar** bit is set. A value of 0x0 specifies that the **fCalloutAccentBar** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefCalloutTextBorder (1 bit):** A bit that specifies whether the **fCalloutTextBorder** bit is set. A value of 0x0 specifies that the **fCalloutTextBorder** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**D - fUsefCalloutMinusX (1 bit):** A bit that specifies whether the **fCalloutMinusX** bit is set. A value of 0x0 specifies that the **fCalloutMinusX** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefCalloutMinusY (1 bit):** A bit that specifies whether the **fCalloutMinusY** bit is set. A value of 0x0 specifies that the **fCalloutMinusY** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - fUsefCalloutDropAuto (1 bit):** A bit that specifies whether the **fCalloutDropAuto** bit is set. A value of 0x0 specifies that the **fCalloutDropAuto** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**G - fUsefCalloutLengthSpecified (1 bit):** A bit that specifies whether the **fCalloutLengthSpecified** bit is set. A value of 0x0 specifies that the **fCalloutLengthSpecified** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused2 (9 bits):** A value that is undefined and MUST be ignored. + +**H - fCallout (1 bit):** A bit that specifies whether the shape is a callout shape. This value MUST be ignored if **fUsefCallout** equals 0x0. The default value for this property is 0x0. + +**I - fCalloutAccentBar (1 bit):** A bit that specifies whether the callout shape has an accent bar. This value MUST be ignored if **fUsefCalloutAccentBar** equals 0x0. The default value for this property is 0x0. + +**J - fCalloutTextBorder (1 bit):** A bit that specifies whether the callout shape has a text border. This value MUST be ignored if **fUsefCalloutTextBorder** equals 0x0. The default value for this property is 0x1. + +**K - fCalloutMinusX (1 bit):** A bit that specifies whether the callout shape is flipped on the x-axis. This value MUST be ignored if **fUsefCalloutMinusX** equals 0x0. The default value for this property is 0x0. + +**L - fCalloutMinusY (1 bit):** A bit that specifies whether the callout shape is flipped on the y-axis. This value MUST be ignored if **fUsefCalloutMinusY** equals 0x0. The default value for this property is 0x0. + +**M - fCalloutDropAuto (1 bit):** A bit that specifies whether the location of the callout shape is calculated based on the endpoint of the object being called out. If this value equals 0x1, the callout SHOULD be located at the **dxyCalloutGap** property, as defined in section [2.3.3.2](#dxycalloutgap), value distance above or below the shape. This value MUST be ignored if **fUsefCalloutDropAuto** equals 0x0. The default value for this property is 0x0. + +**N - fCalloutLengthSpecified (1 bit):** A bit that specifies whether the **dxyCalloutLengthSpecified** property, as defined in section [2.3.3.6](#dxycalloutlengthspecified), SHOULD be used. This value MUST be ignored if **fUsefCalloutLengthSpecified** equals 0x0. The default value for this property is 0x0. + +### Group Shape + +The **Group Shape** property set specifies properties that are applicable to a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) or a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### wzName + +The **wzName** property specifies the name of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0380. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzName_complex** property, as defined in section [2.3.4.2](#wzname_complex), exists. If the value equals 0x1, **wzName_complex** MUST exist. | + +**wzName (4 bytes):** The number of bytes of data in the **wzName_complex** property, as defined in section 2.3.4.2. If **opid.fComplex** equals 0x0, this value MUST equal 0x00000000. The default value for this property is 0x00000000. + +#### wzName_complex + +The **wzName_complex** property specifies additional data for the **wzName** property, as defined in section [2.3.4.1](#wzname). If the **opid.fComplex** bit of **wzName** equals 0x1, this property MUST exist. + +[TABLE] + +**wzName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the name for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### wzDescription + +The **wzDescription** property specifies a textual description for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0381. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzDescription_complex** property, as defined in section [2.3.4.4](#wzdescription_complex), exists. If the value equals 0x1, **wzDescription_complex** MUST exist. | + +**wzDescription (4 bytes):** The number of bytes of data in the **wzDescription_complex** property, as defined in section 2.3.4.4. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzDescription_complex + +The **wzDescription_complex** property specifies additional data for the **wzDescription** property, as defined in section [2.3.4.3](#wzdescription). If the **opid.fComplex** bit of **wzDescription** equals 0x1, this property MUST exist. + +[TABLE] + +**wzDescription_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the description for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### pihlShape + +The **pihlShape** property specifies a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0382. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pihlShape_complex** property, as defined in section [2.3.4.6](#pihlshape_complex), exists. If the value equals 0x1, **pihlShape_complex** MUST exist. | + +**pihlShape (4 bytes):** The number of bytes of data in the **pihlShape_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pihlShape_complex + +The **pihlShape_complex** property specifies additional data for the **pihlShape** property, as defined in section [2.3.4.5](#pihlshape). If the **opid.fComplex** bit of **pihlShape** equals 0x1, this property MUST exist. + +[TABLE] + +**pihlShape_complex (variable):** An **IHlink** record, as defined in section [2.2.60](#ihlink), that specifies the [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### pWrapPolygonVertices + +The **pWrapPolygonVertices** property specifies a list of points that is used to define a [**wrap polygon**](#gt_83f0daa5-41c5-4926-b97a-4c9033b58a5e) for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0383. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pWrapPolygonVertices_complex** property, as defined in section [2.3.4.8](#pwrappolygonvertices_complex), exists. If the value equals 0x1, **pWrapPolygonVertices_complex** MUST exist. | + +**pWrapPolygonVertices (4 bytes):** The number of bytes of data in the **pWrapPolygonVertices_complex** property, as defined in section 2.3.4.8. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pWrapPolygonVertices_complex + +The **pWrapPolygonVertices_complex** property specifies additional data for the **pWrapPolygonVertices** property, as defined in section [2.3.4.7](#pwrappolygonvertices). If the **opid.fComplex** bit of **pWrapPolygonVertices** equals 0x1, this property MUST exist. + +[TABLE] + +**pWrapPolygonVertices_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **POINT** structures, as defined in section [2.2.55](#point), that defines the [**wrap polygon**](#gt_83f0daa5-41c5-4926-b97a-4c9033b58a5e). The **POINT** structures exist in the same coordinate space as the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The coordinate space is specified by the **geoLeft**, as defined in section [2.3.6.1](#geoleft), **geoRight**, as defined in section [2.3.6.3](#georight), **geoTop**, as defined in section [2.3.6.2](#geotop), and **geoBottom**, as defined in section [2.3.6.4](#geobottom), properties. + +#### dxWrapDistLeft + +The **dxWrapDistLeft** property specifies how close other document content can come to the left edge of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0384. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxWrapDistLeft (4 bytes):** A signed integer specifying the minimum distance, in application-defined units, that an object can be placed next to the left edge of the shape. The default value for this property is 0x0001BE7C. + +#### dyWrapDistTop + +The **dyWrapDistTop** property specifies how close other document content can come to the top edge of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0385. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dyWrapDistTop (4 bytes):** A signed integer that specifies the minimum distance, in application-defined units, that an object can be placed next to the top edge of the shape. The default value for this property is 0x00000000. + +#### dxWrapDistRight + +The **dxWrapDistRight** property specifies how close other document content can come to the right edge of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0386. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxWrapDistRight (4 bytes):** A signed integer that specifies the minimum distance, in application-defined units, that an object can be placed next to the right edge of the shape. The default value for this property is 0x0001BE7C. + +#### dyWrapDistBottom + +The **dyWrapDistBottom** property specifies how close other document content can come to the bottom edge of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0387. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dyWrapDistBottom (4 bytes):** A signed integer that specifies the minimum distance, in application-defined units, that an object can be placed next to the bottom edge of the shape. The default value for this property is 0x00000000. + +#### lidRegroup + +The **lidRegroup** property specifies the [**regroup identifier**](#gt_6986f98a-4a8f-467f-b175-8e3c09cb569d) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0388. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lidRegroup (4 bytes):** An unsigned integer that specifies the **FRID** data type, as defined in section [2.1.3](#frid), of this shape. The default value for this property is 0x00000000. + +#### unused906 + +The **unused906** property is undefined and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x038A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused906 (4 bytes):** A value that is undefined and MUST be ignored. + +#### wzTooltip + +The **wzTooltip** property specifies a [**ToolTip**](#gt_84d44447-feaf-41a4-bf12-004c0f080fc2) for a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x038D. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzTooltip_complex** property, as defined in section [2.3.4.16](#wztooltip_complex), exists. If the value equals 0x1, **wzTooltip_complex** MUST exist. | + +**wzTooltip (4 bytes):** The number of bytes of data in the **wzTooltip_complex** property, as defined in section 2.3.4.16. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzTooltip_complex + +The **wzTooltip_complex** property specifies additional data for the **wzTooltip** property, as defined in section [2.3.4.15](#wztooltip). If the **opid.fComplex** bit of **wzTooltip** equals 0x1, this property MUST exist. + +[TABLE] + +**wzTooltip_complex (variable):** A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) null-terminated string that specifies the text of the [**ToolTip**](#gt_84d44447-feaf-41a4-bf12-004c0f080fc2). + +#### wzScript + +The **wzScript** property specifies a script that is attached to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x038E. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzScript_complex**, as defined in section [2.3.4.18](#wzscript_complex), property exists. If the value equals 0x1, **wzScript_complex** MUST exist. | + +**wzScript (4 bytes):** The number of bytes of data in the **wzScript_complex**, as defined in section 2.3.4.18, property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzScript_complex + +The **wzScript_complex** property specifies additional data for the **wzScript** property, as defined in section [2.3.4.17](#wzscript). If the **opid.fComplex** bit of the **wzScript** property equals 0x1, this property MUST exist. + +[TABLE] + +**wzScript_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies a script for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### posh + +The **posh** property specifies the type of horizontal positioning to use for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x038F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**posh (4 bytes):** An enumeration value that MAY[\<21\>](#Appendix_A_21) be used to determine how a shape is horizontally positioned, relative to the [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f) that is specified in the **posrelh** property, as defined in section [2.3.4.20](#posrelh). This value MUST be one of the values in the following table. The default value for this property is **msophAbs**. + +| Name | Value | Description | +|----|----|----| +| **msophAbs** | 0x00000000 | The shape is horizontally offset by an absolute distance from the page element. | +| **msophLeft** | 0x00000001 | The shape is horizontally positioned at the left side of the page element. | +| **msophCenter** | 0x00000002 | The shape is horizontally positioned at the center of the page element. | +| **msophRight** | 0x00000003 | The shape is horizontally positioned at the right side of the page element. | +| **msophInside** | 0x00000004 | The shape is horizontally positioned like **msophLeft** on odd-numbered pages and like **msophRight** on even-numbered pages. | +| **msophOutside** | 0x00000005 | The shape is horizontally positioned like **msophRight** on odd-numbered pages and like **msophLeft** on even-numbered pages. | + +#### posrelh + +The **posrelh** property specifies a [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f) relative to which a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is horizontally positioned. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0390. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**posrelh (4 bytes):** An enumeration value that MAY[\<22\>](#Appendix_A_22) be used to determine the page element that the horizontal position of a shape is relative to. This value MUST be one of the values that are listed in the following tables. The default value for this property is **msoprhText**. + +If the value of the **posh** property, as defined in section [2.3.4.19](#posh), equals **msophAbs**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posh** property, as defined in section 2.3.4.19, equals **msophLeft**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posh** property, as defined in section 2.3.4.19, equals **msophCenter**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posh** property, as defined in section 2.3.4.19, equals **msophRight**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posh** property, as defined in section 2.3.4.19, equals **msophInside**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +The shape is horizontally positioned relative to the edges of the page.The shape is horizontally positioned relative to the edges of the page. The shape is left aligned with the left page edge for odd numbered pages. + +If the value of the **posh** property, as defined in section 2.3.4.19, equals **msophOutside**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +#### posv + +The **posv** property specifies the type of vertical positioning to use for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0391. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**posv (4 bytes):** An enumeration value that MAY[\<23\>](#Appendix_A_23) be used to determine how a shape is vertically positioned, relative to the [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f) that is specified in the **posrelv** property, as defined in section [2.3.4.22](#posrelv). This value MUST be one of the values in the following table. The default value for this property is **msopvAbs**. + +| Name | Value | Description | +|----|----|----| +| **msopvAbs** | 0x00000000 | The shape is vertically offset by an absolute distance from the page element. | +| **msopvTop** | 0x00000001 | The shape is vertically positioned at the top of the page element. | +| **msopvCenter** | 0x00000002 | The shape is vertically positioned in the center of the page element. | +| **msopvBottom** | 0x00000003 | The shape is vertically positioned at the bottom of the page element. | +| **msopvInside** | 0x00000004 | The shape is vertically positioned like **msopvTop** on odd-numbered pages and like **msopvBottom** on even-numbered pages. | +| **msopvOutside** | 0x00000005 | The shape is vertically positioned like **msopvBottom** on odd-numbered pages and like **msopvTop** on even-numbered pages. | + +#### posrelv + +The **posrelv** property specifies a [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f) relative to which a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is vertically positioned. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0392. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**posrelv (4 bytes):** An enumeration value that MAY[\<24\>](#Appendix_A_24) be used to determine the page element that the horizontal position of a shape is relative to. This value MUST be one of the values that are listed in the following tables. The default value for this property is **msoprvText**. + +If the value of the **posv** property, as defined in section [2.3.4.21](#posv), equals **msopvAbs**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posv** property, as defined in section 2.3.4.21, equals **msopvTop**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posv** property, as defined in section 2.3.4.21, equals **msopvCenter**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posv** property, as defined in section 2.3.4.21, equals **msopvBottom**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posv** property, as defined in section 2.3.4.21, equals **msopvInside**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +If the value of the **posv** property, as defined in section 2.3.4.21, equals **msopvOutside**, the possible values for this property position the shape as shown in the following table. + +[TABLE] + +#### pctHR + +The **pctHR** property specifies the width of a [**horizontal rule**](#gt_87c189d8-1b51-4a05-871e-308cdcf14dcd), as a percentage of the page width. This property SHOULD[\<25\>](#Appendix_A_25) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0393. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pctHR (4 bytes):** An unsigned integer that specifies the width of a horizontal rule as a percentage of the page’s width, in units of 0.1%. The value MUST be greater than or equal to 0x00000000 and less than or equal to 0x000003E8. This property is used only if the **fHorizRule** bit of the [Group Shape Boolean Properties](#group-shape-boolean-properties) is set. The default value for this property is 0x000003E8. + +#### alignHR + +The **alignHR** property specifies the alignment of a [**horizontal rule**](#gt_87c189d8-1b51-4a05-871e-308cdcf14dcd). This property SHOULD[\<26\>](#Appendix_A_26) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0394. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**alignHR (4 bytes):** An enumeration value that specifies the alignment of a horizontal rule. This property is used only if the **fHorizRule** bit of the [Group Shape Boolean Properties](#group-shape-boolean-properties) is set. The value MUST be one of the values in the following table. The default value for this property is 0x00000000. + +[TABLE] + +#### dxHeightHR + +The **dxHeightHR** property specifies the height of a [**horizontal rule**](#gt_87c189d8-1b51-4a05-871e-308cdcf14dcd). This property SHOULD[\<27\>](#Appendix_A_27) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0395. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxHeightHR (4 bytes):** A signed integer that specifies the height, in 1440ths of an inch, of a horizontal rule. The value MUST be greater than or equal to 0x00000000. This property is used only if the **fHorizRule** bit of the [Group Shape Boolean Properties](#group-shape-boolean-properties) is set. The default value for this property is 0x00000000. + +#### dxWidthHR + +The **dxWidthHR** property specifies the width of a [**horizontal rule**](#gt_87c189d8-1b51-4a05-871e-308cdcf14dcd). This property SHOULD[\<28\>](#Appendix_A_28) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0396. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxWidthHR (4 bytes):** A signed integer that specifies the width, in 1440ths of an inch, of a horizontal rule. The value MUST be greater than or equal to 0x00000000. If the **pctHR** property, as defined in section [2.3.4.23](#pcthr), is also set, it SHOULD be used instead and this property ignored. This property is used only if the **fHorizRule** bit of the [Group Shape Boolean Properties](#group-shape-boolean-properties) is set. The default value for this property is 0x00000000. + +#### wzScriptExtAttr + +The **wzScriptExtAttr** property specifies an extra [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf) attribute that is associated with a script block for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) if this document is saved as HTML. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0397. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzScriptExtAttr_complex** property, as defined in section [2.3.4.28](#wzscriptextattr_complex), exists. If the value equals 0x1, **wzScriptExtAttr_complex** MUST exist. | + +**wzScriptExtAttr (4 bytes):** The number of bytes of data in the **wzScriptExtAttr_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzScriptExtAttr_complex + +The **wzScriptExtAttr_complex** property specifies additional data for the **wzScriptExtAttr** property, as defined in section [2.3.4.27](#wzscriptextattr). If the **opid.fComplex** bit of **wzScriptExtAttr** equals 0x1, this property MUST exist. + +[TABLE] + +**wzScriptExtAttr_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the extra attribute. + +#### scriptLang + +The **scriptLang** property specifies the language of the script on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0398. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**scriptLang (4 bytes):** A signed integer that specifies the scripting language. The value MUST be one of the values in the following table. The default value for this property is 0x00000001. + +| Value | Meaning | +|----|----| +| 0x00000001 | JavaScript | +| 0x00000002 | VBScript | +| 0x00000003 | [**Active Server Pages (ASP)**](#gt_7951949a-40bb-4d9c-bcce-5ae849989e5d) | +| 0x00000004 | Other language, which MUST be specified in the [wzScriptLangAttr_complex](#wzscriptlangattr_complex) property | + +#### wzScriptLangAttr + +The **wzScriptLangAttr** property specifies the scripting language on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If the **scriptLang** property, as defined in section [2.3.4.29](#scriptlang), equals any value other than 0x00000004, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x039A. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzScriptLangAttr_complex** property, as defined in section [2.3.4.31](#wzscriptlangattr_complex), exists. If the value equals 0x1, **wzScriptLangAttr_complex** MUST exist. | + +**wzScriptLangAttr (4 bytes):** The number of bytes of data in the **wzScriptLangAttr_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzScriptLangAttr_complex + +The **wzScriptLangAttr_complex** property specifies additional data for the **wzScriptLangAttr** property, as defined in section [2.3.4.30](#wzscriptlangattr). If the **opid.fComplex** bit of **wzScriptLangAttr** equals 0x1, this property MUST exist. + +[TABLE] + +**wzScriptLangAttr_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string containing the name of the scripting language that is used for the script on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### borderTopColor + +The **borderTopColor** property specifies the color for the top border of a picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x039B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**borderTopColor (4 bytes):** An [**OfficeArtCOLORREF**](#officeartcolorref) record, as defined in section 2.2.2, that specifies the color. The default value for this property is 0xFFFFFFFF. + +#### borderLeftColor + +The **borderLeftColor** property specifies the color for the left border of a picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x039C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**borderLeftColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the color. The default value for this property is 0xFFFFFFFF. + +#### borderBottomColor + +The **borderBottomColor** property specifies the color for the bottom border of a picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x039D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**borderBottomColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the color. The default value for this property is 0xFFFFFFFF. + +#### borderRightColor + +The **borderRightColor** property specifies the color for the right border of a picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x039E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**borderRightColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the color. The default value for this property is 0xFFFFFFFF. + +#### tableProperties + +The **tableProperties** property specifies flags for a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) that represents a table. This property SHOULD[\<29\>](#Appendix_A_29) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x039F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**tableProperties (4 bytes):** A **TABLEFLAGS** record, as defined in section [2.2.59](#tableflags), that specifies the table-related flags for the group. The default value for this property is 0x00000000. + +#### tableRowProperties + +The **tableRowProperties** property specifies the minimum sizes of the rows in a table. This property SHOULD[\<30\>](#Appendix_A_30) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x03A0. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **tableRowProperties_complex** property, as defined in section [2.3.4.38](#tablerowproperties_complex), exists. If the value equals 0x1, **tableRowProperties_complex** MUST exist. | + +**tableRowProperties (4 bytes):** The number of bytes of data in the **tableRowProperties_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### tableRowProperties_complex + +The **tableRowProperties_complex** property specifies additional data for the **tableRowProperties** property, as defined in section [2.3.4.37](#tablerowproperties). If the **opid.fComplex** bit of **tableRowProperties** equals 0x1, this property MUST exist. + +[TABLE] + +**tableRowProperties_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of 32-bit signed integers that specify the minimum heights, in [**master units**](#gt_b70408ee-a21b-477f-afe9-e73c6fdb4bdb), of the rows in a table. The minimum heights are used if the rows do not contain wrapped text that would otherwise cause the rows to be taller. The array MUST contain the same number of elements as there are rows in the table. If the **fIsTable** bit in the **tableProperties** property, as defined in section [2.3.4.36](#tableproperties), equals 0x00000000, this property SHOULD be ignored. + +#### wzWebBot + +The **wzWebBot** property specifies content for a [**Web component**](#gt_5064ea88-847f-4008-ba59-5f7a0a323970)[\<31\>](#Appendix_A_31), that is associated with a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) if this document is saved as [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x03A5. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzWebBot_complex** property, as defined in section [2.3.4.40](#wzwebbot_complex), exists. If the value equals 0x1, **wzWebBot_complex** MUST exist | + +**wzWebBot (4 bytes):** The number of bytes of data in the **wzWebBot_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzWebBot_complex + +The **wzWebBot_complex** property specifies additional data for the **wzWebBot** property, as defined in section [2.3.4.39](#wzwebbot). If the **opid.fComplex** bit of **wzWebBot** equals 0x1, this property MUST exist. + +[TABLE] + +**wzWebBot_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the content for the [**Web component**](#gt_5064ea88-847f-4008-ba59-5f7a0a323970). + +#### metroBlob + +The **metroBlob** property specifies alternative [**XML**](#gt_982b7f8e-d516-4fd5-8d5e-1a836081ed85) content for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that SHOULD[\<32\>](#Appendix_A_32) be ignored. This property specifies a binary serialization of an Open Packaging Conventions container, as specified in [\[ISO/IEC29500-2:2012\]](https://go.microsoft.com/fwlink/?LinkID=330448). The package contains an Office Open XML DrawingML document, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 5. + +If the shape is modified after it is loaded, Office will delete this information. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x03A9. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **metroBlob_complex** property, as defined in section [2.3.4.42](#metroblob_complex), exists. If the value equals 0x1, the **metroBlob_complex** property MUST exist. | + +**metroBlob (4 bytes):** The number of bytes of data in the **metroBlob_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### metroBlob_complex + +The **metroBlob_complex** property specifies additional data for the **metroBlob** property, as defined in section [2.3.4.41](#metroblob). If the **opid.fComplex** bit of **metroBlob** equals 0x1, this property MUST exist. + +[TABLE] + +**metroBlob_complex (variable):** A binary serialization of an Open Packaging Conventions container, as specified in [\[ISO/IEC29500-2:2012\]](https://go.microsoft.com/fwlink/?LinkID=330448), that specifies the alternative [**XML**](#gt_982b7f8e-d516-4fd5-8d5e-1a836081ed85) content. + +#### dhgt + +The **dhgt** property specifies the relative [**z-order**](#gt_5d059b23-337a-4ab8-82f5-e3789b2e7ae9) of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This property SHOULD[\<33\>](#Appendix_A_33) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03AA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dhgt (4 bytes):** An unsigned integer that specifies the z-order of a shape, relative to the corresponding values for other shapes. Higher z-order values specify that the shape is in front of shapes with lower values. A value of zero means that the z-order is not specified. Only shapes that have the same value in the **fBehindDocument** bit of the [Group Shape Boolean Properties](#group-shape-boolean-properties) are compared to one another. All of the shapes behind the document are beneath the other shapes. The default value for this property is 0x00000000. + +#### Group Shape Boolean Properties + +The **Group Shape Boolean Properties** specify a 32-bit field of Boolean properties for either a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) or a [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**A - fUsefLayoutInCell (1 bit):** A bit that specifies whether the **fLayoutInCell** bit is set. A value of 0x0 specifies that the **fLayoutInCell** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**B - fUsefIsBullet (1 bit):** A bit that specifies whether the **fIsBullet** bit is set. A value of 0x0 specifies that the **fIsBullet** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefStandardHR (1 bit):** A bit that specifies whether the **fStandardHR** bit is set. A value of 0x0 specifies that the **fStandardHR** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**D - fUsefNoshadeHR (1 bit):** A bit that specifies whether the **fNoshadeHR** bit is set. A value of 0x0 specifies that the **fNoshadeHR** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefHorizRule (1 bit):** A bit that specifies whether the **fHorizRule** bit is set. A value of 0x0 specifies that the **fHorizRule** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - fUsefUserDrawn (1 bit):** A bit that specifies whether the **fUserDrawn** bit is set. A value of 0x0 specifies that the **fUserDrawn** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**G - fUsefAllowOverlap (1 bit):** A bit that specifies whether the **fAllowOverlap** bit is set. A value of 0x0 specifies that the **fAllowOverlap** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefReallyHidden (1 bit):** A bit that specifies whether the **fReallyHidden** bit is set. A value of 0x0 specifies that the **fReallyHidden** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefScriptAnchor (1 bit):** A bit that specifies whether the **fScriptAnchor** bit is set. A value of 0x0 specifies that the **fScriptAnchor** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefEditedWrap (1 bit):** A bit that specifies whether the **fEditedWrap** bit is set. A value of 0x0 specifies that the **fEditedWrap** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**K - fUsefBehindDocument (1 bit):** A bit that specifies whether the **fBehindDocument** bit is set. A value of 0x0 specifies that the **fBehindDocument** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**L - fUsefOnDblClickNotify (1 bit):** A bit that specifies whether the **fOnDblClickNotify** bit is set. A value of 0x0 specifies that the **fOnDblClickNotify** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**M - fUsefIsButton (1 bit):** A bit that specifies whether the **fIsButton** bit is set. A value of 0x0 specifies that the **fIsButton** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**N - fUsefOneD (1 bit):** A bit that specifies whether the **fOneD** bit is set. A value of 0x0 specifies that the **fOneD** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**O - fUsefHidden (1 bit):** A bit that specifies whether the **fHidden** bit is set. A value of 0x0 specifies that the **fHidden** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**P - fUsefPrint (1 bit):** A bit that specifies whether the **fPrint** bit is set. A value of 0x0 specifies that the **fPrint** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**Q - fLayoutInCell (1 bit):** A bit that specifies whether this shape is displayed inside a table cell. If **fUsefLayoutInCell** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**R - fIsBullet (1 bit):** A bit that specifies whether this shape is being used as a [**picture bullet**](#gt_3333c5cd-7dd7-4ae1-8780-70ca23ee202c). If **fUsefIsBullet** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**S - fStandardHR (1 bit):** A bit that specifies whether this [**horizontal rule**](#gt_87c189d8-1b51-4a05-871e-308cdcf14dcd) is one that does not contain a picture. If **fUsefStandardHR** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**T - fNoshadeHR (1 bit):** A bit that specifies whether this horizontal rule uses a solid color fill without shading. If **fUsefNoshadeHR** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**U - fHorizRule (1 bit):** A bit that specifies whether this shape is a horizontal rule. If **fUsefHorizRule** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**V - fUserDrawn (1 bit):** A bit that specifies whether this shape has been added to a document [**master**](#gt_7bc43fab-2908-4fdd-b933-2f6429802521) by the user. If **fUsefUserDrawn** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**W - fAllowOverlap (1 bit):** A bit that specifies whether this shape is allowed to overlap another shape. If **fUsefAllowOverlap** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**X - fReallyHidden (1 bit):** A bit that specifies whether this shape will be prevented from displaying. This property applies only to [**script anchors**](#gt_4e48af75-af44-48ca-a993-3468f5fdead8). The **fScriptAnchor** property MUST be set to 0x1 for the value of this property to be used. If **fUsefReallyHidden** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**Y - fScriptAnchor (1 bit):** A bit that specifies whether this shape is a script anchor. If **fUsefScriptAnchor** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**Z - fEditedWrap (1 bit):** A bit that specifies whether the [**wrap polygon**](#gt_83f0daa5-41c5-4926-b97a-4c9033b58a5e) for this shape has been edited by the user. If **fUsefEditedWrap** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**a - fBehindDocument (1 bit):** A bit that specifies whether this shape is set to display behind other document content. If **fUsefBehindDocument** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**b - fOnDblClickNotify (1 bit):** A bit that specifies whether the host application is to be notified when a double-click mouse event occurs for the shape. If **fUsefOnDblClickNotify** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**c - fIsButton (1 bit):** A bit that specifies whether this shape is treated as a button that contains navigation information. If **fUsefIsButton** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**d - fOneD (1 bit):** A bit that is unused and MUST be set to 0x0. If **fUsefOneD** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**e - fHidden (1 bit):** A bit that specifies whether this shape will be prevented from displaying. If **fUsefHidden** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**f - fPrint (1 bit):** A bit that specifies whether this shape will be rendered if the document is printed. If **fUsefPrint** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +### Group Shape 2 + +The **Group Shape 2** property set specifies the relative position and size attributes of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### pctHoriz + +The **pctHoriz** property specifies the width of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) as a percentage relative to the width of a [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f). This property SHOULD[\<34\>](#Appendix_A_34) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07C0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pctHoriz (4 bytes):** An unsigned integer that specifies the width of a shape as a percentage relative to the width of a page element. The **sizerelh** property, as defined in section [2.3.5.5](#sizerelh), specifies the page element. Units are specified in increments of 0.1%. This value MUST be greater than or equal to 0x00000000 and less than or equal to 0x00002710. The default value for this property is 0x00000000. + +#### pctVert + +The **pctVert** property specifies the height of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) as a percentage relative to the height of a [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f). This property SHOULD[\<35\>](#Appendix_A_35) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07C1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pctVert (4 bytes):** An unsigned integer that specifies the height of a shape as a percentage relative to the height of a page element. The **sizerelh** property, as defined in section [2.3.5.5](#sizerelh), specifies the page element. Units are specified in increments of 0.1%. This value MUST be greater than or equal to 0x00000000 and less than or equal to 0x00002710. The default value for this property is 0x00000000. + +#### pctHorizPos + +The **pctHorizPos** property specifies the horizontal position of a shape as a percentage offset relative to the layout of a [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f). The **posrelh** property, as defined in section [2.3.4.20](#posrelh), specifies the page element. This property SHOULD[\<36\>](#Appendix_A_36) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07C2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pctHorizPos (4 bytes):** A signed integer that specifies the horizontal position of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) as a percentage offset relative to the horizontal position of a page element. Units are specified in increments of 0.1%. This value MUST be greater than or equal to 0xFFFFD8EF and less than or equal to 0x00002710. A value of 0x00000000 specifies that the horizontal position equals the left edge of the page element; a value of 0x00002710 specifies that the horizontal position equals the right edge of the page element. A value of 0xFFFFD8EF specifies that the horizontal position of the shape is not a relative percentage offset and not specified by this field. The default value for this property is 0xFFFFD8EF. + +#### pctVertPos + +The **pctVertPos** property specifies the vertical position of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) as a percentage offset relative to the layout of a [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f). The **posrelv** property, as defined in section [2.3.4.22](#posrelv), specifies the page element. This property SHOULD[\<37\>](#Appendix_A_37) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07C3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pctVertPos (4 bytes):** A signed integer that specifies the vertical position of a shape as a percentage offset relative to the vertical position of a page element. Units are specified in increments of 0.1%. This value MUST be greater than or equal to 0xFFFFD8EF and less than or equal to 0x00002710. A value of 0x00000000 specifies that the vertical position equals the top edge of the page element; a value of 0x00002710 specifies that the vertical position equals the bottom edge of the page element. A value of 0xFFFFD8EF specifies that the vertical position of the shape is not a relative percentage offset and not specified by this field. The default value for this property is 0xFFFFD8EF. + +#### sizerelh + +The **sizerelh** property specifies the [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f) that has a width equal to 100% for the **pctHoriz** property, as defined in section [2.3.5.1](#pcthoriz). The page element specifies either the page or a part of the page on which the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is located. This property SHOULD[\<38\>](#Appendix_A_38) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07C4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**sizerelh (4 bytes):** An enumeration specifying the page element that has a width equal to 100% for the **pctHoriz** property, as defined in section 2.3.5.1. The page element specifies either the page or a part of the page on which the shape is located. This value MUST be one of the values in the following table. The default value for this property is **msosrhPage**. + +| Name | Value | Description | +|----|----|----| +| **msosrhMargin** | 0x00000000 | The page, excluding the margins. | +| **msosrhPage** | 0x00000001 | The page. | +| **msosrhLeftMargin** | 0x00000002 | The left margin. | +| **msosrhRightMargin** | 0x00000003 | The right margin. | +| **msosrhInsideMargin** | 0x00000004 | The [**inside margin**](#gt_eb3d2afd-cd0c-4db9-846f-03217b86039f). | +| **msosrhOutsideMargin** | 0x00000005 | The [**outside margin**](#gt_ab666477-1ea5-4661-8d60-5205bc4ce58f). | + +#### sizerelv + +The **sizerelv** property specifies the [**page element**](#gt_039dff32-4d83-4713-a0ad-6239d6a08c8f) that has a height equal to 100% for the **pctVert** property, as defined in section [2.3.5.2](#pctvert). This property SHOULD[\<39\>](#Appendix_A_39) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07C5. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**sizerelv (4 bytes):** An unsigned integer specifying the page element that has a height equal to 100% for the **pctVert** property, as defined in section 2.3.5.2**.** The page element specifies either the page or a part of the page on which the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is located. This value MUST be one of the values in the following table. The default value for this property is **msosrvPage**. + +| Name | Value | Description | +|----|----|----| +| **msosrvMargin** | 0x00000000 | The page, excluding the margins. | +| **msosrvPage** | 0x00000001 | The page. | +| **msosrvTopMargin** | 0x00000002 | The top margin. | +| **msosrvBottomMargin** | 0x00000003 | The bottom margin. | +| **msosrvInsideMargin** | 0x00000004 | The [**inside margin**](#gt_eb3d2afd-cd0c-4db9-846f-03217b86039f). | +| **msosrvOutsideMargin** | 0x00000005 | The [**outside margin**](#gt_ab666477-1ea5-4661-8d60-5205bc4ce58f). | + +### Geometry + +The **Geometry** property set specifies the structure of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), including its points and how those points are connected. These properties also specify how the shape scales in size and how the user can manipulate the scaling. + +#### geoLeft + +The **geoLeft** property specifies the left coordinate of the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0140. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**geoLeft (4 bytes):** A signed integer that specifies the left coordinate of the geometry space for this shape. The **geoLeft**, **geoTop**, as defined in section [2.3.6.2](#geotop), **geoRight**, as defined in section [2.3.6.3](#georight), and **geoBottom**, as defined in section [2.3.6.4](#geobottom), properties combine to define a rectangle that specifies an arbitrary coordinate system, called a geometry space, that geometry coordinates are specified in. When a shape is rendered, any points that are specified in the geometry space are translated into the coordinate system of the shape by matching the geometry space rectangle with the bounding rectangle of the shape, and scaling appropriately. The default value for this property is 0x00000000. + +#### geoTop + +The **geoTop** property specifies the top coordinate of the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0141. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**geoTop (4 bytes):** A signed integer that specifies the top coordinate of the geometry space for this shape. The **geoLeft**, as defined in section [2.3.6.1](#geoleft), **geoTop**, **geoRight**, as defined in section [2.3.6.3](#georight), and **geoBottom**, as defined in section [2.3.6.4](#geobottom), properties combine to define a rectangle that specifies an arbitrary coordinate system, called a geometry space, that geometry coordinates are specified in. When a shape is rendered, any points that are specified in the geometry space are translated into the coordinate system of the shape by matching the geometry space rectangle with the bounding rectangle of the shape, and scaling appropriately. The default value for this property is 0x00000000. + +#### geoRight + +The **geoRight** property specifies the right coordinate of the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0142. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**geoRight (4 bytes):** A signed integer that specifies the right coordinate of the geometry space for this shape. The **geoLeft**, as defined in section [2.3.6.1](#geoleft), **geoTop**, as defined in section [2.3.6.2](#geotop), **geoRight**, and **geoBottom**, as defined in section [2.3.6.4](#geobottom), properties combine to define a rectangle that specifies an arbitrary coordinate system, called a geometry space, that geometry coordinates are specified in. When a shape is rendered, any points that are specified in the geometry space are translated into the coordinate system of the shape by matching the geometry space rectangle with the bounding rectangle of the shape, and scaling appropriately. The default value for this property is 0x00005460. + +#### geoBottom + +The **geoBottom** property specifies the bottom coordinate of the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0143. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**geoBottom (4 bytes):** A signed integer that specifies the bottom coordinate of the geometry space for this shape. The **geoLeft**, as defined in section [2.3.6.1](#geoleft), **geoTop**, as defined in section [2.3.6.2](#geotop), **geoRight**, as defined in section [2.3.6.3](#georight), and **geoBottom** properties combine to define a rectangle that specifies an arbitrary coordinate system, called a geometry space, that geometry coordinates are specified in. When a shape is rendered, any points that are specified in the geometry space are translated into the coordinate system of the shape by matching the geometry space rectangle with the bounding rectangle of the shape, and scaling appropriately. The default value for this property is 0x00005460. + +#### shapePath + +The **shapePath** property specifies the way that lines in this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) are to be drawn. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0144. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shapePath (4 bytes):** An **MSOSHAPEPATH** enumeration value, as defined in section [2.4.9](#msoshapepath), that specifies how vertices in this shape, as specified in the **pVertices_complex** property, as defined in section [2.3.6.7](#pvertices_complex), are connected. If the value is **msoshapeComplex**, the **pSegmentInfo_complex** property, as defined in section [2.3.6.9](#psegmentinfo_complex), MUST exist and contain more-detailed instructions about how to connect the vertices in this shape. If **pSegmentInfo_complex** is neither NULL nor empty, this property MUST be ignored and the connections between vertices specified by **pSegmentInfo_complex**. The default value for this property is **msoshapeLinesClosed**. + +#### pVertices + +The **pVertices** property specifies the set of points that make up this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0145. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pVertices_complex** property, as defined in section [2.3.6.7](#pvertices_complex), exists. If the value equals 0x1, the **pVertices_complex** property MUST exist. | + +**pVertices (4 bytes):** The number of bytes of data in the **pVertices_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pVertices_complex + +The **pVertices_complex** property specifies additional data for the **pVertices** property, as defined in section [2.3.6.6](#pvertices). If the **opid.fComplex** bit of **pVertices** equals 0x1, this property MUST exist. + +[TABLE] + +**pVertices_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **POINT** structures, as defined in section [2.2.55](#point), that represent the points comprising the geometry of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The point coordinates are specified in [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) units, unless a coordinate exists in the range from 0x80000000 through 0x8000007F. In that case, the value is not used directly. Instead, the final value is calculated by subtracting 0x8000000 from the original value, and then using that value as the zero-based index into the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex), to specify the value that controls the position of that coordinate. The way that the points are connected is specified by a combination of the **shapePath**, as defined in section [2.3.6.5](#shapepath), and **pSegmentInfo_complex** properties, as defined in section [2.3.6.9](#psegmentinfo_complex). + +#### pSegmentInfo + +The **pSegmentInfo** property specifies how the vertices that are specified by the **pVertices_complex** property, as defined in section [2.3.6.7](#pvertices_complex), of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) are connected. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0146. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pSegmentInfo_complex** property, as defined in section [2.3.6.9](#psegmentinfo_complex), exists. If the value equals 0x1, **pSegmentInfo_complex** MUST exist. | + +**pSegmentInfo (4 bytes):** The number of bytes of data in the **pSegmentInfo_complex** property, as defined in section 2.3.6.9. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pSegmentInfo_complex + +The **pSegmentInfo_complex** property specifies additional data for the **pSegmentInfo** property, as defined in section [2.3.6.8](#psegmentinfo). If the **opid.fComplex** bit of **pSegmentInfo** equals 0x1, this property MUST exist. + +[TABLE] + +**pSegmentInfo_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **MSOPATHINFO** records, as defined in section [2.2.53](#msopathinfo), that specify how the vertices of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), as specified in the **pVertices_complex** property, as defined in section [2.3.6.7](#pvertices_complex), are connected. + +#### adjustValue + +The **adjustValue** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The **pVertices_complex** array, as defined in section [2.3.6.7](#pvertices_complex), refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjustValue** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0147. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjustValue (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust2Value + +The **adjust2Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The **pVertices_complex** array, as defined in section [2.3.6.7](#pvertices_complex), refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust2Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0148. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust2Value (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust3Value + +The **adjust3Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The **pVertices_complex** array, as defined in section [2.3.6.7](#pvertices_complex), refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust3Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0149. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust3Value (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust4Value + +The **adjust4Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The [pVertices_complex](#pvertices_complex) array refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust4Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x014A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust4Value (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust5Value + +The **adjust5Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The [pVertices_complex](#pvertices_complex) array refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust5Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x014B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust5Value (4 bytes):** A signed integer used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust6Value + +The **adjust6Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The [pVertices_complex](#pvertices_complex) array refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust6Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x014C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust6Value (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust7Value + +The **adjust7Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The [pVertices_complex](#pvertices_complex) array refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust7Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x014D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust7Value (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### adjust8Value + +The **adjust8Value** property specifies a value that a user can change to adjust the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Such an adjustment is accomplished through the interaction of several properties of this shape. An [**adjust handle**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b), as specified in the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), controls how the user’s input is translated into a value in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) to store in this property. That value is used as a parameter in the formulas of the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex). The results of the formulas comprise a set of values that can be used to control the geometry of the shape, but those values cannot be edited by the user. The [pVertices_complex](#pvertices_complex) array refers to these values to specify where the vertices exist in the geometry space. Because of these interactions, the meaning of the value of the **adjust8Value** property depends on the individual shape type and on the formulas that are specified for that shape type. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x014E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**adjust8Value (4 bytes):** A signed integer that is used to adjust the geometry of this shape. The default value for this property is 0x00000000. + +#### pConnectionSites + +The **pConnectionSites** property specifies an array of connection sites that a user can employ to create a link between [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0151. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pConnectionSites_complex** property, as defined in section [2.3.6.19](#pconnectionsites_complex), exists. If the value equals 0x1, **pConnectionSites_complex** MUST exist. | + +**pConnectionSites (4 bytes):** The number of bytes of data in the **pConnectionSites_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pConnectionSites_complex + +The **pConnectionSites_complex** property specifies additional data for the **pConnectionSites** property, as defined in section [2.3.6.18](#pconnectionsites). If the **opid.fComplex** bit of **pConnectionSites** equals 0x1, this property MUST exist. + +[TABLE] + +**pConnectionSites_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **POINT** structures, as defined in section [2.2.55](#point), that specify where connection sites are located on this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If the **cxk** property, as defined in section [2.3.6.30](#cxk), does not equal **msocxkCustom**, this property MUST be ignored. The point coordinates are specified in [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) units, unless a coordinate exists in the range from 0x80000000 through 0x8000007F. In that case, the value is not used directly. Instead, the final value is calculated by subtracting 0x8000000 from the original value, and then using that value as the zero-based index into the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex), to specify the value that controls the position of that coordinate. + +#### pConnectionSitesDir + +The **pConnectionSitesDir** property specifies an array of angles, which correspond to the connection sites in the **pConnectionSites_complex** property, as defined in section [2.3.6.19](#pconnectionsites_complex), that are used to determine the direction in which each connector links to its corresponding connection site. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0152. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the [pConnectionSitesDir_complex](#pconnectionsitesdir_complex) property exists. If the value equals 0x1, **pConnectionSitesDir_complex** MUST exist. | + +**pConnectionSitesDir (4 bytes):** The number of bytes of data in the **pConnectionSitesDir_complex** property, as defined in section 2.3.6.21. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pConnectionSitesDir_complex + +The **pConnectionSitesDir_complex** property specifies additional data for the **pConnectionSitesDir** property, as defined in section [2.3.6.20](#pconnectionsitesdir). If the **opid.fComplex** bit of **pConnectionSitesDir** equals 0x1, this property MUST exist. + +[TABLE] + +**pConnectionSitesDir_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **FixedPoint** structures, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that represent the angles, in degrees, at which each connector SHOULD connect to its corresponding connection site in the **pConnectionSites_complex** array, as defined in section [2.3.6.19](#pconnectionsites_complex). If this property is specified, it MUST contain the same number of elements as the **pConnectionSites_complex** array. + +#### xLimo + +The **xLimo** property specifies the x-coordinate above which limousine scaling will be used in the horizontal direction. Such limousine scaling means that the points with an x-coordinate greater than **xLimo** will have their x-coordinates incremented rather than linearly scaled. The net effect is that area will be added to the interior of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) without any modifications to the geometry on the sides. + +The following table shows what resizing a shape looks like when **xLimo** is specified and when it is not. + +| xLimo specified? | Meaning | +|----|----| +| Yes | Resizing the shape in the horizontal direction causes the points with an x-coordinate greater than **xLimo** to be incremented rather than scaled:![Shape resized larger, but not scaled](media/image51.bin "Shape resized larger, but not scaled") | +| No | Resizing the shape in the horizontal direction causes the x–coordinate of all the points to be linearly scaled:![Shape resized larger and scaled](media/image52.bin "Shape resized larger and scaled") | + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0153. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**xLimo (4 bytes):** A signed integer that represents the x-coordinate in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) above which limousine scaling will be used. The default value for this property is 0x80000000. + +#### yLimo + +The **yLimo** property specifies the y-coordinate above which limousine scaling will be used in the vertical direction. Such limousine scaling means that the points with a y-coordinate greater than **yLimo** will have their y-coordinates incremented rather than linearly scaled. The net effect is that area will be added to the interior of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) without any modifications to the geometry on the sides. + +The following table shows what resizing a shape looks like when **yLimo** is specified and when it is not. + +[TABLE] + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0154. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**yLimo (4 bytes):** A signed integer that represents the y-coordinate in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89) above which limousine scaling will be used. The default value for this property is 0x80000000. + +#### pAdjustHandles + +The **pAdjustHandles** property specifies an array of [**adjust handles**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b) that allow a user to manipulate the geometry of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0155. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), exists. If the value equals 0x1, **pAdjustHandles_complex** MUST exist. | + +**pAdjustHandles (4 bytes):** The number of bytes of data in the **pAdjustHandles_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pAdjustHandles_complex + +The **pAdjustHandles_complex** property specifies additional data for the **pAdjustHandles** property, as defined in section [2.3.6.24](#padjusthandles). If the **opid.fComplex** bit of **pAdjustHandles** equals 0x1, this property MUST exist. + +[TABLE] + +**pAdjustHandles_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **ADJH** records, as defined in section [2.2.57](#adjh), specifying a set of [**adjust handles**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b) that SHOULD[\<40\>](#Appendix_A_40) be used to allow a user to manipulate the geometry of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### pGuides + +The **pGuides** property specifies a set of formulas that are used to calculate values for defining the geometry of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0156. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pGuides_complex** property, as defined in section [2.3.6.27](#pguides_complex), exists. If the value equals 0x1, **pGuides_complex** MUST exist. | + +**pGuides (4 bytes):** The number of bytes of data in the **pGuides_complex** property, as defined in section 2.3.6.27. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pGuides_complex + +The **pGuides_complex** property specifies additional data for the **pGuides** property, as defined in section [2.3.6.26](#pguides). If the **opid.fComplex** bit of **pGuides** equals 0x1, this property MUST exist. + +[TABLE] + +**pGuides_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray) of **SG** records, as defined in section [2.2.58](#sg), specifying a set of values that are used to define the geometry of this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This array MUST NOT have more than 128 elements. + +#### pInscribe + +The **pInscribe** property specifies an array of rectangles that specify how text is inscribed within this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0157. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pInscribe_complex** property, as defined in section [2.3.6.29](#pinscribe_complex), exists. If the value equals 0x1, **pInscribe_complex** MUST exist. | + +**pInscribe (4 bytes):** The number of bytes of data in the **pInscribe_complex** property, as defined in section 2.3.6.29. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pInscribe_complex + +The **pInscribe_complex** property specifies additional data for the **pInscribe** property, as defined in section [2.3.6.28](#pinscribe). If the **opid.fComplex** bit of **pInscribe** equals 0x1, this property MUST exist. + +[TABLE] + +**pInscribe_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of **RECT** records, as defined in section [2.2.56](#rect), that specify the rectangle within this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in which text is inscribed. The coordinates in the **RECT** records are specified in the [**geometry space**](#gt_c8fe3e83-f618-43b7-8515-d3eac5b5ef89), unless a coordinate exists in the range from 0x80000000 through 0x8000007F. In that case, the value is not used directly. Instead, the final value is calculated by subtracting 0x8000000 from the original value, and then using that value as the zero-based index into the **pGuides_complex** array, as defined in section [2.3.6.27](#pguides_complex), to specify the value that is used. + +The algorithm for calculating the inscribed rectangle varies based on the number of rectangles that are provided and on whether the text exists in a horizontal or a vertical layout. The text is laid out vertically if the [txflTextFlow](#txfltextflow) property of this shape equals **msotxflTtoBA**, **msotxflBtoT**, **msotxflTtoBN**, or **msotxflVertN**. Otherwise, the text is laid out horizontally. The number of rectangles that are provided MUST be zero, one, two, three, or six. The following table describes the meaning of each of these numbers of rectangles. + +| Number of rectangles | Meaning | +|----|----| +| Zero | The text is inscribed in the rectangle within the shape. | +| One | The text is inscribed in the single rectangle that is provided. | +| Two | If the text exists in a horizontal layout, it is inscribed in the first rectangle that is provided. If the text exists in a vertical layout, it is inscribed in the second rectangle that is provided. | +| Three | The three rectangles specify the minimum, middle, and maximum rectangles to use for both vertical and horizontal layouts. If the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), is either not specified or empty, the minimum rectangle is used. Otherwise, the **adjustValue** property, as defined in section [2.3.6.10](#adjustvalue), and the first **ADJH** record, as defined in section [2.2.57](#adjh), in the **pAdjustHandles_complex** property are used to determine how to interpolate among the three rectangles. If the **apX** value of the first **ADJH** record is controlling the **adjustValue** property because it equals 0x00000100, the **adjustValue** property is compared with **xMin** and **xMax**. Otherwise, the **adjustValue** property is compared with **yMin** and **yMax**. If the value of the **adjustValue** property is less than the midway point between these values, the inscribed rectangle is calculated by a linear interpolation between the minimum and middle rectangles. If the value of the **adjustValue** property is greater than the midway point between these values, the inscribed rectangle is calculated by a linear interpolation between the middle and maximum rectangles. | +| Six | The first three rectangles specify the minimum, middle, and maximum rectangles to use if the text exists in a horizontal layout. The last three rectangles specify the minimum, middle, and maximum rectangles to use if the text exists in a vertical layout. The same algorithm as the one for the case of three rectangles is used. | + +#### cxk + +The **cxk** property specifies where [**connection points**](#gt_ecd96915-cfc0-404e-a2b2-96f02736e07d) exist on the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0158. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cxk (4 bytes):** An **MSOCXK** enumeration value, as defined in section [2.4.10](#msocxk), that specifies where connection points exist on the shape. If this value is **msocxkCustom**, the **pConnectionSites_complex** property, as defined in section [2.3.6.19](#pconnectionsites_complex), specifies where the custom connection points are located. The default value for this property is **msocxkSegments**. + +#### Geometry Boolean Properties + +The **Geometry Boolean Properties** specify a 32-bit field of Boolean properties for the geometry properties of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x017F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefReflectionOK (1 bit):** This bit is not used and MUST be ignored. + +**B - fUsefGlowOK (1 bit):** This bit is not used and MUST be ignored. + +**C - fUsefSoftEdgeOK (1 bit):** This bit is not used and MUST be ignored. + +**D - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**E - fUsefShadowOK (1 bit):** A bit that specifies whether the **fShadowOK** bit is set. A value of 0x0 specifies that the **fShadowOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - fUsef3DOK (1 bit):** A bit that specifies whether the **f3DOK** bit is set. A value of 0x0 specifies that the **f3DOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**G - fUsefLineOK (1 bit):** A bit that specifies whether the **fLineOK** bit is set. A value of 0x0 specifies that the **fLineOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefGtextOK (1 bit):** A bit that specifies whether the **fGtextOK** bit is set. A value of 0x0 specifies that the **fGtextOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefFillShadeShapeOK (1 bit):** A bit that specifies whether the **fFillShadeShapeOK** bit is set. A value of 0x0 specifies that the **fFillShadeShapeOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefFillOK (1 bit):** A bit that specifies whether the **fFillOK** bit is set. A value of 0x0 specifies that the **fFillOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused3 (6 bits):** A value that is undefined and MUST be ignored. + +**K - fReflectionOK (1 bit):** This bit is not used and MUST be ignored. + +**L - fGlowOK (1 bit):** This bit is not used and MUST be ignored. + +**M - fSoftEdgeOK (1 bit):** This bit is not used and MUST be ignored. + +**N - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**O - fShadowOK (1 bit):** A bit that specifies whether to display the shadow of this shape. This value SHOULD be ignored. If **fUsefShadowOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**P - f3DOK (1 bit):** A bit that specifies whether to display the extrusion effect of this shape. If **fUsef3DOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**Q - fLineOK (1 bit):** A bit that specifies whether to display the line of this shape. If **fUsefLineOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**R - fGtextOK (1 bit):** A bit that specifies whether to display the text aligned to this shape. If **fUsefGtextOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**S - fFillShadeShapeOK (1 bit):** A bit that specifies whether the fill is aligned to the shape. A value of 0x0 specifies that the fill is aligned to the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shape. A value of 0x1 specifies that the fill is aligned to the shape itself. If **fUsefFillShadeShapeOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**T - fFillOK (1 bit):** A bit that specifies whether to display the fill of this shape. If **fUsefFillOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +### Fill Style + +The **Fill Style** property set specifies the fill attributes of either the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) or the background of the [**slide**](#gt_dd8a2def-ebde-4fc7-b420-6e837b2059cc). + +#### fillType + +The **fillType** property specifies the type of fill to display with the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) or the background of the [**slide**](#gt_dd8a2def-ebde-4fc7-b420-6e837b2059cc). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0180. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillType (4 bytes):** An **MSOFILLTYPE** enumeration value, as defined in section [2.4.11](#msofilltype), that specifies the type of fill. The default value for this property is **msofillSolid**. + +#### fillColor + +The **fillColor** property specifies the foreground color of the fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0181. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the fill. The **fillColor** property and the **fillBackColor** property, as defined in section [2.3.7.4](#fillbackcolor), are interpreted according to the value of the **fillType** property, as defined in section [2.3.7.1](#filltype), as specified by the following table. The default value for this property is 0x00FFFFFF. + +| fillType | fillColor | fillBackColor | +|----|----|----| +| **msofillSolid** | The foreground color. | Unused. | +| **msofillPattern** | The foreground color of the pattern. | The background color of the pattern. | +| **msofillTexture** | Unused. | Unused. | +| **msofillPicture** | Unused. | Unused. | +| **msofillShade** | The first color of the shade if the **fillShadeColors_complex** property, as defined in section [2.3.7.27](#fillshadecolors_complex), is used. | The last color of the shade if the **fillShadeColors_complex** property is used. | +| **msofillShadeCenter** | The first color of the shade if the **fillShadeColors_complex** property is used. | The last color of the shade if the **fillShadeColors_complex** property is used. | +| **msofillShadeShape** | The first color of the shade if the **fillShadeColors_complex** property is used. | The last color of the shade if the **fillShadeColors_complex** property is used. | +| **msofillShadeScale** | The first color of the shade if the **fillShadeColors_complex** property is used. | The last color of the shade if the **fillShadeColors_complex** property is used. | +| **msofillShadeTitle** | The first color of the shade if the **fillShadeColors_complex** property is used. | The last color of the shade if the **fillShadeColors_complex** property is used. | +| **msofillBackground** | Unused. | Unused. | + +#### fillOpacity + +The **fillOpacity** property specifies the foreground opacity level of the fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0182. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillOpacity (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the foreground opacity level of the fill. The value MUST be from 0.0 through 1.0, inclusive. A value of 0.0 specifies a completely transparent fill. A value of 1.0 specifies a completely opaque fill. The default value for this property is 0x00010000. + +#### fillBackColor + +The **fillBackColor** property specifies the background color of the fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0183. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillBackColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the background color of the fill. This value is interpreted in the same manner as that of the **fillColor** property, as defined in section [2.3.7.2](#fillcolor). The default value for this property is 0x00FFFFFF. + +#### fillBackOpacity + +The **fillBackOpacity** property specifies the background opacity level of the fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0184. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillBackOpacity (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the background opacity level of the fill. The value MUST be from 0.0 through 1.0, inclusive. A value of 0.0 specifies a completely transparent fill. A value of 1.0 specifies a completely opaque fill. The default value for this property is 0x00010000. + +#### fillCrMod + +The **fillCrMod** property specifies the foreground color of the fill for black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0185. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the fill for black-and-white display mode. The default value for this property is 0x20000000. + +#### fillBlip + +The **fillBlip** property specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used for pattern, texture, or picture fills. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0186. | +| **opid.fBid** | A value that MUST be 0x0 if **fComplex** equals 0x1 or 0x1 if **fComplex** equals 0x0. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), then the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **fillBlip_complex** property, as defined in section [2.3.7.8](#fillblip_complex), exists. If the value equals 0x1, **fillBlip_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section 2.2.15, then the value MUST be ignored. | + +**fillBlip (4 bytes):** An unsigned integer specifying the BLIP that is used for pattern, texture, or picture fills. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section 2.2.15, then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of fillBlip field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **fillBlip_complex** property, as defined in section 2.3.7.8. | + +#### fillBlip_complex + +The **fillBlip_complex** property specifies additional data for the **fillBlip** record, as defined in section [2.3.7.7](#fillblip). If the **opid.fComplex** bit of **fillBlip** equals 0x1, this property MUST exist. This property SHOULD[\<41\>](#Appendix_A_41) be ignored. + +[TABLE] + +**fillBlip_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), specifying the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used for pattern, texture, or picture fills. + +#### fillBlipName + +The **fillBlipName** property specifies the comment, the file name, or the full [**Uniform Resource Locator (URL)**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) of the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used as fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0187. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **fillBlipName_complex** property, as defined in section [2.3.7.10](#fillblipname_complex), exists. If the value equals 0x1, **fillBlipName_complex** MUST exist. | + +**fillBlipName (4 bytes):** The number of bytes of data in the **fillBlipName_complex** property, as defined in section 2.3.7.10. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### fillBlipName_complex + +The **fillBlipName_complex** property specifies additional data for the **fillBlipName** property, as defined in section [2.3.7.9](#fillblipname). If the **opid.fComplex** bit of **fillBlipName** equals 0x1, this property MUST exist. + +[TABLE] + +**fillBlipName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the comment, file name, or full [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1), as specified by the **fillBlipFlags** property, as defined in section [2.3.7.11](#fillblipflags), for the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956). + +#### fillBlipFlags + +The **fillBlipFlags** property specifies how to interpret the **fillBlipName_complex** property, as defined in section [2.3.7.10](#fillblipname_complex). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0188. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillBlipFlags (4 bytes):** A **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **fillBlipName_complex** property, as defined in section 2.3.7.10. The default value for this property is **msoblipflagComment**. + +#### fillWidth + +The **fillWidth** property specifies the width of the fill. This property applies only to texture, picture, and pattern fills. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0189. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillWidth (4 bytes):** A signed integer that specifies the width of the fill in units that are specified by the **fillDztype** property, as defined in section [2.3.7.24](#filldztype). If **fillDztype** equals **msodztypeDefault**, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillHeight + +The **fillHeight** property specifies the height of the fill. This property applies only to texture, picture, and pattern fills. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x018A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillHeight (4 bytes):** A signed integer that specifies the height of the fill in units that are specified by the **fillDztype** property, as defined in section [2.3.7.24](#filldztype). If **fillDztype** equals **msodztypeDefault**, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillAngle + +The **fillAngle** property specifies the angle of the shaded fill that rotates the [**gradient vector**](#gt_c3738f35-d919-4f1b-a5cc-09407a7f2c15) in a counterclockwise direction. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x018B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillAngle (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the angle of the gradient fill. Zero degrees represents a vertical vector from bottom to top. The default value for this property is 0x00000000. + +#### fillFocus + +The **fillFocus** property specifies the relative position of the last color in the shaded fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x018C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillFocus (4 bytes):** A signed integer value that specifies the relative position of the last color in the shaded fill. This value MUST be from 0xFFFFFF9C through 0x00000064, inclusive. The default value for this property is 0x00000000. + +The following figure demonstrates how the **fillFocus** affects the shaded fill. + +![Comparison of fillFocus effects](media/image55.bin "Comparison of fillFocus effects") + +Figure 5: Comparison of fillFocus effects + +The first color of the shaded fill is blue, and the last color is red. If **fillFocus** is less than 0, the relative position of the last color is outside the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), and the relative position of the first color is within the shape. + +#### fillToLeft + +The **fillToLeft** property specifies the relative position of the left boundary of the center rectangle in a concentric shaded fill, as shown in the following figure. + +![The fillToLeft, fillToTop, fillToRight, and fillToBottom properties in the shaded fill](media/image56.bin "The fillToLeft, fillToTop, fillToRight, and fillToBottom properties in the shaded fill") + +Figure 6: The fillToLeft, fillToTop, fillToRight, and fillToBottom properties in the shaded fill + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x018D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillToLeft (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the left boundary of the center rectangle relative to the origin of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in horizontal. The default value for this property is 0x00000000. + +#### fillToTop + +The **fillToTop** property specifies the relative position of the top boundary of the center rectangle in a concentric shaded fill, as shown in the figure of the **fillToLeft** property, as defined in section [2.3.7.16](#filltoleft). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x018E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillToTop (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the top boundary of the center rectangle relative to the origin of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in vertical. The default value for this property is 0x00000000. + +#### fillToRight + +The **fillToRight** property specifies the relative position of the right boundary of the center rectangle in a concentric shaded fill, as shown in the figure of the **fillToLeft** property, as defined in section [2.3.7.16](#filltoleft). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x018F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillToRight (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the right boundary of the center rectangle relative to the origin of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in horizontal. The default value for this property is 0x00000000. + +#### fillToBottom + +The **fillToBottom** property specifies the relative position of the bottom boundary of the center rectangle in a concentric shaded fill, as shown in the figure of the **fillToLeft** property, as defined in section [2.3.7.16](#filltoleft). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0190. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillToBottom (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the bottom boundary of center rectangle relative to the origin of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in vertical. The default value for this property is 0x00000000. + +#### fillRectLeft + +The **fillRectLeft** property specifies the left boundary, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shaded fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0191. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillRectLeft (4 bytes):** A signed integer that specifies the left boundary, in EMUs, of the bounding rectangle of the shaded fill. If the **fillUseRect** bit of **Fill Style Boolean** **fillUseRect** property, as defined in section [2.3.7.43](#fill-style-boolean-properties), equals 0x0, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillRectTop + +The **fillRectTop** property specifies the top boundary, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shaded fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0192. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillRectTop (4 bytes):** A signed integer that specifies the top boundary, in EMUs, of the bounding rectangle of the shaded fill. If the **fillUseRect** bit of **Fill Style Boolean** **fillUseRect** property, as defined in section [2.3.7.43](#fill-style-boolean-properties), equals 0x0, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillRectRight + +The **fillRectRight** property specifies the right boundary, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shaded fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0193. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillRectRight (4 bytes):** A signed integer that specifies the right boundary, in EMUs, of the bounding rectangle of the shaded fill. If the **fillUseRect** bit of **Fill Style Boolean** **fillUseRect** property, as defined in section [2.3.7.43](#fill-style-boolean-properties), equals 0x0, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillRectBottom + +The **fillRectBottom** property specifies the bottom boundary, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shaded fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0194. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillRectBottom (4 bytes):** A signed integer that specifies the bottom boundary, in EMUs, of the bounding rectangle of the shaded fill. If the **fillUseRect** bit of **Fill Style Boolean** **fillUseRect** property, as defined in section [2.3.7.43](#fill-style-boolean-properties), equals 0x0, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillDztype + +The **fillDztype** property specifies how the **fillWidth**, as defined in section [2.3.7.12](#fillwidth), and **fillHeight**, as defined in section [2.3.7.13](#fillheight), properties are interpreted. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0195. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillDztype (4 bytes):** An **MSODZTYPE** enumeration value, as defined in section [2.4.12](#msodztype), that specifies how the **fillWidth**, as defined in section 2.3.7.12, and **fillHeight**, as defined in section 2.3.7.13, properties are interpreted. The default value for this property is **msodztypeDefault**. + +#### fillShadePreset + +The **fillShadePreset** property specifies the preset colors of the gradient fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0196. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillShadePreset (4 bytes):** A signed integer that specifies the preset colors of the gradient fill. This value MUST be from 0x00000088 through 0x0000009F, inclusive. if the **fillShadeColors_complex** property, as defined in section [2.3.7.27](#fillshadecolors_complex), exists, this value MUST be ignored. The default value for this property is 0x00000000. + +#### fillShadeColors + +The **fillShadeColors** property specifies the colors and their relative positions along the shade of the fill. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0197. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **fillShadeColors_complex** property, as defined in section [2.3.7.27](#fillshadecolors_complex), exists. If the value equals 0x1, **fillShadeColors_complex** MUST exist. | + +**fillShadeColors (4 bytes):** The number of bytes of data in the **fillShadeColors_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### fillShadeColors_complex + +The **fillShadeColors_complex** property specifies additional data for the **fillShadeColors** property, as defined in section [2.3.7.26](#fillshadecolors). If the **opid.fComplex** bit of **fillShadeColors** equals 0x1, this property MUST exist. + +[TABLE] + +**fillShadeColors_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), that specifies the colors and their relative positions. Each element of the array is an **MSOSHADECOLOR** record, as defined in section [2.2.61](#msoshadecolor). The values of position MUST be in ascending order. + +#### fillOriginX + +The **fillOriginX** property specifies the position of the origin of the picture fill relative to the center of the picture itself in horizontal. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0198. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillOriginX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies position of the origin of the picture fill relative to the center of the picture itself in horizontal. This value MUST be from -1.5 through 0.5, inclusive, for the picture fill to be visible, but values outside the range do not lead to any errors. The default value for this property is 0x00000000. + +#### fillOriginY + +The **fillOriginY** property specifies the position of the origin of the picture fill relative to the center of the picture itself in vertical. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0199. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillOriginY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the position of the origin of the picture fill relative to the center of the picture itself in vertical. This value MUST be from -1.5 through 0.5, inclusive, for the picture fill to be visible, but values outside the range do not lead to any errors. The default value for this property is 0x00000000. + +#### fillShapeOriginX + +The **fillShapeOriginX** property specifies the position of the origin of the picture fill relative to the center of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in horizontal. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x019A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillShapeOriginX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the position of the origin of the picture fill relative to the center of the bounding rectangle of the shape in horizontal. This value MUST be from -0.5 through 0.5, inclusive, for the picture fill to be visible, but values outside the range do not lead to any errors. The default value for this property is 0x00000000. + +#### fillShapeOriginY + +The **fillShapeOriginY** property specifies the position of the origin of the picture fill relative to the center of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in vertical. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x019B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillShapeOriginY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the position of the origin of the picture fill relative to the center of the bounding rectangle of the shape in vertical. This value MUST be from -0.5 through 0.5, inclusive, for the picture fill to be visible, but values outside the range do not lead to any errors. The default value for this property is 0x00000000. + +#### fillShadeType + +The **fillShadeType** property specifies how the shaded fill is computed. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x019C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillShadeType (4 bytes):** An **MSOSHADETYPE** record, as defined in section [2.2.50](#msoshadetype), that specifies how the shaded fill is computed. The default value for this property is 0x40000003. + +#### fillColorExt + +The **fillColorExt** property specifies the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x019E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended foreground color. The default value for this property is 0xFFFFFFFF. + +#### reserved415 + +The **reserved415** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x019F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved415 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### fillColorExtMod + +The **fillColorExtMod** property specifies the color modification of the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended foreground color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved417 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved417 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### fillBackColorExt + +The **fillBackColorExt** property specifies the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillBackColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended background color. The default value for this property is 0xFFFFFFFF. + +#### reserved419 + +The **reserved419** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved419 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### fillBackColorExtMod + +The **fillBackColorExtMod** property specifies the color modification of the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**fillBackColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended background color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved421 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:----------------| +| **opid.opid** | MUST be 0x01A5. | +| **opid.fBid** | MUST be 0x0. | +| **opid.fComplex** | MUST be 0x0. | + +**reserved421 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved422 + +The **reserved422** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A6. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved422 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved423 + +The **reserved423** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01A7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved423 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Fill Style Boolean Properties + +The **Fill Style Boolean Properties** specify a 32-bit field of Boolean properties for the fill style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (9 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefRecolorFillAsPicture (1 bit):** A bit that specifies whether the **fRecolorFillAsPicture** bit is set. A value of 0x0 specifies that the **fRecolorFillAsPicture** MUST be ignored. The default value for this property is 0x0. + +**B - fUsefUseShapeAnchor (1 bit):** A bit that specifies whether the **fUseShapeAnchor** bit is set. A value of 0x0 specifies that the **fUseShapeAnchor** MUST be ignored. The default value for this property is 0x0. + +**C - fUsefFilled (1 bit):** A bit that specifies whether the **fFilled** bit is set. A value of 0x0 specifies that the **fFilled** MUST be ignored. The default value for this property is 0x0. + +**D - fUsefHitTestFill (1 bit):** A bit that specifies whether the **fHitTestFill** bit is set. A value of 0x0 specifies that the **fHitTestFill** MUST be ignored. The default value for this property is 0x0. + +**E - fUsefillShape (1 bit):** A bit that specifies whether the **fillShape** bit is set. A value of 0x0 specifies that the **fillShape** MUST be ignored. The default value for this property is 0x0. + +**F - fUsefillUseRect (1 bit):** A bit that specifies whether the **fillUseRect** bit is set. A value of 0x0 specifies that the **fillUseRect** MUST be ignored. The default value for this property is 0x0. + +**G - fUsefNoFillHitTest (1 bit):** A bit that specifies whether the **fNoFillHitTest** bit is set. A value of 0x0 specifies that the **fNoFillHitTest** MUST be ignored. The default value for this property is 0x0. + +**unused2 (9 bits):** A value that is undefined and MUST be ignored. + +**H - fRecolorFillAsPicture (1 bit):** A bit that specifies how to recolor a picture fill. If this bit is set to 0x1, the [pictureFillCrMod](#picturefillcrmod) property of the picture fill is used for recoloring. If this bit is set to 0x0, the **fillCrMod** property, as defined in section [2.3.7.6](#fillcrmod), is used for recoloring. If **fUsefRecolorFillAsPicture** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**I - fUseShapeAnchor (1 bit):** A bit that specifies whether the fill is rotated with the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If **fUsefUseShapeAnchor** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**J - fFilled (1 bit):** A bit that specifies whether the fill is rendered if the shape is a 2-D shape. If this bit is set to 0x1, the fill of this shape is rendered based on the properties of the [Fill Style](#Section_be64d06159e44b8fb7ea4f1da74657a4) property set. If this bit is set to 0x0, the fill of this shape is not rendered. If **fUsefFilled** is 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**K - fHitTestFill (1 bit):** A bit that specifies whether this fill will be hit tested. If **fUsefHitTestFill** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**L - fillShape (1 bit):** A bit that specifies how the fill is aligned. If this bit is set to 0x1, the fill is aligned relative to the shape so that it moves with the shape. If this bit is set to 0x0, the fill is aligned with the origin of the view. If **fUsefillShape** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**M - fillUseRect (1 bit):** A bit that specifies whether to use the rectangle specified by the [fillRectLeft](#fillrectleft), [fillRectRight](#fillrectright), [fillRectTop](#fillrecttop), and [fillRectBottom](#fillrectbottom) properties, rather than the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shape, as the filled area. If **fUsefillUseRect** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**N - fNoFillHitTest (1 bit):** A bit that specifies whether this shape will be hit tested as though it were filled. If **fUsefNoFillHitTest** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Line Style + +The **Line Style** property set specifies the line attributes of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### lineColor + +The **lineColor** property specifies the foreground color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line. The default value for this property is 0x00000000. + +#### lineOpacity + +The **lineOpacity** property specifies the opacity level of the foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineOpacity (4 bytes):** A signed integer that specifies the opacity level of the foreground color. This property MUST be from 0x00000000 through 0x00010000, inclusive. A value of 0x00000000 is completely transparent. A value of 0x00010000 is completely opaque. The default value for this property is 0x00010000. + +#### lineBackColor + +The **lineBackColor** property specifies the background color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBackColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the background color of the line. The default value for this property is 0x00FFFFFF. + +#### lineCrMod + +The **lineCrMod** property specifies the foreground color of the line for black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line for black-and-white display mode. The default value for this property is 0x20000000. + +#### lineType + +The **lineType** property specifies the type of line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineType (4 bytes):** An **MSOLINETYPE** enumeration value, as defined in section [2.4.13](#msolinetype), that specifies the type of line. The default value for this property is **msolineSolidType**. + +#### lineFillBlip + +The **lineFillBlip** property specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x01C5. | +| **opid.fBid** | A value that MUST be 0x0 if **fComplex** equals 0x1 or 0x1 if **fComplex** equals 0x0. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), then the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineFillBlip_complex** property, as defined in section [2.3.8.7](#linefillblip_complex), exists. If the value equals 0x1, **lineFillBlip_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section 2.2.15, then the value MUST be ignored. | + +**lineFillBlip (4 bytes):** An unsigned integer specifying the BLIP that is used to fill this line when the **lineType** property, as defined in section [2.3.8.5](#linetype), is set to **msolinePattern** or **msolineTexture**. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section 2.2.15, then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of lineFillBlip field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **lineFillBlip_complex** property. | + +#### lineFillBlip_complex + +The **lineFillBlip_complex** property specifies additional data for the **lineFillBlip** property, as defined in section [2.3.8.6](#linefillblip). If the **opid.fComplex** bit of **lineFillBlip** equals 0x1, this property MUST exist. + +[TABLE] + +**lineFillBlip_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), that specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) used to fill this line when the **lineType** property, as defined in section [2.3.8.5](#linetype), is set to msolinePattern or msolineTexture. + +#### lineFillBlipName + +The **lineFillBlipName** property specifies a comment about the **lineFillBlip** property, as defined in section [2.3.8.6](#linefillblip). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x01C6. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineFillBlipName_complex** property, as defined in section [2.3.8.9](#linefillblipname_complex), exists. If the value equals 0x1, **lineFillBlipName_complex** MUST exist. | + +**lineFillBlipName (4 bytes):** The number of bytes of data in the **lineFillBlipName_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineFillBlipName_complex + +The **lineFillBlipName_complex** property specifies additional data for the [lineFillBlipName](#linefillblipname) property. If the **opid.fComplex** bit of **lineFillBlipName** equals 0x1, this property MUST exist. + +[TABLE] + +**lineFillBlipName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies a comment about the **lineFillBlip** property, as defined in section [2.3.8.6](#linefillblip), as specified by the **lineFillBlipFlags** property, as defined in section [2.3.8.10](#linefillblipflags). + +#### lineFillBlipFlags + +The **lineFillBlipFlags** property specifies how to interpret the **lineFillBlipName_complex** property, as defined in section [2.3.8.9](#linefillblipname_complex). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineFillBlipFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **lineFillBlipName_complex** property. This value MUST be **msoblipflagComment**. The default value for this property is **msoblipflagComment**. + +#### lineFillWidth + +The **lineFillWidth** property specifies the width of a pattern or texture that is used to fill this line. The **lineFillDztype** property, as defined in section [2.3.8.13](#linefilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C8. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineFillWidth (4 bytes):** A signed integer specifying the width of a pattern or texture that is used to fill this line. If this value is 0x00000000, the width of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineFillHeight + +The **lineFillHeight** property specifies the height of a pattern or texture that is used to fill this line. The **lineFillDztype** property, as defined in section [2.3.8.13](#linefilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01C9. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineFillHeight (4 bytes):** A signed integer specifying the height of a pattern or texture that is used to fill this line. If this value is 0x00000000, the height of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineFillDztype + +The **lineFillDztype** property specifies how the **lineFillWidth**, as defined in section [2.3.8.11](#linefillwidth), and **lineFillHeight**, as defined in section [2.3.8.12](#linefillheight), properties MUST be interpreted. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01CA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineFillDztype (4 bytes):** An **MSODZTYPE** enumeration value, as defined in section [2.4.12](#msodztype), that specifies how the **lineFillWidth**, as defined in section 2.3.8.11, and **lineFillHeight**, as defined in section 2.3.8.12, properties MUST be interpreted. The default value for this property is **msodztypeDefault**. + +#### lineWidth + +The **lineWidth** property specifies the width of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01CB. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineWidth (4 bytes):** A signed integer that specifies the width, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the line. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00002535. + +#### lineMiterLimit + +The **lineMiterLimit** property specifies the maximum allowed ratio of miter length to line width. The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls on the outside of the join. The following figure illustrates the miter length. + +![The miter length represented by a dashed line](media/image57.bin "The miter length represented by a dashed line") + +Figure 7: The miter length represented by a dashed line + +If the miter length extends beyond the line miter limit, the line SHOULD be clipped, as shown in the following figure. + +![A line that was clipped because the miter length extended beyond the line miter limit](media/image58.bin "A line that was clipped because the miter length extended beyond the line miter limit") + +Figure 8: A line that was clipped because the miter length extended beyond the line miter limit + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01CC. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineMiterLimit (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the maximum allowed ratio of miter length to line width. The default value for this property is 0x00080000. + +#### lineStyle + +The **lineStyle** property specifies the style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01CD. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineStyle (4 bytes):** An **MSOLINESTYLE** enumeration value, as defined in section [2.4.14](#msolinestyle), that specifies the style of the line. The default value for this property is **msolineSimple**. + +#### lineDashing + +The **lineDashing** property specifies the dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01CE. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineDashing (4 bytes):** An **MSOLINEDASHING** enumeration value, as defined in section [2.4.15](#msolinedashing), that specifies the dash style of the line. The default value for this property is **msolineSolid**. + +#### lineDashStyle + +The **lineDashStyle** property specifies the custom dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x01CF. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineDashStyle_complex** property, as defined in section [2.3.8.19](#linedashstyle_complex), exists. If the value equals 0x1, **lineDashStyle_complex** MUST exist. | + +**lineDashStyle (4 bytes):** The number of bytes of data in the **lineDashStyle_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineDashStyle_complex + +The **lineDashStyle_complex** property specifies additional data for the **lineDashStyle** property, as defined in section [2.3.8.18](#linedashstyle). If the **opid.fComplex** bit of **lineDashStyle** equals 0x1, this property MUST exist. + +[TABLE] + +**lineDashStyle_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of 32-bit unsigned integers that specifies a custom dash style for the line. The length of each dash and space in the dash style of the line is the product of a multiplier and the line width. The first element specifies the multiplier of the first dash, the second element specifies the multiplier of the first space, the third element specifies the multiplier of the second dash, and so on—alternating between spaces and dashes. This value SHOULD be used only if the **lineDashing** property, as defined in section [2.3.8.17](#linedashing), is either not present or equal to **msolineSolid**. + +#### lineStartArrowhead + +The **lineStartArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineStartArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the start of the line. The default value for this property is **msolineNoEnd**. + +#### lineEndArrowhead + +The **lineEndArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineEndArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the end of the line. The default value for this property is **msolineNoEnd**. + +#### lineStartArrowWidth + +The **lineStartArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineStartArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineStartArrowLength + +The **lineStartArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineStartArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineEndArrowWidth + +The **lineEndArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineEndArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineEndArrowLength + +The **lineEndArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D5. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineEndArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineJoinStyle + +The **lineJoinStyle** property specifies the style of the line joins. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D6. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineJoinStyle (4 bytes):** An **MSOLINEJOIN** enumeration value, as defined in section [2.4.19](#msolinejoin), that specifies the style of the line joins. The default value for this property is **msolineJoinRound**. + +#### lineEndCapStyle + +The **lineEndCapStyle** property specifies the style of the line end caps. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineEndCapStyle (4 bytes):** An **MSOLINECAP** enumeration value, as defined in section [2.4.20](#msolinecap), that specifies the style of the line end caps. The default value for this property is **msolineEndCapFlat**. + +#### lineColorExt + +The **lineColorExt** property specifies the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01D9. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended foreground color. The default value for this property is 0xFFFFFFFF. + +#### reserved474 + +The **reserved474** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01DA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved474 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineColorExtMod + +The **lineColorExtMod** property specifies the color modification of the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01DB. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended foreground color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved476 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01DC. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved476 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### lineBackColorExt + +The **lineBackColorExt** property specifies the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01DD. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBackColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended background color. The default value for this property is 0xFFFFFFFF. + +#### reserved478 + +The **reserved478** property MUST be 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01DE. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved478 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineBackColorExtMod + +The **lineBackColorExtMod** property specifies the color modification of the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01DF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBackColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended background color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved480 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01E0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved480 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved481 + +The **reserved481** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01E1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved481 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved482 + +The **reserved482** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01E2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved482 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Line Style Boolean Properties + +The **Line Style Boolean Properties** specify a 32-bit field of Boolean properties for the line style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x01FF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefLineOpaqueBackColor (1 bit):** A bit that specifies whether the **fLineOpaqueBackColor** bit is set. A value of 0x0 specifies that the **fLineOpaqueBackColor** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**B - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**C - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**D - fUsefInsetPen (1 bit):** A bit that specifies whether the **fInsetPen** bit is set. A value of 0x0 specifies that the **fInsetPen** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**E - fUsefInsetPenOK (1 bit):** A bit that specifies whether the **fInsetPenOK** bit is set. A value of 0x0 specifies that the **fInsetPenOK** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**F - fUsefArrowheadsOK (1 bit):** A bit that specifies whether the **fArrowheadsOK** bit is set. A value of 0x0 specifies that the **fArrowheadsOK** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**G - fUsefLine (1 bit):** A bit that specifies whether the **fLine** bit is set. A value of 0x0 specifies that the **fLine** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**H - fUsefHitTestLine (1 bit):** A bit that specifies whether the **fHitTestLine** bit is set. A value of 0x0 specifies that the **fHitTestLine** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**I - fUsefLineFillShape (1 bit):** A bit that specifies whether the **fLineFillShape** bit is set. A value of 0x0 specifies that the **fLineFillShape** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**J - fUsefNoLineDrawDash (1 bit):** A bit that specifies whether the **fNoLineDrawDash** bit is set. A value of 0x0 specifies that the **fNoLineDrawDash** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**unused4 (6 bits):** A value that is undefined and MUST be ignored. + +**K - fLineOpaqueBackColor (1 bit):** A bit that specifies whether an extra line will be rendered underneath the line that is specified by this property set. The extra line MUST be equivalent to the line that is specified by the current property set, except that the **lineColor** property, as defined in section [2.3.8.1](#linecolor), MUST be set to the value of the current property set’s **lineBackColor** property, as defined in section [2.3.8.3](#linebackcolor), and the **lineDashing** property, as defined in section [2.3.8.17](#linedashing), MUST be **msolineSolid**. If **fUsefLineOpaqueBackColor** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**L - reserved1 (1 bit):** A value that MUST be zero and MUST be ignored. + +**M - reserved2 (1 bit):** A value that MUST be zero and MUST be ignored. + +**N - fInsetPen (1 bit):** A bit that specifies whether to draw the line inside the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If **fInsetPenOK** equals 0x0, this value MUST be ignored. If **fUsefInsetPen** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**O - fInsetPenOK (1 bit):** A bit that specifies whether insetting the pen is allowed. If **fUsefInsetPenOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**P - fArrowheadsOK (1 bit):** A bit that specifies whether the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) properties are editable. This value SHOULD NOT[\<42\>](#Appendix_A_42) affect the rendering of the line end decorations. If **fUsefArrowheadsOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**Q - fLine (1 bit):** A bit that specifies whether to display the other line properties in this line style if the shape is a 2-D shape. If **fLeftLine** bit of Left Line Style Boolean Properties (as defined in section [2.3.9.38](#left-line-style-boolean-properties)), **fTopLine** bit of Top Line Style Boolean Properties (as defined in section [2.3.10.38](#top-line-style-boolean-properties)), **fBottomLine** bit of Bottom Line Style Boolean Properties (as defined in section [2.3.12.38](#bottom-line-style-boolean-properties)), or **fRightLine** bit of Right Line Style Boolean Properties (as defined in section [2.3.11.38](#right-line-style-boolean-properties)) is set to 0x1, the other properties in this property set MUST NOT be displayed. If **fUsefLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**R - fHitTestLine (1 bit):** A bit that specifies whether this line will be hit tested. If **fUsefHitTestLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**S - fLineFillShape (1 bit):** A bit that specifies how the fill is aligned. The following table specifies the meaning of each value for this field. If **fUsefLineFillShape** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the fill is aligned with the origin of the view. | +| 0x1 | Specifies that the fill is aligned relative to the shape so that the fill will move with the shape. | + +**T - fNoLineDrawDash (1 bit):** A bit that specifies whether a dashed line will be drawn if the other properties specify that no line exists. If **fUsefNoLineDrawDash** equals0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Left Line Style + +The **Left Line Style** property set specifies the line attributes that are applied to the left side of a rectangular [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### lineLeftColor + +The **lineLeftColor** property specifies the foreground color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0540. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line. The default value for this property is 0x00000000. + +#### lineLeftOpacity + +The **lineLeftOpacity** property specifies the opacity level of the foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0541. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftOpacity (4 bytes):** A signed integer that specifies the opacity level of the foreground color. This property MUST be from 0x00000000 through 0x00010000, inclusive. A value of 0x00000000 is completely transparent. A value of 0x00010000 is completely opaque. The default value for this property is 0x00010000. + +#### lineLeftBackColor + +The **lineLeftBackColor** property specifies the background color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0542. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftBackColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the background color of the line. The default value for this property is 0x00FFFFFF. + +#### lineLeftCrMod + +The **lineLeftCrMod** property specifies the foreground color of the line for black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0543. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line for black-and-white display mode. The default value for this property is 0x20000000. + +#### lineLeftType + +The **lineLeftType** property specifies the type of line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0544. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftType (4 bytes):** An **MSOLINETYPE** enumeration value, as defined in section [2.4.13](#msolinetype), that specifies the type of line. The default value for this property is **msolineSolidType**. + +#### lineLeftFillBlip + +The **lineLeftFillBlip** property specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0545. | +| **opid.fBid** | A value that MUST be 0x0 if **fComplex** equals 0x1 or 0x1 if **fComplex** equals 0x0. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), then the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineLeftFillBlip_complex** property, as defined in section [2.3.9.7](#lineleftfillblip_complex), exists. If the value equals 0x1, **lineLeftFillBlip_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** then the value MUST be ignored. | + +**lineLeftFillBlip (4 bytes):** An unsigned integer specifying the BLIP that is used to fill this line when the **lineLeftType** property, as defined in section [2.3.9.5](#linelefttype), is set to **msolinePattern** or **msolineTexture**. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of lineLeftFillBlip field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **lineLeftFillBlip_complex** property, as defined in section 2.3.9.7. | + +#### lineLeftFillBlip_complex + +The **lineLeftFillBlip_complex** property specifies additional data for the **lineLeftFillBlip** property, as defined in section [2.3.9.6](#lineleftfillblip). If the **opid.fComplex** bit of **lineLeftFillBlip** equals 0x1, this property MUST exist. + +[TABLE] + +**lineLeftFillBlip_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), specifying the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line if the **lineLeftType** property, as defined in section [2.3.9.5](#linelefttype), is set to **msolinePattern** or **msolineTexture**. + +#### lineLeftFillBlipName + +The **lineLeftFillBlipName** property specifies a comment about the **lineLeftFillBlip** property, as defined in section [2.3.9.6](#lineleftfillblip). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0546. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineLeftFillBlipName_complex** property, as defined in section [2.3.9.9](#lineleftfillblipname_complex), exists. If the value equals 0x1, **lineLeftFillBlipName_complex** MUST exist. | + +**lineLeftFillBlipName (4 bytes):** The number of bytes of data in the **lineLeftFillBlipName_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineLeftFillBlipName_complex + +The **lineLeftFillBlipName_complex** property specifies additional data for the **lineLeftFillBlipName** property, as defined in section [2.3.9.8](#lineleftfillblipname). If the **opid.fComplex** bit of **lineLeftFillBlipName** equals 0x1, this property MUST exist. + +[TABLE] + +**lineLeftFillBlipName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies a comment about the **lineLeftFillBlip** property, as defined in section [2.3.9.6](#lineleftfillblip), as specified by the **lineLeftFillBlipFlags** property, as defined in section [2.3.9.10](#lineleftfillblipflags). + +#### lineLeftFillBlipFlags + +The **lineLeftFillBlipFlags** property specifies how to interpret the **lineLeftFillBlipName_complex** property, as defined in section [2.3.9.9](#lineleftfillblipname_complex). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0547. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftFillBlipFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **lineLeftFillBlipName_complex** property, as defined in section 2.3.9.9. This value MUST be **msoblipflagComment**. The default value for this property is **msoblipflagComment**. + +#### lineLeftFillWidth + +The **lineLeftFillWidth** property specifies the width of a pattern or texture that is used to fill this line. The **lineLeftFillDztype** property, as defined in section [2.3.9.13](#lineleftfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0548. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftFillWidth (4 bytes):** A signed integer specifying the width of a pattern or texture that is used to fill this line. If this value is 0x00000000, the width of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineLeftFillHeight + +The **lineLeftFillHeight** property specifies the height of a pattern or texture that is used to fill this line. The **lineLeftFillDztype** property, as defined in section [2.3.9.13](#lineleftfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0549. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftFillHeight (4 bytes):** A signed integer specifying the height of a pattern or texture that is used to fill this line. If this value is 0x00000000, the height of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineLeftFillDztype + +The **lineLeftFillDztype** property specifies how the **lineLeftFillWidth**, as defined in section [2.3.9.11](#lineleftfillwidth), and **lineLeftFillHeight**, as defined in section [2.3.9.12](#lineleftfillheight), properties MUST be interpreted. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x054A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftFillDztype (4 bytes):** An **MSODZTYPE** enumeration value, as defined in section [2.4.12](#msodztype), that specifies how the **lineLeftFillWidth**, as defined in section 2.3.9.11, and **lineLeftFillHeight**, as defined in section 2.3.9.12, properties MUST be interpreted. The default value for this property is **msodztypeDefault**. + +#### lineLeftWidth + +The **lineLeftWidth** property specifies the width of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x054B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftWidth (4 bytes):** A signed integer that specifies the width, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the line. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00002535. + +#### lineLeftMiterLimit + +The **lineLeftMiterLimit** property specifies the maximum allowed ratio of miter length to line width. The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls on the outside of the join. For an explanation of miter length, see section [2.3.8.15](#linemiterlimit). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x054C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftMiterLimit (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the maximum allowed ratio of miter length to line width. The default value for this property is 0x00080000. + +#### lineLeftStyle + +The **lineLeftStyle** property specifies the style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x054D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftStyle (4 bytes):** An **MSOLINESTYLE** enumeration value, as defined in section [2.4.14](#msolinestyle), that specifies the style of the line. The default value for this property is msolineSimple. + +#### lineLeftDashing + +The **lineLeftDashing** property specifies the dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x054E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftDashing (4 bytes):** An **MSOLINEDASHING** enumeration value, as defined in section [2.4.15](#msolinedashing), that specifies the dash style of the line. The default value for this property is **msolineSolid**. + +#### lineLeftDashStyle + +The **lineLeftDashStyle** property specifies the custom dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x054F. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the [lineLeftDashStyle_complex](#lineleftdashstyle_complex) property exists. If the value equals 0x1, **lineLeftDashStyle_complex** MUST exist. | + +**lineLeftDashStyle (4 bytes):** The number of bytes of data in the **lineLeftDashStyle_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineLeftDashStyle_complex + +The **lineLeftDashStyle_complex** property specifies additional data for the [lineLeftDashStyle](#lineleftdashstyle) property. If the **opid.fComplex** bit of **lineLeftDashStyle** equals 0x1, this property MUST exist. + +[TABLE] + +**lineLeftDashStyle_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of 32-bit unsigned integers that specifies a custom dash style for the line. The length of each dash and space in the dash style of the line is the product of a multiplier and the line width. The first element specifies the multiplier of the first dash, the second element specifies the multiplier of the first space, the third element specifies the multiplier of the second dash, and so on—alternating between spaces and dashes. This value SHOULD be used only if the [lineLeftDashing](#lineleftdashing) property is either not present or equal to **msolineSolid**. + +#### lineLeftStartArrowhead + +The **lineLeftStartArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0550. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftStartArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the start of the line. The default value for this property is **msolineNoEnd**. + +#### lineLeftEndArrowhead + +The **lineLeftEndArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0551. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftEndArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the end of the line. The default value for this property is **msolineNoEnd**. + +#### lineLeftStartArrowWidth + +The **lineLeftStartArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0552. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftStartArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineLeftStartArrowLength + +The **lineLeftStartArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0553. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftStartArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineLeftEndArrowWidth + +The **lineLeftEndArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0554. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftEndArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineLeftEndArrowLength + +The **lineLeftEndArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0555. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftEndArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineLeftJoinStyle + +The **lineLeftJoinStyle** property specifies the style of the line joins. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0556. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftJoinStyle (4 bytes):** An **MSOLINEJOIN** enumeration value, as defined in section [2.4.19](#msolinejoin), that specifies the style of the line joins. The default value for this property is **msolineJoinRound**. + +#### lineLeftEndCapStyle + +The **lineLeftEndCapStyle** property specifies the style of the line end caps. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0557. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftEndCapStyle (4 bytes):** An **MSOLINECAP** enumeration value, as defined in section [2.4.20](#msolinecap), that specifies the style of the line end caps. The default value for this property is **msolineEndCapFlat**. + +#### lineLeftColorExt + +The **lineLeftColorExt** property specifies the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0559. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended foreground color. The default value for this property is 0xFFFFFFFF. + +#### reserved1370 + +The **reserved1370** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x055A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1370 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineLeftColorExtMod + +The **lineLeftColorExtMod** property specifies the color modification of the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x055B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended foreground color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1372 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x055C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1372 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### lineLeftBackColorExt + +The **lineLeftBackColorExt** property specifies the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x055D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftBackColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended background color. The default value for this property is 0xFFFFFFFF. + +#### reserved1374 + +The **reserved1374** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x055E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1374 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineLeftBackColorExtMod + +The **lineLeftBackColorExtMod** property specifies the color modification of the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x055F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineLeftBackColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended background color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1376 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0560. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1376 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved1377 + +The **reserved1377** property MUST be 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0561. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1377 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved1378 + +The **reserved1378** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0562. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1378 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Left Line Style Boolean Properties + +The **Left Line Style Boolean Properties** specify a 32-bit field of Boolean properties for the left line style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x057F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**C - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**D - fUsefLeftInsetPen (1 bit):** A bit that specifies whether the **fLeftInsetPen** bit is set. A value of 0x0 specifies that the **fLeftInsetPen** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefLeftInsetPenOK (1 bit):** A bit that specifies whether the **fLeftInsetPenOK** bit is set. A value of 0x0 specifies that the **fLeftInsetPenOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - unused5 (1 bit):** A value that is undefined and MUST be ignored. + +**G - fUsefLeftLine (1 bit):** A bit that specifies whether the **fLeftLine** bit is set. A value of 0x0 specifies that the **fLeftLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefLeftHitTestLine (1 bit):** A bit that specifies whether the **fLeftHitTestLine** bit is set. A value of 0x0 specifies that the **fLeftHitTestLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefLineLeftFillShape (1 bit):** A bit that specifies whether the **fLineLeftFillShape** bit is set. A value of 0x0 specifies that the **fLineLeftFillShape** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefLeftNoLineDrawDash (1 bit):** A bit that specifies whether the **fLeftNoLineDrawDash** bit is set. A value of 0x0 specifies that the **fLeftNoLineDrawDash** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused6 (6 bits):** A value that is undefined and MUST be ignored. + +**K - unused7 (1 bit):** A value that is undefined and MUST be ignored. + +**L - reserved1 (1 bit):** A value that MUST be zero and MUST be ignored. + +**M - reserved2 (1 bit):** A value that MUST be zero and MUST be ignored. + +**N - fLeftInsetPen (1 bit):** A bit that specifies whether to draw the line inside the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If **fLeftInsetPenOK** equals 0x0, this bit MUST be ignored. If **fUsefLeftInsetPen** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**O - fLeftInsetPenOK (1 bit):** A bit that specifies whether insetting the pen is allowed. If **fUsefLeftInsetPenOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**P - reserved3 (1 bit):** A value that MUST be zero and MUST be ignored. + +**Q - fLeftLine (1 bit):** A bit that specifies whether to display the other line properties in this line style when handling the left side of a rectangular 2-D shape. If **fUsefLeftLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. If the **rh.recInstance** field in the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for the shape is not set to one of the **MSOSPT** enumeration values, as defined in section [2.4.24](#msospt), in the following list, the line properties in this line style MUST NOT be displayed: + +- **msosptRectangle** + +- **msosptTextBox** + +- **msosptBevel** + +- **msosptHostControl** + +- **msosptPictureFrame** + +- **msosptFlowChartProcess** + +- **msosptFlowChartPredefinedProcess** + +- **msosptFlowChartInternalStorage** + +- **msosptActionButtonBlank** + +- **msosptActionButtonHome** + +- **msosptActionButtonHelp** + +- **msosptActionButtonInformation** + +- **msosptActionButtonForwardNext** + +- **msosptActionButtonBackPrevious** + +- **msosptActionButtonEnd** + +- **msosptActionButtonBeginning** + +- **msosptActionButtonReturn** + +- **msosptActionButtonDocument** + +- **msosptActionButtonSound** + +- **msosptActionButtonMovie** + +**R - fLeftHitTestLine (1 bit):** A bit that specifies whether this line will be hit tested. If **fUsefLeftHitTestLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**S - fLineLeftFillShape (1 bit):** A bit that specifies how the fill is aligned. The following table specifies the meaning of each value for this field. If **fUsefLineLeftFillShape** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the fill is aligned with the origin of the view. | +| 0x1 | Specifies that the fill is aligned relative to the shape so that it will move with the shape. | + +**T - fLeftNoLineDrawDash (1 bit):** A bit that specifies whether a dashed line will be drawn if the other properties specify that no line exists. If **fUsefLeftNoLineDrawDash** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Top Line Style + +The **Top Line Style** property set specifies the line attributes that are applied to the top side of a rectangular [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### lineTopColor + +The **lineTopColor** property specifies the foreground color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. Sub-fields are further specified in the following table: + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0580. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line. The default value for this property is 0x00000000. + +#### lineTopOpacity + +The **lineTopOpacity** property specifies the opacity level of the foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0581. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopOpacity (4 bytes):** A signed integer that specifies the opacity level of the foreground color. This property MUST be from 0x00000000 through 0x00010000, inclusive. A value of 0x00000000 is completely transparent. A value of 0x00010000 is completely opaque. The default value for this property is 0x00010000. + +#### lineTopBackColor + +The **lineTopBackColor** property specifies the background color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0582. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopBackColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the background color of the line. The default value for this property is 0x00FFFFFF. + +#### lineTopCrMod + +The **lineTopCrMod** property specifies the foreground color of the line for black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0583. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line for black-and-white display mode. The default value for this property is 0x20000000. + +#### lineTopType + +The **lineTopType** property specifies the type of line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0584. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopType (4 bytes):** An **MSOLINETYPE** enumeration value, as defined in section [2.4.13](#msolinetype), that specifies the type of line. The default value for this property is **msolineSolid**. + +#### lineTopFillBlip + +The **lineTopFillBlip** property specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0585. | +| **opid.fBid** | A value that MUST be ignored if **fComplex** equals 0x1. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), then the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineTopFillBlip_complex** property, as defined in section [2.3.10.7](#linetopfillblip_complex), exists. If the value equals 0x1, **lineTopFillBlip_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. | + +**lineTopFillBlip (4 bytes):** An unsigned integer specifying the BLIP that is used to fill this line when the **lineTopType** property, as defined in section [2.3.10.5](#linetoptype), is set to **msolinePattern** or **msolineTexture**. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of lineTopFillBlip field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **lineTopFillBlip_complex** property. | + +#### lineTopFillBlip_complex + +The **lineTopFillBlip_complex** property specifies additional data for the **lineTopFillBlip** property, as defined in section [2.3.10.6](#linetopfillblip). If the **opid.fComplex** bit of **lineTopFillBlip** equals 0x1, this property MUST exist. + +[TABLE] + +**lineTopFillBlip_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), specifying the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line if the **lineTopType** property, as defined in section [2.3.10.5](#linetoptype), is set to **msolinePattern** or **msolineTexture**. + +#### lineTopFillBlipName + +The **lineTopFillBlipName** property specifies a comment about the **lineTopFillBlip** property, as defined in section [2.3.10.6](#linetopfillblip). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0586. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineTopFillBlipName_complex** property, as defined in section [2.3.10.9](#linetopfillblipname_complex), exists. If the value equals 0x1, **lineTopFillBlipName_complex** MUST exist. | + +**lineTopFillBlipName (4 bytes):** The number of bytes of data in the **lineTopFillBlipName_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineTopFillBlipName_complex + +The **lineTopFillBlipName_complex** property specifies additional data for the **lineTopFillBlipName** property, as defined in section [2.3.10.8](#linetopfillblipname). If the **opid.fComplex** bit of **lineTopFillBlipName** equals 0x1, this property MUST exist. + +[TABLE] + +**lineTopFillBlipName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies a comment about the **lineTopFillBlip** property, as defined in section [2.3.10.6](#linetopfillblip), as specified by the **lineTopFillBlipFlags** property, as defined in section [2.3.10.10](#linetopfillblipflags). + +#### lineTopFillBlipFlags + +The **lineTopFillBlipFlags** property specifies how to interpret the **lineTopFillBlipName_complex** property, as defined in section [2.3.10.9](#linetopfillblipname_complex). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0587. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopFillBlipFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **lineTopFillBlipName**\_complex property. This value MUST be **msoblipflagComment**. The default value for this property is **msoblipflagComment**. + +#### lineTopFillWidth + +The **lineTopFillWidth** property specifies the width of a pattern or texture that is used to fill this line. The **lineTopFillDztype** property, as defined in section [2.3.10.13](#linetopfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0588. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopFillWidth (4 bytes):** A signed integer specifying the width of a pattern or texture that is used to fill this line. If this value is 0x00000000, the width of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineTopFillHeight + +The **lineTopFillHeight** property specifies the height of a pattern or texture that is used to fill this line. The **lineTopFillDztype** property, as defined in section [2.3.10.13](#linetopfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0589. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopFillHeight (4 bytes):** A signed integer specifying the height of a pattern or texture that is used to fill this line. If this value is 0x00000000, the height of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineTopFillDztype + +The **lineTopFillDztype** property specifies how the **lineTopFillWidth**, as defined in section [2.3.10.11](#linetopfillwidth), and **lineTopFillHeight**, as defined in section [2.3.10.12](#linetopfillheight), properties MUST be interpreted. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x058A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopFillDztype (4 bytes):** An **MSODZTYPE** enumeration value, as defined in section [2.4.12](#msodztype), that specifies how the **lineTopFillWidth**, as defined in section 2.3.10.11, and **lineTopFillHeight**, as defined in section 2.3.10.12, properties MUST be interpreted. The default value for this property is **msodztypeDefault**. + +#### lineTopWidth + +The **lineTopWidth** property specifies the width of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x058B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopWidth (4 bytes):** A signed integer that specifies the width, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the line. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00002535. + +#### lineTopMiterLimit + +The **lineTopMiterLimit** property specifies the maximum allowed ratio of miter length to line width. The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls on the outside of the join. For an explanation of miter length, see section [2.3.8.15](#linemiterlimit). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x058C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopMiterLimit (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the maximum allowed ratio of miter length to line width. The default value for this property is 0x00080000. + +#### lineTopStyle + +The **lineTopStyle** property specifies the style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x058D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopStyle (4 bytes):** An **MSOLINESTYLE** enumeration value, as defined in section [2.4.14](#msolinestyle), that specifies the style of the line. The default value for this property is **msolineSimple**. + +#### lineTopDashing + +The **lineTopDashing** property specifies the dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x058E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopDashing (4 bytes):** An **MSOLINEDASHING** enumeration value, as defined in section [2.4.15](#msolinedashing), that specifies the dash style of the line. The default value for this property is **msolineSolid**. + +#### lineTopDashStyle + +The **lineTopDashStyle** property specifies the custom dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x058F. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineTopDashStyle_complex** property, as defined in section [2.3.10.19](#linetopdashstyle_complex), exists. If the value equals 0x1, **lineTopDashStyle_complex** MUST exist. | + +**lineTopDashStyle (4 bytes):** The number of bytes of data in the **lineTopDashStyle_complex** property, as defined in section 2.3.10.19. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineTopDashStyle_complex + +The **lineTopDashStyle_complex** property, as defined in section 2.3.10.19, specifies additional data for the **lineTopDashStyle** property, as defined in section [2.3.10.18](#linetopdashstyle). If the **opid.fComplex** bit of **lineTopDashStyle** equals 0x1, this property MUST exist. + +[TABLE] + +**lineTopDashStyle_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of 32-bit unsigned integers that specifies a custom dash style for the line. The length of each dash and space in the dash style of the line is the product of a multiplier and the line width. The first element of the array specifies the multiplier of the first dash, the second element of the array specifies the multiplier of the first space, the third element of the array specifies the multiplier of the second dash, and so on—alternating between spaces and dashes. This value SHOULD be used only if the **lineTopDashing** property, as defined in section [2.3.10.17](#linetopdashing), is either not present or equal to **msolineSolid**. + +#### lineTopStartArrowhead + +The **lineTopStartArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0590. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopStartArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the start of the line. The default value for this property is **msolineNoEnd**. + +#### lineTopEndArrowhead + +The **lineTopEndArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0591. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopEndArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the end of the line. The default value for this property is **msolineNoEnd**. + +#### lineTopStartArrowWidth + +The **lineTopStartArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0592. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopStartArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineTopStartArrowLength + +The **lineTopStartArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0593. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopStartArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineTopEndArrowWidth + +The **lineTopEndArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0594. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopEndArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineTopEndArrowLength + +The **lineTopEndArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0595. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopEndArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineTopJoinStyle + +The **lineTopJoinStyle** property specifies the style of the line joins. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0596. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopJoinStyle (4 bytes):** An **MSOLINEJOIN** enumeration value, as defined in section [2.4.19](#msolinejoin), that specifies the style of the line joins. The default value for this property is **msolineJoinRound**. + +#### lineTopEndCapStyle + +The **lineTopEndCapStyle** property specifies the style of the line end caps. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0597. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopEndCapStyle (4 bytes):** An **MSOLINECAP** enumeration value, as defined in section [2.4.20](#msolinecap), that specifies the style of the line end caps. The default value for this property is **msolineEndCapFlat**. + +#### lineTopColorExt + +The **lineTopColorExt** property specifies the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0599. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended foreground color. The default value for this property is 0xFFFFFFFF. + +#### reserved1434 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x059A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1434 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineTopColorExtMod + +The **lineTopColorExtMod** property specifies the color modification of the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x059B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended foreground color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1436 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x059C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1436 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### lineTopBackColorExt + +The **lineTopBackColorExt** property specifies the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x059D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopBackColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended background color. The default value for this property is 0xFFFFFFFF. + +#### reserved1438 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x059E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1438 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineTopBackColorExtMod + +The **lineTopBackColorExtMod** property specifies the color modification of the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x059F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineTopBackColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended background color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1440 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05A0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1440 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved1441 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05A1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1441 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved1442 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05A2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1442 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Top Line Style Boolean Properties + +The **Top Line Style Boolean Properties** specify a 32-bit field of Boolean properties for the top line style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**C - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**D - fUsefTopInsetPen (1 bit):** A bit that specifies whether the **fTopInsetPen** bit is set. A value of 0x0 specifies that the **fTopInsetPen** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefTopInsetPenOK (1 bit):** A bit that specifies whether the **fTopInsetPenOK** bit is set. A value of 0x0 specifies that the **fTopInsetPenOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - unused5 (1 bit):** A value that is undefined and MUST be ignored. + +**G - fUsefTopLine (1 bit):** A bit that specifies whether the **fTopLine** bit is set. A value of 0x0 specifies that the **fTopLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefTopHitTestLine (1 bit):** A bit that specifies whether the **fTopHitTestLine** bit is set. A value of 0x0 specifies that the **fTopHitTestLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefLineTopFillShape (1 bit):** A bit that specifies whether the **fLineTopFillShape** bit is set. A value of 0x0 specifies that the **fLineTopFillShape** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefTopNoLineDrawDash (1 bit):** A bit that specifies whether the **fTopNoLineDrawDash** bit is set. A value of 0x0 specifies that the **fTopNoLineDrawDash** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused6 (6 bits):** A value that is undefined and MUST be ignored. + +**K - unused7 (1 bit):** A value that is undefined and MUST be ignored. + +**L - reserved1 (1 bit):** A value that MUST be zero and MUST be ignored. + +**M - reserved2 (1 bit):** A value that MUST be zero and MUST be ignored. + +**N - fTopInsetPen (1 bit):** A bit that specifies whether to draw the line inside the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If **fTopInsetPenOK** equals 0x0, this bit MUST be ignored. If **fUsefTopInsetPen** equals 0x0, his value MUST be ignored. The default value for this property is 0x0. + +**O - fTopInsetPenOK (1 bit):** A bit that specifies whether insetting the pen is allowed. If **fUsefTopInsetPenOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**P - reserved3 (1 bit):** A value that MUST be zero and MUST be ignored. + +**Q - fTopLine (1 bit):** A bit that specifies whether to display the other line properties in this line style when handling the top side of a rectangular 2-D shape. If **fUsefTopLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. If the **rh.recInstance** field in the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for the shape is not set to one of the **MSOSPT** enumeration values, as defined in section [2.4.24](#msospt), in the following list, the line properties in this line style MUST NOT be displayed: + +- **msosptRectangle** + +- **msosptTextBox** + +- **msosptBevel** + +- **msosptHostControl** + +- **msosptPictureFrame** + +- **msosptFlowChartProcess** + +- **msosptFlowChartPredefinedProcess** + +- **msosptFlowChartInternalStorage** + +- **msosptActionButtonBlank** + +- **msosptActionButtonHome** + +- **msosptActionButtonHelp** + +- **msosptActionButtonInformation** + +- **msosptActionButtonForwardNext** + +- **msosptActionButtonBackPrevious** + +- **msosptActionButtonEnd** + +- **msosptActionButtonBeginning** + +- **msosptActionButtonReturn** + +- **msosptActionButtonDocument** + +- **msosptActionButtonSound** + +- **msosptActionButtonMovie** + +**R - fTopHitTestLine (1 bit):** A bit that specifies whether this line will be hit tested. If **fUsefTopHitTestLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**S - fLineTopFillShape (1 bit):** A bit that specifies how the fill is aligned. The following table specifies the meaning of each value for this field. If **fUsefLineTopFillShape** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the fill is aligned with the origin of the view. | +| 0x1 | Specifies that the fill is aligned relative to the shape so that it will move with the shape. | + +**T - fTopNoLineDrawDash (1 bit):** A bit that specifies whether a dashed line will be drawn if the other properties specify that no line exists. If **fUsefTopNoLineDrawDash** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Right Line Style + +The **Right Line Style** property set specifies the line attributes that are applied to the right side of a rectangular [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### lineRightColor + +The **lineRightColor** property specifies the foreground color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line. The default value for this property is 0x00000000. + +#### lineRightOpacity + +The **lineRightOpacity** property specifies the opacity level of the foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightOpacity (4 bytes):** A signed integer that specifies the opacity level of the foreground color. This property MUST be from 0x00000000 through 0x00010000, inclusive. A value of 0x00000000 is completely transparent. A value of 0x00010000 is completely opaque. The default value for this property is 0x00010000. + +#### lineRightBackColor + +The **lineRightBackColor** property specifies the background color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightBackColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the background color of the line. The default value for this property is 0x00FFFFFF. + +#### lineRightCrMod + +The **lineRightCrMod** property specifies the foreground color of the line for black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line for black-and-white display mode. The default value for this property is 0x20000000. + +#### lineRightType + +The **lineRightType** property specifies the type of line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightType (4 bytes):** An **MSOLINETYPE** enumeration value, as defined in section [2.4.13](#msolinetype), that specifies the type of line. The default value for this property is **msolineSolid**. + +#### lineRightFillBlip + +The **lineRightFillBlip** property specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x05C5. | +| **opid.fBid** | A value that MUST be 0x0 if **fComplex** equals 0x1 or 0x1 if **fComplex** equals 0x0. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineRightFillBlip_complex** property, as defined in section [2.3.11.7](#linerightfillblip_complex), exists. If the value equals 0x1, **lineRightFillBlip_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. | + +**lineRightFillBlip (4 bytes):** An unsigned integer specifying the BLIP that is used to fill this line when the **lineRightType** property, as defined in section [2.3.11.5](#linerighttype), is set to **msolinePattern** or **msolineTexture**. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of lineRightFillBlip field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **lineRightFillBlip_complex** property, as defined in section 2.3.11.7. | + +#### lineRightFillBlip_complex + +The **lineRightFillBlip_complex** property specifies additional data for the **lineRightFillBlip** property, as defined in section [2.3.11.6](#linerightfillblip). If the **opid.fComplex** bit of **lineRightFillBlip** equals 0x1, this property MUST exist. + +[TABLE] + +**lineRightFillBlip_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), specifying the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line if the **lineRightType** property, as defined in section [2.3.11.5](#linerighttype), is set to **msolinePattern** or **msolineTexture**. + +#### lineRightFillBlipName + +The **lineRightFillBlipName** property specifies a comment about the **lineRightFillBlip** property, as defined in section [2.3.11.6](#linerightfillblip). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x05C6. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineRightFillBlipName_complex** property, as defined in section [2.3.11.9](#linerightfillblipname_complex), exists. If the value equals 0x1, **lineRightFillBlipName_complex** MUST exist. | + +**lineRightFillBlipName (4 bytes):** The number of bytes of data in the **lineRightFillBlipName_complex** property. If **opid.fComplex** equal 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineRightFillBlipName_complex + +The **lineRightFillBlipName_complex** property specifies additional data for the **lineRightFillBlipName** property, as defined in section [2.3.11.8](#linerightfillblipname). If the **opid.fComplex** bit of **lineRightFillBlipName** equals 0x1, this property MUST exist. + +[TABLE] + +**lineRightFillBlipName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies a comment about the **lineRightFillBlip** property, as defined in section [2.3.11.6](#linerightfillblip), as specified by the **lineRightFillBlipFlags** property, as defined in section [2.3.11.10](#linerightfillblipflags). + +#### lineRightFillBlipFlags + +The **lineRightFillBlipFlags** property specifies how to interpret the **lineRightFillBlipName_complex** property, as defined in section [2.3.11.9](#linerightfillblipname_complex). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightFillBlipFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **lineRightFillBlipName_complex** property. This value MUST be **msoblipflagComment**. The default value for this property is **msoblipflagComment**. + +#### lineRightFillWidth + +The **lineRightFillWidth** property specifies the width of a pattern or texture that is used to fill this line. The **lineRightFillDztype** property, as defined in section [2.3.11.13](#linerightfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C8. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightFillWidth (4 bytes):** A signed integer specifying the width of a pattern or texture that is used to fill this line. If this value is 0x00000000, the width of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineRightFillHeight + +The **lineRightFillHeight** property specifies the height of a pattern or texture that is used to fill this line. The **lineRightFillDztype** property, as defined in section [2.3.11.13](#linerightfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05C9. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightFillHeight (4 bytes):** A signed integer specifying the height of a pattern or texture that is used to fill this line. If this value is 0x00000000, the height of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineRightFillDztype + +The **lineRightFillDztype** property specifies how the **lineRightFillWidth**, as defined in section [2.3.11.11](#linerightfillwidth), and **lineRightFillHeight**, as defined in section [2.3.11.12](#linerightfillheight), properties MUST be interpreted. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05CA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightFillDztype (4 bytes):** An **MSODZTYPE** enumeration value, as defined in section [2.4.12](#msodztype), that specifies how the **lineRightFillWidth**, as defined in section 2.3.11.11, and **lineRightFillHeight**, as defined in section 2.3.11.12, properties MUST be interpreted. The default value for this property is **msodztypeDefault**. + +#### lineRightWidth + +The **lineRightWidth** property specifies the width of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05CB. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightWidth (4 bytes):** A signed integer that specifies the width, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the line. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00002535. + +#### lineRightMiterLimit + +The **lineRightMiterLimit** property specifies the maximum allowed ratio of miter length to line width. The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls on the outside of the join. For an explanation of miter length, see section [2.3.8.15](#linemiterlimit). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05CC. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightMiterLimit (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the maximum allowed ratio of miter length to line width. The default value for this property is 0x00080000. + +#### lineRightStyle + +The **lineRightStyle** property specifies the style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05CD. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightStyle (4 bytes):** An **MSOLINESTYLE** enumeration value, as defined in section [2.4.14](#msolinestyle), that specifies the style of the line. The default value for this property is **msolineSimple**. + +#### lineRightDashing + +The **lineRightDashing** property specifies the dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05CE. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightDashing (4 bytes):** An **MSOLINEDASHING** enumeration value, as defined in section [2.4.15](#msolinedashing), that specifies the dash style of the line. The default value for this property is **msolineSolid**. + +#### lineRightDashStyle + +The **lineRightDashStyle** property specifies the custom dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x05CF. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineRightDashStyle_complex** property, as defined in section [2.3.11.19](#linerightdashstyle_complex), exists. If the value equals 0x1, **lineRightDashStyle_complex** MUST exist. | + +**lineRightDashStyle (4 bytes):** The number of bytes of data in the **lineRightDashStyle_complex** property, as defined in section 2.3.11.19. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineRightDashStyle_complex + +The **lineRightDashStyle_complex** property specifies additional data for the **lineRightDashStyle** property, as defined in section [2.3.11.18](#linerightdashstyle). If the **opid.fComplex** bit of **lineRightDashStyle** equals 0x1, this property MUST exist. + +[TABLE] + +**lineRightDashStyle_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of 32-bit unsigned integers that specifies a custom dash style for the line. The length of each dash and space in the dash style of the line is the product of a multiplier and the line width. The first element specifies the multiplier of the first dash, the second element specifies the multiplier of the first space, the third element specifies the multiplier of the second dash, and so on—alternating between spaces and dashes. This value SHOULD be used only if the **lineRightDashing** property, as defined in section [2.3.11.17](#linerightdashing), is either not present or equal to **msolineSolid**. + +#### lineRightStartArrowhead + +The **lineRightStartArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightStartArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the start of the line. The default value for this property is **msolineNoEnd**. + +#### lineRightEndArrowhead + +The **lineRightEndArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightEndArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the end of the line. The default value for this property is **msolineNoEnd**. + +#### lineRightStartArrowWidth + +The **lineRightStartArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightStartArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineRightStartArrowLength + +The **lineRightStartArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightStartArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineRightEndArrowWidth + +The **lineRightEndArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightEndArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineRightEndArrowLength + +The **lineRightEndArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D5. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightEndArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineRightJoinStyle + +The **lineRightJoinStyle** property specifies the style of the line joins. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D6. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightJoinStyle (4 bytes):** An **MSOLINEJOIN** enumeration value, as defined in section [2.4.19](#msolinejoin), that specifies the style of the line joins. The default value for this property is **msolineJoinRound**. + +#### lineRightEndCapStyle + +The **lineRightEndCapStyle** property specifies the style of the line end caps. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightEndCapStyle (4 bytes):** An **MSOLINECAP** enumeration value, as defined in section [2.4.20](#msolinecap), that specifies the style of the line end caps. The default value for this property is **msolineEndCapFlat**. + +#### lineRightColorExt + +The **lineRightColorExt** property specifies the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05D9. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended foreground color. The default value for this property is 0xFFFFFFFF. + +#### reserved1498 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05DA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1498 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineRightColorExtMod + +The **lineRightColorExtMod** property specifies the color modification of the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05DB. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended foreground color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1500 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05DC. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1500 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### lineRightBackColorExt + +The **lineRightBackColorExt** property specifies the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05DD. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightBackColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended background color. The default value for this property is 0xFFFFFFFF. + +#### reserved1502 + +The **reserved1502** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05DE. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1502 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineRightBackColorExtMod + +The **lineRightBackColorExtMod** property specifies the color modification of the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05DF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineRightBackColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended background color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1504 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05E0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1504 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved1505 + +The **reserved1505** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05E1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1505 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved1506 + +The **reserved1506** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05E2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1506 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Right Line Style Boolean Properties + +The **Right Line Style Boolean Properties** specify a 32-bit field of Boolean properties for the right line style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x05FF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**C - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**D - fUsefRightInsetPen (1 bit):** A bit that specifies whether the **fRightInsetPen** bit is set. A value of 0x0 specifies that the **fRightInsetPen** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefRightInsetPenOK (1 bit):** A bit that specifies whether the **fRightInsetPenOK** bit is set. A value of 0x0 specifies that the **fRightInsetPenOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - unused5 (1 bit):** A value that is undefined and MUST be ignored. + +**G - fUsefRightLine (1 bit):** A bit that specifies whether the **fRightLine** bit is set. A value of 0x0 specifies that the **fRightLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefRightHitTestLine (1 bit):** A bit that specifies whether the **fRightHitTestLine** bit is set. A value of 0x0 specifies that the **fRightHitTestLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefLineRightFillShape (1 bit):** A bit that specifies whether the **fLineRightFillShape** bit is set. A value of 0x0 specifies that the **fLineRightFillShape** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefRightNoLineDrawDash (1 bit):** A bit that specifies whether the **fRightNoLineDrawDash** bit is set. A value of 0x0 specifies that the **fRightNoLineDrawDash** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused6 (6 bits):** A value that is undefined and MUST be ignored. + +**K - unused7 (1 bit):** A value that is undefined and MUST be ignored. + +**L - reserved1 (1 bit):** A value that MUST be zero and MUST be ignored. + +**M - reserved2 (1 bit):** A value that MUST be zero and MUST be ignored. + +**N - fRightInsetPen (1 bit):** A bit that specifies whether to draw the line inside the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If **fRightInsetPenOK** equals 0x0, this bit MUST be ignored. If **fUsefRightInsetPen** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**O - fRightInsetPenOK (1 bit):** A bit that specifies whether insetting the pen is allowed. If **fUsefRightInsetPenOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**P - reserved3 (1 bit):** A value that MUST be zero and MUST be ignored. + +**Q - fRightLine (1 bit):** A bit that specifies whether to display the other line properties in this line style when handling the right side of a rectangular 2-D shape. If **fUsefRightLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. If the **rh.recInstance** field in the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for the shape is not set to one of the **MSOSPT** enumeration values, as defined in section [2.4.24](#msospt), in the following list, the line properties in this line style MUST NOT be displayed: + +- **msosptRectangle** + +- **msosptTextBox** + +- **msosptBevel** + +- **msosptHostControl** + +- **msosptPictureFrame** + +- **msosptFlowChartProcess** + +- **msosptFlowChartPredefinedProcess** + +- **msosptFlowChartInternalStorage** + +- **msosptActionButtonBlank** + +- **msosptActionButtonHome** + +- **msosptActionButtonHelp** + +- **msosptActionButtonInformation** + +- **msosptActionButtonForwardNext** + +- **msosptActionButtonBackPrevious** + +- **msosptActionButtonEnd** + +- **msosptActionButtonBeginning** + +- **msosptActionButtonReturn** + +- **msosptActionButtonDocument** + +- **msosptActionButtonSound** + +- **msosptActionButtonMovie** + +**R - fRightHitTestLine (1 bit):** A bit that specifies whether this line will be hit tested. If **fUsefRightHitTestLine** equal 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**S - fLineRightFillShape (1 bit):** A bit that specifies how the fill is aligned. The following table specifies the meaning of each value for this field. If **fUsefLineRightFillShape** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the fill is aligned with the origin of the view. | +| 0x1 | Specifies that the fill is aligned relative to the shape so that it will move with the shape. | + +**T - fRightNoLineDrawDash (1 bit):** A bit that specifies whether a dashed line will be drawn if the other properties specify that no line exists. If **fUsefRightNoLineDrawDash** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Bottom Line Style + +The **Bottom Line Style** property set specifies the line attributes that are applied to the bottom side of a rectangular [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### lineBottomColor + +The **lineBottomColor** property specifies the foreground color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0600. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line. The default value for this property is 0x00000000. + +#### lineBottomOpacity + +The **lineBottomOpacity** property specifies the opacity level of the foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0601. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomOpacity (4 bytes):** A signed integer that specifies the opacity level of the foreground color. This property MUST be from 0x00000000 through 0x00010000, inclusive. A value of 0x00000000 is completely transparent. A value of 0x00010000 is completely opaque. The default value for this property is 0x00010000. + +#### lineBottomBackColor + +This property specifies the background color of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0602. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomBackColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the background color of the line. The default value for this property is 0x00FFFFFF. + +#### lineBottomCrMod + +The **lineBottomCrMod** property specifies the foreground color of the line for black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0603. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the foreground color of the line for black-and-white display mode. The default value for this property is 0x20000000. + +#### lineBottomType + +The **lineBottomType** property specifies the type of line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0604. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomType (4 bytes):** An **MSOLINETYPE** enumeration value, as defined in section [2.4.13](#msolinetype), that specifies the type of line. The default value for this property is **msolineSolid**. + +#### lineBottomFillBlip + +The **lineBottomFillBlip** property specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0605. | +| **opid.fBid** | A value that MUST be 0x0 if **fComplex** equals 0x1 or 0x1 if **fComplex** equals 0x0. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineBottomFillBlip_complex** property, as defined in section [2.3.12.7](#linebottomfillblip_complex), exists. If the value equals 0x1, **lineBottomFillBlip_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. | + +**lineBottomFillBlip (4 bytes):** An unsigned integer specifying the BLIP that is used to fill this line when the **lineBottomType** property, as defined in section [2.3.12.5](#linebottomtype), is set to **msolinePattern** or **msolineTexture**. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of lineBottomFillBlip field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer). A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **lineBottomFillBlip_complex** property. | + +#### lineBottomFillBlip_complex + +The **lineBottomFillBlip_complex** property specifies additional data for the **lineBottomFillBlip** property, as defined in section [2.3.12.6](#linebottomfillblip). If the **opid.fComplex** bit of **lineBottomFillBlip** equals 0x1, this property MUST exist. + +[TABLE] + +**lineBottomFillBlip_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), specifying the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) that is used to fill this line if the **lineBottomType** property, as defined in section [2.3.12.5](#linebottomtype), is set to **msolinePattern** or **msolineTexture**. + +#### lineBottomFillBlipName + +The **lineBottomFillBlipName** property specifies a comment about the **lineBottomFillBlip** property, as defined in section [2.3.12.6](#linebottomfillblip). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0606. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineBottomFillBlipName_complex** property, as defined in section [2.3.12.9](#linebottomfillblipname_complex), exists. If the value equals 0x1, **lineBottomFillBlipName_complex** MUST exist. | + +**lineBottomFillBlipName (4 bytes):** The number of bytes of data in the **lineBottomFillBlipName_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineBottomFillBlipName_complex + +The **lineBottomFillBlipName_complex** property specifies additional data for the **lineBottomFillBlipName** property, as defined in section [2.3.12.8](#linebottomfillblipname). If the **opid.fComplex** bit of **lineBottomFillBlipName** equals 0x1, this property MUST exist. + +[TABLE] + +**lineBottomFillBlipName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies a comment about the **lineBottomFillBlip** property, as specified by the **lineBottomFillBlipFlags** property, as defined in section [2.3.12.10](#linebottomfillblipflags). + +#### lineBottomFillBlipFlags + +The **lineBottomFillBlipFlags** property specifies how to interpret the **lineBottomFillBlipName_complex** property, as defined in section [2.3.12.9](#linebottomfillblipname_complex). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0607. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomFillBlipFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **lineBottomFillBlipName_complex** property, as defined in section 2.3.12.9. This value MUST be **msoblipflagComment**. The default value for this property is **msoblipflagComment**. + +#### lineBottomFillWidth + +The **lineBottomFillWidth** property specifies the width of a pattern or texture that is used to fill this line. The **lineBottomFillDztype** property, as defined in section [2.3.12.13](#linebottomfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0608. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomFillWidth (4 bytes):** A signed integer specifying the width of a pattern or texture that is used to fill this line. If this value is 0x00000000, the width of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineBottomFillHeight + +The **lineBottomFillHeight** property specifies the height of a pattern or texture that is used to fill this line. The **lineBottomFillDztype** property, as defined in section [2.3.12.13](#linebottomfilldztype), specifies how to interpret this value. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0609. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomFillHeight (4 bytes):** A signed integer specifying the height of a pattern or texture that is used to fill this line. If this value is 0x00000000, the height of the pixel data contained in the pattern or texture is to be used, and the appearance of the line fill will depend on the settings of the device on which it is rendered. The default value for this property is 0x00000000. + +#### lineBottomFillDztype + +The **lineBottomFillDztype** property specifies how the **lineBottomFillWidth**, as defined in section [2.3.12.11](#linebottomfillwidth), and **lineBottomFillHeight**, as defined in section [2.3.12.12](#linebottomfillheight), properties MUST be interpreted. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x060A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomFillDztype (4 bytes):** An **MSODZTYPE** enumeration value, as defined in section [2.4.12](#msodztype), that specifies how the **lineBottomFillWidth**, as defined in section 2.3.12.11, and **lineBottomFillHeight**, as defined in section 2.3.12.12, properties MUST be interpreted. The default value for this property is **msodztypeDefault**. + +#### lineBottomWidth + +The **lineBottomWidth** property specifies the width of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x060B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomWidth (4 bytes):** A signed integer that specifies the width, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the line. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00002535. + +#### lineBottomMiterLimit + +The **lineBottomMiterLimit** property specifies the maximum allowed ratio of miter length to line width. The miter length is the distance from the intersection of the line walls on the inside of the join to the intersection of the line walls on the outside of the join. For an explanation of miter length, see section [2.3.8.15](#linemiterlimit). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x060C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomMiterLimit (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the maximum allowed ratio of miter length to line width. The default value for this property is 0x00080000. + +#### lineBottomStyle + +The **lineBottomStyle** property specifies the style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x060D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomStyle (4 bytes):** An **MSOLINESTYLE** enumeration value, as defined in section [2.4.14](#msolinestyle), that specifies the style of the line. The default value for this property is **msolineSimple**. + +#### lineBottomDashing + +The **lineBottomDashing** property specifies the dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x060E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomDashing (4 bytes):** An **MSOLINEDASHING** enumeration value, as defined in section [2.4.15](#msolinedashing), that specifies the dash style of the line. The default value for this property is **msolineSolid**. + +#### lineBottomDashStyle + +The **lineBottomDashStyle** property specifies the custom dash style of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x060F. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **lineBottomDashStyle_complex** property, as defined in section [2.3.12.19](#linebottomdashstyle_complex), exists. If the value equals 0x1, **lineBottomDashStyle_complex** MUST exist. | + +**lineBottomDashStyle (4 bytes):** The number of bytes of data in the **lineBottomDashStyle_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### lineBottomDashStyle_complex + +The **lineBottomDashStyle_complex** property specifies additional data for the **lineBottomDashStyle** property, as defined in section [2.3.12.18](#linebottomdashstyle). If the **opid.fComplex** bit of **lineBottomDashStyle** equals 0x1, this property MUST exist. + +[TABLE] + +**lineBottomDashStyle_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), of 32-bit unsigned integers that specifies a custom dash style for the line. The length of each dash and space in the dash style of the line is the product of a multiplier and the line width. The first element specifies the multiplier of the first dash, the second element specifies the multiplier of the first space, the third element specifies the multiplier of the second dash, and so on—alternating between spaces and dashes. This value SHOULD be used only if the **lineBottomDashing** property, as defined in section [2.3.12.17](#linebottomdashing), is either not present or equal to **msolineSolid**. + +#### lineBottomStartArrowhead + +The **lineBottomStartArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0610. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomStartArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the start of the line. The default value for this property is **msolineNoEnd**. + +#### lineBottomEndArrowhead + +The **lineBottomEndArrowhead** property specifies the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0611. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomEndArrowhead (4 bytes):** An **MSOLINEEND** enumeration value, as defined in section [2.4.16](#msolineend), specifying the line end decoration that is used at the end of the line. The default value for this property is **msolineNoEnd**. + +#### lineBottomStartArrowWidth + +The **lineBottomStartArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0612. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomStartArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineBottomStartArrowLength + +The **lineBottomStartArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the start of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0613. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomStartArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the start of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineBottomEndArrowWidth + +The **lineBottomEndArrowWidth** property specifies the width of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0614. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomEndArrowWidth (4 bytes):** An **MSOLINEENDWIDTH** enumeration value, as defined in section [2.4.17](#msolineendwidth), specifying the width of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumWidthArrow**. + +#### lineBottomEndArrowLength + +The **lineBottomEndArrowLength** property specifies the length of the [**line end decoration**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that is used at the end of the line. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0615. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomEndArrowLength (4 bytes):** An **MSOLINEENDLENGTH** enumeration value, as defined in section [2.4.18](#msolineendlength), specifying the length of the line end decoration that is used at the end of the line. The default value for this property is **msolineMediumLenArrow**. + +#### lineBottomJoinStyle + +The **lineBottomJoinStyle** property specifies the style of the line joins. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0616. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomJoinStyle (4 bytes):** An **MSOLINEJOIN** enumeration value, as defined in section [2.4.19](#msolinejoin), specifying the style of the line joins. The default value for this property is **msolineJoinRound**. + +#### lineBottomEndCapStyle + +The **lineBottomEndCapStyle** property specifies the style of the line end caps. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0617. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomEndCapStyle (4 bytes):** An **MSOLINECAP** enumeration value, as defined in section [2.4.20](#msolinecap), specifying the style of the line end caps. The default value for this property is **msolineEndCapFlat**. + +#### lineBottomColorExt + +The **lineBottomColorExt** property specifies the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0619. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended foreground color. The default value for this property is 0xFFFFFFFF. + +#### reserved1562 + +The **reserved1562** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x061A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1562 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineBottomColorExtMod + +The **lineBottomColorExtMod** property specifies the color modification of the extended foreground color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x061B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended foreground color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1564 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x061C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1564 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### lineBottomBackColorExt + +The **lineBottomBackColorExt** property specifies the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x061D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomBackColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended background color. The default value for this property is 0xFFFFFFFF. + +#### reserved1566 + +The **reserved1566** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x061E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1566 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### lineBottomBackColorExtMod + +The **lineBottomBackColorExtMod** property specifies the color modification of the extended background color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x061F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lineBottomBackColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended background color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved1568 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0620. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1568 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved1569 + +The **reserved1569** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0621. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1569 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved1570 + +The **reserved1570** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0622. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved1570 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Bottom Line Style Boolean Properties + +The **Bottom Line Style Boolean Properties** specify a 32-bit field of Boolean properties for the bottom line style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x063F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**C - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**D - fUsefBottomInsetPen (1 bit):** A bit that specifies whether the **fBottomInsetPen** bit is set. A value of 0x0 specifies that the **fBottomInsetPen** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefBottomInsetPenOK (1 bit):** A bit that specifies whether the **fBottomInsetPenOK** bit is set. A value of 0x0 specifies that the **fBottomInsetPenOK** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**F - unused5 (1 bit):** A value that is undefined and MUST be ignored. + +**G - fUsefBottomLine (1 bit):** A bit that specifies whether the **fBottomLine** bit is set. A value of 0x0 specifies that the **fBottomLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**H - fUsefBottomHitTestLine (1 bit):** A bit that specifies whether the **fBottomHitTestLine** bit is set. A value of 0x0 specifies that the **fBottomHitTestLine** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**I - fUsefLineBottomFillShape (1 bit):** A bit that specifies whether the **fLineBottomFillShape** bit is set. A value of 0x0 specifies that the **fLineBottomFillShape** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**J - fUsefBottomNoLineDrawDash (1 bit):** A bit that specifies whether the **fBottomNoLineDrawDash** bit is set. A value of 0x0 specifies that the **fBottomNoLineDrawDash** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused6 (6 bits):** A value that is undefined and MUST be ignored. + +**K - unused7 (1 bit):** A value that is undefined and MUST be ignored. + +**L - reserved1 (1 bit):** A value that MUST be zero and MUST be ignored. + +**M - reserved2 (1 bit):** A value that MUST be zero and MUST be ignored. + +**N - fBottomInsetPen (1 bit):** A bit that specifies whether to draw the line inside the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If **fBottomInsetPenOK** equals 0x0, this bit MUST be ignored. If **fUsefBottomInsetPen** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +**O - fBottomInsetPenOK (1 bit):** A bit that specifies whether insetting the pen is allowed. If **fUsefBottomInsetPenOK** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**P - reserved3 (1 bit):** A value that MUST be zero and MUST be ignored. + +**Q - fBottomLine (1 bit):** A bit that specifies whether to display the other line properties in this line style when handling the bottom side of a rectangular 2-D shape. If **fUsefBottomLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. If the **rh.recInstance** field in the **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), for the shape is not set to one of the **MSOSPT** enumeration values, as defined in section [2.4.24](#msospt), in the following list, the line properties in this line style MUST NOT be displayed: + +- **msosptRectangle** + +- **msosptTextBox** + +- **msosptBevel** + +- **msosptHostControl** + +- **msosptPictureFrame** + +- **msosptFlowChartProcess** + +- **msosptFlowChartPredefinedProcess** + +- **msosptFlowChartInternalStorage** + +- **msosptActionButtonBlank** + +- **msosptActionButtonHome** + +- **msosptActionButtonHelp** + +- **msosptActionButtonInformation** + +- **msosptActionButtonForwardNext** + +- **msosptActionButtonBackPrevious** + +- **msosptActionButtonEnd** + +- **msosptActionButtonBeginning** + +- **msosptActionButtonReturn** + +- **msosptActionButtonDocument** + +- **msosptActionButtonSound** + +- **msosptActionButtonMovie** + +**R - fBottomHitTestLine (1 bit):** A bit that specifies whether this line will be hit tested. If **fUsefBottomHitTestLine** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +**S - fLineBottomFillShape (1 bit):** A bit that specifies how the fill is aligned. The following table specifies the meaning of each value for this field. If **fUsefLineBottomFillShape** equals 0x0, this value MUST be ignored. The default value for this property is 0x1. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the fill is aligned with the origin of the view. | +| 0x1 | Specifies that the fill is aligned relative to the shape so that it will move with the shape. | + +**T - fBottomNoLineDrawDash (1 bit):** A bit that specifies whether a dashed line will be drawn if the other properties specify that no line exists. If **fUsefBottomNoLineDrawDash** equals 0x0, this value MUST be ignored. The default value for this property is 0x0. + +### Shadow Style + +The **Shadow Style** property set specifies how a shadow will appear when drawn. + +#### shadowType + +The **shadowType** property specifies the style of shadow to display with the object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0200. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowType (4 bytes):** An **MSOSHADOWTYPE** enumeration value, as defined in section [2.4.21](#msoshadowtype), that specifies the type of shadow. The default value for this property is **msoshadowOffset**. + +#### shadowColor + +The **shadowColor** property specifies the primary color of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0201. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the primary color of the shadow. The default value for this property is 0x00808080. + +#### shadowHighlight + +The **shadowHighlight** property specifies the highlight color of the shadow. This property MUST exist if the **shadowType** property, as defined in section [2.3.13.1](#shadowtype), equals [**msoshadowDouble**](#msoshadowtype) or **msoshadowEmbossOrEngrave**; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0202. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowHighlight (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the highlight color of the shadow. The default value for this property is 0x00CBCBCB. + +#### shadowCrMod + +The **shadowCrMod** property specifies the shadow's primary color modifier to use when running in black-and-white display mode. This property MUST exist if black-and-white display mode is to be used; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0203. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the shadow's primary color modifier to use when running in black-and-white display mode. The default value for this property is 0x20000000. + +#### shadowOpacity + +The **shadowOpacity** property specifies the opacity level of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0204. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowOpacity (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the opacity level of the shadow. This value MUST be from 0.0 through 1.0. The default value for this property is 0x00010000. + +#### shadowOffsetX + +The **shadowOffsetX** property specifies the distance along the x-axis that the shadow lies away from the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This property MUST exist if the **shadowType** property, as defined in section [2.3.13.1](#shadowtype), equals [**msoshadowOffset**](#msoshadowtype) or **msoshadowDouble**; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0205. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowOffsetX (4 bytes):** A signed integer that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), along the x-axis that the shadow lies away from the shape. If this value is positive, the shadow is offset from the right side of the axis-aligned [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) for the shape. If this value is negative, the shadow is offset from the left side of the axis-aligned bounding rectangle for the shape. The default value for this property is 0x00006338. + +#### shadowOffsetY + +The **shadowOffsetY** property specifies the distance along the y-axis that the shadow lies away from the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This property MUST exist if the **shadowType** property, as defined in section [2.3.13.1](#shadowtype), equals [**msoshadowOffset**](#msoshadowtype) or **msoshadowDouble**; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0206. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowOffsetY (4 bytes):** A signed integer that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), along the y-axis that the shadow lies away from the shape. If this value is positive, the shadow is offset from the bottom of the axis-aligned [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) for the shape. If this value is negative, the shadow is offset from the top of the axis-aligned bounding rectangle for the shape. The default value for this property is 0x00006338. + +#### shadowSecondOffsetX + +The **shadowSecondOffsetX** property specifies the distance along the x-axis that the highlighted shadow lies away from the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This property MUST exist if the **shadowType** property, as defined in section [2.3.13.1](#shadowtype), equals [**msoshadowDouble**](#msoshadowtype); otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0207. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowSecondOffsetX (4 bytes):** A signed integer that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), along the x-axis that the highlighted portion of the shadow lies away from the shape. If this value is positive, the shadow is offset from the right side of the axis-aligned [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) for the shape. If this value is negative, the shadow is offset from the left side of the axis-aligned bounding rectangle for the shape. The default value for this property is 0x00000000. + +#### shadowSecondOffsetY + +The **shadowSecondOffsetY** property specifies the distance along the y-axis that the highlighted shadow lies away from the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This property MUST exist if the **shadowType** property, as defined in section [2.3.13.1](#shadowtype), equals [**msoshadowDouble**](#msoshadowtype); otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0208. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowSecondOffsetY (4 bytes):** A signed integer that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), along the y-axis that the highlighted portion of the shadow lies away from the shape. If this value is positive, the shadow is offset from the bottom of the axis-aligned [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) for the shape. If this value is negative, the shadow is offset from the top of the axis-aligned bounding rectangle for the shape. + +The default value for this property is 0x00000000. + +#### shadowOriginX + +The **shadowOriginX** property specifies the origin of the shadow on the x-axis, relative to the center of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0210. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowOriginX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the origin, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the shadow relative to the center of the shape on the x-axis. The default value for this property is 0x00000000. + +#### shadowOriginY + +The **shadowOriginY** property specifies the origin of the shadow on the y-axis, relative to the center of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0211. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowOriginY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the origin, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the shadow relative to the center of the shape on the y-axis. The default value for this property is 0x00000000. + +#### shadowColorExt + +The **shadowColorExt** property specifies the primary extended color of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0212. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the primary extended color of the shadow. The default value for this property is 0xFFFFFFFF. + +#### reserved531 + +The **reserved531** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0213. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved531 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### shadowColorExtMod + +The **shadowColorExtMod** property specifies the color modification of the primary extended color of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0214. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the shadow’s primary extended color modification. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved533 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0215. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved533 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### shadowHighlightExt + +The **shadowHighlightExt** property specifies the extended highlight color of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0216. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowHighlightExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended highlight color of the shadow. The default value for this property is 0xFFFFFFFF. + +#### reserved535 + +The **reserved535** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0217. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved535 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### shadowHighlightExtMod + +The **shadowHighlightExtMod** property specifies the color modification of the extended highlight color of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0218. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowHighlightExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the color modification of the extended highlight color of the shadow. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved537 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0219. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved537 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved538 + +The **reserved538** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x021A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved538 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### reserved539 + +The **reserved539** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x021B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved539 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### shadowSoftness + +The **shadowSoftness** property specifies the blur radius of the shadow. This property SHOULD[\<43\>](#Appendix_A_43) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x021C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**shadowSoftness (4 bytes):** A signed integer that specifies the blur radius of the shadow. This value MUST be from 0x00000000 through 0x001170D8, inclusive. The default value for this property is 0x00000000[\<44\>](#Appendix_A_44). + +#### Shadow Style Boolean Properties + +The **Shadow Style Boolean Properties** specify a 32-bit field of Boolean properties for the state of the shadow. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x023F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (13 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefInnerShadow (1 bit):** This bit is not used and MUST be ignored. + +**B - fUsefShadow (1 bit):** A bit that specifies whether the **fShadow** bit is set. A value of 0x0 specifies that the **fShadow** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefshadowObscured (1 bit):** A bit that specifies whether the **fshadowObscured** bit is set. A value of 0x0 specifies that the **fshadowObscured** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused2 (13 bits):** A value that is undefined and MUST be ignored. + +**D - fInnerShadow (1 bit):** This bit is not used and MUST be ignored. + +**E - fShadow (1 bit):** A bit that specifies whether the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) has a shadow. This value MUST be ignored if **fUsefShadow** is 0x0. The default value for this property is 0x0. + +**F - fshadowObscured (1 bit):** A bit that specifies whether the shadow is fully obscured by the shape. Being fully obscured and not being fully obscured, as illustrated by the following figure, are visually different only when the shape has no fill properties. This value MUST be ignored if **fUsefshadowObscured** is 0x0. The default value for this property is 0x0. + +[TABLE] + +### Perspective Style + +The **Perspective Style** property set specifies how a [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) is constructed and applied to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The following figure shows how the perspective transform matrix is specified. + +![Structure of the perspective matrix](media/image61.bin "Structure of the perspective matrix") + +Figure 9: Structure of the perspective matrix + +#### perspectiveType + +The **perspectiveType** property specifies the style of the transform to be constructed for the perspective matrix. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0240. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveType (4 bytes):** An **MSOXFORMTYPE** enumeration value, as defined in section [2.4.22](#msoxformtype), that specifies how the transform is to be applied to the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The default value for this property is **msoxformShape**. + +#### perspectiveOffsetX + +The **perspectiveOffsetX** property specifies the offset that is applied to the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) along the x-axis before the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) is applied. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0241. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveOffsetX (4 bytes):** A value of variable type that specifies the offset applied to a shape. If the **perspectiveType** property, as defined in section [2.3.14.1](#perspectivetype), equals **msoxformShape**, the offset is of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6. Otherwise, the offset is an integral value, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). The default value for this property is 0x00000000. + +#### perspectiveOffsetY + +The **perspectiveOffsetY** property specifies the offset that is applied to the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) along the y-axis before the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) is applied. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0242. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveOffsetY (4 bytes):** A value of variable type that specifies the offset applied to a shape. If the **perspectiveType** property, as defined in section [2.3.14.1](#perspectivetype), equals **msoxformShape**, the offset is of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6. Otherwise, the offset is an integral value, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). The default value for this property is 0x00000000. + +#### perspectiveScaleXToX + +The **perspectiveScaleXToX** property specifies the x-axis scale value of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0243. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveScaleXToX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to scale along the x-axis. The default value for this property is 0x00010000. + +#### perspectiveScaleYToX + +The **perspectiveScaleYToX** property specifies the y-axis to x-axis transform value of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0244. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveScaleYToX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to transform from the y-axis to the x-axis. The default value for this property is 0x00000000. + +#### perspectiveScaleXToY + +The **perspectiveScaleXToY** property specifies the x-axis to y-axis transform value of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0245. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveScaleXToY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to transform from the x-axis to the y-axis. The default value for this property is 0x00000000. + +#### perspectiveScaleYToY + +The **perspectiveScaleYToY** property specifies the y-axis scale value of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0246. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveScaleYToY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to scale along the y-axis. The default value for this property is 0x00010000. + +#### perspectivePerspectiveX + +The **perspectivePerspectiveX** property specifies the offset on the x-axis of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0247. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectivePerspectiveX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, this is divided by the [perspectiveWeight](#perspectiveweight) property to produce a value that specifies the perspective offset on the x-axis. The default value for this property is 0x00000000. + +#### perspectivePerspectiveY + +The **perspectivePerspectiveY** property specifies the offset on the y-axis of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0248. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectivePerspectiveY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, this is divided by the [perspectiveWeight](#perspectiveweight) property to produce a value that specifies the perspective offset on the y-axis. The default value for this property is 0x00000000. + +#### perspectiveWeight + +The **perspectiveWeight** property specifies the perspective weighting of the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) matrix for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0249. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveWeight (4 bytes):** An unsigned integer that specifies the weighting of the [perspectivePerspectiveX](#perspectiveperspectivex) and [perspectivePerspectiveY](#perspectiveperspectivey) properties for the perspective transform. The default value for this property is 0x00000100. + +#### perspectiveOriginX + +The **perspectiveOriginX** property specifies the origin of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) on the x-axis, relative to the center of the shape. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x024A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveOriginX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the origin, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the shape relative to the center of the shape along the x-axis. The default value for this property is 0x00008000. + +#### perspectiveOriginY + +The **perspectiveOriginY** property specifies the origin of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) on the y-axis, relative to the center of the shape. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x024B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**perspectiveOriginY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the origin, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the shape relative to the center of the shape along the y-axis. The default value for this property is 0x00008000. + +#### Perspective Style Boolean Properties + +The **Perspective Style Boolean Properties** specify a 32-bit field of Boolean properties for the [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x027F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (15 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefPerspective (1 bit):** A bit that specifies whether the **fPerspective** bit is set. A value of 0x0 specifies that the **fPerspective** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused2 (15 bits):** A value that is undefined and MUST be ignored. + +**B - fPerspective (1 bit):** A bit that specifies whether the perspective transform is to be applied to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). This value MUST be ignored if **fUsefPerspective** is 0x0. The default value for this property is 0x0. + +### 3D Object + +The **3D Object** property set specifies how a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is to be rendered when displayed three-dimensionally. + +#### c3DSpecularAmt + +The **c3DSpecularAmt** property specifies the ratio of incident to specular light that is reflected on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0280. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DSpecularAmt (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the ratio of incident to specular light that is reflected on a shape. The default value for this property is 0x00000000. + +#### c3DDiffuseAmt + +The **c3DDiffuseAmt** property specifies the ratio of incident to diffuse light that is reflected on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0281. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DDiffuseAmt (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the ratio of incident to diffuse light that is reflected on a shape. The default value for this property is 0x00010000. + +#### c3DShininess + +The **c3DShininess** property specifies the specular power that is applied to the specular light reflected from a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The higher the specular power, the larger the area of reflected specular light. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0282. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DShininess (4 bytes):** A value of type **Long.** The default value for this property is 0x00000005. + +#### c3DEdgeThickness + +The **c3DEdgeThickness** property specifies the thickness of the specular edge. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0283. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DEdgeThickness (4 bytes):** A signed integer that specifies how thick the edge will be around the specular highlight. This value is expressed in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). The default value for this property is 0x0000319C. + +#### c3DExtrudeForward + +The **c3DExtrudeForward** property specifies the distance to extrude the front face of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The front face of the shape points toward the screen on a shape that has not been rotated. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0284. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DExtrudeForward (4 bytes):** A signed integer that specifies the distance to extrude the front face of the shape toward the screen. This value is expressed in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). This value MUST be from 0x00000000 through 0x007445A0 inclusive. The default value for this property is 0x00000000. + +#### c3DExtrudeBackward + +The **c3DExtrudeBackward** property specifies the distance to extrude the back face of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The back face of the shape points away from the screen on a shape that has not been rotated. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0285. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DExtrudeBackward (4 bytes):** A signed integer value that specifies the distance to extrude the back face of the shape away from the screen. This value is expressed in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). This value MUST be from 0x00000000 through 0x07445A00. The default value for this property is 0x0006F9F0. + +#### reserved646 + +The **reserved646** property MUST equal 0x00000000 and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0286. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved646 (4 bytes):** A value that MUST equal 0x00000000 and MUST be ignored. The default value for this property is 0x00000000. + +#### c3DExtrusionColor + +The **c3DExtrusionColor** property specifies the color to apply to extruded geometry. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0287. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DExtrusionColor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the color of the extruded [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) geometry. The default value for this property is 0x100000F7. + +#### c3DCrMod + +The **c3DCrMod** property specifies the extrusion color modifier when running in black-and-white display mode. This property MUST exist if black-and-white display mode is to be used. Otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0288. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extrusion color modifier when running in black-and-white display mode. The default value for this property is 0x20000000. + +#### c3DExtrusionColorExt + +The **c3DExtrusionColorExt** property specifies the extrusion extended color of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) geometry. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0289. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DExtrusionColorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended color of the extruded geometry. The default value for this property is 0xFFFFFFFF. + +#### reserved650 + +The **reserved650** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x028A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved650 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### c3DExtrusionColorExtMod + +The **c3DExtrusionColorExtMod** property specifies the color modification of the extended color for the extruded geometry. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x028B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DExtrusionColorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the extended color modification for the extruded geometry. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved652 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x028C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved652 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved653 + +The **reserved653** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x028D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved653 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### 3D-Object Boolean Properties + +The **3D-Object Boolean Properties** specify a 32-bit field of Boolean properties for a 3-D object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (12 bits):** A value that is undefined and MUST be ignored. + +**A - fUsef3D (1 bit):** A bit that specifies whether the **f3D** bit is set. A value of 0x0 specifies that the **f3D** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**B - fUsefc3DMetallic (1 bit):** A bit that specifies whether the **fc3DMetallic** bit is set. A value of 0x0 specifies that the **fc3DMetallic** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefc3DUseExtrusionColor (1 bit):** A bit that specifies whether the **fc3DUseExtrusionColor** bit is set. A value of 0x0 specifies that the **fc3DUseExtrusionColor** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**D - fUsefc3DLightFace (1 bit):** A bit that specifies whether the **fc3DLightFace** bit is set. A value of 0x0 specifies that the **fc3DLightFace** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused2 (12 bits):** A value that is undefined and MUST be ignored. + +**E - f3D (1 bit):** A bit that specifies whether the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) contains 3-D properties. This value MUST be ignored if **fUsef3D** is 0x0. The default value for this property is 0x0. + +**F - fc3DMetallic (1 bit):** A bit that specifies whether the 3-D shape lighting algorithm will treat the specular color as the diffuse color. This value MUST be ignored if **fUsefc3DMetallic** is 0x0. The default value for this property is 0x0. + +**G - fc3DUseExtrusionColor (1 bit):** A bit that specifies whether the extruded geometry will use a color that is separate from the shape color, as specified in the following table. This value MUST be ignored if **fUsefc3DUseExtrusionColor** is 0x0. The default value for this property is 0x0. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the diffuse color will be used. | +| 0x1 | Specifies that the [c3DExtrusionColor](#c3dextrusioncolor) property will be used. | + +**H - fc3DLightFace (1 bit):** A bit that specifies whether the extruded geometry will be lit according to the current lighting model. This value MUST be ignored if **fUsefc3DLightFace** is 0x0. The default value for this property is 0x1. + +### 3D Style + +The **3D Style** property set specifies how a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) will be oriented when displayed three-dimensionally. + +#### c3DYRotationAngle + +The **c3DYRotationAngle** property specifies the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) rotation around the y-axis. A shape with constrained 3D rotation is rotated in the following manner: + +1. Around the y-axis by the angle specified by **c3DYRotationAngle.** + +2. Around the x-axis by the angle specified by [c3DXRotationAngle](#c3dxrotationangle). + +If the **fc3DConstrainRotation** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x1, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DYRotationAngle (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the number of degrees to rotate the shape around the y-axis. Positive values rotate in the clockwise direction. Negative values rotate in the counterclockwise direction. The valid range is from -90.0 degrees through 90.0 degrees. The default value for this property is 0x00000000. + +#### c3DXRotationAngle + +The **c3DXRotationAngle** property specifies the shape rotation around the x-axis. A shape with constrained 3D rotation is rotated in the following manner: + +1. Around the y-axis by the angle specified by the **c3DYRotationAngle** property, as defined in section [2.3.16.1](#c3dyrotationangle). + +2. Around the x-axis by the angle specified by **c3DXRotationAngle**. + +If the **fc3DConstrainRotation** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x1, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DXRotationAngle (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the number of degrees to rotate the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) around the x-axis. Positive values rotate in the clockwise direction. Negative values rotate in the counterclockwise direction. The valid range is from -90.0 degrees through 90.0 degrees. The default value for this property is 0x00000000. + +#### c3DRotationAxisX + +The **c3DRotationAxisX** property specifies the x portion of the axis that is used to rotate the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If the **fc3DConstrainRotation** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationAxisX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the x portion of the axis that is used to rotate a shape. The default value for this property is 0x00000064. + +#### c3DRotationAxisY + +The **c3DRotationAxisY** property specifies the Y portion of the axis that is used to rotate the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If the **fc3DConstrainRotation** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationAxisY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the Y portion of the axis that is used to rotate a shape. The default value for this property is 0x00000000. + +#### c3DRotationAxisZ + +The **c3DRotationAxisZ** property specifies the Z portion of the axis that is used to rotate the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). If the **fc3DConstrainRotation** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationAxisZ (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the Z portion of the axis that is used to rotate a shape. The default value for this property is 0x00000000. + +#### c3DRotationAngle + +The **c3DRotationAngle** property specifies the number of degrees to rotate a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) around an axis. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C5. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationAngle (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the number of degrees to rotate the shape around the vector specified by the **c3DRotationAxisX**, as defined in section [2.3.16.3](#c3drotationaxisx), **c3DRotationAxisY**, as defined in section [2.3.16.4](#c3drotationaxisy), and **c3DRotationAxisZ**, as defined in section [2.3.16.5](#c3drotationaxisz), properties. Positive values rotate in the clockwise direction. Negative values rotate in the counterclockwise direction. The default value for this property is 0x00000000. + +#### c3DRotationCenterX + +The **c3DRotationCenterX** property specifies the location of the center of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) along the x-axis. If the **fc3DRotationCenterAuto** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C6. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationCenterX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies a fraction of the geometry’s scaled width and height. The default value for this property is 0x00000000. + +#### c3DRotationCenterY + +The **c3DRotationCenterY** property specifies the location of the center of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) along the y-axis. If the **fc3DRotationCenterAuto** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationCenterY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies a fraction of the geometry’s scaled width and height. The default value for this property is 0x00000000. + +#### c3DRotationCenterZ + +The **c3DRotationCenterZ** property specifies the location of the center of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) along the z-axis. If the **fc3DRotationCenterAuto** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C8. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRotationCenterZ (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies a fraction of the geometry’s scaled width and height. The default value for this property is 0x00000000. + +#### c3DRenderMode + +The **c3DRenderMode** property specifies how to display a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02C9. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DRenderMode (4 bytes):** An **MSO3DRENDERMODE** enumeration value, as defined in section [2.4.23](#mso3drendermode), that specifies how to display the shape. The default value for this property is **msoFullRender**. + +#### c3DTolerance + +If the geometry is broken up for rendering purposes, the **c3DTolerance** property specifies the geometric deviation that is permitted for rendering the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02CA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DTolerance (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the number of pixels that the geometry is allowed to deviate from the original geometry during rendering. This value MUST be greater than or equal to 0x00000000. The default value for this property is 0x00007530. + +#### c3DXViewpoint + +The **c3DXViewpoint** property specifies the location of the perspective camera on the x-axis. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02CB. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DXViewpoint (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the location, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the perspective camera on the x-axis. The default value for this property is 0x001312D0. + +#### c3DYViewpoint + +The **c3DYViewpoint** property specifies the location of the perspective camera on the y-axis. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02CC. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DYViewpoint (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the location, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the perspective camera on the y-axis. The default value for this property is 0xFFECED30. + +#### c3DZViewpoint + +The **c3DZViewpoint** property specifies the distance from the view plane of the perspective camera on the z-axis. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02CD. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DZViewpoint (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the distance, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), from the view plane of the perspective camera on the z-axis. The default value for this property is 0x00895440. + +#### c3DOriginX + +The **c3DOriginX** property specifies the origin of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) on the x-axis when displayed with the perspective camera. The origin is specified as a multiple of the width and height of the shape, relative to the center of the shape. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02CE. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DOriginX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the displacement from the center of the shape to use as the shape origin on the x-axis. The default value for this property is 0x00008000. + +#### c3DOriginY + +The **c3DOriginY** property specifies the origin of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) on the y-axis when displayed with the perspective camera. The origin is specified as a multiple of the width and height of the shape, relative to the center of the shape. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x0, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02CF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DOriginY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the displacement from the center of the shape to use as the shape origin on the y-axis. The default value for this property is 0xFFFF8000. + +#### c3DSkewAngle + +The **c3DSkewAngle** property specifies the amount of skew that is added to the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) when a parallel projection is used. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x1, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DSkewAngle (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the angle to skew the shape with a parallel projection. A value of 0x00000000 specifies an orthographic projection. A negative value skews the shape to the right. A positive value skews the shape to the left. The default value for this property is 0xFF790000. + +#### c3DSkewAmount + +The **c3DSkewAmount** property specifies the amount of skew to add to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) as a percentage of the skew. If the **fc3DParallel** bit of the [3D-Style Boolean Properties](#d-style-boolean-properties) equals 0x1, this property MUST exist; otherwise, this property MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DSkewAmount (4 bytes):** A signed integer that specifies the percentage, as a value from 0xFFFFFF9C through 0x00000064, to skew the shape. The default value for this property is 0x00000032. + +#### c3DAmbientIntensity + +The **c3DAmbientIntensity** property specifies the intensity of the ambient light. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DAmbientIntensity (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the intensity of the ambient light. This value MUST be from 0.0 through 1.0. The default value for this property is 0x00004E20. + +#### c3DKeyX + +The **c3DKeyX** property specifies the directional vector of the primary light source along the x-axis. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DKeyX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the directional vector of the primary light source along the x-axis. The default value for this property is 0x0000C350. + +#### c3DKeyY + +The **c3DKeyY** property specifies the directional vector of the primary light source along the y-axis. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DKeyY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the directional vector of the primary light source along the y-axis. The default value for this property is 0x00000000. + +#### c3DKeyZ + +The **c3DKeyZ** property specifies the directional vector of the primary light source along the z-axis. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D5. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DKeyZ (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the directional vector of the primary light source along the z-axis. The default value for this property is 0x00002710. + +#### c3DKeyIntensity + +The **c3DKeyIntensity** property specifies the intensity of the primary light source. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D6. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DKeyIntensity (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the intensity of the primary light source. This value SHOULD[\<45\>](#Appendix_A_45) be from 0.0 through 1.0. The default value for this property is 0x00009470. + +#### c3DFillX + +The **c3DFillX** property specifies the directional vector along the x-axis of the secondary light source. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D7. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DFillX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the directional vector along the x-axis of the secondary light source. The default value for this property is 0xFFFF3CB0. + +#### c3DFillY + +The **c3DFillY** property specifies the directional vector along the y-axis of the secondary light source. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D8. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DFillY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the directional vector along the y-axis of the secondary light source. The default value for this property is 0x00000000. + +#### c3DFillZ + +The **c3DFillZ** property specifies the directional vector along the z-axis of the secondary light source. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02D9. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DFillZ (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the directional vector along the z-axis of the secondary light source. The default value for this property is 0x00002710. + +#### c3DFillIntensity + +The **c3DFillIntensity** property specifies the intensity of the secondary light source. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02DA. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**c3DFillIntensity (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the intensity of the secondary light source. This value SHOULD[\<46\>](#Appendix_A_46) be from 0.0 through 1.0. The default value for this property is 0x00009470. + +#### 3D-Style Boolean Properties + +The **3D-Style Boolean Properties** specify a 32-bit field of Boolean properties for the style of the 3-D object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x02FF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (11 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefc3DConstrainRotation (1 bit):** A bit that specifies whether the **fc3DConstrainRotation** bit is set. A value of 0x0 specifies that the **fc3DConstrainRotation** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**B - fUsefc3DRotationCenterAuto (1 bit):** A bit that specifies whether the **fc3DRotationCenterAuto** bit is set. A value of 0x0 specifies that the **fc3DRotationCenterAuto** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefc3DParallel (1 bit):** A bit that specifies whether the **fc3DParallel** bit is set. A value of 0x0 specifies that the **fc3DParallel** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**D - fUsefc3DKeyHarsh (1 bit):** A bit that specifies whether the **fc3DKeyHarsh** bit is set. A value of 0x0 specifies that the **fc3DKeyHarsh** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**E - fUsefc3DFillHarsh (1 bit):** A bit that specifies whether the **fc3DFillHarsh** bit is set. A value of 0x0 specifies that the **fc3DFillHarsh** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused2 (11 bits):** A value that is undefined and MUST be ignored. + +**F - fc3DConstrainRotation (1 bit):** A bit that specifies how to rotate a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The following table specifies the meaning of each value for this field. The default value for this property is 0x1. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that the shape will rotate around an axis that is specified by the **3D style** property set. | +| 0x1 | Specifies that the shape will rotate along the screen’s z-axis. | + +**G - fc3DRotationCenterAuto (1 bit):** A bit that specifies how to treat the center of the shape. The following table specifies the meaning of each value for this field. The default value for this property is 0x0. + +| Value | Meaning | +|-------|------------------------------------------------------| +| 0x0 | Specifies that a user-specified value will be used. | +| 0x1 | Specifies that the center of the shape will be used. | + +**H - fc3DParallel (1 bit):** A bit that specifies whether the 3-D object will use a parallel projection. The following table specifies the meaning of each value for this field. The default value for this property is 0x1. + +| Value | Meaning | +|-------|-------------------------------------| +| 0x0 | Specifies a perspective projection. | +| 0x1 | Specifies a parallel projection. | + +**I - fc3DKeyHarsh (1 bit):** A bit that specifies the lighting algorithm on the primary light source. The following table specifies the meaning of each value for this field. The default value for this property is 0x1. + +| Value | Meaning | +|-------|------------------------------------------------------| +| 0x0 | Specifies an infinite, uniform, planar light source. | +| 0x1 | Specifies a directional light source. | + +**J - fc3DFillHarsh (1 bit):** A bit that specifies the lighting algorithm on the secondary light source. The following table specifies the meaning of each value for this field. The default value for this property is 0x0. + +| Value | Meaning | +|-------|------------------------------------------------------| +| 0x0 | Specifies an infinite, uniform, planar light source. | +| 0x1 | Specifies a directional light source. | + +### Diagram + +The **Diagram** property set specifies the style and layout attributes of a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +#### dgmt + +The **dgmt** property specifies the type of the [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0500. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmt (4 bytes):** An **MSODGMT** enumeration value, as defined in section [2.4.27](#msodgmt), that specifies the type of the diagram. The default value for this property is 0x00000FFF. + +#### dgmStyle + +The **dgmStyle** property specifies a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0501. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmStyle (4 bytes):** An enumeration value that specifies a diagram style. The meaning of this value depends on the value of the **dgmt** property, as defined in section [2.3.17.1](#dgmt). The default value for this property is **msodgmstNil**, which is represented as 0x0000FFFF. + +If the value of the **dgmt** property equals **msodgmtCanvas**, **dgmStyle** MUST be ignored. + +If the value of the **dgmt** property equals **msodgmtOrgChart**, **dgmStyle** MUST be a value from the enumeration that is listed in the following table. + +| Name | Value | Meaning | Style | +|----|----|----|----| +| **msodgmstOrgChartFirst** | 0x00000000 | Default | ![Default organizational chart style](media/image62.bin "Default organizational chart style") | +| **msodgmstOrgChart2** | 0x00000001 | Outline | ![Outline organizational chart style](media/image63.bin "Outline organizational chart style") | +| **msodgmstOrgChart3** | 0x00000002 | Double outline | ![Double outline organizational chart style](media/image64.bin "Double outline organizational chart style") | +| **msodgmstOrgChart4** | 0x00000003 | Thick outline | ![Thick outline organizational chart style](media/image65.bin "Thick outline organizational chart style") | +| **msodgmstOrgChart5** | 0x00000004 | Primary colors | ![Primary colors organizational chart style](media/image66.bin "Primary colors organizational chart style") | +| **msodgmstOrgChart6** | 0x00000005 | Shaded | ![Shaded organizational chart style](media/image67.bin "Shaded organizational chart style") | +| **msodgmstOrgChart7** | 0x00000006 | Fire | ![Fire colored organizational chart style. Orange blending into red across org chart](media/image68.bin "Fire colored organizational chart style") | +| **msodgmstOrgChart8** | 0x00000007 | 3-D color | ![3 D colored organizational chart style](media/image69.bin "3 D colored organizational chart style") | +| **msodgmstOrgChart9** | 0x00000008 | Gradient | ![Gradient colored organizational chart style](media/image70.bin "Gradient colored organizational chart style") | +| **msodgmstOrgChart10** | 0x00000009 | Brackets | ![Brackets organizational chart style. Chart shapes are made out of brackets](media/image71.bin "Brackets organizational chart style") | +| **msodgmstOrgChart11** | 0x0000000A | Braces | ![Braces organizational chart style. Chart shapes are made out of braces](media/image72.bin "Braces organizational chart style") | +| **msodgmstOrgChart12** | 0x0000000B | Bookend fills | ![Bookend fills organizational chart style. Dark lines on each end with color filled in between](media/image73.bin "Bookend fills organizational chart style") | +| **msodgmstOrgChart13** | 0x0000000C | Stripes | ![Stripes organizational chart style. Stripes on left side of shapes](media/image74.bin "Stripes organizational chart style") | +| **msodgmstOrgChart14** | 0x0000000D | Beveled | ![Beveled organizational chart style Beveled edges on shapes](media/image75.bin "Beveled organizational chart style") | +| **msodgmstOrgChart15** | 0x0000000E | Beveled gradient | ![Beveled gradient organizational chart style](media/image76.bin "Beveled gradient organizational chart style") | +| **msodgmstOrgChart16** | 0x0000000F | Square shadows | ![Square shadows organizational chart style. Drop shadows behind shapes](media/image77.bin "Square shadows organizational chart style") | +| **msodgmstOrgChart17** | 0x00000010 | Wire frame | ![Wire frame organizational chart style](media/image78.bin "Wire frame organizational chart style") | + +If the value of the **dgmt** property equals **msodgmtRadial**, **dgmStyle** MUST be a value from the enumeration that is listed in the following table. + +| Name | Value | Meaning | Style | +|----|----|----|----| +| **msodgmstRadialFirst** | 0x00000000 | Default | ![Default radial style](media/image79.bin "Default radial style") | +| **msodgmstRadial2** | 0x00000001 | Outline | ![Outline radial style. Shapes are not filled](media/image80.bin "Outline radial style") | +| **msodgmstRadial3** | 0x00000002 | Double outline | ![Double outline radial style. Shapes have two outlines](media/image81.bin "Double outline radial style") | +| **msodgmstRadial4** | 0x00000003 | Thick outline | ![Thick outline radial style](media/image82.bin "Thick outline radial style") | +| **msodgmstRadial5** | 0x00000004 | Primary colors | ![Primary colors radial style](media/image83.bin "Primary colors radial style") | +| **msodgmstRadial6** | 0x00000005 | Shaded | ![Shaded radial style](media/image84.bin "Shaded radial style") | +| **msodgmstRadial7** | 0x00000006 | Fire | ![Fire radial style Colors shift from yellow to gold to orange to red across radial](media/image85.bin "Fire radial style") | +| **msodgmstRadial8** | 0x00000007 | 3-D color | ![3 D radial style](media/image86.bin "3 D radial style") | +| **msodgmstRadial9** | 0x00000008 | Gradient | ![Gradient radial style](media/image87.bin "Gradient radial style") | +| **msodgmstRadial10** | 0x00000009 | Square shadows | ![Square shadow radial style. Shapes are square with drop shadows](media/image88.bin "Square shadow radial style") | + +If the value of the **dgmt** property equals **msodgmtCycle**, **dgmStyle** MUST be a value from the enumeration that is listed in the following table. + +| Name | Value | Meaning | Style | +|----|----|----|----| +| **msodgmstCycle11** | 0x0000000A | Default | ![Default cycle style. Colored arrows forming a clockwise circle](media/image89.bin "Default cycle style") | +| **msodgmstCycle12** | 0x0000000B | Outline | ![Outline cycle stye. Colored arrows with no fill forming a clockwise circle](media/image90.bin "Outline cycle style") | +| **msodgmstCycle13** | 0x0000000C | Double outline | ![Double outline cycle stye. Double outline on arrows forming a clockwise circle](media/image91.bin "Double outline cycle stye.") | +| **msodgmstCycle14** | 0x0000000D | Thick outline | ![Thick outline cycle stye. Thick outline on arrows forming a clockwise circle](media/image92.bin "Thick outline cycle stye.") | +| **msodgmstCycle15** | 0x0000000E | Primary colors | ![Primary colors cycle stye. Primary colored arrows forming a clockwise circle](media/image93.bin "Primary colors cycle stye. ") | +| **msodgmstCycle16** | 0x0000000F | Shaded | ![Shaded cycle stye. Shaded arrows forming a clockwise circle](media/image94.bin "Shaded cycle stye.") | +| **msodgmstCycle17** | 0x00000010 | Fire | ![Fire cycle stye. Colored arrows forming a clockwise circle. Yellow blends into orange blends into red](media/image95.bin "Fire cycle stye.") | +| **msodgmstCycle18** | 0x00000011 | 3-D color | ![3 D color cycle stye. 3 D arrows forming a clockwise circle](media/image96.bin "3 D color cycle stye.") | +| **msodgmstCycle19** | 0x00000012 | Gradient | ![Gradient cycle stye. Gradient filled arrows forming a clockwise circle](media/image97.bin "Gradient cycle stye.") | +| **msodgmstCycle20** | 0x00000013 | Square shadows | ![Square shadows cycle stye.Arrows forming a clockwise circle. Between each arrow is a square with a drop shadow](media/image98.bin "Square shadows cycle stye. ") | + +If the value of the **dgmt** property equals **msodgmtStacked**, **dgmStyle** MUST be a value from the enumeration that is listed in the following table. + +| Name | Value | Meaning | Style | +|----|----|----|----| +| **msodgmstStackedFirst** | 0x00000000 | Default | ![Default stacked style. Triangle pointing up, divided horizontally into 5 stacks](media/image99.bin "Default stacked style") | +| **msodgmstStacked2** | 0x00000001 | Outline | ![Outline stacked style. Triangle with no fill pointing up, divided horizontally into 5 stacks](media/image100.bin "Outline stacked style. ") | +| **msodgmstStacked3** | 0x00000002 | Double outline | ![Double outline stacked style. Triangle with double outlines pointing up, divided horizontally into 5 stacks](media/image101.bin "Double outline stacked style. ") | +| **msodgmstStacked4** | 0x00000003 | Thick outline | ![Thick outline stacked style. Triangle with thick outline pointing up, divided horizontally into 5 stacks](media/image102.bin "Thick outline stacked style.") | +| **msodgmstStacked5** | 0x00000004 | Primary colors | ![Primary colore stacked style. Primary colored triangle pointing up, divided horizontally into 5 stacks](media/image103.bin "Primary colore stacked style") | +| **msodgmstStacked6** | 0x00000005 | Shaded | ![Shaded stacked style. Shaded triangle pointing up, divided horizontally into 5 stacks](media/image104.bin "Shaded stacked style") | +| **msodgmstStacked7** | 0x00000006 | Fire | ![Fire stacked style. Fire colored triangle pointing up, divided horizontally into 5 stacks. Yellow blends into orange blends into red](media/image105.bin "Fire stacked style. ") | +| **msodgmstStacked8** | 0x00000007 | 3-D color | ![3 D color stacked style. 3 D colored triangle pointing up, divided horizontally into 5 stacks](media/image106.bin "3 D color stacked style.") | +| **msodgmstStacked9** | 0x00000008 | Gradient | ![Gradient stacked style. Gradient colored triangle pointing up, divided horizontally into 5 stacks](media/image107.bin "Gradient stacked style") | +| **msodgmstStacked10** | 0x00000009 | Square shadows | ![Square shadowst stacked style. Triangle with drop shadow pointing up, divided horizontally into 5 stacks](media/image108.bin "Square shadowst stacked style") | + +If the value of the **dgmt** property equals **msodgmtVenn**, **dgmStyle** MUST be a value from the enumeration that is listed in the following table. + +| Name | Value | Meaning | Style | +|----|----|----|----| +| **msodgmstVennFirst** | 0x00000000 | Default | ![Default venn diagram style](media/image109.bin "Default venn diagram style") | +| **msodgmstVenn2** | 0x00000001 | Outline | ![Outline venn diagram style. Shapes outlined](media/image110.bin "Outline venn diagram style") | +| **msodgmstVenn3** | 0x00000002 | Double outline | ![Double outline venn diagram style. Shapes with double outlines](media/image111.bin "Double outline venn diagram style") | +| **msodgmstVenn4** | 0x00000003 | Thick outline | ![Thick outline venn diagram style. Shapes with thick outlines](media/image112.bin "Thick outline venn diagram style") | +| **msodgmstVenn5** | 0x00000004 | Primary colors | ![Primary colors venn diagram style](media/image113.bin "Primary colors venn diagram style") | +| **msodgmstVenn6** | 0x00000005 | Shaded | ![Shaded venn diagram style](media/image114.bin "Shaded venn diagram style") | +| **msodgmstVenn7** | 0x00000006 | Fire | ![Fire venn diagram style. Shapes colored yellow blending to orange blending to red.](media/image115.bin "Fire venn diagram style") | +| **msodgmstVenn8** | 0x00000007 | 3-D color | ![3 D venn diagram style.](media/image116.bin "3 D venn diagram style.") | +| **msodgmstVenn9** | 0x00000008 | Gradient | ![Gradient venn diagram style.](media/image117.bin "Gradient venn diagram style.") | +| **msodgmstVenn10** | 0x00000009 | Square shadows | ![Square shadows venn diagram style. Venn diagram surrounded by 5 rectangles with drop shadows](media/image118.bin "Square shadows venn diagram style.") | + +If the value of the **dgmt** property equals **msodgmtBullsEye**, **dgmStyle** MUST be a value from the enumeration that is listed in the following table. + +| Name | Value | Meaning | Style | +|----|----|----|----| +| **msodgmstBullsEyeFirst** | 0x00000000 | Default | ![Default Bulls Eye style. Dart board shape with callouts pointing to each ring](media/image119.bin "Default Bulls Eye style") | +| **msodgmstBullsEye2** | 0x00000001 | Outline | ![Outline Bulls Eye style. Dart board shape with no fill with callouts pointing to each ring](media/image120.bin "Outline Bulls Eye style.") | +| **msodgmstBullsEye3** | 0x00000002 | Double outline | ![Double outline Bulls Eye style. Dart board shape with double outline with callouts pointing to each ring](media/image121.bin "Double outline Bulls Eye style.") | +| **msodgmstBullsEye4** | 0x00000003 | Thick outline | ![Thick outline Bulls Eye style. Dart board shape with thick outline with callouts pointing to each ring](media/image122.bin "Thick outline Bulls Eye style.") | +| **msodgmstBullsEye5** | 0x00000004 | Primary colors | ![Primary colors Bulls Eye style. Primary colored Dart board shape with callouts pointing to each ring](media/image123.bin "Primary colors Bulls Eye style. ") | +| **msodgmstBullsEye6** | 0x00000005 | Shaded | ![Shaded Bulls Eye style. Primary colored Dart board shape with callouts pointing to each ring](media/image124.bin "Shaded Bulls Eye style") | +| **msodgmstBullsEye7** | 0x00000006 | Fire | ![Fire Bulls Eye style. Fire colored Dart board shape with callouts pointing to each ring. Yellow blending to orange blending to red](media/image125.bin "Fire Bulls Eye style.") | +| **msodgmstBullsEye8** | 0x00000007 | 3-D color | ![3 D color Bulls Eye style. 3 D Dart board shape with callouts pointing to each ring.](media/image126.bin "3 D color Bulls Eye style. ") | +| **msodgmstBullsEye9** | 0x00000008 | Gradient | ![Gradient color Bulls Eye style. Dart board shape with gradient with callouts pointing to each ring.](media/image127.bin "Gradient color Bulls Eye style.") | +| **msodgmstBullsEye10** | 0x00000009 | Square shadows | ![Square shadows Bulls Eye style. Dart board shape with callouts pointing to each ring. Callouts connected to rectangles with drop shadows](media/image128.bin "Square shadows Bulls Eye style. ") | + +#### pRelationTbl + +The **pRelationTbl** property specifies relationships in a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0504. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pRelationTbl_complex** property, as defined in section [2.3.17.4](#prelationtbl_complex), exists. If the value equals 0x1, **pRelationTbl_complex** MUST exist. | + +**pRelationTbl (4 bytes):** The number of bytes of data in the **pRelationTbl_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### pRelationTbl_complex + +The **pRelationTbl_complex** property specifies additional data for the **pRelationTbl** property, as defined in section [2.3.17.3](#prelationtbl). If the **opid.fComplex** bit of **pRelationTbl** equals 0x1, this property MUST exist. + +[TABLE] + +**pRelationTbl_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), that specifies relationships in a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). Each array element describes a connection between two [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). Each element is 12 bytes and consists of three values of type **ULONG**. Each of these values is a CRC32 Hash of the respective shape name[\<47\>](#Appendix_A_47). + +The three **ULONG** values specify the source shape, the destination shape, and the [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape, in that order. Each array element specifies a connection from the source to the destination via the connector. + +#### dgmScaleX + +The **dgmScaleX** property specifies the amount to scale along the x-axis. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0505. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmScaleX (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to scale along the x-axis. The default value for this property is 0x00010000. + +#### dgmScaleY + +The **dgmScaleY** property specifies the amount to scale along the y-axis. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0506. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmScaleY (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to scale along the y-axis. The default value for this property is 0x00010000. + +#### dgmDefaultFontSize + +The **dgmDefaultFontSize** property specifies the default font size for new text in the [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0507. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmDefaultFontSize (4 bytes):** A signed integer that specifies the default font size, in [**points**](#gt_d072e4da-7898-4227-8f25-9fe77db43571), for new text in the diagram. A value of 0xFFFFFFFF MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### dgmConstrainBounds + +The **dgmConstrainBounds** property specifies the bounds of the [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0508. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **dgmConstrainBounds_complex** property, as defined in section [2.3.17.9](#dgmconstrainbounds_complex), exists. If the value equals 0x1, **dgmConstrainBounds_complex** MUST exist. | + +**dgmConstrainBounds (4 bytes):** The number of bytes of data in the **dgmConstrainBounds_complex** property, as defined in section 2.3.17.9. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### dgmConstrainBounds_complex + +The **dgmConstrainBounds_complex** property specifies additional data for the **dgmConstrainBounds** property, as defined in section [2.3.17.8](#dgmconstrainbounds). If the **opid.fComplex** bit of **dgmConstrainBounds** equals 0x1, this property MUST exist. + +[TABLE] + +**dgmConstrainBounds_complex (variable):** An **IMsoArray** record, as defined in section [2.2.51](#imsoarray), that specifies the bounds of the [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). Each element in this array is a 32-bit signed integer. The value of **dgmConstrainBounds**\_**complex.nElems** MUST equal 0x0004. The four elements of this array specify, in order, the left, top, right, and bottom bound, in application-defined coordinates, of the diagram. + +#### dgmBaseTextScale + +The **dgmBaseTextScale** property specifies the amount to scale text. This property MAY[\<48\>](#Appendix_A_48) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0509. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dgmBaseTextScale (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the amount to scale text. The default value for this property is 0x00010000. + +#### Diagram Boolean Properties + +The **Diagram Boolean Properties** specify a 32-bit field of Boolean properties for a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x053F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (10 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**C - fUsefDoFormat (1 bit):** A bit that specifies whether the **fDoFormat** bit is set. A value of 0x0 specifies that the **fDoFormat** bit MUST be ignored. The default value for this property is 0x0. + +**D - fUsefReverse (1 bit):** A bit that specifies whether the **fReverse** bit is set. A value of 0x0 specifies that the **fReverse** bit MUST be ignored. The default value for this property is 0x0. + +**E - fUsefDoLayout (1 bit):** A bit that specifies whether the **fDoLayout** bit is set. A value of 0x0 specifies that the **fDoLayout** bit MUST be ignored. The default value for this property is 0x0. + +**F - fUsefPseudoInline (1 bit):** A bit that specifies whether the **fPseudoInline** bit is set. A value of 0x0 specifies that the **fPseudoInline** bit MUST be ignored. The default value for this property is 0x0. + +**unused4 (10 bits):** A value that is undefined and MUST be ignored. + +**G - unused5 (1 bit):** A value that is undefined and MUST be ignored. + +**H - unused6 (1 bit):** A value that is undefined and MUST be ignored. + +**I - fDoFormat (1 bit):** A bit that specifies whether the **dgmStyle** property, as defined in section [2.3.17.2](#dgmstyle), specifies a nondefault formatting style for the diagram type. This value MUST be ignored if **fUsefDoFormat** is 0x0. The default value for this property is 0x0. + +**J - fReverse (1 bit):** A bit that specifies whether the diagram is horizontally mirrored. This value MUST be ignored if **fUsefReverse** is 0x0. The default value for this property is 0x0. + +**K - fDoLayout (1 bit):** A bit that specifies whether the diagram has a layout that is not directly editable. This value MUST be ignored if **fUsefDoLayout** is 0x0. The default value for this property is 0x1. + +**L - fPseudoInline (1 bit):** A bit that specifies whether the diagram is placed inline with surrounding text. This value MUST be ignored if **fUsefPseudoInline** is 0x0. The default value for this property is 0x0. + +### Transform + +The **Transform** property set specifies the values that are necessary to construct a transform that is applied to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) prior to rendering. + +#### left + +The **left** property specifies the left side of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0000. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**left (4 bytes):** A signed integer that specifies the left side, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000000. + +#### top + +The **top** property specifies the top of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0001. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**top (4 bytes):** A signed integer that specifies the top, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000000. + +#### right + +The **right** property specifies the right side of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0002. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**right (4 bytes):** A signed integer that specifies the right side, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000001. + +#### bottom + +The **bottom** property specifies the bottom of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0003. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**bottom (4 bytes):** A signed integer value that specifies the bottom, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000001. + +#### rotation + +The **rotation** property specifies the rotation on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0004. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**rotation (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the rotation, in degrees, that is applied to a shape. Positive values specify rotation in the clockwise direction. Negative values specify rotation in the counterclockwise direction. Rotation occurs around the center of the shape. The default value for this property is 0x00000000. + +#### gvPage + +The **gvPage** property specifies the page on which an object is located. This property SHOULD[\<49\>](#Appendix_A_49) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0005. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**gvPage (4 bytes):** An unsigned integer that specifies the page on which an object is located. The default value for this property is 0x00000000. + +#### Transform Boolean Properties + +The **Transform Boolean Properties** specify a 32-bit field of Boolean properties for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) transform. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x003F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (13 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - fUsefFlipV (1 bit):** A bit that specifies whether the **fFlipV** bit is set. A value of 0x0 specifies that the **fFlipV** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**C - fUsefFlipH (1 bit):** A bit that specifies whether the **fFlipH** bit is set. A value of 0x0 specifies that the **fFlipH** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**unused3 (13 bits):** A value that is undefined and MUST be ignored. + +**D - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**E - fFlipV (1 bit):** A bit that specifies whether the object will be flipped along the vertical axis. This value MUST be ignored if **fUsefFlipV** is 0x0. The default value of this property is 0x0. + +**F - fFlipH (1 bit):** A bit that specifies whether the object will be flipped along the horizontal axis. This value MUST be ignored if **fUsefFlipH** is 0x0. The default value of this property is 0x0. + +### Relative Transform + +The **Relative Transform** property set specifies the values that are necessary to construct a transform, relative to another [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), that is applied to a shape prior to rendering. + +#### relLeft + +The **relLeft** property specifies the left side of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. The bounding rectangle specifies the location of the object, relative to a parent object or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03C0. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**relLeft (4 bytes):** A signed integer that specifies the left side, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000000. + +#### relTop + +The **relTop** property specifies the top of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. The bounding rectangle specifies the location of the object, relative to a parent object or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03C1. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**relTop (4 bytes):** A signed integer that specifies the top, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000000. + +#### relRight + +The **relRight** property specifies the right side of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. The bounding rectangle specifies the location of the object, relative to a parent object or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03C2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**relRight (4 bytes):** A signed integer that specifies the right side, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000001. + +#### relBottom + +The **relBottom** property specifies the bottom of the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) that contains an object. The bounding rectangle specifies the location of the object, relative to a parent object or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03C3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**relBottom (4 bytes):** A signed integer that specifies the bottom, in application-defined coordinates, of the bounding rectangle. The default value for this property is 0x00000001. + +#### relRotation + +The **relRotation** property specifies the rotation on a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), relative to the parent object or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03C4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**relRotation (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the rotation, in degrees, that is applied to a shape, relative to the parent object or group. Positive values specify rotation in the clockwise direction. Negative values specify rotation in the counterclockwise direction. Rotation occurs around the center of the shape. The default value for this property is 0x00000000. + +#### gvRelPage + +The **gvRelPage** property specifies the page on which an object is located, relative to a parent object or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). This property SHOULD[\<50\>](#Appendix_A_50) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03C5. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**gvRelPage (4 bytes):** An unsigned integer that specifies the page on which an object is located, relative to a parent object or group. The default value for this property is 0x00000000. + +#### Relative Transform Boolean Properties + +The **Relative Transform Boolean Properties** specify a 32-bit field of Boolean properties for the relative transform of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x03FF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (13 bits):** A value that is undefined and MUST be ignored. + +**A - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**B - fUsefRelFlipV (1 bit):** A bit that specifies whether the **fRelFlipV** bit is set. A value of 0x0 specifies that the **fRelFlipV** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefRelFlipH (1 bit):** A bit that specifies whether the **fRelFlipH** bit is set. A value of 0x0 specifies that the **fRelFlipH** bit MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused3 (13 bits):** A value that is undefined and MUST be ignored. + +**D - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +**E - fRelFlipV (1 bit):** A bit that specifies whether the object will be flipped along the vertical axis, relative to its parent or [**group**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac). This value MUST be ignored if **fUsefRelFlipV** is 0x0. The default value for this property is 0x0. + +**F - fRelFlipH (1 bit):** A bit that specifies whether the object will be flipped along the horizontal axis, relative to its parent or group. This value MUST be ignored if **fUsefRelFlipH** is 0x0. The default value for this property is 0x0. + +### Protection + +The **Protection** property set specifies the protection attributes that apply to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### Protection Boolean Properties + +The **Protection Boolean Properties** specify a 32-bit field of Boolean properties for the protection of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x007F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (6 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefLockAgainstUngrouping (1 bit):** A bit that specifies whether the **fLockAgainstUngrouping** bit is set. A value of 0x0 specifies that the **fLockAgainstUngrouping** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**B - fUsefLockRotation (1 bit):** A bit that specifies whether the **fLockRotation** bit is set. A value of 0x0 specifies that the **fLockRotation** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**C - fUsefLockAspectRatio (1 bit):** A bit that specifies whether the **fLockAspectRatio** bit is set. A value of 0x0 specifies that the **fLockAspectRatio** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**D - fUsefLockPosition (1 bit):** A bit that specifies whether the **fLockPosition** bit is set. A value of 0x0 specifies that the **fLockPosition** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**E - fUsefLockAgainstSelect (1 bit):** A bit that specifies whether the **fLockAgainstSelect** bit is set. A value of 0x0 specifies that the **fLockAgainstSelect** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**F - fUsefLockCropping (1 bit):** A bit that specifies whether the **fLockCropping** bit is set. A value of 0x0 specifies that the **fLockCropping** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**G - fUsefLockVertices (1 bit):** A bit that specifies whether the **fLockVertices** bit is set. A value of 0x0 specifies that the **fLockVertices** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**H - fUsefLockText (1 bit):** A bit that specifies whether the **fLockText** bit is set. A value of 0x0 specifies that the **fLockText** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**I - fUsefLockAdjustHandles (1 bit):** A bit that specifies whether the **fLockAdjustHandles** bit is set. A value of 0x0 specifies that the **fLockAdjustHandles** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**J - fUsefLockAgainstGrouping (1 bit):** A bit that specifies whether the **fLockAgainstGrouping** bit is set. A value of 0x0 specifies that the **fLockAgainstGrouping** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**unused2 (6 bits):** A value that is undefined and MUST be ignored. + +**K - fLockAgainstUngrouping (1 bit):** A bit that specifies whether a grouped shape is be locked from being ungrouped. This bit MAY[\<51\>](#Appendix_A_51) be ignored. This value MUST be ignored if **fUsefLockAgainstUngrouping** is 0x0. The default value of this property is 0x0. + +**L - fLockRotation (1 bit):** A bit that specifies whether the rotation of a shape is be locked from being edited. This value MUST be ignored if **fUsefLockRotation** is 0x0. The default value of this property is 0x0. + +**M - fLockAspectRatio (1 bit):** A bit that specifies whether the aspect ratio of a shape is be locked from being edited. This value MUST be ignored if **fUsefLockAspectRatio** is 0x0. The default value of this property is 0x0. + +**N - fLockPosition (1 bit):** A bit that specifies whether the position of a shape is be locked from being edited. This value MUST be ignored if **fUsefLockPosition** is 0x0. The default value of this property is 0x0. + +**O - fLockAgainstSelect (1 bit):** A bit that specifies whether the shape is be locked from being selectable in an editor application. This value MUST be ignored if **fUsefLockAgainstSelect** is 0x0. The default value of this property is 0x0. + +**P - fLockCropping (1 bit):** A bit that specifies whether the cropping of a picture is be locked from being edited. This value MUST be ignored if **fUsefLockCropping** is 0x0. The default value of this property is 0x0. + +**Q - fLockVertices (1 bit):** A bit that specifies whether the vertices of a path is be locked from being edited. This value MUST be ignored if **fUsefLockVertices** is 0x0. The default value of this property is 0x0. + +**R - fLockText (1 bit):** A bit that specifies whether the text that is attached to a shape is be locked from being edited. This value MUST be ignored if **fUsefLockText** is 0x0. The default value of this property is 0x0. + +**S - fLockAdjustHandles (1 bit):** A bit that specifies whether the [**adjust handles**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b) of a shape, as specified by the **pAdjustHandles_complex** property, as defined in section [2.3.6.25](#padjusthandles_complex), is locked from being edited. This value MUST be ignored if **fUsefLockAdjustHandles** is 0x0. The default value of this property is 0x0. + +**T - fLockAgainstGrouping (1 bit):** A bit that specifies whether the shape is locked from being grouped with other shapes. This value MUST be ignored if **fUsefLockAgainstGrouping** is 0x0. The default value of this property is 0x0. + +### Text + +The **Text** property set specifies properties for text that is contained by [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### lTxid + +The **lTxid** property specifies an identifier for the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0080. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**lTxid (4 bytes):** A signed integer that specifies an identifier for the text. This value is determined by the host application. The default value for this property is 0x00000000. + +#### dxTextLeft + +The **dxTextLeft** property specifies the size of the margin to the left of the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|-------------------|------------------------------| +| **opid.opid** | A value that MUST be 0x0081. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxTextLeft (4 bytes):** A signed integer that specifies the size, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the margin inside the containing [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) to the left of the text. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00016530. + +#### dyTextTop + +The **dyTextTop** property specifies the size of the margin above the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|-------------------|------------------------------| +| **opid.opid** | A value that MUST be 0x0082. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dyTextTop (4 bytes):** A signed integer that specifies the size, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the margin inside the containing [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) above the text. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x0000B298. + +#### dxTextRight + +The **dxTextRight** property specifies the size of the margin to the right of the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|-------------------|------------------------------| +| **opid.opid** | A value that MUST be 0x0083. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dxTextRight (4 bytes):** A signed integer that specifies the size, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the margin inside the containing [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) to the right of the text. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x00016530. + +#### dyTextBottom + +The **dyTextBottom** property specifies the size of the margin below the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|-------------------|------------------------------| +| **opid.opid** | A value that MUST be 0x0084. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**dyTextBottom (4 bytes):** A signed integer that specifies the size, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the margin inside the containing [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) below the text. This value MUST be from 0x00000000 through 0x0132F540, inclusive. The default value for this property is 0x0000B298. + +#### WrapText + +The **WrapText** property specifies the type of wrapping that is applied to the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0085. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**WrapText (4 bytes):** An **MSOWRAPMODE** enumeration value, as defined in section [2.4.3](#msowrapmode), specifying the type of wrapping that is applied to the text. The default value for this property is **msowrapSquare**. + +#### unused134 + +The **unused134** property is undefined and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0086. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused134 (4 bytes):** A value that is undefined and MUST be ignored. + +#### anchorText + +The **anchorText** property specifies the type of [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997) that is applied to the text. This value MAY[\<52\>](#Appendix_A_52) be used. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0087. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**anchorText (4 bytes):** An **MSOANCHOR** enumeration value, as defined in section [2.4.4](#msoanchor), specifying the type of anchor that is applied to the text. The default value for this property is **msoanchorTop**. + +#### txflTextFlow + +The **txflTextFlow** property specifies the type of flow that is applied to the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0088. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**txflTextFlow (4 bytes):** An **MSOTXFL** enumeration value, as defined in section [2.4.5](#msotxfl), specifying the type of flow that is applied to the text. The default value for this property is **msotxflHorzN**. + +#### cdirFont + +The **cdirFont** property specifies the rotation that is applied to the text. This property MAY[\<53\>](#Appendix_A_53) be used. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0089. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cdirFont (4 bytes):** An **MSOCDIR** enumeration value, as defined in section [2.4.6](#msocdir), specifying the rotation that is applied to the text. The default value for this property is msocdir0. + +#### hspNext + +The **hspNext** property specifies the next [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in a sequence of linked shapes. This property MAY[\<54\>](#Appendix_A_54) be used. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x008A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**hspNext (4 bytes):** A value of type **MSOSPID**, as defined in section [2.1.2](#msospid), that specifies the next shape in a sequence of linked shapes. The default value for this property is 0x00000000. + +#### txdir + +The **txdir** property specifies the direction of the text. This property MAY[\<55\>](#Appendix_A_55) be used. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x008B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**txdir (4 bytes):** An **MSOTXDIR** enumeration value, as defined in section [2.4.7](#msotxdir), that specifies the direction of the text. The default value for this property is **msotxdirLTR**. + +#### unused140 + +The **unused140** property is undefined and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x008C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused140 (4 bytes):** A value that is undefined and MUST be ignored. + +#### unused141 + +The **unused141** property is undefined and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x008D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused141 (4 bytes):** A value that is undefined and MUST be ignored. + +#### Text Boolean Properties + +The **Text Boolean Properties** specify a 32-bit field of Boolean properties for the text that is contained by a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x00BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (11 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefSelectText (1 bit):** A bit that specifies whether the **fSelectText** bit is set. A value of 0x0 specifies that the **fSelectText** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**B - fUsefAutoTextMargin (1 bit):** A bit that specifies whether the **fAutoTextMargin** bit is set. A value of 0x0 specifies that the **fAutoTextMargin** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**C - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**D - fUsefFitShapeToText (1 bit):** A bit that specifies whether the **fFitShapeToText** bit is set. A value of 0x0 specifies that the **fFitShapeToText** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**E - unused3 (1 bit):** A value that is undefined and MUST be ignored. + +**unused4 (11 bits):** A value that is undefined and MUST be ignored. + +**F - fSelectText (1 bit):** A bit that specifies whether the containing shape SHOULD[\<56\>](#Appendix_A_56) enter a text editing mode when the user clicks the contained text area. A value of 0x0 specifies that a single click selects the shape and that a second click will enter a text editing mode. This value MUST be ignored if **fUsefSelectText** is 0x0. The default value of this property is 0x1. + +**G - fAutoTextMargin (1 bit):** A bit that specifies whether the containing shape SHOULD[\<57\>](#Appendix_A_57) use a set of default internal margins for text on shapes. A value of 0x0 specifies that the internal margins of the containing shape will assume the values that are specified by the [dxTextLeft](#dxtextleft), [dyTextTop](#dytexttop), [dxTextRight](#dxtextright), and [dyTextBottom](#dytextbottom) properties in the containing **OfficeArtRGFOPTE** record, as defined in section [2.3.1](#officeartrgfopte), using the default for any of these values that are not specified. This value MUST be ignored if **fUsefAutoTextMargin** is 0x0. The default value of this property is 0x0. + +**H - unused5 (1 bit):** A value that is undefined and MUST be ignored. + +**I - fFitShapeToText (1 bit):** A bit that specifies whether the containing shape SHOULD[\<58\>](#Appendix_A_58) adjust its dimensions to fit its contained text. This value MUST be ignored if **fUsefFitShapeToText** is 0x0. The default value of this property is 0x0. + +**J - unused6 (1 bit):** A value that is undefined and MUST be ignored. + +### Geometry Text + +The **Geometry Text** property set specifies text that is drawn to follow the geometry of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) containing it, as opposed to text box text, which uses the geometry of the shape as a [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1). A shape SHOULD NOT have both [**geometry text**](#gt_1ecc89aa-00da-4cdc-bd9e-ea15ac60267b) and text for a text box. + +#### gtextUNICODE + +The **gtextUNICODE** property specifies the text for this shape’s [**geometry text**](#gt_1ecc89aa-00da-4cdc-bd9e-ea15ac60267b). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x00C0. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **gtextUNICODE_complex** property, as defined in section [2.3.22.2](#gtextunicode_complex), exists. If the value equals 0x1, **gtextUNICODE_complex** MUST exist. | + +**gtextUNICODE (4 bytes):** The number of bytes of data in the **gtextUNICODE_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### gtextUNICODE_complex + +The **gtextUNICODE_complex** property specifies additional data for the **gtextUNICODE** property, as defined in section [2.3.22.1](#gtextunicode). If the **opid.fComplex** bit of **gtextUNICODE** equals 0x1, this property MUST exist. + +[TABLE] + +**gtextUNICODE_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the text to show. + +#### gtextAlign + +The **gtextAlign** property specifies how [**geometry text**](#gt_1ecc89aa-00da-4cdc-bd9e-ea15ac60267b) is aligned on this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x00C2. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**gtextAlign (4 bytes):** An unsigned integer that specifies how geometry text is aligned on this shape. The alignment is applicable only if space remains after laying out a line of text along the geometry of the shape. The curve on which a single line of text is laid out is known as the path of that text. The allowed values are shown in the following table. The default value for this property is **msoalignTextCenter**. + +[TABLE] + +#### gtextSize + +The **gtextSize** property specifies the font size, in points, of the [**geometry text**](#gt_1ecc89aa-00da-4cdc-bd9e-ea15ac60267b) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x00C3. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**gtextSize (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the font size, in points, of the geometry text for this shape. This value MUST be greater than or equal to 0x00000000. The default value for this property is 0x00240000. + +#### gtextSpacing + +The **gtextSpacing** property specifies the amount of spacing between characters in the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x00C4. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**gtextSpacing (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies a scaling factor to apply to the spacing between characters in the [**geometry text**](#gt_1ecc89aa-00da-4cdc-bd9e-ea15ac60267b) for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The quantity to which the scaling factor is applied is specified by the **gtextFTight** bit of the [Geometry Text Boolean Properties](#geometry-text-boolean-properties) for this shape. This value MUST be greater than or equal to 0x00000000 and less than or equal to 0x00050000. A value of 0x00010000 means that no scaling is necessary. The default value for this property is 0x00010000. + +#### gtextFont + +The **gtextFont** property specifies the font to use for the text. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x00C5. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **gtextFont_complex** property, as defined in section [2.3.22.7](#gtextfont_complex), exists. If the value equals 0x1, **gtextFont_complex** MUST exist. | + +**gtextFont (4 bytes):** The number of bytes of data in the **gtextFont_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is an empty string. + +#### gtextFont_complex + +The **gtextFont_complex** property specifies additional data for the **gtextFont** property, as defined in section [2.3.22.6](#gtextfont). If the **opid.fComplex** bit of **gtextFont** equals 0x1, this property MUST exist. + +[TABLE] + +**gtextFont_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the font name to use for this text. + +#### gtextCSSFont + +The **gtextCSSFont** property specifies extra font information, beyond the single font in the **gtextFont_complex** property, as defined in section [2.3.22.7](#gtextfont_complex). This property SHOULD[\<62\>](#Appendix_A_62) be used so that on conversion to and from [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf), the correct font information will be preserved. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x00C6. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **gtextCSSFont_complex** property, as defined in section [2.3.22.9](#gtextcssfont_complex), exists. If the value equals 0x1, **gtextCSSFont_complex** MUST exist. | + +**gtextCSSFont (4 bytes):** The number of bytes of data in the **gtextCSSFont_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### gtextCSSFont_complex + +The **gtextCSSFont_complex** property specifies additional data for the **gtextCSSFont** property, as defined in section [2.3.22.8](#gtextcssfont). If the **opid.fComplex** bit of **gtextCSSFont** equals 0x1, this property MUST exist. + +[TABLE] + +**gtextCSSFont_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies extra font information, beyond the font that is stored in the **gTextFont_complex** property, as defined in section [2.3.22.7](#gtextfont_complex), for this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The string contains a comma-delimited list of font-family names and generic font-family names, according to the **font** or **font-family** property as specified in [\[CSS-LEVEL2\]](https://go.microsoft.com/fwlink/?LinkId=114090), minus the first value in that string. The first value is stored instead in the **gtextFont_complex** property. The font names are enclosed by double quotation marks. + +#### Geometry Text Boolean Properties + +The **Geometry Text Boolean Properties** specify a 32-bit field of Boolean values for text that is drawn with visual effects. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x00FF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**A - fUsegtextFReverseRows (1 bit):** A bit that specifies whether the **gtextFReverseRows** bit is set. A value of 0x0 specifies that the **gtextFReverseRows** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**B - fUsefGtext (1 bit):** A bit that specifies whether the **fGtext** bit is set. A value of 0x0 specifies that the **fGtext** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**C - fUsegtextFVertical (1 bit):** A bit that specifies whether the **gtextFVertical** bit is set. A value of 0x0 specifies that the **gtextFVertical** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**D - fUsegtextFKern (1 bit):** A bit that specifies whether the **gtextFKern** bit is set. A value of 0x0 specifies that the **gtextFKern** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**E - fUsegtextFTight (1 bit):** A bit that specifies whether the **gtextFTight** bit is set. A value of 0x0 specifies that the **gtextFTight** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**F - fUsegtextFStretch (1 bit):** A bit that specifies whether the **gtextFStretch** bit is set. A value of 0x0 specifies that the **gtextFStretch** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**G - fUsegtextFShrinkFit (1 bit):** A bit that specifies whether the **gtextFShrinkFit** bit is set. A value of 0x0 specifies that the **gtextFShrinkFit** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**H - fUsegtextFBestFit (1 bit):** A bit that specifies whether the **gtextFBestFit** bit is set. A value of 0x0 specifies that the **gtextFBestFit** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**I - fUsegtextFNormalize (1 bit):** A bit that specifies whether the **gtextFNormalize** bit is set. A value of 0x0 specifies that the **gtextFNormalize** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**J - fUsegtextFDxMeasure (1 bit):** A bit that specifies whether the **gtextFDxMeasure** bit is set. A value of 0x0 specifies that the **gtextFDxMeasure** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**K - fUsegtextFBold (1 bit):** A bit that specifies whether the **gtextFBold** bit is set. A value of 0x0 specifies that the **gtextFBold** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**L - fUsegtextFItalic (1 bit):** A bit that specifies whether the **gtextFItalic** bit is set. A value of 0x0 specifies that the **gtextFItalic** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**M - fUsegtextFUnderline (1 bit):** A bit that specifies whether the **gtextFUnderline** bit is set. A value of 0x0 specifies that the **gtextFUnderline** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**N - fUsegtextFShadow (1 bit):** A bit that specifies whether the **gtextFShadow** bit is set. A value of 0x0 specifies that the **gtextFShadow** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**O - fUsegtextFSmallcaps (1 bit):** A bit that specifies whether the **gtextFSmallcaps** bit is set. A value of 0x0 specifies that the **gtextFSmallcaps** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**P - fUsegtextFStrikethrough (1 bit):** A bit that specifies whether the **gtextFStrikethrough** bit is set. A value of 0x0 specifies that the **gtextFStrikethrough** bit MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**Q - gtextFReverseRows (1 bit):** A bit that specifies whether the order in which lines of [**geometry text**](#gt_1ecc89aa-00da-4cdc-bd9e-ea15ac60267b) are laid out SHOULD[\<63\>](#Appendix_A_63) be reversed. This bit is applicable only if the geometry text is vertically oriented, as specified by **gtextFVertical**; otherwise, it MAY be any value. This value MUST be ignored if **fUsegtextFReverseRows** is 0x0. The default value of this property is 0x0. + +**R - fGtext (1 bit):** A bit that specifies whether this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) has geometry text. If **fGtext** is 0x1, the **gtextUNICODE_complex** property, as defined in section [2.3.22.2](#gtextunicode_complex), MUST exist. This value MUST be ignored if **fUsefGtext** is 0x0. The default value of this property is 0x0. + +**S - gtextFVertical (1 bit):** A bit that specifies whether the characters of the geometry text for this shape are laid out vertically rather than horizontally. This value MUST be ignored if **fUsegtextFVertical** is 0x0. The default value of this property is 0x0. + +**T - gtextFKern (1 bit):** A bit that specifies whether the geometry text of this shape SHOULD[\<64\>](#Appendix_A_64) use kerning. This value MUST be ignored if **fUsegtextFKern** is 0x0. The default value of this property is 0x0. + +**U - gtextFTight (1 bit):** A bit that specifies the quantity that the scaling factor, as specified by the [gtextSpacing](#gtextspacing) property, SHOULD[\<65\>](#Appendix_A_65) be applied to. The following table describes the effect of each value for this bit. This value MUST be ignored if **fUsegtextFTight** is 0x0. The default value of this property is 0x0. + +[TABLE] + +**V - gtextFStretch (1 bit):** A bit that specifies whether the geometry text of this shape SHOULD[\<66\>](#Appendix_A_66) be stretched to fit the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the container. This value MUST be ignored if **fUsegtextFStretch** is 0x0. The default value of this property is 0x0. + +**W - gtextFShrinkFit (1 bit):** A bit that specifies whether the bounding rectangle of the geometry text SHOULD[\<67\>](#Appendix_A_67) be measured according to the bounding rectangle of the characters that are used in the string, rather than according to the bounding rectangle of the characters in the font. The following table shows the effect of this bit on the bounding rectangle of the geometry text. This bit is applicable only if **gtextFStretch** is 0x1 and **fUsegtextFStretch** is 0x1; otherwise, it MAY be any value. This value MUST be ignored if **fUsegtextFShrinkFit** is 0x0. + +[TABLE] + +**X - gtextFBestFit (1 bit):** A bit that specifies whether the geometry text SHOULD[\<68\>](#Appendix_A_68) be stretched to fill the entire line. Stretching occurs in the same direction as the orientation of the geometry text, as specified by **gtextFVertical**. This bit is applicable only if **gtextFStretch** is 0x0 or **fUsegtextFStretch** is 0x0; otherwise, it MAY be any value. This value MUST be ignored if **fUsegtextFBestFit** is 0x0. The default value of this property is 0x0. + +**Y - gtextFNormalize (1 bit):** A bit that specifies whether every character in the geometry text is adjusted to fill the available space for that character. The definition of the available space varies based on the text orientation, as specified by **gtextFVertical**. The following table shows how the text orientation affects the normalization of the text. This value MUST be ignored if **fUsegtextFNormalize** is 0x0. + +| Text orientation | Original text | Normalized text | +|----|----|----| +| Horizontal | ![Original horizontal text](media/image138.bin "Original horizontal text") | ![Normalized horizontal text. Characters are all sized the same](media/image139.bin "Normalized horizontal text") | +| Vertical | ![Original vertical text](media/image140.bin "Original vertical text") | ![Normalized vertical text. Characters are resized to be the same size](media/image141.bin "Normalized vertical text") | + +**Z - gtextFDxMeasure (1 bit):** A bit that specifies whether the distance that is used to calculate the amount to warp text along the geometry of this shape SHOULD[\<69\>](#Appendix_A_69) use only the x component rather a combination of the x and y components. This value MUST be ignored if **fUsegtextFDxMeasure** is 0x0. The default value of this property is 0x0. + +**a - gtextFBold (1 bit):** A bit that specifies whether this geometry text uses bold text. This value MUST be ignored if **fUsegtextFBold** is 0x0. The default value of this property is 0x0. + +**b - gtextFItalic (1 bit):** A bit that specifies whether this geometry text uses italics. This value MUST be ignored if **fUsegtextFItalic** is 0x0. The default value of this property is 0x0. + +**c - gtextFUnderline (1 bit):** A bit that specifies whether this geometry text uses an underline effect on the text characters. This value SHOULD[\<70\>](#Appendix_A_70) be ignored. This value MUST be ignored if **fUsegtextFUnderline** is 0x0. The default value of this property is 0x0. + +**d - gtextFShadow (1 bit):** A bit that specifies whether this geometry text uses a shadow effect on the text characters. This value SHOULD be ignored. This value MUST be ignored if **fUsegtextFShadow** is 0x0. The default value of this property is 0x0. + +**e - gtextFSmallcaps (1 bit):** A bit that specifies whether this geometry text shows every character in uppercase, with the lowercase characters in the text being smaller-sized versions of their uppercase counterparts. This value SHOULD[\<71\>](#Appendix_A_71) be ignored. This value MUST be ignored if **fUsegtextFSmallcaps** is 0x0. The default value of this property is 0x0. + +**f - gtextFStrikethrough (1 bit):** A bit that specifies whether this geometry text has strikethrough formatting. This value SHOULD[\<72\>](#Appendix_A_72) be ignored. This value MUST be ignored if **fUsegtextFStrikethrough** is 0x0. The default value of this property is 0x0. + +### Blip + +The **Blip** property set specifies the visual attributes of a picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### cropFromTop + +The **cropFromTop** property specifies the location of the top of the [**crop**](#gt_d9df8310-82c9-4a68-9f55-07b97eb76067) rectangle. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0100. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cropFromTop (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the location, expressed as a fraction of the image height, of the top of the crop rectangle. A value of 0x00000000 specifies that the top of the image is uncropped. Positive values specify cropping into the image. Negative values specify cropping out from the image. The default value for this property is 0x00000000. + +#### cropFromBottom + +The **cropFromBottom** property specifies the location of the bottom of the crop rectangle. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0101. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cropFromBottom (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the location, expressed as a fraction of the image height, of the bottom of the crop rectangle. A value of 0x00000000 specifies that the bottom of the image is uncropped. Positive values specify cropping into the image. Negative values specify cropping out from the image. The default value for this property is 0x00000000. + +#### cropFromLeft + +The **cropFromLeft** property specifies the location of the left side of the crop rectangle. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0102. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cropFromLeft (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the location, expressed as a fraction of the image width, of the left side of the crop rectangle. A value of 0x00000000 specifies that the left side of the image is uncropped. Positive values specify cropping into the image. Negative values specify cropping out from the image. The default value for this property is 0x00000000. + +#### cropFromRight + +The **cropFromRight** property specifies the location of the right side of the crop rectangle. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0103. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**cropFromRight (4 bytes):** A value of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, that specifies the location of the right side, expressed as a fraction of the image width, of the crop rectangle. A value of 0x00000000 specifies that the right side of the image is uncropped. Positive values specify cropping into the image. Negative values specify cropping out from the image. The default value for this property is 0x00000000. + +#### pib + +The **pib** property specifies which [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) in the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer), to display in the picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0104. | +| **opid.fBid** | A value that MUST be 0x1 if **fComplex** equals 0x0. Otherwise, this value MUST be ignored. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), then the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pib_complex** property, as defined in section [2.3.23.6](#pib_complex), exists. If the value equals 0x1, **pib_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. | + +**pib (4 bytes):** An unsigned integer that specifies the BLIP to display in the picture shape. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of pib field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section 2.2.20. A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **pib_complex** property, as defined in section 2.3.23.6. | + +#### pib_complex + +The **pib_complex** property specifies additional data for the **pib** property, as defined in section [2.3.23.5](#pib). If the **opid.fComplex** bit of the **pib** equals 0x1, this property MUST exist. + +[TABLE] + +**pib_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), that specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) to display in the picture [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### pibName + +The **pibName** property specifies the comment, file name, or [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1), as specified by the **pibFlags** property, as defined in section [2.3.23.9](#pibflags), for this [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0105. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pibName_complex** property, as defined in section [2.3.23.8](#pibname_complex), exists. If the value equals 0x1, **pibName_complex** MUST exist. | + +**pibName (4 bytes):** The number of bytes of data in the **pibName_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### pibName_complex + +The **pibName_complex** property specifies additional data for the **pibName** property, as defined in section [2.3.23.7](#pibname). If the **opid.fComplex** bit of **pibName** equals 0x1, this property MUST exist. + +[TABLE] + +**pibName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the comment, file name, or [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1), as specified by the **pibFlags** property, as defined in section [2.3.23.9](#pibflags), for the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956). + +#### pibFlags + +The **pibFlags** property specifies a set of flags that relate to the usage of the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0106. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pibFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **pibName_complex** property, as defined in section [2.3.23.8](#pibname_complex), and other properties of the BLIP to display. The default value for this property is **msoblipflagComment**. + +#### pictureTransparent + +The **pictureTransparent** property specifies the transparent pixel color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0107. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureTransparent (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the color value that is treated as transparent. The default value for this property is 0xFFFFFFFF. + +#### pictureContrast + +The **pictureContrast** property specifies the contrast modification for the picture. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0108. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureContrast (4 bytes):** A signed integer that specifies the amount with which to modify the contrast of the picture. The minimum value of 0x00000000 specifies that the picture is rendered with no contrast. The maximum value of 0x7FFFFFFF specifies that the picture is rendered with maximum contrast. The default value for this property is 0x00010000 and specifies no change to the contrast of the picture. + +#### pictureBrightness + +The **pictureBrightness** property specifies the brightness modification for the picture. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0109. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureBrightness (4 bytes):** A signed integer that specifies the amount with which to modify the brightness of the picture. The minimum value of 0xFFFF8000 specifies that the picture is rendered with the minimum brightness. The maximum value of 0x00008000 specifies that the picture is rendered with the maximum brightness. The default value for this property is 0x00000000 and specifies no change to the brightness of the picture. + +#### pictureId + +The **pictureId** property specifies the [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) identifier of the picture. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x010B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureId (4 bytes):** A signed integer that specifies the host-defined OLE identifier for the picture. The default value for this property is 0x00000000. + +#### pictureDblCrMod + +The **pictureDblCrMod** property specifies a shadow color for pictures that have a double shadow in black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x010C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureDblCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), specifying the shadow color that is used to modify the picture when a double shadow exists in black-and-white display mode. This value SHOULD be ignored. The default value for this property is 0x100000F4. + +#### pictureFillCrMod + +The **pictureFillCrMod** property specifies the fill color modification that is used in black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x010D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureFillCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), specifying the fill color modification that is used in black-and-white display mode. The default value for this property is 0x20000000. + +#### pictureLineCrMod + +The **pictureLineCrMod** property specifies the line color modification that is used in black-and-white display mode. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x010E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureLineCrMod (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), specifying the line color modification that is used in black-and-white display mode. The default value for this property is 0x20000000. + +#### pibPrint + +The **pibPrint** property specifies which [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) in the **OfficeArtBStoreContainer** record, as defined in section [2.2.20](#officeartbstorecontainer), to print. By default, this property is not set, and the display BLIP that is specified by the **pib**, as defined in section [2.3.23.5](#pib), property or **pib_complex** property, as defined in section [2.3.23.6](#pib_complex), will be printed. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x010F. | +| **opid.fBid** | A value that MUST be 0x1 if **fComplex** equals 0x0. Otherwise, this value MUST be ignored. If this record is contained in an **OfficeArtInlineSpContainer** record, as defined in section [2.2.15](#officeartinlinespcontainer), the value MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pibPrint_complex** property, as defined in section [2.3.23.18](#pibprint_complex), exists. If the value equals 0x1, **pibPrint_complex** MUST exist. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. | + +**pibPrint (4 bytes):** An unsigned integer that specifies the BLIP to print. The value of **opid.fComplex** determines the meaning of this field, as specified in the following table. The default value for this property is 0x00000000. If this record is contained in an **OfficeArtInlineSpContainer** record then the value MUST be ignored. + +| **Value of opid.fComplex** | **Meaning of pibPrint field** | +|:---|:---| +| **0x0** | Specifies a one-based index into the **rgfb** array of the **OfficeArtBStoreContainer** record, as defined in section 2.2.20. A value of 0x00000000 MUST be ignored. | +| **0x1** | Specifies the number of bytes of data in the **pibPrint_complex** property, as defined in section 2.3.23.18. | + +#### pibPrint_complex + +The **pibPrint_complex** property specifies additional data for the **pibPrint** property, as defined in section [2.3.23.17](#pibprint). If the **opid.fComplex** bit of **pibPrint** equals 0x1, this property MUST exist. + +[TABLE] + +**pibPrint_complex (variable):** An **OfficeArtBlip** record, as defined in section [2.2.23](#officeartblip), that specifies the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) to print. + +#### pibPrintName + +The **pibPrintName** property specifies the comment, file name, or [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1), as specified by the **pibPrintFlags** property, as defined in section [2.3.23.21](#pibprintflags), for the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) to print. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0110. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pibPrintName_complex** property, as defined in section [2.3.23.20](#pibprintname_complex), exists. If the value equals 0x1, **pibPrintName_complex** MUST exist. | + +**pibPrintName (4 bytes):** The number of bytes of data in the **pibPrintName_complex** property, as defined in section 2.3.23.20. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### pibPrintName_complex + +The **pibPrintName_complex** property specifies additional data for the **pibPrintName** property, as defined in section [2.3.23.19](#pibprintname). If the **opid.fComplex** bit of **pibPrintName** equals 0x1, this property MUST exist. + +[TABLE] + +**pibPrintName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the comment, file name, or [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1), as specified by the **pibPrintFlags** property, as defined in section [2.3.23.21](#pibprintflags), for the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) to print. + +#### pibPrintFlags + +The **pibPrintFlags** property specifies a set of flags that relate to the usage of the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) to print. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| Field | Meaning | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0111. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pibPrintFlags (4 bytes):** An **MSOBLIPFLAGS** enumeration value, as defined in section [2.4.8](#msoblipflags), that specifies how to interpret the **pibPrintName_complex** property, as defined in section [2.3.23.20](#pibprintname_complex), and other properties of the BLIP to print. The default value for this property is **msoblipflagComment**. + +#### movie + +The **movie** property specifies movie data. This property SHOULD be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0112. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **movie_complex** property, as defined in section [2.3.23.23](#movie_complex), exists. If the value equals 0x1, **movie_complex** MUST exist. | + +**movie (4 bytes):** The number of bytes of data in the **movie_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### movie_complex + +The **movie_complex** property specifies movie data. This property SHOULD be ignored. + +[TABLE] + +**movie_complex (variable):** A binary serialization of movie data, as determined by the implementer. + +#### pictureTransparentExt + +The **pictureTransparentExt** property specifies the transparent pixel extended color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0115. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureTransparentExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), that specifies the extended color value to be treated as transparent. The default value for this property is 0xFFFFFFFF. + +#### reserved278 + +The reserved278 property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0116. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved278 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### pictureTransparentExtMod + +The **pictureTransparentExtMod** property specifies the color modification of the transparent pixel extended color. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0117. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureTransparentExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record that specifies the color modification of the extended color value. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved280 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0118. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved280 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved281 + +The **reserved281** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x0119. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved281 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### pictureRecolor + +The **pictureRecolor** property specifies the color that is used to recolor the image. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x011A. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureRecolor (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), specifies the color that is used to recolor the image. The default value for this property is 0xFFFFFFFF. + +#### pictureRecolorExt + +The **pictureRecolorExt** property specifies the extended color that is used to recolor the image. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x011B. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureRecolorExt (4 bytes):** An **OfficeArtCOLORREF** record, as defined in section [2.2.2](#officeartcolorref), specifying the extended color that is used to recolor the image. The default value for this property is 0xFFFFFFFF. + +#### reserved284 + +The **reserved284** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x011C. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved284 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### pictureRecolorExtMod + +The **pictureRecolorExtMod** property specifies the color modification of the extended color that is used to recolor the image. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x011D. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**pictureRecolorExtMod (4 bytes):** An [MSOTINTSHADE](#msotintshade) record specifying the color modification of the extended color that is used to recolor the image. For more information, see the **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref). The default value for this property is 0x20000000. + +#### reserved286 + +This property is reserved and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x011E. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved286 (4 bytes):** A value that MUST equal zero and MUST be ignored. The default value for this property is 0x00000000. + +#### reserved287 + +The **reserved287** property MUST equal 0xFFFFFFFF and MUST be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x011F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**reserved287 (4 bytes):** A value that MUST equal 0xFFFFFFFF and MUST be ignored. The default value for this property is 0xFFFFFFFF. + +#### Blip Boolean Properties + +The **Blip Boolean Properties** specify a 32-bit field of Boolean properties for the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) style. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x013F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (9 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefPicturePreserveGrays (1 bit):** A bit that specifies whether the **fPicturePreserveGrays** bit is set. A value of 0x0 specifies that **fPicturePreserveGrays** MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**B - fUsefRewind (1 bit):** A bit that specifies whether the **fRewind** bit is set. A value of 0x0 specifies that **fRewind** MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**C - fUsefLooping (1 bit):** A bit that specifies whether the **fLooping** bit is set. A value of 0x0 specifies that **fLooping** MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**D - fUsefNoHitTestPicture (1 bit):** A bit that specifies whether the **fNoHitTestPicture** bit is set. A value of 0x0 specifies that **fNoHitTestPicture** MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**E - fUsefPictureGray (1 bit):** A bit that specifies whether the **fPictureGray** bit is set. A value of 0x0 specifies that **fPictureGray** MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**F - fUsefPictureBiLevel (1 bit):** A bit that specifies whether the **fPictureBiLevel** bit is set. A value of 0x0 specifies that **fPictureBiLevel** MUST be ignored and the default value be used instead. The default value of this property is 0x0. + +**G - fUsefPictureActive (1 bit):** A bit that specifies whether the **fPictureActive** bit is set. A value of 0x0 specifies that **fPictureActive** MUST be ignored and the default value used instead. The default value of this property is 0x0. + +**unused2 (9 bits):** A value that is undefined and MUST be ignored. + +**H - fPicturePreserveGrays (1 bit):** A bit that specifies whether color modifications to this picture leave gray values unchanged. This value MUST be ignored if **fUsefPicturePreserveGrays** is 0x0. The default value of this property is 0x0. + +**I - fRewind (1 bit):** A bit that specifies whether to rewind this animated picture or movie when it is finished playing. This value MUST be ignored if **fUsefRewind** is 0x0. The default value of this property is 0x0. + +**J - fLooping (1 bit):** A bit that specifies whether to loop this animated picture or movie. This value MUST be ignored if **fUsefLooping** is 0x0. The default value of this property is 0x0. + +**K - fNoHitTestPicture (1 bit):** A bit that specifies whether this picture is selectable from the user interface. A value of 0x0 means that the picture is selectable. This value MUST be ignored if **fUsefNoHitTestPicture** is 0x0. The default value of this property is 0x0. + +**L - fPictureGray (1 bit):** A bit that specifies whether this picture SHOULD be displayed in gray scale. This value MUST be ignored if **fUsefPictureGray** is 0x0. The default value of this property is 0x0. + +**M - fPictureBiLevel (1 bit):** A bit that specifies whether this picture SHOULD be displayed in two-color black and white. This value MUST be ignored if **fUsefPictureBiLevel** is 0x0. The default value of this property is 0x0. + +**N - fPictureActive (1 bit):** A bit specifying whether the [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) server that is associated with this picture is active. This value MUST be ignored if **fUsefPictureActive** is 0x0. The default value of this property is 0x0. + +### Unknown HTML + +The **Unknown HTML** property set specifies the [**Vector Markup Language (VML)**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38), as specified in [\[ISO/IEC29500-4:2012\]](https://go.microsoft.com/fwlink/?LinkID=330450), Section 14, of specific attributes of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that is imported from the [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf) document. + +#### wzLineId + +The **wzLineId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **stroke** element, as specified in [\[ISO/IEC29500-4:2012\]](https://go.microsoft.com/fwlink/?LinkID=330450), Section 14. This property MAY[\<73\>](#Appendix_A_73) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0402. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzLineId_complex** property, as defined in section [2.3.24.2](#wzlineid_complex), exists. If the value equals 0x1, **wzLineId_complex** MUST exist. | + +**wzLineId (4 bytes):** The number of bytes of data in the **wzLineId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzLineId_complex + +The **wzLineId_complex** property specifies additional data for the **wzLineId** property, as defined in section [2.3.24.1](#wzlineid). If the **opid.fComplex** bit of **wzLineId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzLineId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) stroke element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzFillId + +The **wzFillId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **fill** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<74\>](#Appendix_A_74) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0403. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzFillId_complex** property, as defined in section [2.3.24.4](#wzfillid_complex), exists. If the value equals 0x1, **wzFillId_complex** MUST exist. | + +**wzFillId (4 bytes):** The number of bytes of data in the **wzFillId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzFillId_complex + +The **wzFillId_complex** property specifies additional data for the **wzFillId** property, as defined in section [2.3.24.3](#wzfillid). If the **opid.fComplex** bit of **wzFillId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzFillId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) fill element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzPictureId + +The **wzPictureId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **imagedata** element, as specified [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<75\>](#Appendix_A_75) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0404. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzPictureId_complex** property, as defined in section [2.3.24.6](#wzpictureid_complex), exists. If the value equals 0x1, **wzPictureId_complex** MUST exist. | + +**wzPictureId (4 bytes):** The number of bytes of data in the **wzPictureId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzPictureId_complex + +The **wzPictureId_complex** property specifies additional data for the **wzPictureId** property, as defined in section [2.3.24.5](#wzpictureid). If the **opid.fComplex** bit of **wzPictureId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzPictureId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **imagedata** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzPathId + +The **wzPathId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **path** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<76\>](#Appendix_A_76) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0405. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzPathId_complex** property, as defined in section [2.3.24.8](#wzpathid_complex), exists. If the value equals 0x1, **wzPathId_complex** MUST exist. | + +**wzPathId (4 bytes):** The number of bytes of data in the **wzPathId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzPathId_complex + +The **wzPathId_complex** property specifies additional data for the **wzPathId** property, as defined in section [2.3.24.7](#wzpathid). If the **opid.fComplex** bit of **wzPathId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzPathId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **path** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzShadowId + +The **wzShadowId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **shadow** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<77\>](#Appendix_A_77) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0406. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the [**wzShadowId_complex**](#wzshadowid_complex) property, as defined in section 2.3.24.10, exists. If the value equals 0x1, **wzShadowId_complex** MUST exist. | + +**wzShadowId (4 bytes):** The number of bytes of data in the **wzShadowId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzShadowId_complex + +The **wzShadowId_complex** property specifies additional data for the **wzShadowId** property, as defined in section [2.3.24.9](#wzshadowid). If the **opid.fComplex** bit of **wzShadowId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzShadowId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **shadow** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzPerspectiveId + +The **wzPerspectiveId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **skew** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<78\>](#Appendix_A_78) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0407. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzPerspectiveId_complex** property, as defined in section [2.3.24.12](#wzperspectiveid_complex), exists. If the value equals 0x1, **wzPerspectiveId_complex** MUST exist. | + +**wzPerspectiveId (4 bytes):** The number of bytes of data in the **wzPerspectiveId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzPerspectiveId_complex + +The **wzPerspectiveId_complex** property specifies additional data for the **wzPerspectiveId** property, as defined in section [2.3.24.11](#wzperspectiveid). If the **opid.fComplex** bit of **wzPerspectiveId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzPerspectiveId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **skew** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzGtextId + +The **wzGtextId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **textpath** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<79\>](#Appendix_A_79) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0408. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzGtextId_complex** property, as defined in section [2.3.24.14](#wzgtextid_complex), exists. If the value equals 0x1, **wzGtextId_complex** MUST exist. | + +**wzGtextId (4 bytes):** The number of bytes of data in the **wzGtextId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzGtextId_complex + +The **wzGtextId_complex** property specifies additional data for the **wzGtextId** property, as defined in section [2.3.24.13](#wzgtextid). If the **opid.fComplex** bit of **wzGtextId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzGtextId_complex (variable):** A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) null-terminated Unicode string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **textpath** element, as specified [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzFormulaeId + +The **wzFormulaeId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **formulas** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<80\>](#Appendix_A_80) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0409. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzFormulaeId_complex** property, as defined in section [2.3.24.16](#wzformulaeid_complex), exists. If the value equals 0x1, **wzFormulaeId_complex** MUST exist. | + +**wzFormulaeId (4 bytes):** The number of bytes of data in the **wzFormulaeId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzFormulaeId_complex + +The **wzFormulaeId_complex** property specifies additional data for the **wzFormulaeId** property, as defined in section [2.3.24.15](#wzformulaeid). If the **opid.fComplex** bit of **wzFormulaeId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzFormulaeId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **formulas** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzHandlesId + +The **wzHandlesId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **handles** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<81\>](#Appendix_A_81) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x040A. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzHandlesId_complex** property, as defined in section [2.3.24.18](#wzhandlesid_complex), exists. If the value equals 0x1, **wzHandlesId_complex** MUST exist. | + +**wzHandlesId (4 bytes):** The number of bytes of data in the **wzHandlesId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzHandlesId_complex + +The **wzHandlesId_complex** property specifies additional data for the **wzHandlesId** property, as defined in section [2.3.24.17](#wzhandlesid). If the **opid.fComplex** bit of **wzHandlesId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzHandlesId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **handles** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzCalloutId + +The **wzCalloutId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **callout** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<82\>](#Appendix_A_82) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x040B. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzCalloutId_complex** property, as defined in section [2.3.24.20](#wzcalloutid_complex), exists. If the value equals 0x1, **wzCalloutId_complex** MUST exist. | + +**wzCalloutId (4 bytes):** The number of bytes of data in the **wzCalloutId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzCalloutId_complex + +The **wzCalloutId_complex** property specifies additional data for the **wzCalloutId** property, as defined in section [2.3.24.19](#wzcalloutid). If the **opid.fComplex** bit of **wzCalloutId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzCalloutId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **callout** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzLockId + +The **wzLockId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **lock** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<83\>](#Appendix_A_83) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x040C. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzLockId_complex** property, as defined in section [2.3.24.22](#wzlockid_complex), exists. If the value equals 0x1, **wzLockId_complex** MUST exist. | + +**wzLockId (4 bytes):** The number of bytes of data in the **wzLockId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzLockId_complex + +The **wzLockId_complex** property specifies additional data for the **wzLockId** property, as defined in section [2.3.24.21](#wzlockid). If the **opid.fComplex** bit of **wzLockId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzLockId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **lock** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzTextId + +The **wzTextId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **textbox** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<84\>](#Appendix_A_84) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x040D. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzTextId_complex** property, as defined in section [2.3.24.24](#wztextid_complex), exists. If the value equals 0x1, **wzTextId_complex** MUST exist. | + +**wzTextId (4 bytes):** The number of bytes of data in the **wzTextId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzTextId_complex + +The **wzTextId_complex** property specifies additional data for the **wzTextId** property, as defined in section [2.3.24.23](#wztextid). If the **opid.fComplex** bit of **wzTextId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzTextId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **textbox** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### wzThreeDId + +The **wzThreeDId** property specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **extrusion** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<85\>](#Appendix_A_85) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x040E. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzThreeDId_complex** property, as defined in section [2.3.24.26](#wzthreedid_complex), exists. If the value equals 0x1, **wzThreeDId_complex** MUST exist. | + +**wzThreeDId (4 bytes):** The number of bytes of data in the **wzThreeDId_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### wzThreeDId_complex + +The **wzThreeDId_complex** property specifies additional data for the **wzThreeDId** property, as defined in section [2.3.24.25](#wzthreedid). If the **opid.fComplex** bit of **wzThreeDId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzThreeDId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the identifier of the [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) **extrusion** element, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. + +#### Unknown HTML Boolean Properties + +The **Unknown HTML Boolean Properties** specify a 32-bit field of Boolean properties for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that is imported from [**VML**](#gt_eb6b7893-b656-4b91-8fab-51fd1cf28a38) content, as specified in [\[ISO/IEC29500-4:2011\]](https://go.microsoft.com/fwlink/?LinkId=330293), Section 14. This property MAY[\<86\>](#Appendix_A_86) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x043F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (13 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefOleFromHtml (1 bit):** A bit that specifies whether the **fOleFromHtml** bit is set. A value of 0x0 specifies that **fOleFromHtml** MUST be ignored. The default value for this property is 0x0. + +**B - fUsefFakeMaster (1 bit):** A bit that specifies whether the **fFakeMaster** bit is set. A value of 0x0 specifies that **fFakeMaster** MUST be ignored. The default value for this property is 0x0. + +**C - unused2 (1 bit):** A value that is undefined and MUST be ignored. + +**unused3 (13 bits):** A value that is undefined and MUST be ignored. + +**D - fOleFromHtml (1 bit):** A bit that specifies whether this shape is imported from a VML **shape** element, as specified in \[ISO/IEC29500-4:2011\], Section 14, which is an embedded object. This value MUST be ignored if **fUsefOleFromHtml** is 0x0. The default value for this property is 0x0. + +**E - fFakeMaster (1 bit):** A bit that specifies whether the shape is imported from a VML **shapetype** element, as specified in \[ISO/IEC29500-4:2011\], Section 14. If this bit is set to 0x1, the shape will not be rendered and can be used to create other shapes. This value MUST be ignored if **fUsefFakeMaster** is 0x0. The default value for this property is 0x0. + +**F - unused4 (1 bit):** A value that is undefined and MUST be ignored. + +### Web Component + +The **Web Component** property set specifies the [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf) content attributes of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### webComponentWzHtml + +The **webComponentWzHtml** property specifies the [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf) content of the [**Web component**](#gt_5064ea88-847f-4008-ba59-5f7a0a323970). This property MAY[\<87\>](#Appendix_A_87) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0680. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **webComponentWzHtml_complex** property, as defined in section [2.3.25.2](#webcomponentwzhtml_complex), exists. If the value equals 0x1, **webComponentWzHtml_complex** MUST exist. | + +**webComponentWzHtml (4 bytes):** The number of bytes of data in the **webComponentWzHtml_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### webComponentWzHtml_complex + +The **webComponentWzHtml_complex** property specifies additional data for the **webComponentWzHtml** property, as defined in section [2.3.25.1](#webcomponentwzhtml). If the **opid.fComplex** bit of **webComponentWzHtml** equals 0x1, this property MUST exist. + +[TABLE] + +**webComponentWzHtml_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf) content. + +#### webComponentWzName + +The **webComponentWzName** property specifies the name of the [**Web component**](#gt_5064ea88-847f-4008-ba59-5f7a0a323970). This property MAY[\<88\>](#Appendix_A_88) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0681. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **webComponentWzName_complex** property, as defined in section [2.3.25.4](#webcomponentwzname_complex), exists. If the value equals 0x1, **webComponentWzName_complex** MUST exist. | + +**webComponentWzName (4 bytes):** The number of bytes of data in the **webComponentWzName_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### webComponentWzName_complex + +The **webComponentWzName_complex** property specifies additional data for the **webComponentWzName** property, as defined in section [2.3.25.3](#webcomponentwzname). If the **opid.fComplex** bit of **webComponentWzName** equals 0x1, this property MUST exist. + +[TABLE] + +**webComponentWzName_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the name. + +#### webComponentWzUrl + +The **webComponentWzUrl** property specifies the [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) of the [**Web component**](#gt_5064ea88-847f-4008-ba59-5f7a0a323970). This property MAY[\<89\>](#Appendix_A_89) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0682. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **webComponentWzUrl_complex** property, as defined in section [2.3.25.6](#webcomponentwzurl_complex), exists. If the value equals 0x1, **webComponentWzUrl_complex** MUST exist. | + +**webComponentWzUrl (4 bytes):** The number of bytes of data in the **webComponentWzUrl_complex** property. If **opid.fComplex** equals 0x0, this value MUST be 0x00000000. The default value for this property is 0x00000000. + +#### webComponentWzUrl_complex + +The **webComponentWzUrl_complex** property specifies additional data for the **webComponentWzUrl** property, as defined in section [2.3.25.5](#webcomponentwzurl). If the **opid.fComplex** bit of **webComponentWzUrl** equals 0x1, this property MUST exist. + +[TABLE] + +**webComponentWzUrl_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1). + +#### Web Component Boolean Properties + +The **Web Component Boolean Properties** specify a 32-bit field of Boolean properties for the [**Web component**](#gt_5064ea88-847f-4008-ba59-5f7a0a323970). This property MAY[\<90\>](#Appendix_A_90) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x06BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (15 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefIsWebComponent (1 bit):** A bit that specifies whether the **fIsWebComponent** bit is set. A value of 0x0 specifies that the **fIsWebComponent** MUST be ignored. The default value for this property is 0x0. + +**unused2 (15 bits):** A value that is undefined and MUST be ignored. + +**B - fIsWebComponent (1 bit):** A bit that specifies whether the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is a Web component. This value MUST be ignored if **fUsefIsWebComponent** is 0x0. The default value for this property is 0x0. + +### Ink + +The **Ink** property set specifies the ink data of an [**ink shape**](#gt_f2674485-0f40-4ece-bdcf-062eff7e7405). + +#### pInkData + +The **pInkData** property specifies the data that is used to represent an [**ink shape**](#gt_f2674485-0f40-4ece-bdcf-062eff7e7405). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0700. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **pInkData_complex** property, as defined in section [2.3.26.2](#pinkdata_complex), exists. If the value equals 0x1, **pInkData_complex** MUST exist. | + +**pInkData (4 bytes):** The number of bytes of data in the **pInkData_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### pInkData_complex + +The **pInkData_complex** property specifies additional data for the **pInkData** property, as defined in section [2.3.26.1](#pinkdata). If the **opid.fComplex** bit of **pInkData** equals 0x1, this property MUST exist. + +[TABLE] + +**pInkData_complex (variable):** An Ink Serialization Format stream, as specified in [\[MC-ISF\]](%5bMC-ISF%5d.pdf), that specifies the ink strokes in this [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +This property is an **IMsoInkData** record, as specified in section [2.2.52](#imsoinkdata). It contains custom data that is stored as extended properties on ink stroke objects. The extended property information is specified in the following table. + +| Name | GUID | Meaning | +|----|----|----| +| **DrawAttributeColorScheme** | 000C6800-0000-0000-C000-000000000046 | An **MSOCR** record, as defined in section [2.2.44](#msocr), that specifies an ink stroke color. | +| **TimeStamp** | 8A54CF58-97E6-4fc5-8F06-F8BAD2E19B22 | A Universal Time Coordinates (UTC) time stamp. | + +#### Ink Boolean Properties + +The **Ink Boolean Properties** specify a 32-bit field of Boolean properties for [**ink**](#gt_9fcdd1d5-3563-49b9-8a2e-bf696fb08fd0) [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x073F. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (12 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefInkAnnotation (1 bit):** A bit that specifies whether the **fInkAnnotation** bit is set. A value of 0x0 specifies that **fInkAnnotation** MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**B - fUsefHitTestInk (1 bit):** A bit that specifies whether the **fHitTestInk** bit is set. A value of 0x0 specifies that **fHitTestInk** MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**C - fUsefRenderShape (1 bit):** A bit that specifies whether the **fRenderShape** bit is set. A value of 0x0 specifies that **fRenderShape** MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**D - fUsefRenderInk (1 bit):** A bit that specifies whether the **fRenderInk** bit is set. A value of 0x0 specifies that **fRenderInk** MUST be ignored and the default value used instead. The default value for this property is 0x0. + +**unused2 (12 bits):** A value that is undefined and MUST be ignored. + +**E - fInkAnnotation (1 bit):** A bit that specifies whether this shape is an ink annotation. This value MUST be ignored if **fUsefInkAnnotation** is 0x0. The default value for this property is 0x0. + +**F - fHitTestInk (1 bit):** A bit that specifies whether to allow mouse hit testing of the ink strokes in this shape. This value MUST be ignored if **fUsefHitTestInk** is 0x0. The default value for this property is 0x1. + +**G - fRenderShape (1 bit):** A bit that specifies whether to render the shape effects that are specified by other graphics properties in the **OfficeArtRGFOPTE** record, as defined in section [2.3.1](#officeartrgfopte). This value MUST be ignored if **fUsefRenderShape** is 0x0. The default value for this property is 0x0. + +**H - fRenderInk (1 bit):** A bit that specifies whether to render the ink strokes in this shape. This value MUST be ignored if **fUsefRenderInk** is 0x0. The default value for this property is 0x0. + +### Signature Line + +The **Signature Line** property set specifies the attributes of the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) signing setup of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +#### wzSigSetupId + +The **wzSigSetupId** property specifies the GUID of the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). This property SHOULD[\<91\>](#Appendix_A_91) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0781. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupId_complex** property, as defined in section [2.3.27.2](#wzsigsetupid_complex), exists. If the value equals 0x1, **wzSigSetupId_complex** MUST exist. | + +**wzSigSetupId (4 bytes):** The number of bytes of data in the **wzSigSetupId_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupId_complex + +The **wzSigSetupId_complex** property specifies additional data for the **wzSigSetupId** property, as defined in section [2.3.27.1](#wzsigsetupid). If the **opid.fComplex** bit of **wzSigSetupId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the GUID of the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). The GUID is formatted in the following pattern: + +{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} + +where the value of the GUID is represented as a series of hexadecimal digits in groups of 8, 4, 4, 4, and 12 digits that are separated by hyphens, with the entire series enclosed by braces. + +#### wzSigSetupProvId + +The **wzSigSetupProvId** property specifies the GUID of the provider that creates the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). This property SHOULD[\<92\>](#Appendix_A_92) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0782. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupProvId_complex** property, as defined in section [2.3.27.4](#wzsigsetupprovid_complex), exists. If the value equals 0x1, **wzSigSetupProvId_complex** MUST exist. | + +**wzSigSetupProvId (4 bytes):** The number of bytes of data in the **wzSigSetupProvId_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupProvId_complex + +The **wzSigSetupProvId_complex** property specifies additional data for the **wzSigSetupProvId** property, as defined in section [2.3.27.3](#wzsigsetupprovid). If the **opid.fComplex** bit of **wzSigSetupProvId** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupProvId_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the GUID of the provider that creates the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). The GUID is formatted in the following pattern: + +{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX} + +where the value of the GUID is represented as a series of hexadecimal digits in groups of 8, 4, 4, 4, and 12 digits that are separated by hyphens, with the entire series enclosed by braces. + +#### wzSigSetupSuggSigner + +The **wzSigSetupSuggSigner** property specifies the name of the suggested signer. This property SHOULD[\<93\>](#Appendix_A_93) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0783. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupSuggSigner_complex** property, as defined in section [2.3.27.6](#wzsigsetupsuggsigner_complex), exists. If the value equals 0x1, **wzSigSetupSuggSigner_complex** MUST exist. | + +**wzSigSetupSuggSigner (4 bytes):** The number of bytes of data in the **wzSigSetupSuggSigner_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupSuggSigner_complex + +The **wzSigSetupSuggSigner_complex** property specifies additional data for the **wzSigSetupSuggSigner** property, as defined in section [2.3.27.5](#wzsigsetupsuggsigner). If the **opid.fComplex** bit of **wzSigSetupSuggSigner** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupSuggSigner_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the name of the suggested signer. + +#### wzSigSetupSuggSigner2 + +The **wzSigSetupSuggSigner2** property specifies the title or additional information about the suggested signer. This property SHOULD[\<94\>](#Appendix_A_94) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0784. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupSuggSigner2_complex** property, as defined in section [2.3.27.8](#wzsigsetupsuggsigner2_complex), exists. If the value equals 0x1, **wzSigSetupSuggSigner2_complex** MUST exist. | + +**wzSigSetupSuggSigner2 (4 bytes):** The number of bytes of data in the **wzSigSetupSuggSigner2_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupSuggSigner2_complex + +This property specifies additional data for the **wzSigSetupSuggSigner2** property, as defined in section [2.3.27.7](#wzsigsetupsuggsigner2). If the **opid.fComplex** bit of **wzSigSetupSuggSigner2** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupSuggSigner2_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the title or additional information about the suggested signer. + +#### wzSigSetupSuggSignerEmail + +The **wzSigSetupSuggSignerEmail** property specifies the e-mail address of the suggested signer. This property SHOULD[\<95\>](#Appendix_A_95) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0785. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupSuggSignerEmail_complex** property, as defined in section [2.3.27.10](#wzsigsetupsuggsigneremail_complex), exists. If the value equals 0x1, **wzSigSetupSuggSignerEmail_complex** MUST exist. | + +**wzSigSetupSuggSignerEmail (4 bytes):** The number of bytes of data in the **wzSigSetupSuggSignerEmail_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupSuggSignerEmail_complex + +The **wzSigSetupSuggSignerEmail_complex** property specifies additional data for the **wzSigSetupSuggSignerEmail** property, as defined in section [2.3.27.9](#wzsigsetupsuggsigneremail). If the **opid.fComplex** bit of **wzSigSetupSuggSignerEmail** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupSuggSignerEmail_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the e-mail address of the suggested signer. + +#### wzSigSetupSignInst + +The **wzSigSetupSignInst** property specifies the signing instruction that is displayed to the signer. This property SHOULD[\<96\>](#Appendix_A_96) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0786. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupSignInst_complex** property, as defined in section [2.3.27.12](#wzsigsetupsigninst_complex), exists. If the value equals 0x1, **wzSigSetupSignInst_complex** MUST exist. | + +**wzSigSetupSignInst (4 bytes):** The number of bytes of data in the **wzSigSetupSignInst_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupSignInst_complex + +The **wzSigSetupSignInst_complex** property specifies additional data for the **wzSigSetupSignInst** property, as defined in section [2.3.27.11](#wzsigsetupsigninst). If the **opid.fComplex** bit of **wzSigSetupSignInst** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupSignInst_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string specifying the signing instruction that is displayed to the signer. + +#### wzSigSetupAddlXml + +The **wzSigSetupAddlXml** property specifies additional information in [**XML**](#gt_982b7f8e-d516-4fd5-8d5e-1a836081ed85) format that is provided by the provider that creates the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). This property SHOULD[\<97\>](#Appendix_A_97) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0787. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupAddlXml_complex** property, as defined in section [2.3.27.14](#wzsigsetupaddlxml_complex), exists. If the value equals 0x1, **wzSigSetupAddlXml_complex** MUST exist. | + +**wzSigSetupAddlXml (4 bytes):** The number of bytes of data in the **wzSigSetupAddlXml_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupAddlXml_complex + +The **wzSigSetupAddlXml_complex** property specifies additional data for the **wzSigSetupAddlXml** property, as defined in section [2.3.27.13](#wzsigsetupaddlxml). If the **opid.fComplex** bit of **wzSigSetupAddlXml** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupAddlXml_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies additional information in [**XML**](#gt_982b7f8e-d516-4fd5-8d5e-1a836081ed85) format. + +#### wzSigSetupProvUrl + +The **wzSigSetupProvUrl** property specifies the [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) of the provider that creates the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). This property SHOULD[\<98\>](#Appendix_A_98) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:---|:---| +| **opid.opid** | A value that MUST be 0x0788. | +| **opid.fBid** | A value that is undefined and MUST be ignored. | +| **opid.fComplex** | A bit that indicates whether the **wzSigSetupProvUrl_complex** property, as defined in section [2.3.27.16](#wzsigsetupprovurl_complex), exists. If the value equals 0x1, **wzSigSetupProvUrl_complex** MUST exist. | + +**wzSigSetupProvUrl (4 bytes):** The number of bytes of data in the **wzSigSetupProvUrl_complex** property. This value MUST be 0x00000000 if **opid.fComplex** is 0x0. The default value for this property is 0x00000000. + +#### wzSigSetupProvUrl_complex + +The **wzSigSetupProvUrl_complex** property specifies additional data for the **wzSigSetupProvUrl** property, as defined in section [2.3.27.15](#wzsigsetupprovurl). If the **opid.fComplex** bit of **wzSigSetupProvUrl** equals 0x1, this property MUST exist. + +[TABLE] + +**wzSigSetupProvUrl_complex (variable):** A null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string that specifies the [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) of the provider. + +#### Signature Line Boolean Properties + +The **Signature Line Boolean Properties** specify a 32-bit field of Boolean properties for the [**signature line**](#gt_bed616d4-a14c-421c-8770-7cb946784a18). This property SHOULD[\<99\>](#Appendix_A_99) be ignored. + +[TABLE] + +**opid (2 bytes):** An **OfficeArtFOPTEOPID** record, as defined in section [2.2.8](#officeartfopteopid), that specifies the header for this property. The following table specifies the subfields. + +| **Field** | **Meaning** | +|:------------------|:-----------------------------| +| **opid.opid** | A value that MUST be 0x07BF. | +| **opid.fBid** | A value that MUST be 0x0. | +| **opid.fComplex** | A value that MUST be 0x0. | + +**unused1 (12 bits):** A value that is undefined and MUST be ignored. + +**A - fUsefSigSetupShowSignDate (1 bit):** A bit that specifies whether the **fSigSetupShowSignDate** bit is set. A value of 0x0 specifies that **fSigSetupShowSignDate** MUST be ignored. The default value for this property is 0x0. + +**B - fUsefSigSetupAllowComments (1 bit):** A bit that specifies whether the **fSigSetupAllowComments** bit is set. A value of 0x0 specifies that **fSigSetupAllowComments** MUST be ignored. The default value for this property is 0x0. + +**C - fUsefSigSetupSignInstSet (1 bit):** A bit that specifies whether the **fSigSetupSignInstSet** bit is set. A value of 0x0 specifies that **fSigSetupSignInstSet** MUST be ignored. The default value for this property is 0x0. + +**D - fUsefIsSignatureLine (1 bit):** A bit that specifies whether the **fIsSignatureLine** bit is set. A value of 0x0 specifies that **fIsSignatureLine** MUST be ignored. The default value for this property is 0x0. + +**unused2 (12 bits):** A value that is undefined and MUST be ignored. + +**E - fSigSetupShowSignDate (1 bit):** A bit that specifies whether the signing date will be displayed. This value MUST be ignored if **fUsefSigSetupShowSignDate** is 0x0. The default value for this property is 0x1. + +**F - fSigSetupAllowComments (1 bit):** A bit that specifies whether a comment from the signer is allowed. This value MUST be ignored if **fUsefSigSetupAllowComments** is 0x0. The default value for this property is 0x0. + +**G - fSigSetupSignInstSet (1 bit):** A bit that specifies whether the signing instruction will be overridden. The following table specifies the meaning of each value for this bit. This value MUST be ignored if **fUsefSigSetupSignInstSet** is 0x0. The default value for this property is 0x0. + +| Value | Meaning | +|----|----| +| 0x0 | Specifies that a default signing instruction will be displayed. | +| 0x1 | Specifies that the [wzSigSetupSignInst_complex](#wzsigsetupsigninst_complex) property will be displayed. | + +**H - fIsSignatureLine (1 bit):** A bit that specifies whether the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is a signature line. This value MUST be ignored if **fUsefIsSignatureLine** is 0x0. The default value for this property is 0x0. + +## Enumerations + +### MSOBLIPTYPE + +*Referenced by: [OfficeArtFBSE](#officeartfbse)* + +The **MSOBLIPTYPE** enumeration, as shown in the following table, specifies the persistence format of bitmap data. + +| Name | Value | Meaning | +|----|----|----| +| **msoblipERROR** | 0x00 | Error reading the file. | +| **msoblipUNKNOWN** | 0x01 | Unknown [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) type. | +| **msoblipEMF** | 0x02 | [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36). | +| **msoblipWMF** | 0x03 | [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b). | +| **msoblipPICT** | 0x04 | [**Macintosh PICT**](#gt_467e07ae-91a8-4af9-9094-61d8e4400dae). | +| **msoblipJPEG** | 0x05 | [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d). | +| **msoblipPNG** | 0x06 | [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604). | +| **msoblipDIB** | 0x07 | [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) | +| **msoblipTIFF** | 0x11 | [**TIFF**](#gt_eddadea9-c278-4d16-9279-f222df2cb735) | +| **msoblipCMYKJPEG** | 0x12 | JPEG in the [**YCCK**](#gt_6dd9d854-7ce0-4cc1-9e12-2f20e2424269) or [**CMYK**](#gt_7c5541e5-c01d-45c3-a2c6-a312a2a14d8f) color space. | + +### MSODGCID + +The **MSODGCID** enumeration, as shown in the following table, specifies the command identifiers that are used for customizing toolbars and keyboard shortcuts. + +| Name | Value | Meaning | +|----|----|----| +| **msodgcidNil** | 0x0000 | Undefined—the command is specified by a [**toolbar control identifier (TCID)**](#gt_28d9adbd-b340-469a-97cd-3befd6a782b3). | +| **msodgcidPaste** | 0x0004 | Paste the [**drawing object**](#gt_51dfe494-9c84-4a0e-9d53-06068c5ce3ac). | +| **msodgcidSelectAll** | 0x0006 | Select all drawing objects. | +| **msodgcidRepeat** | 0x0008 | Repeat the last action. | +| **msodgcidBringToFront** | 0x000C | Bring the drawing objects to the front. | +| **msodgcidSendToBack** | 0x000D | Send the drawing objects to the back. | +| **msodgcidBringForward** | 0x000E | Bring the drawing objects forward. (Not necessarily all the way to the front.) | +| **msodgcidSendBackward** | 0x000F | Send the drawing objects backward. (Not necessarily all the way to the back.) | +| **msodgcidBringInFrontOfDocument** | 0x0010 | Bring the drawing objects in front of the text. | +| **msodgcidSendBehindDocument** | 0x0011 | Send the drawing objects behind the text. | +| **msodgcidGroup** | 0x0012 | Group the drawing objects. | +| **msodgcidUngroup** | 0x0013 | Ungroup the grouped drawing objects. | +| **msodgcidRegroup** | 0x0014 | Regroup the drawing objects. | +| **msodgcidInsertPolygonPt** | 0x0019 | Add a point to a polygon [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). | +| **msodgcidDeletePolygonPt** | 0x001A | Delete a point from a polygon shape. | +| **msodgcidCopyPolygonPt** | 0x001C | Copy a polygon point. | +| **msodgcidClosePolygon** | 0x001D | Close the path on a shape that has an open path. | +| **msodgcidOpenPolygon** | 0x001E | Open the path on a shape that has a closed path. | +| **msodgcidPolygonReshape** | 0x0020 | Update the vertex and segment information in the polygon. | +| **msodgcidAutoVertex** | 0x0021 | Edit a point on a shape to be an automatic point. An automatic point has Bezier handles which are automatically calculated based on the positions of the adjacent vertices. | +| **msodgcidSmoothVertex** | 0x0022 | Edit a point on a shape to be a smooth point. A smooth point has Bezier handles which are collinear with and equidistant from the point. | +| **msodgcidStraightVertex** | 0x0023 | Edit a point on a shape to be a straight point. A straight point has Bezier handles which are collinear with the point, but not necessarily equidistant from it. | +| **msodgcidCornerVertex** | 0x0024 | Edit a point on a shape to be a corner point. | +| **msodgcidStraightSegment** | 0x0025 | Edit a segment on a shape to be a straight segment. | +| **msodgcidCurvedSegment** | 0x0026 | Edit a segment on a shape to be a curved segment. | +| **msodgcidRotateLeft90** | 0x0029 | Rotate the drawing objects 90 degrees counterclockwise. | +| **msodgcidRotateRight90** | 0x002A | Rotate the drawing objects 90 degrees clockwise. | +| **msodgcidFlipHorizontal** | 0x002B | Horizontally flip the drawing objects. | +| **msodgcidFlipVertical** | 0x002C | Vertically flip the drawing objects. | +| **msodgcidAlignLeft** | 0x002D | Align the drawing objects to the left side. | +| **msodgcidAlignCenterHorizontal** | 0x002E | Align the drawing objects to the center. | +| **msodgcidAlignRight** | 0x002F | Align the drawing objects to the right side. | +| **msodgcidAlignTop** | 0x0030 | Align the drawing objects to the top. | +| **msodgcidAlignCenterVertical** | 0x0031 | Vertically align the drawing objects to the middle. | +| **msodgcidAlignBottom** | 0x0032 | Align the drawing objects to the bottom. | +| **msodgcidAlignPageRelative** | 0x0033 | Align the drawing objects relative to the page, rather than relative to one another. | +| **msodgcidDistributeHorizontal** | 0x0034 | Horizontally distribute the drawing objects. | +| **msodgcidDistributeVertical** | 0x0035 | Vertically distribute the drawing objects. | +| **msodgcidDistributePageRelative** | 0x0036 | Distribute the drawing objects relative to the page or [**slide**](#gt_dd8a2def-ebde-4fc7-b420-6e837b2059cc), rather than relative to one another. | +| **msodgcidNudgeLeft** | 0x0037 | Nudge the drawing objects to the left. | +| **msodgcidNudgeRight** | 0x0038 | Nudge the drawing objects to the right. | +| **msodgcidNudgeUp** | 0x0039 | Nudge the drawing objects up. | +| **msodgcidNudgeDown** | 0x003A | Nudge the drawing objects down. | +| **msodgcidNudgeLeftOne** | 0x003B | Nudge the drawing objects to the left by one pixel. | +| **msodgcidNudgeRightOne** | 0x003C | Nudge the drawing objects to the right by one pixel. | +| **msodgcidNudgeUpOne** | 0x003D | Nudge the drawing objects up by one pixel. | +| **msodgcidNudgeDownOne** | 0x003E | Nudge the drawing objects down by one pixel. | +| **msodgcidToggleReshapeMode** | 0x003F | Toggle the reshape mode. | +| **msodgcidToggleRotateMode** | 0x0040 | Toggle the rotate mode. | +| **msodgcidToggleCropMode** | 0x0041 | Crop the picture. | +| **msodgcidMoreFillColor** | 0x0043 | Show more fill colors. | +| **msodgcidFillEffect** | 0x0044 | Show more fill effects. | +| **msodgcidMoreLineColor** | 0x0045 | Show more outline colors. | +| **msodgcidMoreLineWidth** | 0x0046 | Show more line widths. | +| **msodgcidMoreArrow** | 0x0047 | Show more line end decorations. | +| **msodgcidTextEffectRotateCharacters** | 0x0048 | Display the text in stylized text objects as vertical text. | +| **msodgcidTextEffectStretchToFill** | 0x0049 | Stretch the text in stylized text objects to fill the shape. | +| **msodgcidTextEffectSameHeight** | 0x004A | Set all the letters to the same height in stylized text objects. | +| **msodgcidTextEffectAlignLeft** | 0x004B | Align the text in stylized text objects to the left side. | +| **msodgcidTextEffectAlignCenter** | 0x004C | Align the text in stylized text objects to the center. | +| **msodgcidTextEffectAlignRight** | 0x004D | Align the text in stylized text objects to the right side. | +| **msodgcidTextEffectAlignLetterJustify** | 0x004E | Set the alignment for stylized text objects to letter justify. | +| **msodgcidTextEffectAlignWordJustify** | 0x0050 | Set the alignment for stylized text objects to word justify. | +| **msodgcidTextEffectAlignStretchJustify** | 0x0051 | Set the alignment for stylized text objects to stretch justify. | +| **msodgcidTextEffectSpacingVeryTight** | 0x0052 | Set the text spacing for stylized text objects to very tight. | +| **msodgcidTextEffectSpacingTight** | 0x0053 | Set the text spacing for stylized text objects to tight. | +| **msodgcidTextEffectSpacingNormal** | 0x0054 | Set the text spacing for stylized text objects to normal. | +| **msodgcidTextEffectSpacingLoose** | 0x0055 | Set the text spacing for stylized text objects to loose. | +| **msodgcidTextEffectSpacingVeryLoose** | 0x0056 | Set the text spacing for stylized text objects to very loose. | +| **msodgcidTextEffectKernPairs** | 0x0057 | Kern character pairs that exist in the text in stylized text objects. | +| **msodgcidTextEffectEditText** | 0x0058 | Edit the text in a stylized text object. | +| **msodgcidPictureMoreContrast** | 0x0059 | Increase the contrast of the picture. | +| **msodgcidPictureLessContrast** | 0x005A | Decrease the contrast of the picture. | +| **msodgcidPictureMoreBrightness** | 0x005B | Increase the brightness of the picture. | +| **msodgcidPictureLessBrightness** | 0x005C | Decrease the brightness of the picture. | +| **msodgcidPictureReset** | 0x005D | Reset the picture to the default settings. | +| **msodgcidPictureImageAutomatic** | 0x005E | Use automatic picture colors. | +| **msodgcidPictureImageGrayscale** | 0x005F | Display the picture in grayscale. | +| **msodgcidPictureImageBlackWhite** | 0x0060 | Display picture in black and white. | +| **msodgcidPictureImageWatermark** | 0x0061 | Add a watermark to the picture. | +| **msodgcidPictureInLine** | 0x0062 | Set the picture to be inline with the text. | +| **msodgcidMoreShadow** | 0x0067 | Show the shadow settings. | +| **msodgcidMoreShadowColor** | 0x0068 | Show more shadow colors. | +| **msodgcidNudgeShadowUp** | 0x0069 | Nudge the shadow up. | +| **msodgcidNudgeShadowDown** | 0x006A | Nudge the shadow down. | +| **msodgcidNudgeShadowLeft** | 0x006B | Nudge the shadow to the left. | +| **msodgcidNudgeShadowRight** | 0x006C | Nudge the shadow to the right. | +| **msodgcidMore3D** | 0x006D | Show the 3-D settings. | +| **msodgcidMore3DColor** | 0x006E | Show more 3-D colors. | +| **msodgcid3DToggle** | 0x006F | Toggle the 3-D options on or off. | +| **msodgcid3DTiltForward** | 0x0070 | Tilt the 3-D drawing objects down. | +| **msodgcid3DTiltBackward** | 0x0071 | Tilt the 3-D drawing objects up. | +| **msodgcid3DTiltLeft** | 0x0072 | Tilt the 3-D drawing objects to the left. | +| **msodgcid3DTiltRight** | 0x0073 | Tilt the 3-D drawing objects to the right. | +| **msodgcid3DDepth0** | 0x0074 | Set the 3-D depth to 0 [**points**](#gt_d072e4da-7898-4227-8f25-9fe77db43571). | +| **msodgcid3DDepth1** | 0x0075 | Set the 3-D depth to 36 points. | +| **msodgcid3DDepth2** | 0x0076 | Set the 3-D depth to 72 points. | +| **msodgcid3DDepth3** | 0x0077 | Set the 3-D depth to 144 points. | +| **msodgcid3DDepth4** | 0x0078 | Set the 3-D depth to 288 points. | +| **msodgcid3DDepthInfinite** | 0x0079 | Set the 3-D depth to infinity. | +| **msodgcid3DPerspective** | 0x007A | Set the 3-D direction to perspective. | +| **msodgcid3DParallel** | 0x007B | Set the 3-D direction to parallel. | +| **msodgcid3DLightingFlat** | 0x007C | Set the 3-D lighting to bright. | +| **msodgcid3DLightingNormal** | 0x007D | Set the 3-D lighting to normal. | +| **msodgcid3DLightingHarsh** | 0x007E | Set the 3-D lighting to dim. | +| **msodgcid3DSurfaceMatte** | 0x007F | Set the 3-D surface to matte. | +| **msodgcid3DSurfacePlastic** | 0x0080 | Set the 3-D surface to plastic. | +| **msodgcid3DSurfaceMetal** | 0x0081 | Set the 3-D surface to metal. | +| **msodgcid3DSurfaceWireFrame** | 0x0082 | Set the 3-D surface to wire frame. | +| **msodgcidToolPointer** | 0x0087 | Select drawing objects. | +| **msodgcidToolMarquee** | 0x0088 | Drag a rectangle to select multiple drawing objects. | +| **msodgcidToolLine** | 0x008C | Insert a line shape. | +| **msodgcidToolArrow** | 0x008D | Insert an arrow shape. | +| **msodgcidToolDoubleArrow** | 0x008E | Insert a double arrow shape. | +| **msodgcidToolArc** | 0x008F | Insert an arc shape. | +| **msodgcidToolPolygon** | 0x0090 | Insert a polygon shape. | +| **msodgcidToolFilledPolygon** | 0x0091 | Insert a filled polygon shape. | +| **msodgcidToolCurve** | 0x0092 | Insert a curve shape. | +| **msodgcidToolFreeform** | 0x0093 | Insert a freeform shape. | +| **msodgcidToolFilledFreeform** | 0x0094 | Insert a filled freeform shape. | +| **msodgcidToolFreehand** | 0x0095 | Insert a scribble shape. | +| **msodgcidToolText** | 0x0098 | Insert a text box. | +| **msodgcidToolStraightConnector** | 0x009D | Insert a straight [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape. | +| **msodgcidToolAngledConnector** | 0x009E | Insert an elbow connector shape. | +| **msodgcidToolCurvedConnector** | 0x009F | Insert a curved connector shape. | +| **msodgcidSwatchFillColorNone** | 0x00A1 | Set the fill color to no color. | +| **msodgcidSwatchFillColorStandard** | 0x00A2 | Use standard colors to fill a shape. | +| **msodgcidSwatchFillColorMRU** | 0x00A3 | Use recently used colors to fill a shape. | +| **msodgcidSwatchLineColorNone** | 0x00A4 | Set the line color to no color. | +| **msodgcidSwatchLineColorStandard** | 0x00A5 | Use standard colors for a line. | +| **msodgcidSwatchLineColorMRU** | 0x00A6 | Use recently used colors for a line. | +| **msodgcidSwatchShadowColorStandard** | 0x00A8 | Use standard colors for a shadow. | +| **msodgcidSwatchShadowColorMRU** | 0x00A9 | Use recently used colors for a shadow. | +| **msodgcidSwatch3DColorAutomatic** | 0x00AB | Use automatic colors for a 3-D shape.. | +| **msodgcidSwatch3DColorStandard** | 0x00AC | Use standard colors for a 3-D shape. | +| **msodgcidSwatch3DColorMRU** | 0x00AD | Use recently used colors for a 3-D shape. | +| **msodgcidSwatchDlgGradientFgColorStandard** | 0x00BD | Select the gradient foreground color from the standard colors. | +| **msodgcidSwatchDlgColorMRU** | 0x00C7 | Select from all recently used colors. | +| **msodgcidSplitMenuLineColor** | 0x00DF | Select from colors that were recently used for a line. | +| **msodgcidSplitMenuShadowColor** | 0x00E0 | Select from colors that were recently used for a shadow. | +| **msodgcidSplitMenu3DColor** | 0x00E1 | Select from colors that were recently used for a 3-D shape. | +| **msodgcidRerouteConnections** | 0x00E2 | Reroute the connectors. | +| **msodgcidStraightStyle** | 0x00E3 | Change the selected connector to a straight connector. | +| **msodgcidAngledStyle** | 0x00E4 | Change the selected connector to an elbow connector. | +| **msodgcidCurvedStyle** | 0x00E5 | Change the selected connector to a curved connector. | +| **msodgcidToggleFill** | 0x00E6 | Toggle the fill color on or off. | +| **msodgcidToggleLine** | 0x00E7 | Toggle the line color on or off. | +| **msodgcidToggleShadow** | 0x00E8 | Toggle the shadow on or off. | +| **msodgcidEditPicture** | 0x00EB | Edit the picture. | +| **msodgcidFormatShape** | 0x00EC | Format the shape object. | +| **msodgcidTextEffectInsert** | 0x00F0 | Show the options for stylized text objects. | +| **msodgcidTextEffectToolbarToggle** | 0x00F1 | Show the toolbar for stylized text objects. | +| **msodgcidLinePatternFill** | 0x00FD | Show the options for patterned lines. | +| **msodgcidActivateText** | 0x010A | Add text to the drawing object. | +| **msodgcidToggleShadowOpacity** | 0x010B | Set the shadow opacity. | +| **msodgcidExitReshapeMode** | 0x010C | Exit edit point mode. | +| **msodgcidToolVerticalText** | 0x010D | Insert a vertical text box. | +| **msodgcidExitRotateMode** | 0x010E | Exit rotate mode. | +| **msodgcidTogglePictureToolbar** | 0x010F | Show the picture toolbar. | +| **msodgcidSetDefaults** | 0x0110 | Set the selected shape as the default shape. | +| **msodgcidToolStraightArrowConnector** | 0x0112 | Insert a straight arrow connector shape. | +| **msodgcidToolAngledArrowConnector** | 0x0113 | Insert an elbow arrow connector shape. | +| **msodgcidToolCurvedArrowConnector** | 0x0114 | Insert a curved arrow connector shape. | +| **msodgcidToolStraightDblArrowConnector** | 0x0115 | Insert a straight double-arrow connector shape. | +| **msodgcidToolAngledDblArrowConnector** | 0x0116 | Insert an elbow double-arrow connector shape. | +| **msodgcidToolCurvedDblArrowConnector** | 0x0117 | Insert a curved double-arrow connector shape. | +| **msodgcidToolSetTransparentColor** | 0x0118 | Set the transparent color. | +| **msodgcidTextEffectGallery** | 0x0119 | Show the gallery for stylized text objects. The gallery is a series of sample images that illustrate the various stylized text objects available. Any option might be customized after it has been selected from the gallery. | +| **msodgcidShowAutoShapesAndDrawingToolbars** | 0x011A | Show the automatic shapes and drawing toolbars. | +| **msodgcidDeleteSegment** | 0x011D | Delete a line segment from a shape. | +| **msodgcidTogglePointerMode** | 0x0122 | Select objects. | +| **msodgcidInsertScript** | 0x0136 | Insert a script on the Web page. | +| **msodgcidRunCag** | 0x0139 | Open the task pane for clip art. | +| **msodgcidRunCagForPictures** | 0x013A | Insert a picture from the clip organizer. | +| **msodgcidRunCagForMovies** | 0x013B | Insert a movie from the clip organizer. | +| **msodgcidRunCagForSounds** | 0x013C | Insert a sound from the clip organizer. | +| **msodgcidRunCagForShapes** | 0x013D | Show the automatic shapes from the clip organizer. | +| **msodgcidMultiSelect** | 0x013F | Select multiple objects. | +| **msodgcidInsertDrawingCanvas** | 0x0140 | Insert a new drawing canvas. | +| **msodgcidInsertOrgChart** | 0x0141 | Insert an organizational chart [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). | +| **msodgcidInsertRadialChart** | 0x0142 | Insert a radial diagram. | +| **msodgcidInsertCycleChart** | 0x0143 | Insert a cycle diagram. | +| **msodgcidInsertStackedChart** | 0x0144 | Insert a pyramid diagram. | +| **msodgcidInsertBullsEyeChart** | 0x0145 | Insert a target diagram. | +| **msodgcidInsertVennDiagram** | 0x0146 | Insert a Venn diagram. | +| **msodgcidOrgChartInsertSubordinate** | 0x0147 | Insert a subordinate node for an organizational chart. | +| **msodgcidOrgChartInsertCoworker** | 0x0148 | Insert a coworker node for an organizational chart. | +| **msodgcidOrgChartInsertAssistant** | 0x0149 | Insert an assistant node for an organizational chart. | +| **msodgcidOrgChartDeleteNode** | 0x014A | Delete the diagram node. | +| **msodgcidOrgChartLayoutHorizontal1** | 0x014B | Set the organizational chart layout to standard. | +| **msodgcidOrgChartLayoutHorizontal2** | 0x014C | Set the organizational chart layout to both hanging. | +| **msodgcidOrgChartLayoutVertical1** | 0x014D | Set the organizational chart layout to right hanging. | +| **msodgcidOrgChartLayoutVertical2** | 0x014E | Set the organizational chart layout to left hanging. | +| **msodgcidDiagramStyle** | 0x014F | Change the diagram style. | +| **msodgcidConvertToVenn** | 0x0151 | Convert the selected diagram to a Venn diagram. | +| **msodgcidConvertToRadial** | 0x0152 | Convert the selected diagram to a radial diagram. | +| **msodgcidConvertToCycle** | 0x0153 | Convert the selected diagram to a cycle diagram. | +| **msodgcidConvertToBullsEye** | 0x0154 | Convert the selected diagram to a target diagram. | +| **msodgcidConvertToPyramid** | 0x0155 | Convert the selected diagram to a pyramid diagram. | +| **msodgcidMoveDiagramShapeUp** | 0x0156 | Move the diagram shape backward. | +| **msodgcidMoveDiagramShapeDown** | 0x0157 | Move the diagram shape forward. | +| **msodgcidInsertDiagramShape** | 0x0158 | Insert a shape into diagram. | +| **msodgcidInsertDiagram** | 0x0159 | Insert a diagram. | +| **msodgcidCanvasFit** | 0x015B | Fit the diagram to the canvas. | +| **msodgcidCanvasResize** | 0x015C | Resize the drawing canvas. | +| **msodgcidToggleCanvasToolbar** | 0x015D | Show the drawing canvas toolbar. | +| **msodgcidCanvasExpand** | 0x015F | Expand the drawing canvas. | +| **msodgcidAlignCanvasRelative** | 0x0179 | Align the diagram relative to the drawing canvas, rather than relative to the page or to other objects. | +| **msodgcidOrgChartSelectLevel** | 0x017A | Select the level inside the organizational chart. | +| **msodgcidOrgChartSelectBranch** | 0x017B | Select the branch inside the organizational chart. | +| **msodgcidOrgChartSelectAllAssistants** | 0x017C | Select all the assistants. | +| **msodgcidOrgChartSelectAllConnectors** | 0x017D | Select all the connector shapes. | +| **msodgcidDiagramDeleteNode** | 0x017E | Delete the shape from the diagram. | +| **msodgcidDiagramReverse** | 0x017F | Reverse the direction of the diagram. | +| **msodgcidDiagramAutoLayout** | 0x0180 | Set the diagram layout to automatic layout. | +| **msodgcidOrgChartAutoLayout** | 0x0181 | Set the organizational chart layout to automatic layout. | +| **msodgcidOptimizePictDialog** | 0x0187 | Show the compress pictures options. | +| **msodgcidDiagramFit** | 0x018D | Fit the diagram to its contents. | +| **msodgcidDiagramResize** | 0x018E | Resize the diagram. | +| **msodgcidDiagramExpand** | 0x018F | Expand the diagram. | +| **msodgcidOrgChartFit** | 0x0190 | Fit the organizational chart to its contents. | +| **msodgcidOrgChartResize** | 0x01F5 | Resize the organizational chart. | +| **msodgcidOrgChartExpand** | 0x01F6 | Expand the organizational chart. | +| **msodgcidOrgChartStyle** | 0x01F7 | Change the style for the organizational chart. | +| **msodgciSplitMenuOrgChartInsertShape** | 0x01F8 | Insert a shape in the organizational chart. | +| **msodgcidDiagramAutoFormat** | 0x01F9 | Use automatic formatting for the organizational chart. | +| **msodgcidCanvasScale** | 0x01FB | Scale the drawing canvas. | +| **msodgcidOrgChartScale** | 0x01FC | Scale the organizational chart. | +| **msodgcidDiagramScale** | 0x01FD | Scale the diagram. | +| **msodgcidAlignOrgChartRelative** | 0x01FF | Align the selection relative to the organizational chart it is contained in. | +| **msodgcidAlignDiagramRelative** | 0x0200 | Align the selection relative to the diagram it is contained in. | +| **msodgcidSplitMenuInkColor** | 0x0204 | Select from recently used [**ink**](#gt_9fcdd1d5-3563-49b9-8a2e-bf696fb08fd0) colors. | +| **msodgcidSplitMenuInkAnntColor** | 0x0206 | Select from recently used annotation colors. | +| **msodgcidInkStyle1** | 0x0208 | Set the ink style to Color 1. | +| **msodgcidInkStyle2** | 0x0209 | Set the ink style to Color 2. | +| **msodgcidInkStyle3** | 0x020A | Set the ink style to Color 3. | +| **msodgcidInkStyle4** | 0x020B | Set the ink style to Color 4. | +| **msodgcidInkStyle5** | 0x020C | Set the ink style to Color 5. | +| **msodgcidInkStyle6** | 0x020D | Set the ink style to Color 6. | +| **msodgcidInkStyle7** | 0x020E | Set the ink style to Color 7. | +| **msodgcidInkStyle8** | 0x020F | Set the ink style to Color 8. | +| **msodgcidInkStyle9** | 0x0210 | Set the ink style to Color 9. | +| **msodgcidInkAnnotationStyle1** | 0x0211 | Set the annotation style to Color 1. | +| **msodgcidInkAnnotationStyle2** | 0x0212 | Set the annotation style to Color 2. | +| **msodgcidInkAnnotationStyle3** | 0x0213 | Set the annotation style to Color 3. | +| **msodgcidInkAnnotationStyle4** | 0x0214 | Set the annotation style to Color 4. | +| **msodgcidInkAnnotationStyle5** | 0x0215 | Set the annotation style to Color 5. | +| **msodgcidInkAnnotationStyle6** | 0x0216 | Set the annotation style to Color 6. | +| **msodgcidInkAnnotationStyle7** | 0x0217 | Set the annotation style to Color 7. | +| **msodgcidInkAnnotationStyle8** | 0x0218 | Set the annotation style to Color 8. | +| **msodgcidInkAnnotationStyle9** | 0x0219 | Set the annotation style to Color 9. | +| **msodgcidToggleInkToolbar** | 0x021A | Show the ink drawing and writing toolbar. | +| **msodgcidToggleInkAnnotationToolbar** | 0x021B | Show the ink annotations toolbar. | +| **msodgcidClearAllInkAnnotations** | 0x021C | Delete all the ink annotations in the document. | +| **msodgcidInkDrawing** | 0x021E | Toggle the ink drawing/writing mode. | +| **msodgcidExitInkMode** | 0x0220 | Exit ink mode. | +| **msodgcidInkEraser** | 0x0221 | Use the ink eraser. | +| **msodgcidInkAnnotationEraser** | 0x0222 | Use the annotation eraser. | +| **msodgcidExitInkAnnotationMode** | 0x0223 | Exit ink annotation mode. | +| **msodgcidInkLabel1** | 0x0224 | Use the ballpoint pen for ink. | +| **msodgcidInkLabel2** | 0x0225 | Use the felt tip pen for ink. | +| **msodgcidInkLabel3** | 0x0226 | Use the highlighter pen for ink. | +| **msodgcidOrgChartFitText** | 0x0227 | Fit text inside the organizational chart. | +| **msodgcidEyedropperFillColor** | 0x0228 | Set the eyedropper fill color. | +| **msodgcidEyedropperLineColor** | 0x0229 | Set the eyedropper line color. | +| **msodgcidEyedropperShadowColor** | 0x022A | Set the eyedropper shadow color. | +| **msodgcidEyedropper3DColor** | 0x022B | Set the eyedropper 3-D color. | +| **msodgcidPictureFill** | 0x022C | Set the picture fill. | +| **msodgcidAlignSelectionRelativeSmart** | 0x022D | Align the selected objects relative to the page. | +| **msodgcidAlignContainerRelativeSmart** | 0x022E | Align all drawing objects relative to the page. | +| **msodgcidDistributeHorizontalSmart** | 0x0235 | Horizontally distribute the drawing objects. | +| **msodgcidDistributeVerticalSmart** | 0x0236 | Vertically distribute the drawing objects. | +| **msodgcidInkInsertSpace** | 0x023A | Insert a space inside the ink shape. | +| **msodgcidInkAnnotationBallpoint** | 0x0242 | Use the ballpoint pen for ink annotation. | +| **msodgcidInkAnnotationFelt** | 0x0243 | Use the felt tip pen for ink annotation. | +| **msodgcidInkAnnotationHighlighter** | 0x0244 | Use the highlighter pen for ink annotation. | +| **msodgcidMoreColorsLines** | 0x0245 | Show additional color and line options. | +| **msodgcidAlignRelativeToMarginSmart** | 0x0248 | Align the drawing objects to the nearest margin. | +| **msodgcidMoreSize** | 0x0249 | Show additional size options. | +| **msodgcidMoreInkColor** | 0x024B | Show more pen colors. | +| **msodgcidFillEffectGradient** | 0x024C | Show the gradient options. | +| **msodgcidFillEffectTexture** | 0x024D | Show the texture options. | +| **msodgcidFillEffectPattern** | 0x024E | Show the pattern options. | +| **msodgcidCloseInkTab** | 0x024F | Close the ink tools. | +| **msodgcidShapeRectangle** | 0x1001 | Insert a rectangle shape. | +| **msodgcidShapeRoundRectangle** | 0x1002 | Insert a rounded rectangle shape. | +| **msodgcidShapeEllipse** | 0x1003 | Insert an oval shape. | +| **msodgcidShapeDiamond** | 0x1004 | Insert a diamond shape. | +| **msodgcidShapeIsocelesTriangle** | 0x1005 | Insert an isosceles triangle shape. | +| **msodgcidShapeRightTriangle** | 0x1006 | Insert a right triangle shape. | +| **msodgcidShapeParallelogram** | 0x1007 | Insert a parallelogram shape. | +| **msodgcidShapeTrapezoid** | 0x1008 | Insert a trapezoid shape. | +| **msodgcidShapeHexagon** | 0x1009 | Insert a hexagon shape. | +| **msodgcidShapeOctagon** | 0x100A | Insert an octagon shape. | +| **msodgcidShapePlus** | 0x100B | Insert a cross shape. | +| **msodgcidShapeStar** | 0x100C | Insert a 5-point star shape. | +| **msodgcidShapeArrow** | 0x100D | Insert a right arrow shape. | +| **msodgcidShapeHomePlate** | 0x100F | Insert a pentagon shape. | +| **msodgcidShapeCube** | 0x1010 | Insert a cube shape. | +| **msodgcidShapeBalloon** | 0x1011 | Insert a balloon shape. | +| **msodgcidShapeArc** | 0x1013 | Insert an arc shape. | +| **msodgcidShapePlaque** | 0x1015 | Insert a plaque shape. | +| **msodgcidShapeCan** | 0x1016 | Insert a can shape. | +| **msodgcidShapeDonut** | 0x1017 | Insert a donut shape. | +| **msodgcidShapeCallout1** | 0x1029 | Insert a Line Callout 2 (no border) shape. | +| **msodgcidShapeCallout2** | 0x102A | Insert a Line Callout 3 (no border) shape. | +| **msodgcidShapeCallout3** | 0x102B | Insert a Line Callout 4 (no border) shape. | +| **msodgcidShapeAccentCallout1** | 0x102C | Insert a Line Callout 2 (accent bar) shape. | +| **msodgcidShapeAccentCallout2** | 0x102D | Insert a Line Callout 3 (accent bar) shape. | +| **msodgcidShapeAccentCallout3** | 0x102E | Insert a Line Callout 4 (accent bar) shape. | +| **msodgcidShapeBorderCallout1** | 0x102F | Insert a Line Callout 2 shape. | +| **msodgcidShapeBorderCallout2** | 0x1030 | Insert a Line Callout 3 shape. | +| **msodgcidShapeBorderCallout3** | 0x1031 | Insert a Line Callout 4 shape. | +| **msodgcidShapeAccentBorderCallout1** | 0x1032 | Insert a Line Callout 2 (border and accent bar) shape. | +| **msodgcidShapeAccentBorderCallout2** | 0x1033 | Insert a Line Callout 3 (border and accent bar) shape. | +| **msodgcidShapeAccentBorderCallout3** | 0x1034 | Insert a Line Callout 4 (border and accent bar) shape. | +| **msodgcidShapeRibbon** | 0x1035 | Insert a down ribbon shape. | +| **msodgcidShapeRibbon2** | 0x1036 | Insert an up ribbon shape. | +| **msodgcidShapeChevron** | 0x1037 | Insert a chevron shape. | +| **msodgcidShapePentagon** | 0x1038 | Insert a regular pentagon shape. | +| **msodgcidShapeNoSmoking** | 0x1039 | Insert a no symbol shape. | +| **msodgcidShapeSeal8** | 0x103A | Insert an 8-point star shape. | +| **msodgcidShapeSeal16** | 0x103B | Insert a 16-point star shape. | +| **msodgcidShapeSeal32** | 0x103C | Insert a 32-point star shape. | +| **msodgcidShapeWedgeRectCallout** | 0x103D | Insert a rectangular callout shape. | +| **msodgcidShapeWedgeRRectCallout** | 0x103E | Insert a rounded rectangular callout shape. | +| **msodgcidShapeWedgeEllipseCallout** | 0x103F | Insert an oval callout shape. | +| **msodgcidShapeWave** | 0x1040 | Insert a wave shape. | +| **msodgcidShapeFoldedCorner** | 0x1041 | Insert a folded corner shape. | +| **msodgcidShapeLeftArrow** | 0x1042 | Insert a left arrow shape. | +| **msodgcidShapeDownArrow** | 0x1043 | Insert a down arrow shape. | +| **msodgcidShapeUpArrow** | 0x1044 | Insert an up arrow shape. | +| **msodgcidShapeLeftRightArrow** | 0x1045 | Insert a left-right arrow shape. | +| **msodgcidShapeUpDownArrow** | 0x1046 | Insert an up-down arrow shape. | +| **msodgcidShapeIrregularSeal1** | 0x1047 | Insert an Explosion 1 shape. | +| **msodgcidShapeIrregularSeal2** | 0x1048 | Insert an Explosion 2 shape. | +| **msodgcidShapeLightningBolt** | 0x1049 | Insert a lightning bolt shape. | +| **msodgcidShapeHeart** | 0x104A | Insert a heart shape. | +| **msodgcidShapeQuadArrow** | 0x104C | Insert a quad arrow shape. | +| **msodgcidShapeLeftArrowCallout** | 0x104D | Insert a left-arrow callout shape. | +| **msodgcidShapeRightArrowCallout** | 0x104E | Insert a right-arrow callout shape. | +| **msodgcidShapeUpArrowCallout** | 0x104F | Insert an up-arrow callout shape. | +| **msodgcidShapeDownArrowCallout** | 0x1050 | Insert a down-arrow callout shape. | +| **msodgcidShapeLeftRightArrowCallout** | 0x1051 | Insert a left-right arrow callout shape. | +| **msodgcidShapeUpDownArrowCallout** | 0x1052 | Insert an up-down arrow callout shape. | +| **msodgcidShapeQuadArrowCallout** | 0x1053 | Insert a quad-arrow callout shape. | +| **msodgcidShapeBevel** | 0x1054 | Insert a bevel shape. | +| **msodgcidShapeLeftBracket** | 0x1055 | Insert a left bracket shape. | +| **msodgcidShapeRightBracket** | 0x1056 | Insert a right bracket shape. | +| **msodgcidShapeLeftBrace** | 0x1057 | Insert a left brace shape. | +| **msodgcidShapeRightBrace** | 0x1058 | Insert a right brace shape. | +| **msodgcidShapeLeftUpArrow** | 0x1059 | Insert a left-up arrow shape. | +| **msodgcidShapeBentUpArrow** | 0x105A | Insert a bent-up arrow shape. | +| **msodgcidShapeBentArrow** | 0x105B | Insert a bent arrow shape. | +| **msodgcidShapeSeal24** | 0x105C | Insert a 24-point star shape. | +| **msodgcidShapeStripedRightArrow** | 0x105D | Insert a striped right-arrow shape. | +| **msodgcidShapeNotchedRightArrow** | 0x105E | Insert a notched right-arrow shape. | +| **msodgcidShapeBlockArc** | 0x105F | Insert a block arc shape. | +| **msodgcidShapeSmileyFace** | 0x1060 | Insert a smiling face shape. | +| **msodgcidShapeVerticalScroll** | 0x1061 | Insert a vertical scroll shape. | +| **msodgcidShapeHorizontalScroll** | 0x1062 | Insert a horizontal scroll shape. | +| **msodgcidShapeCircularArrow** | 0x1063 | Insert a circular arrow shape. | +| **msodgcidShapeNotchedCircularArrow** | 0x1064 | Insert a reserved shape. | +| **msodgcidShapeUturnArrow** | 0x1065 | Insert a U-turn arrow shape. | +| **msodgcidShapeCurvedRightArrow** | 0x1066 | Insert a curved right-arrow shape. | +| **msodgcidShapeCurvedLeftArrow** | 0x1067 | Insert a curved left-arrow shape. | +| **msodgcidShapeCurvedUpArrow** | 0x1068 | Insert a curved up-arrow shape. | +| **msodgcidShapeCurvedDownArrow** | 0x1069 | Insert a curved down-arrow shape. | +| **msodgcidShapeCloudCallout** | 0x106A | Insert a cloud callout shape. | +| **msodgcidShapeEllipseRibbon** | 0x106B | Insert a curved-down ribbon shape. | +| **msodgcidShapeEllipseRibbon2** | 0x106C | Insert a curved-up ribbon shape. | +| **msodgcidShapeFlowChartProcess** | 0x106D | Insert a flowchart process shape. | +| **msodgcidShapeFlowChartDecision** | 0x106E | Insert a flowchart decision shape. | +| **msodgcidShapeFlowChartInputOutput** | 0x106F | Insert a flowchart data shape. | +| **msodgcidShapeFlowChartPredefinedProcess** | 0x1070 | Insert a flowchart predefined-process shape. | +| **msodgcidShapeFlowChartInternalStorage** | 0x1071 | Insert a flowchart internal-storage shape. | +| **msodgcidShapeFlowChartDocument** | 0x1072 | Insert a flowchart document shape. | +| **msodgcidShapeFlowChartMultidocument** | 0x1073 | Insert a flowchart multiple-document shape. | +| **msodgcidShapeFlowChartTerminator** | 0x1074 | Insert a flowchart terminator shape. | +| **msodgcidShapeFlowChartPreparation** | 0x1075 | Insert a flowchart preparation shape. | +| **msodgcidShapeFlowChartManualInput** | 0x1076 | Insert a flowchart manual-input shape. | +| **msodgcidShapeFlowChartManualOperation** | 0x1077 | Insert a flowchart manual-operation shape. | +| **msodgcidShapeFlowChartConnector** | 0x1078 | Insert a flowchart connector shape. | +| **msodgcidShapeFlowChartPunchedCard** | 0x1079 | Insert a flowchart card shape. | +| **msodgcidShapeFlowChartPunchedTape** | 0x107A | Insert a flowchart punched-tape shape. | +| **msodgcidShapeFlowChartSummingJunction** | 0x107B | Insert a flowchart summing-junction shape. | +| **msodgcidShapeFlowChartOr** | 0x107C | Insert a flowchart OR shape. | +| **msodgcidShapeFlowChartCollate** | 0x107D | Insert a flowchart collate shape. | +| **msodgcidShapeFlowChartSort** | 0x107E | Insert a flowchart sort shape. | +| **msodgcidShapeFlowChartExtract** | 0x107F | Insert a flowchart extract shape. | +| **msodgcidShapeFlowChartMerge** | 0x1080 | Insert a flowchart merge shape. | +| **msodgcidShapeFlowChartOfflineStorage** | 0x1081 | Insert a flowchart offline-storage shape. | +| **msodgcidShapeFlowChartOnlineStorage** | 0x1082 | Insert a flowchart stored-data shape. | +| **msodgcidShapeFlowChartMagneticTape** | 0x1083 | Insert a flowchart sequential-access storage shape. | +| **msodgcidShapeFlowChartMagneticDisk** | 0x1084 | Insert a flowchart magnetic-disk shape. | +| **msodgcidShapeFlowChartMagneticDrum** | 0x1085 | Insert a flowchart direct-access storage shape. | +| **msodgcidShapeFlowChartDisplay** | 0x1086 | Insert a flowchart display shape. | +| **msodgcidShapeFlowChartDelay** | 0x1087 | Insert a flowchart delay shape. | +| **msodgcidShapeFlowChartAlternateProcess** | 0x10B0 | Insert a flowchart alternate-process shape. | +| **msodgcidShapeFlowChartOffpageConnector** | 0x10B1 | Insert a flowchart off-page connector shape. | +| **msodgcidShapeCallout90** | 0x10B2 | Insert a Line Callout 1 (no border) shape. | +| **msodgcidShapeAccentCallout90** | 0x10B3 | Insert a Line Callout 1 (accent bar) shape. | +| **msodgcidShapeBorderCallout90** | 0x10B4 | Insert a Line Callout 1 shape. | +| **msodgcidShapeAccentBorderCallout90** | 0x10B5 | Insert a Line Callout 1 (border and accent bar) shape. | +| **msodgcidShapeLeftRightUpArrow** | 0x10B6 | Insert a left-right-up arrow shape. | +| **msodgcidShapeSun** | 0x10B7 | Insert a sun shape. | +| **msodgcidShapeMoon** | 0x10B8 | Insert a moon shape. | +| **msodgcidShapeBracketPair** | 0x10B9 | Insert a double bracket shape. | +| **msodgcidShapeBracePair** | 0x10BA | Insert a double brace shape. | +| **msodgcidShapeSeal4** | 0x10BB | Insert a 4-point star shape. | +| **msodgcidShapeDoubleWave** | 0x10BC | Insert a double wave shape. | +| **msodgcidShapeMinusSign** | 0x10CC | Insert a minus sign shape. | +| **msodgcidShapeMultiplySign** | 0x10CD | Insert a multiply sign shape. | +| **msodgcidShapeDivisionSign** | 0x10CE | Insert a division sign shape. | +| **msodgcidShapeEqualSign** | 0x10CF | Insert an equal sign shape. | +| **msodgcidShapeNotEqualSign** | 0x10D0 | Insert a not-equal sign shape. | +| **msodgcidShapeSnipSingleCornerRectangle** | 0x10D1 | Insert a rectangle shape which has a single snipped corner. | +| **msodgcidShapeSnipSameSideCornerRectangle** | 0x10D2 | Insert a rectangle shape which has two snipped corners on the same side. | +| **msodgcidShapeSnipDiagonalCornerRectangle** | 0x10D3 | Insert a rectangle shape which has two snipped corners diagonally across from one another. | +| **msodgcidShapeSnipRoundSingleCornerRectangle** | 0x10D4 | Insert a rectangle shape which has one rounded and one snipped corner on the same side. | +| **msodgcidShapeRoundSingleCornerRectangle** | 0x10D5 | Insert a rectangle shape which has a single rounded corner. | +| **msodgcidShapeRoundSameSideCornerRectangle** | 0x10D6 | Insert a rectangle shape which has two rounded corners on the same side. | +| **msodgcidShapeRoundDiagonalCornerRectangle** | 0x10D7 | Insert a rectangle shape which has two rounded corners diagonally across from one another. | +| **msodgcidShapeDecagon** | 0x10D8 | Insert a decagon shape. | +| **msodgcidShapeDodecagon** | 0x10D9 | Insert a dodecagon shape. | +| **msodgcidShapeDiagonalStripe** | 0x10DA | Insert a diagonal stripe shape. | +| **msodgcidShapeTearDrop** | 0x10DB | Insert a teardrop shape. | +| **msodgcidShapeChord** | 0x10DC | Insert a chord shape. | +| **msodgcidShapeHeptagon** | 0x10DD | Insert a heptagon shape. | +| **msodgcidShapeFrame** | 0x10DE | Insert a frame shape. | +| **msodgcidShapeHalfFrame** | 0x10DF | Insert a half-frame shape. | +| **msodgcidShapePie** | 0x10E0 | Insert a pie shape. | +| **msodgcidShapeLShape** | 0x10E1 | Insert an L-shape shape. | +| **msodgcidShape6PointStar** | 0x10E2 | Insert a 6-point star shape. | +| **msodgcidShape7PointStar** | 0x10E3 | Insert a 7-point star shape. | +| **msodgcidShape10PointStar** | 0x10E4 | Insert a 10-point star shape. | +| **msodgcidShape12PointStar** | 0x10E5 | Insert a 12-point star shape. | +| **msodgcidShapeCloud** | 0x10E6 | Insert a cloud shape. | +| **msodgcidChangeShapeRectangle** | 0x2001 | Change the selected shape to a rectangle shape. | +| **msodgcidChangeShapeRoundRectangle** | 0x2002 | Change the selected shape to a rounded rectangle shape. | +| **msodgcidChangeShapeEllipse** | 0x2003 | Change the selected shape to an oval shape. | +| **msodgcidChangeShapeDiamond** | 0x2004 | Change the selected shape to a diamond shape. | +| **msodgcidChangeShapeIsocelesTriangle** | 0x2005 | Change the selected shape to an isosceles triangle shape. | +| **msodgcidChangeShapeRightTriangle** | 0x2006 | Change the selected shape to a right triangle shape. | +| **msodgcidChangeShapeParallelogram** | 0x2007 | Change the selected shape to a parallelogram shape. | +| **msodgcidChangeShapeTrapezoid** | 0x2008 | Change the selected shape to a trapezoid shape. | +| **msodgcidChangeShapeHexagon** | 0x2009 | Change the selected shape to a hexagon shape. | +| **msodgcidChangeShapeOctagon** | 0x200A | Change the selected shape to an octagon shape. | +| **msodgcidChangeShapePlus** | 0x200B | Change the selected shape to a cross shape. | +| **msodgcidChangeShapeStar** | 0x200C | Change the selected shape to a 5-point star shape. | +| **msodgcidChangeShapeArrow** | 0x200D | Change the selected shape to a right arrow shape. | +| **msodgcidChangeShapeHomePlate** | 0x200F | Change the selected shape to a pentagon shape. | +| **msodgcidChangeShapeCube** | 0x2010 | Change the selected shape to a cube shape. | +| **msodgcidChangeShapeArc** | 0x2013 | Change the selected shape to an arc shape. | +| **msodgcidChangeShapePlaque** | 0x2015 | Change the selected shape to a plaque shape. | +| **msodgcidChangeShapeCan** | 0x2016 | Change the selected shape to a can shape. | +| **msodgcidChangeShapeDonut** | 0x2017 | Change the selected shape to a donut shape. | +| **msodgcidChangeShapeCallout1** | 0x2029 | Change the selected shape to a Line Callout 2 (no border) shape. | +| **msodgcidChangeShapeCallout2** | 0x202A | Change the selected shape to a Line Callout 3 (no border) shape. | +| **msodgcidChangeShapeCallout3** | 0x202B | Change the selected shape to a Line Callout 4 (no border) shape. | +| **msodgcidChangeShapeAccentCallout1** | 0x202C | Change the selected shape to a Line Callout 2 (accent bar) shape. | +| **msodgcidChangeShapeAccentCallout2** | 0x202D | Change the selected shape to a Line Callout 3 (accent bar) shape. | +| **msodgcidChangeShapeAccentCallout3** | 0x202E | Change the selected shape to a Line Callout 4 (accent bar) shape. | +| **msodgcidChangeShapeBorderCallout1** | 0x202F | Change the selected shape to a Line Callout 2 shape. | +| **msodgcidChangeShapeBorderCallout2** | 0x2030 | Change the selected shape to a Line Callout 3 shape. | +| **msodgcidChangeShapeBorderCallout3** | 0x2031 | Change the selected shape to a Line Callout 4 shape. | +| **msodgcidChangeShapeAccentBorderCallout1** | 0x2032 | Change the selected shape to a Line Callout 2 (border and accent bar) shape. | +| **msodgcidChangeShapeAccentBorderCallout2** | 0x2033 | Change the selected shape to a Line Callout 3 (border and accent bar) shape. | +| **msodgcidChangeShapeAccentBorderCallout3** | 0x2034 | Change the selected shape to a Line Callout 4 (border and accent bar) shape. | +| **msodgcidChangeShapeRibbon** | 0x2035 | Change the selected shape to a down ribbon shape. | +| **msodgcidChangeShapeRibbon2** | 0x2036 | Change the selected shape to an up ribbon shape. | +| **msodgcidChangeShapeChevron** | 0x2037 | Change the selected shape to a chevron shape. | +| **msodgcidChangeShapePentagon** | 0x2038 | Change the selected shape to a regular pentagon shape. | +| **msodgcidChangeShapeNoSmoking** | 0x2039 | Change the selected shape to a no symbol shape. | +| **msodgcidChangeShapeSeal8** | 0x203A | Change the selected shape to an 8-point star shape. | +| **msodgcidChangeShapeSeal16** | 0x203B | Change the selected shape to a 16-point star shape. | +| **msodgcidChangeShapeSeal32** | 0x203C | Change the selected shape to a 32-point star shape. | +| **msodgcidChangeShapeWedgeRectCallout** | 0x203D | Change the selected shape to a rectangular callout shape. | +| **msodgcidChangeShapeWedgeRRectCallout** | 0x203E | Change the selected shape to a rounded-rectangular callout shape. | +| **msodgcidChangeShapeWedgeEllipseCallout** | 0x203F | Change the selected shape to an oval callout shape. | +| **msodgcidChangeShapeWave** | 0x2040 | Change the selected shape to a wave shape. | +| **msodgcidChangeShapeFoldedCorner** | 0x2041 | Change the selected shape to a folded corner shape. | +| **msodgcidChangeShapeLeftArrow** | 0x2042 | Change the selected shape to a left arrow shape. | +| **msodgcidChangeShapeDownArrow** | 0x2043 | Change the selected shape to a down arrow shape. | +| **msodgcidChangeShapeUpArrow** | 0x2044 | Change the selected shape to an up arrow shape. | +| **msodgcidChangeShapeLeftRightArrow** | 0x2045 | Change the selected shape to a left-right arrow shape. | +| **msodgcidChangeShapeUpDownArrow** | 0x2046 | Change the selected shape to an up-down arrow shape. | +| **msodgcidChangeShapeIrregularSeal1** | 0x2047 | Change the selected shape to an Explosion 1 shape. | +| **msodgcidChangeShapeIrregularSeal2** | 0x2048 | Change the selected shape to an Explosion 2 shape. | +| **msodgcidChangeShapeLightningBolt** | 0x2049 | Change the selected shape to lightning bolt shape. | +| **msodgcidChangeShapeHeart** | 0x204A | Change the selected shape to a heart shape. | +| **msodgcidChangeShapeQuadArrow** | 0x204C | Change the selected shape to a quad arrow shape. | +| **msodgcidChangeShapeLeftArrowCallout** | 0x204D | Change the selected shape to a left-arrow callout shape. | +| **msodgcidChangeShapeRightArrowCallout** | 0x204E | Change the selected shape to a right-arrow callout shape. | +| **msodgcidChangeShapeUpArrowCallout** | 0x204F | Change the selected shape to an up-arrow callout shape. | +| **msodgcidChangeShapeDownArrowCallout** | 0x2050 | Change the selected shape to a down-arrow callout shape. | +| **msodgcidChangeShapeLeftRightArrowCallout** | 0x2051 | Change the selected shape to a left-right arrow callout shape. | +| **msodgcidChangeShapeUpDownArrowCallout** | 0x2052 | Change the selected shape to an up-down arrow callout shape. | +| **msodgcidChangeShapeQuadArrowCallout** | 0x2053 | Change the selected shape to a quad-arrow callout shape. | +| **msodgcidChangeShapeBevel** | 0x2054 | Change the selected shape to a bevel shape. | +| **msodgcidChangeShapeLeftBracket** | 0x2055 | Change the selected shape to a left bracket shape. | +| **msodgcidChangeShapeRightBracket** | 0x2056 | Change the selected shape to a right bracket shape. | +| **msodgcidChangeShapeLeftBrace** | 0x2057 | Change the selected shape to a left brace shape. | +| **msodgcidChangeShapeRightBrace** | 0x2058 | Change the selected shape to a right brace shape. | +| **msodgcidChangeShapeLeftUpArrow** | 0x2059 | Change the selected shape to a left-up arrow shape. | +| **msodgcidChangeShapeBentUpArrow** | 0x205A | Change the selected shape to a bent-up arrow shape. | +| **msodgcidChangeShapeBentArrow** | 0x205B | Change the selected shape to a bent arrow shape. | +| **msodgcidChangeShapeSeal24** | 0x205C | Change the selected shape to a 24-point star shape. | +| **msodgcidChangeShapeStripedRightArrow** | 0x205D | Change the selected shape to a striped right-arrow shape. | +| **msodgcidChangeShapeNotchedRightArrow** | 0x205E | Change the selected shape to a notched right-arrow shape. | +| **msodgcidChangeShapeBlockArc** | 0x205F | Change the selected shape to a block arc shape. | +| **msodgcidChangeShapeSmileyFace** | 0x2060 | Change the selected shape to a smiling face shape. | +| **msodgcidChangeShapeVerticalScroll** | 0x2061 | Change the selected shape to a vertical scroll shape. | +| **msodgcidChangeShapeHorizontalScroll** | 0x2062 | Change the selected shape to a horizontal scroll shape. | +| **msodgcidChangeShapeCircularArrow** | 0x2063 | Change the selected shape to a circular arrow shape. | +| **msodgcidChangeShapeUturnArrow** | 0x2065 | Change the selected shape to a U-turn arrow shape. | +| **msodgcidChangeShapeCurvedRightArrow** | 0x2066 | Change the selected shape to a curved right-arrow shape. | +| **msodgcidChangeShapeCurvedLeftArrow** | 0x2067 | Change the selected shape to a curved left-arrow shape. | +| **msodgcidChangeShapeCurvedUpArrow** | 0x2068 | Change the selected shape to a curved up-arrow shape. | +| **msodgcidChangeShapeCurvedDownArrow** | 0x2069 | Change the selected shape to a curved down-arrow shape. | +| **msodgcidChangeShapeCloudCallout** | 0x206A | Change the selected shape to a cloud callout shape. | +| **msodgcidChangeShapeEllipseRibbon** | 0x206B | Change the selected shape to a curved-down ribbon shape. | +| **msodgcidChangeShapeEllipseRibbon2** | 0x206C | Change the selected shape to a curved-up ribbon shape. | +| **msodgcidChangeShapeFlowChartProcess** | 0x206D | Change the selected shape to a flowchart process shape. | +| **msodgcidChangeShapeFlowChartDecision** | 0x206E | Change the selected shape to a flowchart decision shape. | +| **msodgcidChangeShapeFlowChartInputOutput** | 0x206F | Change the selected shape to a flowchart data shape. | +| **msodgcidChangeShapeFlowChartPredefinedProcess** | 0x2070 | Change the selected shape to a flowchart predefined-process shape. | +| **msodgcidChangeShapeFlowChartInternalStorage** | 0x2071 | Change the selected shape to a flowchart internal-storage shape. | +| **msodgcidChangeShapeFlowChartDocument** | 0x2072 | Change the selected shape to a flowchart document shape. | +| **msodgcidChangeShapeFlowChartMultidocument** | 0x2073 | Change the selected shape to a flowchart multiple-document shape. | +| **msodgcidChangeShapeFlowChartTerminator** | 0x2074 | Change the selected shape to a flowchart terminator shape. | +| **msodgcidChangeShapeFlowChartPreparation** | 0x2075 | Change the selected shape to a flowchart preparation shape. | +| **msodgcidChangeShapeFlowChartManualInput** | 0x2076 | Change the selected shape to a flowchart manual-input shape. | +| **msodgcidChangeShapeFlowChartManualOperation** | 0x2077 | Change the selected shape to a flowchart manual-operation shape. | +| **msodgcidChangeShapeFlowChartConnector** | 0x2078 | Change the selected shape to a flowchart connector shape. | +| **msodgcidChangeShapeFlowChartPunchedCard** | 0x2079 | Change the selected shape to a flowchart card shape. | +| **msodgcidChangeShapeFlowChartPunchedTape** | 0x207A | Change the selected shape to a flowchart punched-tape shape. | +| **msodgcidChangeShapeFlowChartSummingJunction** | 0x207B | Change the selected shape to a flowchart summing-junction shape. | +| **msodgcidChangeShapeFlowChartOr** | 0x207C | Change the selected shape to a flowchart OR shape. | +| **msodgcidChangeShapeFlowChartCollate** | 0x207D | Change the selected shape to a flowchart collate shape. | +| **msodgcidChangeShapeFlowChartSort** | 0x207E | Change the selected shape to a flowchart sort shape. | +| **msodgcidChangeShapeFlowChartExtract** | 0x207F | Change the selected shape to a flowchart extract shape. | +| **msodgcidChangeShapeFlowChartMerge** | 0x2080 | Change the selected shape to a flowchart merge shape. | +| **msodgcidChangeShapeFlowChartOnlineStorage** | 0x2082 | Change the selected shape to a flowchart stored-data shape. | +| **msodgcidChangeShapeFlowChartMagneticTape** | 0x2083 | Change the selected shape to a flowchart sequential-access storage shape. | +| **msodgcidChangeShapeFlowChartMagneticDisk** | 0x2084 | Change the selected shape to a flowchart magnetic-disk shape. | +| **msodgcidChangeShapeFlowChartMagneticDrum** | 0x2085 | Change the selected shape to a flowchart direct-access storage shape. | +| **msodgcidChangeShapeFlowChartDisplay** | 0x2086 | Change the selected shape to a flowchart display shape. | +| **msodgcidChangeShapeFlowChartDelay** | 0x2087 | Change the selected shape to a flowchart delay shape. | +| **msodgcidChangeShapeFlowChartAlternateProcess** | 0x20B0 | Change the selected shape to a flowchart alternate-process shape. | +| **msodgcidChangeShapeFlowChartOffpageConnector** | 0x20B1 | Change the selected shape to a flowchart off-page connector shape. | +| **msodgcidChangeShapeCallout90** | 0x20B2 | Change the selected shape to a Line Callout 1 (no border) shape. | +| **msodgcidChangeShapeAccentCallout90** | 0x20B3 | Change the selected shape to a Line Callout 1 (accent bar) shape. | +| **msodgcidChangeShapeBorderCallout90** | 0x20B4 | Change the selected shape to a Line Callout 1 shape. | +| **msodgcidChangeShapeAccentBorderCallout90** | 0x20B5 | Change the selected shape to a Line Callout 1 (border and accent bar) shape. | +| **msodgcidChangeShapeLeftRightUpArrow** | 0x20B6 | Change the selected shape to a left-right-up arrow shape. | +| **msodgcidChangeShapeSun** | 0x20B7 | Change the selected shape to a sun shape. | +| **msodgcidChangeShapeMoon** | 0x20B8 | Change the selected shape to a moon shape. | +| **msodgcidChangeShapeBracketPair** | 0x20B9 | Change the selected shape to a double bracket shape. | +| **msodgcidChangeShapeBracePair** | 0x20BA | Change the selected shape to a double brace shape. | +| **msodgcidChangeShapeSeal4** | 0x20BB | Change the selected shape to a 4-point star shape. | +| **msodgcidChangeShapeDoubleWave** | 0x20BC | Change the selected shape to a double wave shape. | + +### MSOWRAPMODE + +*Referenced by: [WrapText](#wraptext)* + +The **MSOWRAPMODE** enumeration, as shown in the following table, specifies the wrapping [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) for a body of text. + +| Name | Value | Meaning | +|----|----|----| +| **msowrapSquare** | 0x00000000 | Specifies that a line of text will continue on subsequent lines instead of extending into or beyond a margin. This value MAY[\<100\>](#Appendix_A_100) be used. | +| **msowrapByPoints** | 0x00000001 | Specifies a wrapping rule that is equivalent to that of **msowrapSquare**. This value MAY[\<101\>](#Appendix_A_101) be used. | +| **msowrapNone** | 0x00000002 | Specifies that a line of text will extend into or beyond a margin instead of continuing on subsequent lines. This value SHOULD[\<102\>](#Appendix_A_102) be used. | +| **msowrapTopBottom** | 0x00000003 | Specifies a wrapping rule that is undefined and MUST be ignored. | +| **msowrapThrough** | 0x00000004 | Specifies a wrapping rule that is undefined and MUST be ignored. | + +### MSOANCHOR + +*Referenced by: [anchorText](#anchortext)* + +The **MSOANCHOR** enumeration, as shown in the following table, specifies the suggested placement [**rule**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) for a body of text. These enumeration values are relative to the orientation, text box area, and margin sizes of the containing [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The exact placement of the text is application dependent and varies to accommodate other languages and text properties. These enumeration values MAY[\<103\>](#Appendix_A_103) be used. + +[TABLE] + +### MSOTXFL + +*Referenced by: [txflTextFlow](#txfltextflow)* + +The **MSOTXFL** enumeration, as shown in the following table, specifies the text flow [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) for a body of text. These rules encompass the rotation of individual character glyphs, the relational positioning of a sequence of character glyphs, and the relational positioning of a sequence of lines of text. The descriptions in the table use spatial direction terminology that is relative to the container of the body of text. The exact placement of the text is application dependent and varies to accommodate other languages and text properties. + +[TABLE] + +### MSOCDIR + +*Referenced by: [cdirFont](#cdirfont)* + +The **MSOCDIR** enumeration, as shown in the following table, specifies a rotation. Rotation begins horizontally to the right and proceeds in a clockwise direction, completing a full rotation at 360 degrees. + +| Name | Value | Meaning | +|----|----|----| +| **msocdir0** | 0x00000000 | Specifies either no rotation or a direction that is horizontally to the right. | +| **msocdir90** | 0x00000001 | Specifies either a 90-degree rotation or a direction that is vertically down. | +| **msocdir180** | 0x00000002 | Specifies either a 180-degree rotation or a direction that is horizontally to the left. | +| **msocdir270** | 0x00000003 | Specifies either a 270-degree rotation or a direction that is vertically up. | + +### MSOTXDIR + +*Referenced by: [txdir](#txdir)* + +The **MSOTXDIR** enumeration, which is used for bidirectional text, specifies the direction of a [**text run**](#gt_393612a7-9552-48b0-abf6-0371dbd6d553). + +| Name | Value | Meaning | +|----|----|----| +| **msotxdirLTR** | 0x00000000 | Specifies that the text is read from left to right.[\<114\>](#Appendix_A_114) | +| **msotxdirRTL** | 0x00000001 | Specifies that the text is read from right to left.[\<115\>](#Appendix_A_115) | +| **msotxdirContext** | 0x00000002 | Specifies that the direction is determined from the text string. If no associated text string exists, the text SHOULD be read from left to right. | + +### MSOBLIPFLAGS + +*Referenced by: [fillBlipFlags](#fillblipflags), [lineBottomFillBlipFlags](#linebottomfillblipflags), [lineFillBlipFlags](#linefillblipflags), [lineLeftFillBlipFlags](#lineleftfillblipflags), [lineRightFillBlipFlags](#linerightfillblipflags), [lineTopFillBlipFlags](#linetopfillblipflags), [pibFlags](#pibflags), [pibPrintFlags](#pibprintflags)* + +The **MSOBLIPFLAGS** enumeration, as shown in the following table, specifies a set of flags that are used by the [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) properties. The enumeration values can be combined, except where prohibited as indicated in the table. + +| Name | Value | Meaning | +|----|----|----| +| **msoblipflagComment** | 0x00000000 | Specifies that the name in the property set designates a comment. This value, **msoblipflagFile**, and **msoblipflagURL** are mutually exclusive. | +| **msoblipflagFile** | 0x00000001 | Specifies that the name in the property set designates a file name. This value, **msoblipflagComment**, and **msoblipflagURL** are mutually exclusive. | +| **msoblipflagURL** | 0x00000002 | Specifies that the name in the property set designates a [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1). This value, **msoblipflagComment**, and **msoblipflagFile** are mutually exclusive. | +| **msoblipflagDoNotSave** | 0x00000004 | Specifies that the BLIP data MUST NOT be embedded on save. If this flag is set, **msoblipflagLinkToFile** MUST also be set. | +| **msoblipflagLinkToFile** | 0x00000008 | Specifies that the BLIP data is linked in the specified URL. If this flag is set, either **msoblipflagFile** or **msoblipflagURL** MUST also be set. | + +### MSOSHAPEPATH + +*Referenced by: [shapePath](#shapepath)* + +The **MSOSHAPEPATH** enumeration, as shown in the following table, specifies how all of the vertices along the path of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) are connected by lines. + +| Name | Value | Meaning | +|----|----|----| +| **msoshapeLines** | 0x00000000 | An open path of straight line segments. | +| **msoshapeLinesClosed** | 0x00000001 | A closed path of straight line segments. | +| **msoshapeCurves** | 0x00000002 | An open path of Bezier curve line segments. | +| **msoshapeCurvesClosed** | 0x00000003 | A closed path of Bezier curve line segments. | +| **msoshapeComplex** | 0x00000004 | A complex path composed of a combination of multiple types of lines. The **pSegmentInfo_complex** property, as defined in section [2.3.6.9](#psegmentinfo_complex), of this shape specifies the types of lines that form the path, and that property MUST exist. | + +### MSOCXK + +*Referenced by: [cxk](#cxk)* + +The **MSOCXK** enumeration, as shown in the following table, specifies the types of [**connection points**](#gt_ecd96915-cfc0-404e-a2b2-96f02736e07d). + +| Name | Value | Meaning | +|----|----|----| +| **msocxkNone** | 0x00000000 | No connection points exist. | +| **msocxkSegments** | 0x00000001 | The [**edit points**](#gt_d477c1f2-8ca7-49ba-817a-e503553ab555) of the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) are used as connection points. | +| **msocxkCustom** | 0x00000002 | A custom array of connection points is used. | +| **msocxkRect** | 0x00000003 | The standard four connection points at the midpoints of the top, bottom, left, and right sides are used. | + +### MSOFILLTYPE + +*Referenced by: [fillType](#filltype)* + +The **MSOFILLTYPE** enumeration, as shown in the following table, specifies the fill types. + +[TABLE] + +### MSODZTYPE + +*Referenced by: [fillDztype](#filldztype), [lineBottomFillDztype](#linebottomfilldztype), [lineFillDztype](#linefilldztype), [lineLeftFillDztype](#lineleftfilldztype), [lineRightFillDztype](#linerightfilldztype), [lineTopFillDztype](#linetopfilldztype)* + +The **MSODZTYPE** enumeration, as shown in the following table, specifies the units for measuring length and how drawing parameters will be interpreted. + +| Name | Value | Meaning | +|----|----|----| +| **msodztypeDefault** | 0x00000000 | The width and height are ignored, and the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) dimensions are used. | +| **msodztypeA** | 0x00000001 | Values are in **[EMUs](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39).** | +| **msodztypeV** | 0x00000002 | Values are in pixels. | +| **msodztypeShape** | 0x00000003 | Values are of type **FixedPoint**, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.2.1.6, and specify fractions of a shape dimension. | +| **msodztypeFixedAspect** | 0x00000004 | The aspect ratio of the shape is maintained. The width and height are ignored, and the shape dimensions are used. | +| **msodztypeAFixed** | 0x00000005 | Values are in EMUs. The aspect ratio of the shape is maintained. | +| **msodztypeVFixed** | 0x00000006 | Values are in pixels. The aspect ratio of the shape is maintained. | +| **msodztypeShapeFixed** | 0x00000007 | Values are proportional to the size of the shape. The aspect ratio of the shape is maintained. | +| **msodztypeFixedAspectEnlarge** | 0x00000008 | The aspect ratio is maintained, favoring the largest dimension. | +| **msodztypeAFixedBig** | 0x00000009 | Values are in EMUs. The aspect ratio is maintained, favoring the largest dimension. | +| **msodztypeVFixedBig** | 0x0000000A | Values are in pixels. The aspect ratio is maintained, favoring the largest dimension. | +| **msodztypeShapeFixedBig** | 0x0000000B | Values are proportional to the size of the shape. The aspect ratio is maintained, favoring the largest dimension. | + +### MSOLINETYPE + +*Referenced by: [lineBottomType](#linebottomtype), [lineLeftType](#linelefttype), [lineRightType](#linerighttype), [lineTopType](#linetoptype), [lineType](#linetype)* + +The **MSOLINETYPE** enumeration, as shown in the following table, specifies the fill properties for a line. + +[TABLE] + +### MSOLINESTYLE + +*Referenced by: [lineBottomStyle](#linebottomstyle), [lineLeftStyle](#lineleftstyle), [lineRightStyle](#linerightstyle), [lineStyle](#linestyle), [lineTopStyle](#linetopstyle)* + +The **MSOLINESTYLE** enumeration, as shown in the following table, specifies the type of line style that will be used. + +[TABLE] + +### MSOLINEDASHING + +*Referenced by: [lineBottomDashing](#linebottomdashing), [lineDashing](#linedashing), [lineLeftDashing](#lineleftdashing), [lineRightDashing](#linerightdashing), [lineTopDashing](#linetopdashing)* + +The **MSOLINEDASHING** enumeration, as shown in the following table, specifies preset dashed-line values. Each style corresponds to a precise binary representation of the repeating dash style. Each 1 corresponds to a line segment, and each 0 corresponds to a space. + +[TABLE] + +### MSOLINEEND + +*Referenced by: [lineBottomEndArrowhead](#linebottomendarrowhead), [lineBottomStartArrowhead](#linebottomstartarrowhead), [lineEndArrowhead](#lineendarrowhead), [lineLeftEndArrowhead](#lineleftendarrowhead), [lineLeftStartArrowhead](#lineleftstartarrowhead), [lineRightEndArrowhead](#linerightendarrowhead), [lineRightStartArrowhead](#linerightstartarrowhead), [lineStartArrowhead](#linestartarrowhead), [lineTopEndArrowhead](#linetopendarrowhead), [lineTopStartArrowhead](#linetopstartarrowhead)* + +The **MSOLINEEND** enumeration, as shown in the following table, specifies the [**line end decorations**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that appear at the ends of lines. + +[TABLE] + +### MSOLINEENDWIDTH + +*Referenced by: [lineBottomEndArrowWidth](#linebottomendarrowwidth), [lineBottomStartArrowWidth](#linebottomstartarrowwidth), [lineEndArrowWidth](#lineendarrowwidth), [lineLeftEndArrowWidth](#lineleftendarrowwidth), [lineLeftStartArrowWidth](#lineleftstartarrowwidth), [lineRightEndArrowWidth](#linerightendarrowwidth), [lineRightStartArrowWidth](#linerightstartarrowwidth), [lineStartArrowWidth](#linestartarrowwidth), [lineTopEndArrowWidth](#linetopendarrowwidth), [lineTopStartArrowWidth](#linetopstartarrowwidth)* + +The **MSOLINEENDWIDTH** enumeration, as shown in the following table, specifies widths of [**line end decorations**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) that are relative to the widths of the lines themselves. + +[TABLE] + +### MSOLINEENDLENGTH + +*Referenced by: [lineBottomEndArrowLength](#linebottomendarrowlength), [lineBottomStartArrowLength](#linebottomstartarrowlength), [lineEndArrowLength](#lineendarrowlength), [lineLeftEndArrowLength](#lineleftendarrowlength), [lineLeftStartArrowLength](#lineleftstartarrowlength), [lineRightEndArrowLength](#linerightendarrowlength), [lineRightStartArrowLength](#linerightstartarrowlength), [lineStartArrowLength](#linestartarrowlength), [lineTopEndArrowLength](#linetopendarrowlength), [lineTopStartArrowLength](#linetopstartarrowlength)* + +The **MSOLINEENDLENGTH** enumeration, as shown in the following table, specifies lengths of [**line end decorations**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab). + +[TABLE] + +### MSOLINEJOIN + +*Referenced by: [lineBottomJoinStyle](#linebottomjoinstyle), [lineJoinStyle](#linejoinstyle), [lineLeftJoinStyle](#lineleftjoinstyle), [lineRightJoinStyle](#linerightjoinstyle), [lineTopJoinStyle](#linetopjoinstyle)* + +The **MSOLINEJOIN** enumeration, as shown in the following table, specifies the types of [**join styles**](#gt_5caf9b0d-367e-40da-96ea-b6d6e86337eb) that can be applied to lines in the document. + +[TABLE] + +### MSOLINECAP + +*Referenced by: [lineBottomEndCapStyle](#linebottomendcapstyle), [lineEndCapStyle](#lineendcapstyle), [lineLeftEndCapStyle](#lineleftendcapstyle), [lineRightEndCapStyle](#linerightendcapstyle), [lineTopEndCapStyle](#linetopendcapstyle)* + +The **MSOLINECAP** enumeration, as shown in the following table, specifies ways to cap the ends of lines in the document. + +[TABLE] + +### MSOSHADOWTYPE + +*Referenced by: [shadowType](#shadowtype)* + +The **MSOSHADOWTYPE** enumeration, as shown in the following table, specifies how to display shadows that are applied to a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +[TABLE] + +### MSOXFORMTYPE + +*Referenced by: [perspectiveType](#perspectivetype)* + +The **MSOXFORMTYPE** enumeration, as shown in the following table, specifies the ways that a [**perspective transform**](#gt_35fdcdca-8f6a-4f9d-8113-9f474a9285d7) SHOULD be applied. + +| Name | Value | Meaning | +|----|----|----| +| **msoxformAbsolute** | 0x00000000 | The perspective transform is applied in [**absolute space**](#gt_7684e2eb-af09-40e0-89ff-5eb118a210b5), centered on the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). | +| **msoxformShape** | 0x00000001 | The perspective transform is applied to the shape geometry. | +| **msoxformDrawing** | 0x00000002 | The perspective transform is applied in the [**drawing space**](#gt_630ebcdf-9eed-46f9-b221-9095c5ca7ce2). | + +### MSO3DRENDERMODE + +*Referenced by: [c3DRenderMode](#c3drendermode)* + +The **MSO3DRENDERMODE** enumeration, as shown in the following table, specifies the rendering modes to be used for a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +| Name | Value | Meaning | +|----|----|----| +| **msoFullRender** | 0x00000000 | Rendering displays a solid shape. | +| **msoWireframe** | 0x00000001 | Rendering displays a wireframe shape. | +| **msoBoundingCube** | 0x00000002 | Rendering displays the bounding cube that contains the shape. | + +### MSOSPT + +The **MSOSPT** enumeration, as shown in the following table, specifies the preset [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) and preset text shape geometries that will be used for a shape. An enumeration of this type is used so that a custom geometry does not need to be specified but can instead be automatically constructed by the generating application. + +[TABLE] + +### MSOCXSTYLE + +*Referenced by: [cxstyle](#cxstyle)* + +The **MSOCXSTYLE** enumeration specifies types of [**connectors**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4). + +| Name | Value | Meaning | +|------------------------|------------|----------------------------| +| **msocxstyleStraight** | 0x00000000 | A straight connector. | +| **msocxstyleBent** | 0x00000001 | An elbow-shaped connector. | +| **msocxstyleCurved** | 0x00000002 | A curved connector. | +| **msocxstyleNone** | 0x00000003 | No connector. | + +### MSOBWMODE + +*Referenced by: [bWMode](#bwmode), [bWModeBW](#bwmodebw), [bWModePureBW](#bwmodepurebw)* + +The **MSOBWMODE** enumeration, as shown in the following table, specifies the ways to render an object when black-and-white display mode is specified. + +| Name | Value | Meaning | +|----|----|----| +| **msobwColor** | 0x00000000 | The object is rendered with normal coloring. | +| **msobwAutomatic** | 0x00000001 | The object is rendered with automatic coloring. | +| **msobwGrayScale** | 0x00000002 | The object is rendered with gray coloring. | +| **msobwLightGrayScale** | 0x00000003 | The object is rendered with light gray coloring. | +| **msobwInverseGray** | 0x00000004 | The object is rendered with inverse gray coloring. | +| **msobwGrayOutline** | 0x00000005 | The object is rendered with gray and white coloring. | +| **msobwBlackTextLine** | 0x00000006 | The object is rendered with black and gray coloring. | +| **msobwHighContrast** | 0x00000007 | The object is rendered with black and white coloring. | +| **msobwBlack** | 0x00000008 | The object is rendered only with black coloring. | +| **msobwWhite** | 0x00000009 | The object is rendered with white coloring. | +| **msobwDontShow** | 0x0000000A | The object is not rendered. | + +### MSODGMT + +*Referenced by: [dgmt](#dgmt)* + +The **MSODGMT** enumeration, as shown in the following table specifies the types of [**diagrams**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). + +[TABLE] + +### MSODGSLK + +*Referenced by: [OfficeArtFDGSL](#officeartfdgsl)* + +The **MSODGSLK** enumeration, as shown in the following table, specifies selection states for selected [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +| Name | Value | Meaning | +|----|----|----| +| **msodgslkNormal** | 0x00000000 | The default state. | +| **msodgslkRotate** | 0x00000001 | Ready to rotate. | +| **msodgslkReshape** | 0x00000002 | Ready to change the curvature of line shapes. | +| **msodgslkCrop** | 0x00000007 | Ready to crop the picture. | + +### MSODGMLO + +*Referenced by: [dgmLayout](#dgmlayout), [dgmLayoutMRU](#dgmlayoutmru)* + +The **MSODGMLO** enumeration, as defined in the following table, specifies layouts for [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) that are nodes in a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). The value 0x000000FF (**msodgmloNil**) indicates that no shape is present. + +[TABLE] + +### MSOPATHTYPE + +The **MSOPATHTYPE** enumeration, as shown in the following table, specifies how the individual pieces of a path SHOULD be interpreted. + +| Name | Value | Meaning | +|----|----|----| +| **msopathLineTo** | 0x00000000 | For each **POINT** record, as defined in section [2.2.55](#point), in the array, add a straight line segment from the current ending **POINT** to the new **POINT**. The number of **POINT** values to process equals the number of segments. The last **POINT** in the array becomes the new ending **POINT**. | +| **msopathCurveTo** | 0x00000001 | For each segment, three **POINT** values are used to draw a cubic Bezier curve. The first two **POINT** values are control **POINT** values, and the last **POINT** is the new ending **POINT**. The number of **POINT** values consumed is three times the number of segments. | +| **msopathMoveTo** | 0x00000002 | Start a new sub-path by using a single **POINT**. The starting **POINT** becomes the current ending **POINT**. The value of the segment field MUST be zero. The number of **POINT** values used is one. | +| **msopathClose** | 0x00000003 | If the starting **POINT** and the ending **POINT** are not the same, a single straight line is drawn to connect the starting **POINT** and the ending **POINT** of the path. The number of segments MUST be one. The number of **POINT** values used is zero. | +| **msopathEnd** | 0x00000004 | The end of the current path. All consecutive lines and fill values MUST be drawn before any subsequent path or line is drawn. The number of segments MUST be zero. The number of **POINT** values used is zero. | +| **msopathEscape** | 0x00000005 | The **MSOPATHINFO** record, as defined in section [2.2.53](#msopathinfo), is treated as an **MSOPATHESCAPEINFO** record, as defined in section [2.2.54](#msopathescapeinfo). | +| **msopathClientEscape** | 0x00000006 | The **MSOPATHINFO** record is treated as an **MSOPATHESCAPEINFO** record specific to the client. | + +### MSOPATHESCAPE + +The **MSOPATHESCAPE** enumeration, as shown in the following table, modifies the path properties by adding elements to a path, providing additional control, or specifying how to handle the editing of **POINT** data, as defined in section [2.2.55](#point). + +| Name | Value | Meaning | +|----|----|----| +| **msopathEscapeExtension** | 0x00000000 | This value adds additional **POINT** values, as defined in section 2.2.55, to the escape code that follows **msopathEscapeExtension**. | +| **msopathEscapeAngleEllipseTo** | 0x00000001 | The first **POINT** specifies the center of the ellipse. The second **POINT** specifies the starting radius in the x value and the ending radius in the y value. The third **POINT** specifies the starting angle in the x value and the ending angle in the y value. Angles are in degrees. The number of ellipse segments drawn equals the number of segments divided by three. | +| **msopathEscapeAngleEllipse** | 0x00000002 | The first **POINT** specifies the center of the ellipse. The second **POINT** specifies the starting radius in the x value and the ending radius in the y value. The third **POINT** specifies the starting angle in the x value and the ending angle in the y value. Angles are in degrees. The number of ellipse segments drawn equals the number of segments divided by three. The first **POINT** of the ellipse becomes the first **POINT** of a new path. | +| **msopathEscapeArcTo** | 0x00000003 | The first two **POINT** values specify the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the ellipse. The second two **POINT** values specify the radial vectors for the ellipse. The radial vectors are cast from the center of the bounding rectangle. The path starts at the **POINT** where the first radial vector intersects the bounding rectangle and goes to the **POINT** where the second radial vector intersects the bounding rectangle. The drawing direction is counterclockwise. If the path has already been started, a line is drawn from the last **POINT** to the starting **POINT** of the arc; otherwise, a new path is started. The number of arc segments drawn equals the number of segments divided by four. | +| **msopathEscapeArc** | 0x00000004 | The first two **POINT** values specify the bounding rectangle of the ellipse. The second two **POINT** values specify the radial vectors for the ellipse. The radial vectors are cast from the center of the bounding rectangle. The path starts at the **POINT** where the first radial vector intersects the bounding rectangle and goes to the **POINT** where the second radial vector intersects the bounding rectangle. The drawing direction is counterclockwise. The number of arc segments drawn equals the number of segments divided by four. | +| **msopathEscapeClockwiseArcTo** | 0x00000005 | The first two **POINT** values specify the bounding rectangle of the ellipse. The second two **POINT** values specify the radial vectors for the ellipse. The radial vectors are cast from the center of the bounding rectangle. The path starts at the **POINT** where the first radial vector intersects the bounding rectangle and goes to the **POINT** where the second radial vector intersects the bounding rectangle. The drawing direction is clockwise. If the path has already been started, a line is drawn from the last **POINT** to the starting **POINT** of the arc; otherwise, a new path is started. The number of arc segments drawn equals the number of segments divided by four. | +| **msopathEscapeClockwiseArc** | 0x00000006 | The first two **POINT** values specify the bounding rectangle of the ellipse. The second two **POINT** values specify the radial vectors for the ellipse. The radial vectors are cast from the center of the bounding rectangle. The path starts at the **POINT** where the first radial vector intersects the bounding rectangle and goes to the **POINT** where the second radial vector intersects the bounding rectangle. The drawing direction is clockwise. The number of arc segments drawn equals the number of segments divided by four. This escape code starts a new path. | +| **msopathEscapeEllipticalQuadrantX** | 0x00000007 | This value adds an ellipse to the path from the current **POINT** to the next **POINT**. The ellipse is drawn as a quadrant that starts as a tangent to the x-axis. Multiple elliptical quadrants are joined by a straight line. The number of elliptical quadrants drawn equals the number of segments. | +| **msopathEscapeEllipticalQuadrantY** | 0x00000008 | This value adds an ellipse to the path from the current **POINT** to the next **POINT**. The ellipse is drawn as a quadrant that starts as a tangent to the y-axis. Multiple elliptical quadrants are joined by a straight line. The number of elliptical quadrants drawn equals the number of segments. | +| **msopathEscapeQuadraticBezier** | 0x00000009 | Each **POINT** defines a control point for a quadratic Bezier curve. The number of control **POINT** values is defined by the **segments** property of the containing **MSOPATHESCAPEINFO** record, as defined in section [2.2.54](#msopathescapeinfo). | +| **msopathEscapeNoFill** | 0x0000000A | The path is not to be filled, even if it is passed to a rendering routine that would normally fill the path. | +| **msopathEscapeNoLine** | 0x0000000B | The path is not to be drawn, even if it passed to a rendering routine that would normally draw the path. | +| **msopathEscapeAutoLine** | 0x0000000C | For Bezier curve editing, the vertex joints are calculated, are of equal length, and are collinear. The segment after the **POINT** is a line. The tangent is not visible. | +| **msopathEscapeAutoCurve** | 0x0000000D | For Bezier curve editing, the vertex joints are calculated, are of equal length, and are collinear. The segment after the **POINT** is a curve. The tangent is not visible. | +| **msopathEscapeCornerLine** | 0x0000000E | For Bezier curve editing, the vertex joints are not calculated, are not of equal lengths and are not collinear. The segment after the **POINT** is a line. The tangent is visible. | +| **msopathEscapeCornerCurve** | 0x0000000F | For Bezier curve editing, the vertex joints are not calculated, are not of equal length, and are not collinear. The segment after the **POINT** is a curve. The tangent is visible. | +| **msopathEscapeSmoothLine** | 0x00000010 | For Bezier curve editing, the vertex joints are not calculated, are not of equal length, and are not collinear. The segment after the **POINT** is a line. The tangent is visible. | +| **msopathEscapeSmoothCurve** | 0x00000011 | For Bezier curve editing, the vertex joints are not calculated, are not of equal length, and are not collinear. The segment after the **POINT** is a curve. The tangent is visible. | +| **msopathEscapeSymmetricLine** | 0x00000012 | For Bezier curve editing, the vertex joints are not calculated, are of equal length, and are not collinear. The segment after the **POINT** is a line. The tangent is visible. | +| **msopathEscapeSymmetricCurve** | 0x00000013 | For Bezier curve editing the vertex joints are not calculated, are of equal length, and are not collinear. The segment after the **POINT** is a curve. The tangent is visible. | +| **msopathEscapeFreeform** | 0x00000014 | For Bezier curve editing, the vertex joints are calculated, are of equal length, and are collinear. The tangent is not visible. | +| **msopathEscapeFillColor** | 0x00000015 | This value sets a new fill color. A single **POINT** is used to represent the colors. The x value is an **OfficeArtCOLORREF** structure, as defined in section [2.2.2](#officeartcolorref), that specifies the new foreground color. The y value is an **OfficeArtCOLORREF** that specifies the new background color. | +| **msopathEscapeLineColor** | 0x00000016 | This value sets a new line drawing color. A single **POINT** is used to represent the colors. The x value is an **OfficeArtCOLORREF** structure, as defined in section 2.2.2, that specifies the new foreground color. The y value is an **OfficeArtCOLORREF** that specifies the new background color. | + +## Algorithms + +### Data for VtHyperlink + +The following algorithm specifies how hyperlink properties, as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.3.3.1.18, that are associated with OfficeArt shapes construct their **dwInfo** structure member values: + +- If the hyperlink defines a link that is associated with the shape itself, the **dwInfo** value MUST be 0x00000004. + +- If the hyperlink defines a [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) path to an image resource that specifies the background image of the document, the **dwInfo** value MUST be 0x00000000. + +- If the hyperlink defines a URL path to an image resource that specifies the foreground graphic displayed for the shape, the **dwInfo** value MUST be 0x00000001. + +- If the hyperlink defines a URL path to an image resource that specifies the fill graphic for the shape, the **dwInfo** value MUST be 0x00000002. + +- If the hyperlink defines a URL path to an image resource that specifies the graphic used for the shape outline, the **dwInfo** value MUST be 0x00000003. + +# Structure Examples + +This section contains examples that illustrate different features of the Office Drawing Binary File Format Structure. + +The example structures are derived from sample files[\<124\>](#Appendix_A_124). The example structures will be similar for other applications[\<125\>](#Appendix_A_125), but records and fields that are defined by the client application might vary slightly. + +## Diagram + +This section provides an example of the record hierarchy within a [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) container that specifies the structure of a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4). This section outlines some of the records that define the structure and properties specific to the following [**drawing objects**](#gt_51dfe494-9c84-4a0e-9d53-06068c5ce3ac)[\<126\>](#Appendix_A_126): + +- Basic [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e), including: + + - Shape fill and color + + - Shape outline + + - Shape position + + - Shape grouping + +- Text + +- Diagram type, layout, and protection + +- [**Connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) lines + +The diagram image that is shown in the following figure represents a basic organizational-chart diagram, which consists of a top-level shape, an assistant shape, coworker shapes, and a subordinate shape. Each shape in the diagram contains text, a fill color, and a shape outline. All of the shapes are connected by lines that are called connectors. + +![Basic organizational chart](media/image414.bin "Basic organizational chart") + +Figure 10: Basic organizational chart + +The remainder of this section shows the record hierarchy that is used to define a diagram and the shapes that are used to construct a diagram. For a detailed specification of each record that is mentioned, see Structures, as defined in section [2](#Section_e8ec3303925e4b089045d1969b5dbd96). + +### DrawingContainer + +All the records that are used to construct the multiple parts of a [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) are stored in the [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) container. The drawing container is defined by the host application and might be named differently in the file format of the host application. + +The following table shows the child-record hierarchy of the **DrawingContainer** record ([\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) section 2.5.13) named **drawing**. This example focuses on the four top-level containers, which are labeled **1**, **2**, **3**, and **4** within the **OfficeArtDgContainer** record, as defined in section [2.2.13](#officeartdgcontainer). + +| **Offset** | **Size** | **Structure** | +|----|----|----| +| 00000D6F | 0A7E | DrawingContainer **- drawing** | +| 00000D6F | 0008 | RecordHeader **- rh** | +| 00000D77 | 0A76 | OfficeArtDgContainer **- OfficeArtDg** | +| 00000D77 | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | +| 00000D7F | 0010 | **1**: [OfficeArtFDG](#officeartfdg) **- drawingData** | +| 00000D8F | 0966 | **2**: [OfficeArtSpgrContainer](#officeartspgrcontainer) **- groupShape** | +| 000016F5 | 0050 | **3**: [OfficeArtSpContainer](#officeartspcontainer) **- shape** | +| 00001745 | 00A8 | **4**: [OfficeArtSolverContainer](#officeartsolvercontainer) **- solvers** | + +Figure 11: Child-Record Hierarchy of a DrawingContainer Record + +The top-level records of the drawing container are specified as follows: + +**drawing:** A drawing container that contains a **RecordHeader** record, as defined in section 2.2.1, and a top-level **OfficeArtDgContainer** drawing container. + +**OfficeArtDg:** An **OfficeArtDgContainer** record, as defined in section 2.2.13, that contains all the per-slide, per-document, and per-sheet information, including the [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). + +**OfficeArtDg.drawingData:** An **OfficeArtFDG** record, as defined in section 2.2.49, that contains information about the shape count, drawing identifier, and shape identifier of the last shape in a drawing. + +**OfficeArtDg.groupShape:** An **OfficeArtSpgrContainer** record, as defined in section 2.2.16, that contains groups of shapes. This group container contains a variable number of shape containers and other group containers. The group itself is a shape. + +**OfficeArtDg.shape:** An **OfficeArtSpContainer** record, as defined in section 2.2.14, that acts as a container for shapes. + +**OfficeArtDg.solvers:** An **OfficeArtSolverContainer** record, as defined in section 2.2.18, that acts as a container for [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) that are applicable to shapes. + +The containers that are labeled **1**, **2**, **3**, and **4** are described in more detail in the following four subsections. + +### OfficeArtFDG + +The following table shows the child-record hierarchy of **OfficeArtFDG**, as defined in section [2.2.49](#officeartfdg), container **1**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000D7F | 0010 | **1**: OfficeArtFDG **- drawingData** | | +| 00000D7F | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | | +| 00000D7F | 4 bits | bit **- recVer** | 0x0 | +| 00000D7F | 12 bits | bit **- recInstance** | 0x002 | +| 00000D81 | 0002 | USHORT **- recType** | 0xF008 | +| 00000D83 | 0004 | DWORD **- recLen** | 0x00000008 | +| 00000D87 | 0004 | ULONG **- csp** | 0x0000000E | +| 00000D8B | 0004 | ULONG **- spidCur** | 0x00000818 | + +Figure 12: Child-Record Hierarchy of OfficeArtFDG Container 1 + +The records that are contained within **OfficeArtFDG** container **1** are specified as follows: + +**rh:** An **OfficeArtRecordHeader** structure, as defined in section 2.2.1, that describes the record data. This 8-byte header contains the record type, the record length, and if it is an [**atom**](#gt_e0c68b3f-d976-411b-a247-7cef57e73728) type, a version identifier. + +**rh.recVer:** The record version, which is 0x0 if the record is an atom or 0xF if the record is a container. + +**rh.recInstance:** The record instance (0x002), which is useful for differentiating atoms when more than one atom of the same type exists in a particular container. + +**rh.recType:** The type (0xF008) of the record. OfficeArt uses values from 0xF000 to 0xFFFF. Client applications can define their own records by using other ranges. + +**rh.recLen:** The length (0x00000008), in bytes, of the record. If the record is an atom, this value specifies the length of the atom excluding the header. If the record is a container, this value specifies the sum of the lengths of the contained atoms plus the length of the record header for each atom. + +**csp:** The number (0x0000000E) of [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) in this [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). + +**spidCur:** The shape identifier (0x00000818) of the last shape in this drawing. + +### OfficeArtSpgrContainer + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainer** container, as defined in section [2.2.16](#officeartspgrcontainer), record **2**. + +| **Offset** | **Size** | **Structure** | +|----|----|----| +| 00000D8F | 0966 | **2**: OfficeArtSpgrContainer **- groupShape** | +| 00000D8F | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | +| 00000D97 | 095E | OfficeArtSpgrContainerFileBlockArray **- rgfb** | +| 00000D97 | 0030 | **A**: [OfficeArtSpgrContainerFileBlock](#officeartspgrcontainerfileblock) **- OfficeArtSpgrContainerFB** | +| 00000DC7 | 092E | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00000DC7 | 092E | OfficeArtSpgrContainer **- case_of_msofbtSpgrContainer** | +| 00000DC7 | 0008 | OfficeArtRecordHeader **- rh** | +| 00000DCF | 0926 | OfficeArtSpgrContainerFileBlockArray **- rgfb** | +| 00000DCF | 00EA | **B**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00000EB9 | 005C | **C**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00000F15 | 007C | **D**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00000F91 | 0076 | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00001007 | 007C | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00001083 | 007C | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 000010FF | 007C | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 0000117B | 00EB | **E**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00001266 | 00E5 | **F**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 0000134B | 00E5 | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00001430 | 00E5 | **G**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00001515 | 00EF | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | +| 00001604 | 00F1 | OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | + +Figure 13: Child-Record Hierarchy of OfficeArtSpgrContainer Container 2 + +The record types within **OfficeArtSpgrContainer** container **2** that have not been explained in previous sections are specified as follows: + +**rgfb:** An array of **OfficeArtSpgrContainerFileBlock** records, as defined in section 2.2.17, that specifies [**groups**](#gt_51c51c14-7f9d-4c0b-a69c-d3e059bfffac) or [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) contained within this group. + +**rgfb.OfficeArtSpgrContainerFB:** A container for groups of shapes. The group container contains a variable number of shape containers and other group containers. Each group is a shape. + +The following seven structure examples show the records that are labeled **A**, **B**, **C**, **D**, **E**, **F**, and **G** in the preceding table in more detail. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock** record **A**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000D97 | 0030 | **A**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 00000D97 | 0030 | [OfficeArtSpContainer](#officeartspcontainer) **- case_of_msofbtSpContainer** | | +| 00000D97 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000D9F | 0018 | [OfficeArtFSPGR](#officeartfspgr) **- shapeGroup** | | +| 00000D9F | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000DA7 | 0010 | OfficeArtFRC **- frc** | | +| 00000DA7 | 0004 | LONG **- xLeft** | 0x00000000 | +| 00000DAB | 0004 | LONG **- yTop** | 0x00000000 | +| 00000DAF | 0004 | LONG **- xRight** | 0x00000000 | +| 00000DB3 | 0004 | LONG **- yBottom** | 0x00000000 | +| 00000DB7 | 0010 | **H**: [OfficeArtFSP](#officeartfsp) **- shapeProp** | | + +Figure 14: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record A + +The record types within **OfficeArtSpgrContainerFileBlock** record **A** that have not been explained in previous structure examples are specified as follows: + +**case_of_msofbtSpContainer.shapeGroup.frc:** The coordinate system of the [**group shape**](#gt_b2238184-3c83-4e64-babb-08b02a9138db) that the anchors of the child shape are expressed in. This structure is present only in group shapes. + +**case_of_msofbtSpContainer.shapeGroup.frc.xLeft:** The left boundary (0x00000000) of the coordinate system of the group. + +**case_of_msofbtSpContainer.shapeGroup.frc.yTop:** The top boundary (0x00000000) of the coordinate system of the group. + +**case_of_msofbtSpContainer.shapeGroup.frc.xRight:** The right boundary (0x00000000) of the coordinate system of the group. + +**case_of_msofbtSpContainer.shapeGroup.frc.yBottom:** The bottom boundary (0x00000000) of the coordinate system of the group. + +**case_of_msofbtSpContainer.shapeProp:** An **OfficeArtFSP** record, as defined in section 2.2.40, that contains an instance of a shape. The record header contains the shape type, and the record itself contains the shape identifier and a set of bits that further define the shape. + +The following table shows the child-record hierarchy of **OfficeArtFSP** record **H**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-------------------------------------|------------| +| 00000DB7 | 0010 | **H**: OfficeArtFSP **- shapeProp** | | +| 00000DB7 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000DBF | 0004 | ULONG **- spid** | 0x00000800 | +| 00000DC3 | 1 bit | bit **- fGroup** | 0x1 | +| 00000DC3 | 1 bit | bit **- fChild** | 0x0 | +| 00000DC3 | 1 bit | bit **- fPatriarch** | 0x1 | +| 00000DC3 | 1 bit | bit **- fDeleted** | 0x0 | +| 00000DC3 | 1 bit | bit **- fOleShape** | 0x0 | +| 00000DC3 | 1 bit | bit **- fHaveMaster** | 0x0 | +| 00000DC3 | 1 bit | bit **- fFlipH** | 0x0 | +| 00000DC3 | 1 bit | bit **- fFlipV** | 0x0 | +| 00000DC3 | 1 bit | bit **- fConnector** | 0x0 | +| 00000DC3 | 1 bit | bit **- fHaveAnchor** | 0x0 | +| 00000DC3 | 1 bit | bit **- fBackground** | 0x0 | +| 00000DC3 | 1 bit | bit **- fHaveSpt** | 0x0 | +| 00000DC3 | 20 bits | bit **- unused1** | 0x00000 | + +Figure 15: Child-Record Hierarchy of OfficeArtFSP Record H + +The record types within **OfficeArtFSP** record **H** that have not been explained in previous structure examples are specified as follows: + +**spid:** The identifier (0x00000800) of this shape. + +**fGroup:** A value that specifies whether this shape is a group shape. The value 0x1 specifies that this shape is a group shape. + +**fChild:** A value that specifies whether this shape is a [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) shape. The value 0x0 specifies that this shape is not a child shape. + +**fPatriarch:** A value that specifies whether this shape is the topmost group shape. The value 0x1 specifies that this shape is the topmost group shape. Exactly one topmost group shape exists per [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3). + +**fDeleted:** A value that specifies whether this shape has been deleted. The value 0x0 specifies that this shape has not been deleted. + +**fOleShape:** A value that specifies whether this shape is an [**OLE object**](#gt_cdff9514-a3fb-4897-941d-4e99193a0096). The value 0x0 specifies that this shape is not an OLE object. + +**fHaveMaster:** A value that specifies whether this shape has a valid [**master**](#gt_7bc43fab-2908-4fdd-b933-2f6429802521) in the **hspMaster** property, as defined in section [2.3.2.1](#hspmaster). The value 0x0 specifies that this shape does not have such a valid master. + +**fFlipH:** A value that specifies whether this shape is flipped horizontally. The value 0x0 specifies that this shape is not flipped horizontally. + +**fFlipV:** A value that specifies whether this shape is flipped vertically. The value 0x0 specifies that this shape is not flipped vertically. + +**fConnector:** A value that specifies whether this shape is a [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape. The value 0x0 specifies that this shape is not a connector shape. + +**fHaveAnchor:** A value that specifies whether this shape has an [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997). The value 0x0 specifies that this shape does not have an anchor. + +**fBackground:** A value that specifies whether this shape is a [**background shape**](#gt_35f68e44-a7fb-4b81-863a-a8ab1db2b016). The value 0x0 specifies that this shape is not a background shape. + +**fHaveSpt:** A value that specifies whether this shape has a shape type property. The value 0x0 specifies that this shape does not have a shape type property. + +**unused1:** A value that is undefined and needs to be ignored. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock**, as defined in section 2.2.17, record **B**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000DCF | 00EA | **B**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 00000DCF | 00EA | OfficeArtSpContainer **- case_of_msofbtSpContainer** | | +| 00000DCF | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000DD7 | 0018 | OfficeArtFSPGR **- shapeGroup** | | +| 00000DEF | 0010 | OfficeArtFSP **- shapeProp** | | +| 00000DFF | 000E | [OfficeArtFOPT](#officeartfopt) **- shapePrimaryOptions** | | +| 00000E0D | 009C | [OfficeArtTertiaryFOPT](#officearttertiaryfopt) **- shapeTertiaryOptions** | | +| 00000E0D | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000E15 | 0094 | [OfficeArtRGFOPTE](#officeartrgfopte) **- fopt** | | +| 00000E15 | 0006 | [dgmt](#dgmt) **- Diagram Type** | | +| 00000E15 | 0002 | [OfficeArtFOPTEOPID](#officeartfopteopid) **- opid** | | +| 00000E17 | 0004 | [MSODGMT](#msodgmt) **- dgmt** | 0x00000001 | +| 00000E1B | 0006 | [dgmStyle](#dgmstyle) **- Diagram Style** | | +| 00000E1B | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E1D | 0004 | LONG **- dgmStyle** | 0x00000000 | +| 00000E21 | 0006 | [pRelationTbl](#prelationtbl) **- Diagram Shape Relationship** | | +| 00000E21 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E23 | 0004 | ULONG **- pRelationTbl** | 0x0000004E | +| 00000E27 | 0006 | [dgmScaleX](#dgmscalex) **- Diagram ScaleX** | | +| 00000E27 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E29 | 0004 | FixedPoint **- dgmScaleX** | 0x00013333 | +| 00000E2D | 0006 | [dgmScaleY](#dgmscaley) **- Diagram ScaleY** | | +| 00000E2D | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E2F | 0004 | FixedPoint **- dgmScaleY** | 0x00011748 | +| 00000E33 | 0006 | [dgmDefaultFontSize](#dgmdefaultfontsize) **- Diagram Default Font Size** | | +| 00000E33 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E35 | 0004 | LONG **- dgmDefaultFontSize** | 0x0000000D | +| 00000E39 | 0006 | [dgmConstrainBounds](#dgmconstrainbounds) **- Diagram Bounds** | | +| 00000E39 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E3B | 0004 | ULONG **- dgmConstrainBounds** | 0x00000016 | +| 00000E3F | 0006 | **I**: [Diagram Boolean Properties](#diagram-boolean-properties) **- Diagram Boolean** | | +| 00000E45 | 004E | **J**: [pRelationTbl_complex](#prelationtbl_complex) **- Diagram Shape Relationship Data** | | +| 00000E93 | 0016 | **K**: [dgmConstrainBounds_complex](#dgmconstrainbounds_complex) **- Diagram Bounds Data** | | +| 00000EA9 | 0010 | OfficeArtClientAnchor **- clientAnchor** | | + +Figure 16: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record B + +The record types within **OfficeArtSpgrContainerFileBlock** record **B** that have not been explained in previous structure examples are specified as follows: + +**case_of_msofbtSpContainer.shapeTertiaryOptions:** An **OfficeArtTertiaryFOPT** record, as defined in section 2.2.11, that contains a table of **OfficeArtRGFOPTE** properties, as defined in section 2.3.1. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Type.opid:** An **OfficeArtFOPTEOPID** record, as defined in section 2.2.8, that specifies the header for an entry in a property table. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Type.dgmt:** A value that specifies whether this [**diagram**](#gt_4b31fd56-f587-421b-b713-0dcf0f7f13a4) type is an organizational-chart diagram. The value 0x00000001 specifies that this diagram type is an organizational-chart diagram. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Style:** A property that specifies a diagram style. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Style.dgmStyle:** A value that specifies whether this diagram has the default style. The value 0x00000000 specifies that this diagram has the default style. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Shape Relationship:** A pRelationTbl property that specifies the relationships in a diagram. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Shape Relationship.pRelationTbl:** The number (0x0000004E) of bytes of data in the pRelationTbl_complex property. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram ScaleX:** A property that specifies the amount to scale along the x-axis. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram ScaleX.dgmScaleX:** The amount (0x00013333) to scale along the x-axis. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram ScaleY:** A property that specifies the amount to scale along the y-axis. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram ScaleY.dgmScaleY:** The amount (0x00011748) to scale along the y-axis. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Default Font Size:** A property that specifies the default font size for new text in this diagram. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Default Font Size.dgmDefaultFontSize:** The default font size (0x0000000D), in [**points**](#gt_d072e4da-7898-4227-8f25-9fe77db43571), for new text in this diagram. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Bounds:** A **dgmConstrainBounds** property, as defined in section 2.3.17.8, that specifies the bounds of this diagram. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Bounds.dgmConstrainBounds:** The number (0x00000016) of bytes of data in the **dgmConstrainBounds_complex** property, as defined in section 2.3.17.9. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Boolean:** A 32-bit field of Boolean properties for a diagram. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Shape Relationship Data:** A **pRelationTbl_complex** property that specifies additional data for **pRelationTbl**. + +**case_of_msofbtSpContainer.shapeTertiaryOptions.fopt.Diagram Bounds Data:** A **dgmConstrainBounds_complex** property, as defined in section 2.3.17.9, that specifies additional data for the **dgmConstrainBounds** property, as defined in section 2.3.17.8. + +The following three example structures show the records that are labeled **I**, **J**, and **K** in **OfficeArtSpgrContainerFileBlock** record **B** in more detail. + +The following table shows the child-record hierarchy of **Diagram Boolean Properties** record **I**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E3F | 0006 | **I**: Diagram Boolean Properties **- Diagram Boolean Properties** | | +| 00000E3F | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E3F | 14 bits | bit **- opid** | 0x053F | +| 00000E3F | 1 bit | bit **- fBid** | 0x0 | +| 00000E3F | 1 bit | bit **- fComplex** | 0x0 | +| 00000E41 | 10 bits | bit **- unused6** | 0x000 | +| 00000E41 | 1 bit | bit **- unused5** | 0x0 | +| 00000E41 | 1 bit | bit **- unused4** | 0x0 | +| 00000E41 | 1 bit | bit **- fUsefDoFormat** | 0x1 | +| 00000E41 | 1 bit | bit **- fUsefReverse** | 0x0 | +| 00000E41 | 1 bit | bit **- fUsefDoLayout** | 0x0 | +| 00000E41 | 1 bit | bit **- fUsefPseudoInline** | 0x0 | +| 00000E41 | 10 bits | bit **- unused3** | 0x000 | +| 00000E41 | 1 bit | bit **- unused2** | 0x0 | +| 00000E41 | 1 bit | bit **- unused1** | 0x0 | +| 00000E41 | 1 bit | bit **- fDoFormat** | 0x0 | +| 00000E41 | 1 bit | bit **- fReverse** | 0x0 | +| 00000E41 | 1 bit | bit **- fDoLayout** | 0x0 | +| 00000E41 | 1 bit | bit **- fPseudoInline** | 0x0 | + +Figure 17: Child-Record Hierarchy of Diagram Boolean Properties Record I + +The **Diagram Boolean Properties** that are listed in record **I** are specific to diagrams. The record types within **Diagram Boolean Properties** record **I** that have not been explained in previous structure examples are specified as follows: + +**opid.opid:** The identifier (0x053F) of the property in this entry. + +**opid.fBid:** A value that specifies whether the value in the **op** field is a [**BLIP**](#gt_f9c3c085-93c6-49a8-9043-591902711956) identifier. The value 0x0 specifies that the value in the **op** field is not a BLIP identifier. + +**opid.fComplex:** A value that specifies whether this property is a complex property. The value 0x0 specifies that this property is not a complex property. + +**fUsefDoFormat:** A value that specifies whether the **fDoFormat** bit has been set. The value 0x1 specifies that the **fDoFormat** bit has been set. + +**fUsefReverse:** A value that specifies whether the **fReverse** bit needs to be ignored. The value 0x0 specifies that the **fReverse** bit needs to be ignored. + +**fUsefDoLayout:** A value that specifies whether the **fDoLayout** bit needs to be ignored. The value 0x0 specifies that the **fDoLayout** bit needs to be ignored. + +**fUsefPseudoInline:** A value that specifies whether the **fPseudoInline** bit needs to be ignored. The value 0x0 specifies that the **fPseudoInline** bit needs to be ignored. + +**fDoFormat:** A value that specifies whether the **dgmStyle** property, as defined in section 2.3.17.2, for this diagram contains a default formatting style for this diagram type. The value 0x0 specifies that the **dgmStyle** property for this diagram contains a default formatting style for this diagram type. + +**fReverse:** A value that specifies whether this diagram is mirrored horizontally. The value 0x0 specifies that this diagram is not mirrored horizontally. + +**fDoLayout:** A value that specifies whether this diagram has a layout that is directly editable. The value 0x0 specifies that this diagram has a layout that is directly editable. + +**fPseudoInline:** A value that specifies whether this diagram is placed in line with surrounding text. The value 0x0 specifies that this diagram is not placed in line with surrounding text. + +The following table shows the child-record hierarchy of **pRelationTbl_complex** record **J**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E45 | 004E | **J**: pRelationTbl_complex **- Diagram Shape Relationship Data** | | +| 00000E45 | 004E | [IMsoArray](#imsoarray) **- pRelationTbl** | | +| 00000E45 | 0002 | USHORT **- nElems** | 0x0006 | +| 00000E47 | 0002 | USHORT **- nElemsAlloc** | 0x0008 | +| 00000E49 | 0002 | USHORT **- cbElem** | 0x000C | +| 00000E4B | 0048 | Blob **- data** | 40 95 09 97 40 95 09 97 00 00 00 00 EB CE CB F8 40 95 09 97 28 9D E6 D3 01 A4 12 8E 40 95 09 97 4C DA BC 3B C2 F7 3F A5 40 95 09 97 0D EB A7 22 83 C6 24 BC 40 95 09 97 AA FF D0 E1 8E A9 77 40 83 C6 24 BC 4D FA 5A 6B | + +Figure 18: Child-Record Hierarchy of pRelationTbl_complex Record J + +The record types within **pRelationTbl_complex** record **J** that have not been explained in previous structure examples are specified as follows: + +**pRelationTbl:** An **IMsoArray** record, as defined in section 2.2.51, that specifies the relationships in a diagram. Each array element specifies a connection between two shapes. + +**pRelationTbl.nElems:** A value (0x0006) that specifies the number of elements contained in this record. This diagram thus contains six shapes. + +**pRelationTbl.nElemsAlloc:** The maximum number (0x0008) of elements that this record can contain. + +**pRelationTbl.cbElem:** The size (0x000C), in bytes, of each element in the **data** record. + +**pRelationTbl.data:** An array that contains **nElems** elements, each of which is **cbElem** bytes in size. + +The following table shows the child-record hierarchy of **dgmConstrainBounds_complex** record **K**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E93 | 0016 | **K**: dgmConstrainBounds_complex **- Diagram Bounds Data** | | +| 00000E93 | 0016 | IMsoArray **- dgmConstrainBounds** | | +| 00000E93 | 0002 | USHORT **- nElems** | 0x0004 | +| 00000E95 | 0002 | USHORT **- nElemsAlloc** | 0x0004 | +| 00000E97 | 0002 | USHORT **- cbElem** | 0x0004 | +| 00000E99 | 0010 | Blob **- data** | 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | + +Figure 19: Child-Record Hierarchy of dgmConstrainBounds_complex Record K + +The record types within **dgmConstrainBounds_complex** record **K** that have not been explained in previous structure examples are specified as follows: + +**dgmConstrainBounds:** An **IMsoArray** record, as defined in section 2.2.51, of four elements that specify, in order, the left, top, right, and bottom bounds, in application-defined coordinates, of the diagram. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock**, as defined in section 2.2.17, record **C**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000EB9 | 005C | **C**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 00000EB9 | 005C | OfficeArtSpContainer **- case_of_msofbtSpContainer** | | +| 00000EB9 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000EC1 | 0010 | **L**: OfficeArtFSP **- shapeProp** | | +| 00000ED1 | 002C | OfficeArtFOPT **- shapePrimaryOptions** | | +| 00000ED1 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000ED9 | 0024 | OfficeArtRGFOPTE **- fopt** | | +| 00000ED9 | 0006 | **M**: [Protection Boolean Properties](#protection-boolean-properties) **- Protection Boolean** | | +| 00000EDF | 0006 | [cxk](#cxk) **- Shape Connection Points** | | +| 00000EDF | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000EE1 | 0004 | [MSOCXK](#msocxk) **- cxk** | 0x00000000 | +| 00000EE5 | 0006 | **N**: [Geometry Boolean Properties](#geometry-boolean-properties) **- Geometry Boolean** | | +| 00000EEB | 0006 | **O**: [Fill Style Boolean Properties](#fill-style-boolean-properties) **- Fill Style Boolean** | | +| 00000EF1 | 0006 | **P**: [Line Style Boolean Properties](#line-style-boolean-properties) **- Line Style Boolean** | | +| 00000EF7 | 0006 | **Q**: [Shape Boolean Properties](#shape-boolean-properties) **- Shape Boolean Properties** | | +| 00000EFD | 0018 | **R**: [OfficeArtChildAnchor](#officeartchildanchor) **- childAnchor** | | + +Figure 20: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record C + +The record types within **OfficeArtSpgrContainerFileBlock** record **C** that have not been explained in previous structure examples are specified as follows: + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Protection Boolean:** A 32-bit field that aggregates Boolean values to prevent the editing of certain shape properties. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Shape Connection Points:** A record that specifies where [**connection points**](#gt_ecd96915-cfc0-404e-a2b2-96f02736e07d) exist on the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Shape Connection Points.cxk:** An **MSOCXK** enumeration value, as defined in section 2.4.10, that specifies where connection points exist on the shape. The value 0x00000000 specifies that this shape has no connection points. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Geometry Boolean:** A 32-bit field that aggregates the Boolean values of the geometry properties for the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Fill Style Boolean:** A 32-bit field that aggregates the Boolean properties of the fill style. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Line Style Boolean:** A 32-bit field that aggregates the Boolean properties of the line style. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.Shape Boolean Properties:** A 32-bit field that aggregates the Boolean properties for a shape. + +**case_of_msofbtSpContainer.childAnchor:** A record containing four signed integers that specify the anchor for the shape that contains this record. This record is present only when the containing shape is a member of a group of shapes. The integers identify the offset from the origin of the specified coordinate system—that is, specified by the **OfficeArtFSPGR** record, as defined in section 2.2.38, contained in the same **OfficeArtSpgrContainer**, as defined in, as defined in section 2.2.16, that contains this record. The integers are in units of the coordinate system that is specified by the same **OfficeArtFSPGR**. + +The following seven example structures show the records labeled **L**, **M**, **N**, **O**, **P**, **Q**, and **R** from **OfficeArtSpgrContainerFileBlock** record **C** in more detail. + +The following table shows the child-record hierarchy of **OfficeArtFSP** record, as defined in section 2.2.40, **L**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-------------------------------------|------------| +| 00000EC1 | 0010 | **L**: OfficeArtFSP **- shapeProp** | | +| 00000EC1 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000EC9 | 0004 | ULONG **- spid** | 0x00000804 | +| 00000ECD | 1 bit | bit **- fGroup** | 0x0 | +| 00000ECD | 1 bit | bit **- fChild** | 0x1 | +| 00000ECD | 1 bit | bit **- fPatriarch** | 0x0 | +| 00000ECD | 1 bit | bit **- fDeleted** | 0x0 | +| 00000ECD | 1 bit | bit **- fOleShape** | 0x0 | +| 00000ECD | 1 bit | bit **- fHaveMaster** | 0x0 | +| 00000ECD | 1 bit | bit **- fFlipH** | 0x0 | +| 00000ECD | 1 bit | bit **- fFlipV** | 0x0 | +| 00000ECD | 1 bit | bit **- fConnector** | 0x0 | +| 00000ECD | 1 bit | bit **- fHaveAnchor** | 0x1 | +| 00000ECD | 1 bit | bit **- fBackground** | 0x0 | +| 00000ECD | 1 bit | bit **- fHaveSpt** | 0x1 | +| 00000ECD | 20 bits | bit **- unused1** | 0x00000 | + +Figure 21: Child-Record Hierarchy of OfficeArtFSP Record L + +The records contained in **OfficeArtFSP** record **L** are similar to those in **OfficeArtFSP** record **H** but represent a different shape in the diagram. The differences can be seen in the values of **fChild** and **fPatriarch**. In **OfficeArtFSP** record **H**, the value of **fChild** is 0x0, which specifies that the shape is not a child shape, and the value of **fPatriarch** is 0x1, which specifies that the shape is the topmost one. The values of for **fChild** and **fPatriarch** in **OfficeArtFSP** record **L** specify that the shape is a child shape and that it is not the topmost shape. + +The following table shows the child-record hierarchy of **Protection Boolean Properties** record **M**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000ED9 | 0006 | **M**: Protection Boolean Properties **- Protection Boolean Properties** | | +| 00000ED9 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000ED9 | 14 bits | bit **- opid** | 0x007F | +| 00000ED9 | 1 bit | bit **- fBid** | 0x0 | +| 00000ED9 | 1 bit | bit **- fComplex** | 0x0 | +| 00000EDB | 6 bits | bit **- unused2** | 0x00 | +| 00000EDB | 1 bit | bit **- fUsefLockAgainstUngrouping** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockRotation** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockAspectRatio** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockPosition** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockAgainstSelect** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockCropping** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockVertices** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockText** | 0x1 | +| 00000EDB | 1 bit | bit **- fUsefLockAdjustHandles** | 0x0 | +| 00000EDB | 1 bit | bit **- fUsefLockAgainstGrouping** | 0x0 | +| 00000EDB | 6 bits | bit **- unused1** | 0x00 | +| 00000EDB | 1 bit | bit **- fLockAgainstUngrouping** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockRotation** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockAspectRatio** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockPosition** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockAgainstSelect** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockCropping** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockVertices** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockText** | 0x1 | +| 00000EDB | 1 bit | bit **- fLockAdjustHandles** | 0x0 | +| 00000EDB | 1 bit | bit **- fLockAgainstGrouping** | 0x0 | + +Figure 22: Child-Record Hierarchy of Protection Boolean Properties Record M + +The record types within **Protection Boolean Properties** record **M** that have not been explained in previous structure examples are specified as follows: + +**fUsefLockAgainstUngrouping:** A value that specifies whether the **fLockAgainstUngrouping** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockAgainstUngrouping** flag will be ignored and the default value used instead. + +**fUsefLockRotation:** A value that specifies whether the **fLockRotation** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockRotation** flag will be ignored and the default value used instead. + +**fUsefLockAspectRatio:** A value that specifies whether the **fLockAspectRatio** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockAspectRatio** flag will be ignored and the default value used instead. + +**fUsefLockPosition:** A value that specifies whether the **fLockPosition** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockPosition** flag will be ignored and the default value used instead. + +**fUsefLockAgainstSelect:** A value that specifies whether the **fLockAgainstSelect** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockAgainstSelect** flag will be ignored and the default value used instead. + +**fUsefLockCropping:** A value that specifies whether the **fLockCropping** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockCropping** flag will be ignored and the default value used instead. + +**fUsefLockVertices:** A value that specifies whether the **fLockVertices** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockVertices** flag will be ignored and the default value used instead. + +**fUsefLockText:** A value that specifies whether the **fLockText** flag is set. The value 0x1 specifies that the **fLockText** flag is set. + +**fUsefLockAdjustHandles:** A value that specifies whether the **fLockAdjustHandles** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockAdjustHandles** flag will be ignored and the default value used instead. + +**fUsefLockAgainstGrouping:** A value that specifies whether the **fLockAgainstGrouping** flag will be ignored and the default value used instead. The value 0x0 specifies that the **fLockAgainstGrouping** flag will be ignored and the default value used instead. + +**fLockAgainstUngrouping:** A value that specifies whether the grouped shape is locked from being ungrouped. The value 0x0 specifies that the grouped shape is not locked from being ungrouped. + +**fLockRotation:** A value that specifies whether the rotation of the shape is locked from being edited. The value 0x0 specifies that the rotation of the shape is not locked from being edited. + +**fLockAspectRatio:** A value that specifies whether the aspect ratio of the shape is locked from being edited. The value 0x0 specifies that the aspect ratio of the shape is not locked from being edited. + +**fLockPosition:** A value that specifies whether the position of the shape is locked from being edited. The value 0x0 specifies that the position of the shape is not locked from being edited. + +**fLockAgainstSelect:** A value that specifies whether the shape is locked from being selectable in an editor application. The value 0x0 specifies that the shape is not locked from being selectable in an editor application. + +**fLockCropping:** A value that specifies whether the cropping of a picture in the diagram is locked from being edited. The value 0x0 specifies that the cropping of a picture in the diagram is not locked from being edited. + +**fLockVertices:** A value that specifies whether the vertices of the path are locked from being edited. The value 0x0 specifies that the vertices of the path are not locked from being edited. + +**fLockText:** A value that specifies whether the text attached to the shape is locked from being edited. The value 0x1 specifies that the text attached to the shape is locked from being edited. + +**fLockAdjustHandles:** A value that specifies whether the [**adjust handles**](#gt_57ce8ee9-ef94-473f-8ca1-13fbad2ec11b) of the shape are locked from being edited. The value 0x0 specifies that the adjust handles of the shape are not locked from being edited. + +**fLockAgainstGrouping:** A value that specifies whether the shape is locked from being grouped with other shapes. The value 0x0 specifies that the shape is not locked from being grouped with other shapes. + +The following table shows the child-record hierarchy of **Geometry Boolean Properties** record **N**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000EE5 | 0006 | **N**: Geometry Boolean Properties **- Geometry Boolean Properties** | | +| 00000EE5 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000EE5 | 14 bits | bit **- opid** | 0x017F | +| 00000EE5 | 1 bit | bit **- fBid** | 0x0 | +| 00000EE5 | 1 bit | bit **- fComplex** | 0x0 | +| 00000EE7 | 9 bits | bit **- unused4** | 0x000 | +| 00000EE7 | 1 bit | bit **- unused3** | 0x0 | +| 00000EE7 | 1 bit | bit **- fUsefShadowOK** | 0x1 | +| 00000EE7 | 1 bit | bit **- fUsef3DOK** | 0x1 | +| 00000EE7 | 1 bit | bit **- fUsefLineOK** | 0x1 | +| 00000EE7 | 1 bit | bit **- fUsefGtextOK** | 0x0 | +| 00000EE7 | 1 bit | bit **- fUsefFillShadeShapeOK** | 0x0 | +| 00000EE7 | 1 bit | bit **- fUsefFillOK** | 0x1 | +| 00000EE7 | 9 bits | bit **- unused2** | 0x000 | +| 00000EE7 | 1 bit | bit **- unused1** | 0x0 | +| 00000EE7 | 1 bit | bit **- fShadowOK** | 0x1 | +| 00000EE7 | 1 bit | bit **- f3DOK** | 0x1 | +| 00000EE7 | 1 bit | bit **- fLineOK** | 0x1 | +| 00000EE7 | 1 bit | bit **- fGtextOK** | 0x0 | +| 00000EE7 | 1 bit | bit **- fFillShadeShapeOK** | 0x0 | +| 00000EE7 | 1 bit | bit **- fFillOK** | 0x1 | + +Figure 23: Child-Record Hierarchy of Geometry Boolean Properties Record N + +The record types within **Geometry Boolean Properties** record **N** that have not been explained in previous structure examples are specified as follows: + +**fUsefShadowOK:** A value that specifies whether the **fShadowOK** bit is set. The value 0x1 specifies that the **fShadowOK** bit is set. + +**fUsef3DOK:** A value that specifies whether the **f3DOK** bit is set. The value 0x1 specifies that the **f3DOK** bit is set. + +**fUsefLineOK:** A value that specifies whether the **fLineOK** bit is set. The value 0x1 specifies that the **fLineOK** bit is set. + +**fUsefGtextOK:** A value that specifies whether the **fGtextOK** bit will be ignored and the default value used instead. The value 0x0 specifies the **fGtextOK** bit will be ignored and the default value used instead. + +**fUsefFillShadeShapeOK:** A value that specifies whether the **fFillShadeShapeOK** bit will be ignored and the default value used instead. The value 0x0 specifies that the **fFillShadeShapeOK** bit will be ignored and the default value used instead. + +**fUsefFillOK:** A value that specifies whether the **fFillOK** bit is set. The value 0x1 specifies that the **fFillOK** bit is set. + +**fShadowOK:** A value that specifies whether the shadow of this shape is set to display if applied. The value 0x1 specifies that the shadow of this shape is set to display if applied. + +**f3DOK:** A value that specifies whether the extrusion effect of this shape is set to display if applied. The value 0x1 specifies that the extrusion effect of this shape is set to display if applied. + +**fLineOK:** A value that specifies whether the line of this shape is set to display if applied. The value 0x1 specifies that the line of this shape is set to display if applied. + +**fGtextOK:** A value that specifies whether the text aligned to this shape will display. The value 0x0 specifies that the text aligned to this shape will not display. + +**fFillShadeShapeOK:** A value that specifies whether the fill is aligned to the [**bounding rectangle**](#gt_e349a155-0fb9-4ba1-abd4-e363e21abcd1) of the shape. The value 0x0 specifies that the fill is aligned to the bounding rectangle of the shape. + +**fFillOK:** A value that specifies whether the fill of this shape is set to display if applied. The value 0x1 specifies that the fill of this shape is set to display if applied. + +The following table shows the child-record hierarchy of **Fill Style Boolean Properties** record **O**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000EEB | 0006 | **O**: Fill Style Boolean Properties **- Fill Style Boolean Properties** | | +| 00000EEB | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000EEB | 14 bits | bit **- opid** | 0x01BF | +| 00000EEB | 1 bit | bit **- fBid** | 0x0 | +| 00000EEB | 1 bit | bit **- fComplex** | 0x0 | +| 00000EED | 9 bits | bit **- unused2** | 0x000 | +| 00000EED | 1 bit | bit **- fUsefRecolorFillAsPicture** | 0x0 | +| 00000EED | 1 bit | bit **- fUsefUseShapeAnchor** | 0x0 | +| 00000EED | 1 bit | bit **- fUsefFilled** | 0x1 | +| 00000EED | 1 bit | bit **- fUsefHitTestFill** | 0x0 | +| 00000EED | 1 bit | bit **- fUsefillShape** | 0x0 | +| 00000EED | 1 bit | bit **- fUsefillUseRect** | 0x0 | +| 00000EED | 1 bit | bit **- fUsefNoFillHitTest** | 0x1 | +| 00000EED | 9 bits | bit **- unused1** | 0x000 | +| 00000EED | 1 bit | bit **- fRecolorFillAsPicture** | 0x0 | +| 00000EED | 1 bit | bit **- fUseShapeAnchor** | 0x0 | +| 00000EED | 1 bit | bit **- fFilled** | 0x0 | +| 00000EED | 1 bit | bit **- fHitTestFill** | 0x0 | +| 00000EED | 1 bit | bit **- fillShape** | 0x0 | +| 00000EED | 1 bit | bit **- fillUseRect** | 0x0 | +| 00000EED | 1 bit | bit **- fNoFillHitTest** | 0x1 | + +Figure 24: Child-Record Hierarchy of Fill Style Boolean Properties Record O + +The record types within **Fill Style Boolean Properties** record **O** that have not been explained in previous structure examples are specified as follows: + +**fUsefRecolorFillAsPicture:** A value that specifies whether **fRecolorFillAsPicture** will be ignored and the default value used instead. The value 0x0 specifies that **fRecolorFillAsPicture** will be ignored and the default value used instead. + +**fUsefUseShapeAnchor:** A value that specifies whether **fUseShapeAnchor** will be ignored and the default value used instead. The value 0x0 specifies that **fUseShapeAnchor** will be ignored and the default value used instead. + +**fUsefFilled:** A value that specifies whether the **fFilled** bit is set. The value 0x1 specifies that the **fFilled** bit is set. + +**fUsefHitTestFill:** A value that specifies whether **fHitTestFill** will be ignored and the default value used instead. The value 0x0 specifies that **fHitTestFill** will be ignored and the default value used instead. + +**fUsefillShape:** A value that specifies whether **fillShape** will be ignored and the default value used instead. The value 0x0 specifies that **fillShape** will be ignored and the default value used instead. + +**fUsefillUseRect:** A value that specifies whether **fillUseRect** will be ignored and the default value used instead. The value 0x0 specifies that **fillUseRect** will be ignored and the default value used instead. + +**fUsefNoFillHitTest:** A value that specifies whether the **fNoFillHitTest** bit is set. The value 0x1 specifies that the **fNoFillHitTest** bit is set. + +**fRecolorFillAsPicture:** A value that specifies whether the **fillCrMod** property, as defined in section [2.3.7.6](#fillcrmod), will be used for recoloring. The value 0x0 specifies that the **fillCrMod** property will be used for recoloring. + +**fUseShapeAnchor:** A value that specifies whether the fill will be rotated with the shape. The value 0x0 specifies that the fill will not be rotated with the shape. + +**fFilled:** A value that specifies whether the fill of this shape will be rendered. The value 0x0 specifies that the fill of this shape will not be rendered. + +**fHitTestFill:** A value that specifies whether this fill is to be hit tested. The value 0x0 specifies that this fill is not to be hit tested. + +**fillShape:** A value that specifies whether the fill is aligned with the origin of the view. The value 0x0 specifies the fill is aligned with the origin of the view. + +**fillUseRect:** A value that specifies whether to use the bounding rectangle of the shape as the filled area. The value 0x0 specifies using the bounding rectangle of the shape as the filled area**.** + +**fNoFillHitTest:** A value that specifies whether this shape is to be hit tested as though it were filled. The value 0x1 specifies that this shape is to be hit tested as though it were filled. + +The following table shows the child-record hierarchy of **Line Style Boolean Properties** record **P**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000EF1 | 0006 | **P**: Line Style Boolean Properties **- Line Style Boolean Properties** | | +| 00000EF1 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000EF1 | 14 bits | bit **- opid** | 0x01FF | +| 00000EF1 | 1 bit | bit **- fBid** | 0x0 | +| 00000EF1 | 1 bit | bit **- fComplex** | 0x0 | +| 00000EF3 | 6 bits | bit **- unused4** | 0x00 | +| 00000EF3 | 1 bit | bit **- fUsefLineOpaqueBackColor** | 0x0 | +| 00000EF3 | 1 bit | bit **- unused3** | 0x0 | +| 00000EF3 | 1 bit | bit **- unused2** | 0x0 | +| 00000EF3 | 1 bit | bit **- fUsefInsetPen** | 0x0 | +| 00000EF3 | 1 bit | bit **- fUsefInsetPenOK** | 0x0 | +| 00000EF3 | 1 bit | bit **- fUsefArrowheadsOK** | 0x0 | +| 00000EF3 | 1 bit | bit **- fUsefLine** | 0x1 | +| 00000EF3 | 1 bit | bit **- fUsefHitTestLine** | 0x0 | +| 00000EF3 | 1 bit | bit **- fUsefLineFillShape** | 0x0 | +| 00000EF3 | 1 bit | bit **- fUsefNoLineDrawDash** | 0x0 | +| 00000EF3 | 6 bits | bit **- unused1** | 0x00 | +| 00000EF3 | 1 bit | bit **- fLineOpaqueBackColor** | 0x0 | +| 00000EF3 | 1 bit | bit **- reserved2** | 0x0 | +| 00000EF3 | 1 bit | bit **- reserved1** | 0x0 | +| 00000EF3 | 1 bit | bit **- fInsetPen** | 0x0 | +| 00000EF3 | 1 bit | bit **- fInsetPenOK** | 0x0 | +| 00000EF3 | 1 bit | bit **- fArrowheadsOK** | 0x0 | +| 00000EF3 | 1 bit | bit **- fLine** | 0x0 | +| 00000EF3 | 1 bit | bit **- fHitTestLine** | 0x0 | +| 00000EF3 | 1 bit | bit **- fLineFillShape** | 0x0 | +| 00000EF3 | 1 bit | bit **- fNoLineDrawDash** | 0x0 | + +Figure 25: Child-Record Hierarchy of Line Style Boolean Properties Record P + +The record types within **Line Style Boolean Properties** record **P** that have not been explained in previous structure examples are specified as follows: + +**fUsefLineOpaqueBackColor:** A value that specifies whether **fLineOpaqueBackColor** will be ignored and the default value used instead. The value 0x0 specifies that **fLineOpaqueBackColor** will be ignored and the default value used instead. + +**fUsefInsetPen:** A value that specifies whether the **fInsetPen** will be ignored and the default value used instead. The value 0x0 specifies that **fInsetPen** will be ignored and the default value used instead. + +**fUsefInsetPenOK:** A value that specifies whether **fInsetPenOK** will be ignored and the default value used instead. The value 0x0 specifies that **fInsetPenOK** will be ignored and the default value used instead. + +**fUsefArrowheadsOK:** A value that specifies whether **fArrowheadsOK** will be ignored and the default value used instead. The value 0x0 specifies that **fArrowheadsOK** will be ignored and the default value used instead. + +**fUsefLine:** A value that specifies whether **fLine** will be ignored and the default value used instead. The value 0x1 specifies that the value for **fLine** will be used. + +**fUsefHitTestLine:** A value that specifies whether **fHitTestLine** will be ignored and the default value used instead. The value 0x0 specifies that **fHitTestLine** will be ignored and the default value used instead. + +**fUsefLineFillShape:** A value that specifies whether **fLineFillShape** will be ignored and the default value used instead. The value 0x0 specifies that **fLineFillShape** will be ignored and the default value used instead. + +**fUsefNoLineDrawDash:** A value that specifies whether **fNoLineDrawDash** will be ignored and the default value used instead. The value 0x0 specifies that **fNoLineDrawDash** will be ignored and the default value used instead. + +**fLineOpaqueBackColor:** A value that specifies whether an extra line is to be rendered underneath the line that is specified by this property set. The value 0x0 specifies that an extra line is not to be rendered underneath the line that is specified by this property set. + +**fInsetPen:** A value that specifies whether the pen is inset. The value 0x0 specifies that the pen is not inset. + +**fInsetPenOK:** A value that specifies whether insetting the pen is allowed. The value 0x0 specifies that insetting the pen is not allowed. + +**fArrowheadsOK:** A value that specifies whether the arrowhead properties are to be editable. The value 0x0 specifies that the arrowhead properties are not to be editable. + +**fLine:** A value that specifies whether the lines of this shape will be drawn. The value 0x0 specifies that the lines of this shape will not be drawn. + +**fHitTestLine:** A value that specifies whether this line is be hit tested. The value 0x0 specifies that this line is not be hit tested. + +**fLineFillShape:** A value that specifies whether the pattern or texture fill is to be aligned with the origin of the view. The value 0x0 specifies that the pattern or texture fill is to be aligned with the origin of the view. + +**fNoLineDrawDash:** A value that specifies whether a dashed line is to be drawn. The value 0x0 specifies that a dashed line is not to be drawn. + +The following table shows the child-record hierarchy of **Shape Boolean Properties** record **Q**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000EF7 | 0006 | **Q**: Shape Boolean Properties **- Shape Boolean Properties** | | +| 00000EF7 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000EF7 | 14 bits | bit **- opid** | 0x033F | +| 00000EF7 | 1 bit | bit **- fBid** | 0x0 | +| 00000EF7 | 1 bit | bit **- fComplex** | 0x0 | +| 00000EF9 | 6 bits | bit **- unused3** | 0x00 | +| 00000EF9 | 1 bit | bit **- fUsefPolicyLabel** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefPolicyBarcode** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefFlipHOverride** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefFlipVOverride** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefOleIcon** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefPreferRelativeResize** | 0x1 | +| 00000EF9 | 1 bit | bit **- fUsefLockShapeType** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefInitiator** | 0x0 | +| 00000EF9 | 1 bit | bit **- unused2** | 0x0 | +| 00000EF9 | 1 bit | bit **- fUsefBackground** | 0x0 | +| 00000EF9 | 6 bits | bit **- unused1** | 0x00 | +| 00000EF9 | 1 bit | bit **- fPolicyLabel** | 0x0 | +| 00000EF9 | 1 bit | bit **- fPolicyBarcode** | 0x0 | +| 00000EF9 | 1 bit | bit **- fFlipHOverride** | 0x0 | +| 00000EF9 | 1 bit | bit **- fFlipVOverride** | 0x0 | +| 00000EF9 | 1 bit | bit **- fOleIcon** | 0x0 | +| 00000EF9 | 1 bit | bit **- fPreferRelativeResize** | 0x0 | +| 00000EF9 | 1 bit | bit **- fLockShapeType** | 0x0 | +| 00000EF9 | 1 bit | bit **- fInitiator** | 0x0 | +| 00000EF9 | 1 bit | bit **- reserved1** | 0x0 | +| 00000EF9 | 1 bit | bit **- fBackground** | 0x0 | + +Figure 26: Child-Record Hierarchy of Shape Boolean Properties Record Q + +The record types within **Shape Boolean Properties** record **Q** that have not been explained in previous structure examples are specified as follows: + +**fUsefPolicyLabel:** A value that specifies whether **fPolicyLabel** will be ignored and the default value used instead. The value 0x0 specifies that **fPolicyLabel** will be ignored and the default value used instead. + +**fUsefPolicyBarcode:** A value that specifies whether **fPolicyBarcode** will be ignored and the default value used instead. The value 0x0 specifies that **fPolicyBarcode** will be ignored and the default value used instead. + +**fUsefFlipHOverride:** A value that specifies whether **fFlipHOverride** will be ignored and the default value used instead. The value 0x0 specifies that **fFlipHOverride** will be ignored and the default value used instead. + +**fUsefFlipVOverride:** A value that specifies whether **fFlipVOverride** will be ignored and the default value used instead. The value 0x0 specifies that **fFlipVOverride** will be ignored and the default value used instead. + +**fUsefOleIcon:** A value that specifies whether **fOleIcon** will be ignored and the default value used instead. The value 0x0 specifies that **fOleIcon** will be ignored and the default value used instead. + +**fUsefPreferRelativeResize:** A value that specifies whether the **fPreferRelativeResize** bit has been set. The value 0x1 specifies that the **fPreferRelativeResize** bit has been set. + +**fUsefLockShapeType:** A value that specifies whether **fLockShapeType** will be ignored and the default value used instead. The value 0x0 specifies that **fLockShapeType** will be ignored and the default value used instead. + +**fUsefInitiator:** A value that specifies whether **fInitiator** will be ignored and the default value used instead. The value 0x0 specifies that **fInitiator** will be ignored and the default value used instead. + +**fUsefBackground:** A value that specifies whether **fBackground** will be ignored and the default value used instead. The value 0x0 specifies that **fBackground** will be ignored and the default value used instead. + +**fPolicyLabel:** A value that specifies whether this object is a label image and will be used to identify the containing document as part of a [**content management system**](#gt_8265634f-8937-416a-8e21-220744453d2e). The value 0x0 specifies that this object is not a label image and will not be used to identify the containing document as part of a content management system. + +**fPolicyBarcode:** A value that specifies whether this object is a barcode image and will be used to identify the containing document as part of a content management system. The value 0x0 specifies that this object is not a barcode image and will not be used to identify the containing document as part of a content management system. + +**fFlipHOverride:** A value that specifies whether the **fFlipH** flag in the **OfficeArtFSP** record, as defined in section 2.2.40, of the containing **OfficeArtSpContainer** record, as defined in section 2.2.14, is to be used. The value 0x0 specifies that the **fFlipH** flag in the **OfficeArtFSP** of the containing **OfficeArtSpContainer** is to be used. + +**fFlipVOverride:** A value that specifies whether the **fFlipV** flag in the **OfficeArtFSP** record, as defined in section 2.2.40, of the containing **OfficeArtSpContainer** record, as defined in section 2.2.14, is to be used. The value 0x0 specifies that the **fFlipV** flag in the **OfficeArtFSP** of the containing **OfficeArtSpContainer** is to be used. + +**fOleIcon:** A value that specifies whether this OLE object will be displayed as an icon. The value 0x0 specifies that this OLE object will not be displayed as an icon. + +**fPreferRelativeResize:** A value that specifies whether the application’s user interface for resizing this shape is to express its size relative to the current size. The value 0x0 specifies that the application’s user interface for resizing this shape is not to express its size relative to the current size. + +**fLockShapeType:** A value that specifies whether the shape type is locked and can be changed by the end user. The value 0x0 specifies that the shape type is not locked and can be changed by the end user. + +**fInitiator:** A value that specifies whether this shape is to be processed by a [**rules**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) engine. The value 0x0 specifies that this shape is not to be processed by a rules engine. + +**fBackground:** A value that specifies whether this shape is the background shape of a drawing. The value 0x0 specifies that this shape is not the background shape of a drawing. + +The following table shows the child-record hierarchy of **OfficeArtChildAnchor** record, as defined in section 2.2.39, **R**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000EFD | 0018 | **R**: OfficeArtChildAnchor **- case_of_msofbtChildAnchor** | | +| 00000EFD | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000F05 | 0010 | OfficeArtFRC **- frc** | | +| 00000F05 | 0004 | LONG **- xLeft** | 0x00000480 | +| 00000F09 | 0004 | LONG **- yTop** | 0x00000510 | +| 00000F0D | 0004 | LONG **- xRight** | 0x00000FC0 | +| 00000F11 | 0004 | LONG **- yBottom** | 0x00000B40 | + +Figure 27: Child-Record Hierarchy of OfficeArtChildAnchor Record R + +**OfficeArtChildAnchor** record **R** specifies the coordinate system of the group shape that the anchors of the child shape are expressed in. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock**, as defined in section 2.2.17, record **D**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000F15 | 007C | **D**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 00000F15 | 007C | OfficeArtSpContainer **- case_of_msofbtSpContainer** | | +| 00000F15 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000F1D | 0010 | OfficeArtFSP **- shapeProp** | | +| 00000F2D | 004C | OfficeArtFOPT **- shapePrimaryOptions** | | +| 00000F2D | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000F35 | 0044 | OfficeArtRGFOPTE **- fopt** | | +| 00000F35 | 0006 | [rotation](#rotation) **- rotation** | | +| 00000F35 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F37 | 0004 | FixedPoint **- rotation** | 0x010E0000 | +| 00000F3B | 0006 | [adjustValue](#adjustvalue) **- adjustValue** | | +| 00000F3B | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F3D | 0004 | LONG **- adjustValue** | 0xFFF769F3 | +| 00000F41 | 0006 | [adjust2Value](#adjust2value) **- adjust2Value** | | +| 00000F41 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F43 | 0004 | LONG **- adjust2Value** | 0xFFFFFFFF | +| 00000F47 | 0006 | [adjust3Value](#adjust3value) **- adjust3Value** | | +| 00000F47 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F49 | 0004 | LONG **- adjust3Value** | 0xFFF769F3 | +| 00000F4D | 0006 | **S**: [lineColor](#linecolor) **- lineColor** | | +| 00000F4D | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F4F | 0004 | [OfficeArtCOLORREF](#officeartcolorref) **- lineColor** | | +| 00000F53 | 0006 | [lineWidth](#linewidth) **- lineWidth** | | +| 00000F53 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F55 | 0004 | LONG **- lineWidth** | 0x00006F9F | +| 00000F59 | 0006 | **T**: Line Style Boolean Properties **- Line Style Boolean** | | +| 00000F5F | 0006 | [cxstyle](#cxstyle) **- cxstyle** | | +| 00000F5F | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F61 | 0004 | [MSOCXSTYLE](#msocxstyle) **- cxstyle** | 0x00000001 | +| 00000F65 | 0006 | [wzName](#wzname) **- wzName** | | +| 00000F65 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F67 | 0004 | ULONG **- wzName** | 0x0000000E | +| 00000F6B | 000E | [wzName_complex](#wzname_complex) **- wzName_complex** | | +| 00000F6B | 000E | WideString **- wzName** | \_s2072 | +| 00000F79 | 0018 | OfficeArtChildAnchor **- childAnchor** | | + +Figure 28: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record D + +The record types within **OfficeArtSpgrContainerFileBlock** record **D** that have not been explained in previous structure examples are specified as follows: + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.rotation:** A property that specifies the rotation on a shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.rotation.rotation:** The rotation (0x010E0000) on the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.adjustValue:** A property that specifies a value that a user can change to adjust the geometry of the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.adjustValue.adjustValue:** A value (0xFFF769F3) that is used to adjust the geometry of this shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.adjust2Value:** A property that specifies a value that a user can change to adjust the geometry of the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.adjust2Value.adjust2Value:** A value (0xFFFFFFFF) that is used to adjust the geometry of this shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.adjust3Value:** A property that specifies a value that a user can change to adjust the geometry of the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.adjust3Value.adjust3Value:** A value (0xFFF769F3) that is used to adjust the geometry of this shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.lineColor:** A property that specifies the foreground color of the line. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.lineColor.lineColor:** An **OfficeArtCOLORREF** record, as defined in section 2.2.2, that specifies the color to use while drawing. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.lineWidth:** A property that specifies the width of the line. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.lineWidth.lineWidth:** The width (0x00006F9F) of the line. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.cxstyle:** A property that specifies the connector style. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.cxstyle.cxstyle:** A value (0x00000001) that specifies that this shape is an elbow-shaped connector. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.wzName:** A property that specifies the name of the shape. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.wzName.wzName:** The number (0x0000000E) of bytes of data that is contained in the **wzName_complex** property, as defined in section 2.3.4.2. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.wzName_complex:** A property that specifies additional data for the **wzName** property, as defined in section 2.3.4.1. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.wzName_complex.wzName:** The name (\_s2072) of the shape. + +The following two example structures show the records labeled **S** and **T** from **OfficeArtSpgrContainerFileBlock** record **D** in more detail. + +The following table shows the child-record hierarchy of **lineColor** record **S**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------|-----------| +| 00000F4D | 0006 | **S**: lineColor **- lineColor** | | +| 00000F4D | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F4D | 14 bits | bit **- opid** | 0x01C0 | +| 00000F4D | 1 bit | bit **- fBid** | 0x0 | +| 00000F4D | 1 bit | bit **- fComplex** | 0x0 | +| 00000F4F | 0004 | OfficeArtCOLORREF **- lineColor** | | +| 00000F52 | 1 bit | bit **- unused3** | 0x0 | +| 00000F52 | 1 bit | bit **- unused2** | 0x0 | +| 00000F52 | 1 bit | bit **- unused1** | 0x0 | +| 00000F52 | 1 bit | bit **- fSysIndex** | 0x0 | +| 00000F52 | 1 bit | bit **- fSchemeIndex** | 0x1 | +| 00000F52 | 1 bit | bit **- fSystemRGB** | 0x0 | +| 00000F52 | 1 bit | bit **- fPaletteRGB** | 0x0 | +| 00000F52 | 1 bit | bit **- fPaletteIndex** | 0x0 | +| 00000F51 | 0001 | BYTE **- blue** | 0x00 | +| 00000F50 | 0001 | BYTE **- green** | 0x00 | +| 00000F4F | 0001 | BYTE **- red** | 0x01 | + +Figure 29: Child-Record Hierarchy of lineColor Record S + +The record types within **lineColor** record **S** that have not been explained in previous structure examples are specified as follows: + +**opid:** An **OfficeArtFOPTEOPID** record, as defined in section 2.2.8, that specifies the header for an entry in a property table. + +**lineColor:** An **OfficeArtCOLORREF** structure, as defined in section 2.2.2, that specifies the foreground color of the line. + +**lineColor.unused3:** A value that is undefined and needs to be ignored. + +**lineColor.unused2:** A value that is undefined and needs to be ignored. + +**lineColor.unused1:** A value that is undefined and needs to be ignored. + +**lineColor.fSysIndex:** A value (0x0) specifying that the system color scheme will not be used to determine the color.  + +**lineColor.fSchemeIndex:** A value (0x1) specifying that the current color scheme will be used to determine the color. The value 0x1 indicates that **red** provides an index into the current scheme color table. When the value of **fSchemeIndex** is 0x1, the values of **green** and **blue** need to be 0x00. + +**lineColor.fSystemRGB:** A value (0x0) that specifies whether the color is a standard RGB color. The value 0x0 indicates that the RGB color might use half-tone dithering to display. + +**lineColor.fPaletteRGB:** A value (0x0) specifying that the current palette will not be used to determine the color. + +**lineColor.fPaletteIndex:** A value (0x0) specifying that the current palette will not be used to determine the color. + +**lineColor.blue:** A property that will be ignored when **fSchemeIndex** is set to 0x1. + +**lineColor.green:** A property that will be ignored when **fSchemeIndex** is set to 0x1. + +**lineColor.red:** The index (0x01) into the current scheme color table when **fSchemeIndex** is set to 0x1. + +The following table shows the child-record hierarchy of **Line Style Boolean Properties** record **T**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000F59 | 0006 | **T**: Line Style Boolean Properties **- Line Style Boolean Properties** | | +| 00000F59 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000F59 | 14 bits | bit **- opid** | 0x01FF | +| 00000F59 | 1 bit | bit **- fBid** | 0x0 | +| 00000F59 | 1 bit | bit **- fComplex** | 0x0 | +| 00000F5B | 6 bits | bit **- unused4** | 0x00 | +| 00000F5B | 1 bit | bit **- fUsefLineOpaqueBackColor** | 0x0 | +| 00000F5B | 1 bit | bit **- unused3** | 0x0 | +| 00000F5B | 1 bit | bit **- unused2** | 0x0 | +| 00000F5B | 1 bit | bit **- fUsefInsetPen** | 0x0 | +| 00000F5B | 1 bit | bit **- fUsefInsetPenOK** | 0x0 | +| 00000F5B | 1 bit | bit **- fUsefArrowheadsOK** | 0x0 | +| 00000F5B | 1 bit | bit **- fUsefLine** | 0x1 | +| 00000F5B | 1 bit | bit **- fUsefHitTestLine** | 0x0 | +| 00000F5B | 1 bit | bit **- fUselineFillShape** | 0x0 | +| 00000F5B | 1 bit | bit **- fUsefNoLineDrawDash** | 0x0 | +| 00000F5B | 6 bits | bit **- unused1** | 0x00 | +| 00000F5B | 1 bit | bit **- fLineOpaqueBackColor** | 0x0 | +| 00000F5B | 1 bit | bit **- reserved2** | 0x0 | +| 00000F5B | 1 bit | bit **- reserved1** | 0x0 | +| 00000F5B | 1 bit | bit **- fInsetPen** | 0x0 | +| 00000F5B | 1 bit | bit **- fInsetPenOK** | 0x0 | +| 00000F5B | 1 bit | bit **- fArrowheadsOK** | 0x0 | +| 00000F5B | 1 bit | bit **- fLine** | 0x1 | +| 00000F5B | 1 bit | bit **- fHitTestLine** | 0x0 | +| 00000F5B | 1 bit | bit **- lineFillShape** | 0x0 | +| 00000F5B | 1 bit | bit **- fNoLineDrawDash** | 0x0 | + +Figure 30: Child-Record Hierarchy of Line Style Boolean Properties Record T + +**Line Style Boolean Properties** record **T** is similar to **Line Style Boolean Properties** record **P**, except that the **fLine** property in record **T** is set to 0x1, which specifies displaying other line properties in the line style when handling a 2-D shape. The **fLine** property in record **P** is set to 0x0, so the other line properties in that line style will not be displayed. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock**, as defined in section 2.2.17, record **E**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 0000117B | 00EB | **E**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 0000117B | 00EB | OfficeArtSpContainer **- case_of_msofbtSpContainer** | | +| 0000117B | 0008 | OfficeArtRecordHeader **- rh** | | +| 00001183 | 0010 | OfficeArtFSP **- shapeProp** | | +| 00001193 | 005E | OfficeArtFOPT **- shapePrimaryOptions** | | +| 00001193 | 0008 | OfficeArtRecordHeader **- rh** | | +| 0000119B | 0056 | OfficeArtRGFOPTE **- fopt** | | +| 0000119B | 0006 | [lTxid](#ltxid) **- lTxid** | | +| 0000119B | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 0000119D | 0004 | LONG **- lTxid** | 0x00AEDC04 | +| 000011A1 | 0006 | [dxTextLeft](#dxtextleft) **- dxTextLeft** | | +| 000011A1 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011A3 | 0004 | LONG **- dxTextLeft** | 0x00000000 | +| 000011A7 | 0006 | [dyTextTop](#dytexttop) **- dyTextTop** | | +| 000011A7 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011A9 | 0004 | LONG **- dyTextTop** | 0x00000000 | +| 000011AD | 0006 | [dxTextRight](#dxtextright) **- dxTextRight** | | +| 000011AD | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011AF | 0004 | LONG **- dxTextRight** | 0x00000000 | +| 000011B3 | 0006 | [dyTextBottom](#dytextbottom) **- dyTextBottom** | | +| 000011B3 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011B5 | 0004 | LONG **- dyTextBottom** | 0x00000000 | +| 000011B9 | 0006 | [WrapText](#wraptext) **- WrapText** | | +| 000011B9 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011BB | 0004 | [MSOWRAPMODE](#msowrapmode) **- WrapText** | 0x00000002 | +| 000011BF | 0006 | [anchorText](#anchortext) **- anchorText** | | +| 000011BF | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011C1 | 0004 | [MSOANCHOR](#msoanchor) **- anchorText** | 0x00000001 | +| 000011C5 | 0006 | **U**: [fillColor](#fillcolor) **- fillColor** | | +| 000011CB | 0006 | **V**: Fill Style Boolean Properties **- Fill Style Boolean Properties** | | +| 000011D1 | 0006 | lineColor **- lineColor** | | +| 000011D1 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011D3 | 0004 | OfficeArtCOLORREF **- lineColor** | | +| 000011D7 | 0006 | Line Style Boolean Properties **- Line Style Boolean Properties** | | +| 000011DD | 0006 | wzName **- wzName** | | +| 000011DD | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011DF | 0004 | ULONG **- wzName** | 0x0000000E | +| 000011E3 | 000E | wzName_complex **- wzName_complex** | | +| 000011E3 | 000E | WideString **- wzName** | \_s2054 | +| 000011F1 | 001A | OfficeArtTertiaryFOPT **- shapeTertiaryOptions** | | +| 0000120B | 0018 | OfficeArtChildAnchor **- childAnchor** | | +| 00001223 | 0043 | OfficeArtClientTextbox **- clientTextbox** | | + +Figure 31: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record E + +The record types within **OfficeArtSpgrContainerFileBlock** record **E** that have not been explained in previous structure examples are specified as follows: + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.lTxid:** A property that specifies an identifier for the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.lTxid.lTxid:** An identifier (0x00AEDC04) for the text. The value is determined by the host application. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dxTextLeft:** A property that specifies the size of the margin to the left of the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dxTextLeft.dxTextLeft:** The size (0x00000000) of the margin that exists inside the containing shape to the left of the text. The unit of measurement is an [**EMU**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39). + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dyTextTop:** A property that specifies the size of the margin above the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dyTextTop.dyTextTop:** The size (0x00000000) of the margin that exists inside the containing shape above the text. The unit of measurement is an EMU. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dxTextRight:** A property that specifies the size of the margin to the right of the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dxTextRight.dxTextRight:** The size (0x00000000) of the margin that exists inside the containing shape to the right of the text. The unit of measurement is an EMU. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dyTextBottom:** A property that specifies the size of the margin below the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.dyTextBottom.dyTextBottom:** The size (0x00000000) of the margin that exists inside the containing shape below the text. The unit of measurement is an EMU. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.WrapText:** A property that specifies the type of wrapping applied to the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.WrapText.WrapText:** A value (0x00000002) specifying that a line of text will extend into or beyond a margin instead of continuing on subsequent lines. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.anchorText:** A property that specifies the type of anchor applied to the text. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.anchorText.anchorText:** A value that specifies the primary determinant for the placement of the text. The value 0x00000001 specifies that the vertical center of the text will coincide with the vertical midpoint of the internal margins of the text box area. + +**case_of_msofbtSpContainer.shapePrimaryOptions.fopt.fillColor:** A property that specifies the foreground color of the fill. + +The following two example structures show the records labeled **U** and **V** from **OfficeArtSpgrContainerFileBlock** record **E** in more detail. + +The following table shows the child-record hierarchy of **fillColor** record **U**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------|-----------| +| 000011C5 | 0006 | **U**: fillColor **- fillColor** | | +| 000011C5 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011C5 | 14 bits | bit **- opid** | 0x0181 | +| 000011C5 | 1 bit | bit **- fBid** | 0x0 | +| 000011C5 | 1 bit | bit **- fComplex** | 0x0 | +| 000011C7 | 0004 | OfficeArtCOLORREF **- fillColor** | | +| 000011CA | 1 bit | bit **- unused3** | 0x0 | +| 000011CA | 1 bit | bit **- unused2** | 0x0 | +| 000011CA | 1 bit | bit **- unused1** | 0x0 | +| 000011CA | 1 bit | bit **- fSysIndex** | 0x0 | +| 000011CA | 1 bit | bit **- fSchemeIndex** | 0x1 | +| 000011CA | 1 bit | bit **- fSystemRGB** | 0x0 | +| 000011CA | 1 bit | bit **- fPaletteRGB** | 0x0 | +| 000011CA | 1 bit | bit **- fPaletteIndex** | 0x0 | +| 000011C9 | 0001 | BYTE **- blue** | 0x00 | +| 000011C8 | 0001 | BYTE **- green** | 0x00 | +| 000011C7 | 0001 | BYTE **- red** | 0x04 | + +Figure 32: Child-Record Hierarchy of fillColor Record U + +The properties in **fillColor** record **U** are similar to the color properties in **lineColor** record **S**. Record **S** outlines color properties applied to a line. Record **U** outlines color properties applied to a shape fill. For more details about the property values that are listed in record **U**, see the property value definitions for record **S** earlier in this section. + +The following table shows the child-record hierarchy of **Fill Style Boolean Properties** record **V**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000011CB | 0006 | **V**: Fill Style Boolean Properties **- Fill Style Boolean Properties** | | +| 000011CB | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000011CB | 14 bits | bit **- opid** | 0x01BF | +| 000011CB | 1 bit | bit **- fBid** | 0x0 | +| 000011CB | 1 bit | bit **- fComplex** | 0x0 | +| 000011CD | 9 bits | bit **- unused1** | 0x000 | +| 000011CD | 1 bit | bit **- fUsefRecolorFillAsPicture** | 0x0 | +| 000011CD | 1 bit | bit **- fUsefUseShapeAnchor** | 0x0 | +| 000011CD | 1 bit | bit **- fUsefFilled** | 0x1 | +| 000011CD | 1 bit | bit **- fUsefHitTestFill** | 0x0 | +| 000011CD | 1 bit | bit **- fUsefillShape** | 0x0 | +| 000011CD | 1 bit | bit **- fUsefillUseRect** | 0x0 | +| 000011CD | 1 bit | bit **- fUsefNoFillHitTest** | 0x0 | +| 000011CD | 9 bits | bit **- unused2** | 0x000 | +| 000011CD | 1 bit | bit **- fRecolorFillAsPicture** | 0x0 | +| 000011CD | 1 bit | bit **- fUseShapeAnchor** | 0x0 | +| 000011CD | 1 bit | bit **- fFilled** | 0x1 | +| 000011CD | 1 bit | bit **- fHitTestFill** | 0x0 | +| 000011CD | 1 bit | bit **- fillShape** | 0x0 | +| 000011CD | 1 bit | bit **- fillUseRect** | 0x0 | +| 000011CD | 1 bit | bit **- fNoFillHitTest** | 0x0 | + +Figure 33: Child-Record Hierarchy of Fill Style Boolean Properties Record V + +**Fill Style Boolean Properties** record **V** is similar to **Fill Style Boolean Properties** record **O**. Record **O** outlines property settings that will not render the shape fill. Record **V** outlines values that will render the shape fill. For more details about the property values that are listed in record **V**, see the property value definitions that are listed for record **O** earlier in this section. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock**, as defined in section 2.2.17, record **F**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00001266 | 00E5 | **F**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 00001266 | 00E5 | OfficeArtSpContainer **- case_of_msofbtSpContainer** | | +| 00001266 | 0008 | OfficeArtRecordHeader **- rh** | | +| 0000126E | 0010 | OfficeArtFSP **- shapeProp** | | +| 0000127E | 005E | OfficeArtFOPT **- shapePrimaryOptions** | | +| 000012DC | 0014 | **W**: OfficeArtTertiaryFOPT **- shapeTertiaryOptons** | | +| 000012F0 | 0018 | OfficeArtChildAnchor **- childAnchor** | | +| 00001308 | 0043 | OfficeArtClientTextbox **- clientTextbox** | | +| 00001308 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00001310 | 003B | TextClientDataRecordArray **- rgChildRec** | | +| 00001310 | 000C | TextClientDataSubContainerOrAtom **- rec** | | +| 00001310 | 000C | TextHeaderAtom **- case_of_RT_TextHeaderAtom** | | +| 00001310 | 0008 | RecordHeader **- rh** | | +| 00001318 | 0004 | TextTypeEnum **- textType** | 0x00000004 | +| 0000131C | 0011 | TextClientDataSubContainerOrAtom **- rec1** | | +| 0000131C | 0011 | TextBytesAtom **- case_of_RT_TextBytesAtom** | | +| 0000131C | 0008 | RecordHeader **- rh** | | +| 00001324 | 0009 | NarrowStringBufferEx **- textBytes** | Shape 2.0 | +| 0000132D | 001E | TextClientDataSubContainerOrAtom **- rec2** | | +| 0000132D | 001E | StyleTextPropAtom **- case_of_RT_StyleTextPropAtom** | | +| 0000132D | 0008 | RecordHeader **- rh** | | +| 00001335 | 000C | **X**: TextPFRunArray **- rgTextPFRun** | | +| 00001341 | 000A | **Y**: TextCFRunArray **- rgTextCFRun** | | + +Figure 34: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record F + +The record types within **OfficeArtSpgrContainerFileBlock** record **F** that have not been explained in previous structure examples are specified by the following definitions. The host application defines these fields and records. For more information, see [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) section 2.9.76. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec:** An array of **TextClientDataSubContainerOrAtom** records. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec:** A **TextClientDataSubContainerOrAtom** record, which is a variable-type record. The type and meaning of this record is dictated by the value of **rh.recType** (not shown in this example). + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec.case_of_RT_TextHeaderAtom:** An [**atom**](#gt_e0c68b3f-d976-411b-a247-7cef57e73728) record that specifies the type of a text body. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec.case_of_RT_TextHeaderAtom.textType:** A value (0x00000004) specifying that the text is of type "Any other text". + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec1.case_of_RT_TextBytesAtom:** An atom record that specifies Unicode characters. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec1.case_of_RT_TextBytesAtom.textBytes:** A value ("Shape 2.0") specifying that the text string within **shape**.**textBytes** is an array of bytes containing the characters of the corresponding text. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec2.case_of_RT_StyleTextPropAtom:** An atom record that specifies character-level and paragraph-level formatting. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec2.case_of_RT_StyleTextPropAtom.rgTextPFRun:** An array of **TextPFRun** container records that each specify paragraph-level formatting for a length of the corresponding text. + +**case_of_msofbtSpContainer.clientTextbox.rgChildRec.rec2.case_of_RT_StyleTextPropAtom.rgTextCFRun:** An array of **TextCFRun** container records that each specify character-level formatting for a length of the corresponding text. + +The following three example structures show the records labeled **W**, **X**, and **Y** from **OfficeArtSpgrContainerFileBlock** record **F** in more detail. + +The following table shows the child-record hierarchy of the **OfficeArtTertiaryFOPT** record, as defined in section 2.2.11, **W**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000012DC | 0014 | **W**: OfficeArtTertiaryFOPT **- shapeTertiaryOptions** | | +| 000012DC | 0008 | OfficeArtRecordHeader **- rh** | | +| 000012E4 | 000C | OfficeArtRGFOPTE **- fopt** | | +| 000012E4 | 0006 | [dgmLayout](#dgmlayout) **- dgmLayout** | | +| 000012E4 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000012E4 | 14 bits | bit **- opid** | 0x0309 | +| 000012E4 | 1 bit | bit **- fBid** | 0x0 | +| 000012E4 | 1 bit | bit **- fComplex** | 0x0 | +| 000012E6 | 0004 | [MSODGMLO](#msodgmlo) **- dgmLayout** | 0x00000000 | +| 000012EA | 0006 | [dgmNodeKind](#dgmnodekind) **- dgmNodeKind** | | +| 000012EA | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000012EA | 14 bits | bit **- opid** | 0x030A | +| 000012EA | 1 bit | bit **- fBid** | 0x0 | +| 000012EA | 1 bit | bit **- fComplex** | 0x0 | +| 000012EC | 0004 | LONG **- dgmNodeKind** | 0x00000000 | + +Figure 35: Child-Record Hierarchy of OfficeArtTertiaryFOPT Record W + +The record types within **OfficeArtTertiaryFOPT** record **W** that have not been explained in previous structure examples are specified as follows: + +**fopt.dgmLayout:** A property that specifies the diagram node layout for a shape. + +**fopt.dgmLayout.dgmLayout:** A value (0x00000000) specifying that this **MSODGMLO** layout is an organizational chart. + +**fopt.dgmNodeKind:** A property that specifies a diagram node type. + +**fopt.dgmNodeKind.dgmNodeKind:** A value (0x00000000) specifying that this node is a regular diagram node of no particular type. + +The following table shows the child-record hierarchy of **TextPFRunArray** record **X**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------------|------------| +| 00001335 | 000C | **X**: TextPFRunArray **- rgTextPFRun** | | +| 00001335 | 000C | TextPFRun **- textPFRun** | | +| 00001335 | 0004 | ULONG **- runCount** | 0x0000000A | +| 00001339 | 0002 | USHORT **- indentLevel** | 0x0000 | +| 0000133B | 0006 | TextPFException **- pf** | | +| 0000133B | 0004 | PFMasks **- masks** | | +| 0000133F | 0002 | TextAlignmentEnum **- textAlignment** | 0x0001 | + +Figure 36: Child-Record Hierarchy of TextPFRunArray Record X + +The fields and records for text in **TextPFRunArray** record **X** are defined by the host application. For more information, see \[MS-PPT\] section 2.9.45. Record **X** might appear differently for each host application. Some text, font, and paragraph properties might be located in other containers, depending on the structure requirements for each host application. + +The following table shows the child-record hierarchy of **TextCFRunArray** record **Y**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------------|------------| +| 00001341 | 000A | **Y**: TextCFRunArray **- rgTextCFRun** | | +| 00001341 | 000A | TextCFRun **- textCFRun** | | +| 00001341 | 0004 | ULONG **- runCount** | 0x0000000A | +| 00001345 | 0006 | TextCFException **- cf** | | +| 00001345 | 0004 | CFMasks **- masks** | | +| 00001349 | 0002 | SHORT **- fontSize** | 0x000D | + +Figure 37: Child-Record Hierarchy of TextCFRunArray Record Y + +The fields and records for text in **TextCFRunArray** record **Y** are defined by the host application. For more information, see \[MS-PPT\] section 2.9.46. Record **Y** might appear differently for each host application. Some text, font, and paragraph properties might be located in other containers, depending on the structure requirements for each host application. + +The following table shows the child-record hierarchy of **OfficeArtSpgrContainerFileBlock**, as defined in section 2.2.17, record **G**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00001430 | 00E5 | **G**: OfficeArtSpgrContainerFileBlock **- OfficeArtSpgrContainerFB** | | +| 00001430 | 00E5 | OfficeArtSpContainer **- case_of_msofbtSpContainer** | | +| 00001430 | 0008 | OfficeArtRecordHeader **- rh** | | +| 00001438 | 0010 | OfficeArtFSP **- shapeProp** | | +| 00001448 | 005E | OfficeArtFOPT **- shapePrimaryOptions** | | +| 000014A6 | 0014 | OfficeArtTertiaryFOPT **- shapeTertiaryOptions** | | +| 000014A6 | 0008 | OfficeArtRecordHeader **- rh** | | +| 000014AE | 000C | OfficeArtRGFOPTE **- fopt** | | +| 000014AE | 0006 | dgmLayout **- dgmLayout** | | +| 000014AE | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000014B0 | 0004 | MSODGMLO **- dgmLayout** | 0x00000000 | +| 000014B4 | 0006 | dgmNodeKind **- dgmNodeKind** | | +| 000014B4 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 000014B6 | 0004 | LONG **- dgmNodeKind** | 0x00000000 | +| 000014BA | 0018 | OfficeArtChildAnchor **- childAnchor** | | +| 000014D2 | 0043 | OfficeArtClientTextbox **- clientTextbox** | | + +Figure 38: Child-Record Hierarchy of OfficeArtSpgrContainerFileBlock Record G + +### OfficeArtSpContainer + +The following table shows the child-record hierarchy of **OfficeArtSpContainer**, as defined in section [2.2.14](#officeartspcontainer), container **3**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000016F5 | 0050 | **3**: OfficeArtSpContainer **- shape** | | +| 000016F5 | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | | +| 000016FD | 0010 | [OfficeArtFSP](#officeartfsp) **- shapeProp** | | +| 0000170D | 0038 | [OfficeArtFOPT](#officeartfopt) **- shapePrimaryOptions** | | +| 0000170D | 0008 | OfficeArtRecordHeader **- rh** | | +| 00001715 | 0030 | [OfficeArtRGFOPTE](#officeartrgfopte) **- fopt** | | +| 00001715 | 0006 | [fillColor](#fillcolor) **- fillColor** | | +| 00001715 | 0002 | [OfficeArtFOPTEOPID](#officeartfopteopid) **- opid** | | +| 00001717 | 0004 | [OfficeArtCOLORREF](#officeartcolorref) **- fillColor** | | +| 0000171B | 0006 | [fillBackColor](#fillbackcolor) **- fillBackColor** | | +| 0000171B | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 0000171D | 0004 | **A**: OfficeArtCOLORREF **- fillBackColor** | | +| 00001721 | 0006 | [fillRectRight](#fillrectright) **- fillRectRight** | | +| 00001721 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00001723 | 0004 | LONG **- fillRectRight** | 0x008B9F8E | +| 00001727 | 0006 | [fillRectBottom](#fillrectbottom) **- fillRectBottom** | | +| 00001727 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00001729 | 0004 | LONG **- fillRectBottom** | 0x0068BDDE | +| 0000172D | 0006 | [Fill Style Boolean Properties](#fill-style-boolean-properties) **- Fill Style Boolean Properties** | | +| 00001733 | 0006 | [Line Style Boolean Properties](#line-style-boolean-properties) **- Line Style Boolean** | | +| 00001739 | 0006 | [bWMode](#bwmode) **- bWMode** | | +| 00001739 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 0000173B | 0004 | [MSOBWMODE](#msobwmode) **- bWMode** | 0x00000009 | +| 0000173F | 0006 | [Shape Boolean Properties](#shape-boolean-properties) **- Shape Boolean Properties** | | + +Figure 39: Child-Record Hierarchy of OfficeArtSpContainer Container 3 + +The record types within **OfficeArtSpContainer** container **3** that have not been explained in previous structure examples are specified as follows: + +**shapePrimaryOptions.fopt.fillBackColor:** A property that specifies the background color of the fill. + +**shapePrimaryOptions.fopt.fillRectRight:** A property that specifies the rectangle right bound, in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the shaded fill. + +**shapePrimaryOptions.fopt.fillRectRight.fillRectRight:** A value (0x008B9F8E) that specifies the rectangle right bound of the shaded fill. + +**shapePrimaryOptions.fopt.fillRectBottom:** A property that specifies the rectangle bottom bound, in EMUs, of the shaded fill. + +**shapePrimaryOptions.fopt.fillRectBottom.fillRectBottom:** A value (0x0068BDDE) that specifies the rectangle bottom bound of the shaded fill. + +**shapePrimaryOptions.fopt.bWMode:** A property that specifies how a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) will render in black-and-white display mode. + +**shapePrimaryOptions.fopt.bWMode.bWMode:** A value (0x00000009) specifying that the shape will render with white coloring. + +The following table shows the child-record hierarchy of **OfficeArtCOLORREF**, as defined in section 2.2.2, record **A**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|----------------------------------------------|-----------| +| 0000171D | 0004 | **A**: OfficeArtCOLORREF **- fillBackColor** | | +| 00001720 | 1 bit | bit **- unused3** | 0x0 | +| 00001720 | 1 bit | bit **- unused2** | 0x0 | +| 00001720 | 1 bit | bit **- unused1** | 0x0 | +| 00001720 | 1 bit | bit **- fSysIndex** | 0x0 | +| 00001720 | 1 bit | bit **- fSchemeIndex** | 0x1 | +| 00001720 | 1 bit | bit **- fSystemRGB** | 0x0 | +| 00001720 | 1 bit | bit **- fPaletteRGB** | 0x0 | +| 00001720 | 1 bit | bit **- fPaletteIndex** | 0x0 | +| 0000171F | 0001 | BYTE **- blue** | 0x00 | +| 0000171E | 0001 | BYTE **- green** | 0x00 | +| 0000171D | 0001 | BYTE **- red** | 0x05 | + +Figure 40: Child-Record Hierarchy of OfficeArtCOLORREF Record A + +### OfficeArtSolverContainer + +The following table shows the child-record hierarchy of **OfficeArtSolverContainer**, as defined in section [2.2.18](#officeartsolvercontainer), container **4**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00001745 | 00A8 | **4**: OfficeArtSolverContainer **- solvers** | | +| 00001745 | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | | +| 0000174D | 00A0 | OfficeArtSolverContainerFileBlockArray **- rgfb** | | +| 0000174D | 0020 | [OfficeArtSolverContainerFileBlock](#officeartsolvercontainerfileblock) **- OfficeArtSolverContainerFB** | | +| 0000174D | 0020 | [OfficeArtFConnectorRule](#officeartfconnectorrule) **- case_of_msofbtConnectorRule** | | +| 0000174D | 0008 | OfficeArtRecordHeader **- rh** | | +| 00001755 | 0004 | ULONG **- ruid** | 0x00000001 | +| 00001759 | 0004 | ULONG **- spidA** | 0x00000807 | +| 0000175D | 0004 | ULONG **- spidB** | 0x00000806 | +| 00001761 | 0004 | ULONG **- spidC** | 0x0000080A | +| 00001765 | 0004 | ULONG **- cptiA** | 0x00000000 | +| 00001769 | 0004 | ULONG **- cptiB** | 0x00000002 | +| 0000176D | 0020 | OfficeArtSolverContainerFileBlock **- OfficeArtSolverContainerFB** | | +| 0000178D | 0020 | OfficeArtSolverContainerFileBlock **- OfficeArtSolverContainerFB** | | +| 000017AD | 0020 | OfficeArtSolverContainerFileBlock **- OfficeArtSolverContainerFB** | | +| 000017CD | 0020 | OfficeArtSolverContainerFileBlock **- OfficeArtSolverContainerFB** | | + +Figure 41: Child-Record Hierarchy of OfficeArtSolverContainer Container 4 + +The record types within **OfficeArtSolverContainer** container **4** that have not been explained in previous structure examples are specified as follows: + +**rgfb:** A record that specifies a file block containing a record that specifies [**rule**](#gt_b4fb40b2-72f2-4fd8-875b-277270553c4f) data. + +**rgfb.OfficeArtSolverContainerFB:** A record that specifies a file block containing a record that specifies overall [**drawing**](#gt_4b4d1a42-c4a2-464d-ad16-d53b5c493fd3) data. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule:** A record that specifies the connection between two [**shapes**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) via a [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule.ruid:** The identifier (0x00000001) of this rule. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule.spidA:** The identifier (0x00000807) of the shape where the connector shape starts. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule.spidB:** The identifier (0x00000806) of the shape where the connector shape ends. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule.spidC:** The identifier (0x0000080A) of the connector shape. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule.cptiA:** The **[connection site](#gt_57020094-5e23-4456-b71c-58b8be42b92d)** index (0x00000000) of the shape where the connector shape starts. + +**rgfb.OfficeArtSolverContainerFB.case_of_msofbtConnectorRule.cptiB:** The connection site index (0x00000002) of the shape where the connector shape ends. + +## Shape Properties + +This section provides an example of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) with effects. The following figure shows a rounded rectangle that contains text and that has a gradient background fill, double-line outline, and shadow properties applied. + +![Shape with effects](media/image415.bin "Shape with effects") + +Figure 42: Shape with effects + +The remainder of this section provides example structures that outline properties specific to similar[\<127\>](#Appendix_A_127) shapes. For a detailed specification of each record that is mentioned, see section [2](#Section_e8ec3303925e4b089045d1969b5dbd96). + +### Shape Type Properties + +The **OfficeArtFSP** record, as defined in section [2.2.40](#officeartfsp), specifies an instance of a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). The **OfficeArtRecordHeader** structure, as defined in section [2.2.1](#officeartrecordheader), contains the shape type, and the record contains the shape identifier and a set of bits that further define the shape. + +The following table shows the child-record hierarchy of the **OfficeArtFSP** container for the shape. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|--------------------------------|------------| +| 00000DBB | 0010 | OfficeArtFSP **- shapeProp** | | +| 00000DBB | 0008 | OfficeArtRecordHeader **- rh** | | +| 00000DBB | 4 bits | bit **- recVer** | 0x2 | +| 00000DBB | 12 bits | bit **- recInstance** | 0x002 | +| 00000DBD | 0002 | USHORT **- recType** | 0xF00A | +| 00000DBF | 0004 | DWORD **- recLen** | 0x00000008 | +| 00000DC3 | 0004 | ULONG **- spid** | 0x00000804 | +| 00000DC7 | 1 bit | bit **- fGroup** | 0x0 | +| 00000DC7 | 1 bit | bit **- fChild** | 0x0 | +| 00000DC7 | 1 bit | bit **- fPatriarch** | 0x0 | +| 00000DC7 | 1 bit | bit **- fDeleted** | 0x0 | +| 00000DC7 | 1 bit | bit **- fOleShape** | 0x0 | +| 00000DC7 | 1 bit | bit **- fHaveMaster** | 0x0 | +| 00000DC7 | 1 bit | bit **- fFlipH** | 0x0 | +| 00000DC7 | 1 bit | bit **- fFlipV** | 0x0 | +| 00000DC7 | 1 bit | bit **- fConnector** | 0x0 | +| 00000DC7 | 1 bit | bit **- fHaveAnchor** | 0x1 | +| 00000DC7 | 1 bit | bit **- fBackground** | 0x0 | +| 00000DC7 | 1 bit | bit **- fHaveSpt** | 0x1 | +| 00000DC7 | 20 bits | bit **- unused1** | 0x00000 | + +Figure 43: OfficeArtFSP Shape Properties + +The records that are contained within the **OfficeArtFSP** container, as defined in section 2.2.40, are specified as follows: + +**shapeProp:** An **OfficeArtFSP** record that specifies an instance of the shape. + +**rh:** An **OfficeArtRecordHeader** structure, as defined in section 2.2.1, that contains the record type, the record length, and if the record is an [**atom**](#gt_e0c68b3f-d976-411b-a247-7cef57e73728), a version identifier. + +**rh.recVer:** The record version (0x2). + +**rh.recInstance:** The shape type, which in this case is a rectangle shape with rounded corners (0x002). + +**rh.recType:** The type (0xF00A) of this record. + +**rh.recLen:** The length (0x00000008), in bytes, of the record. + +**spid:** The identifier (0x00000804) of this shape. + +**fGroup:** A value that specifies whether this shape is a [**group shape**](#gt_b2238184-3c83-4e64-babb-08b02a9138db). The value 0x0 specifies that this shape is not a group shape. + +**fChild:** A value that specifies whether this shape is a [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) shape. The value 0x0 specifies that this shape is not a child shape. + +**fPatriarch:** A value that specifies whether this shape is the topmost group shape. The value 0x0 specifies that this shape is not the topmost group shape. + +**fDeleted:** A value that specifies whether this shape has been deleted. The value 0x0 specifies that this shape has not been deleted. + +**fOleShape:** A value that specifies whether this shape is an [**OLE object**](#gt_cdff9514-a3fb-4897-941d-4e99193a0096). The value 0x0 specifies that this shape is not an OLE object. + +**fHaveMaster:** A value that specifies whether this shape has a [**master**](#gt_7bc43fab-2908-4fdd-b933-2f6429802521) in the **hspMaster** property, as defined in section [2.3.2.1](#hspmaster). The value 0x0 specifies that this shape does not have a master in the **hspMaster** property. + +**fFlipH:** A value that specifies whether this shape is flipped horizontally. The value 0x0 specifies that this shape is not flipped horizontally. + +**fFlipV:** A value that specifies whether this shape is flipped vertically. The value 0x0 specifies that this shape is not flipped vertically. + +**fConnector:** A value that specifies whether this shape is a [**connector**](#gt_97870ca0-28cb-4a16-8195-7bd5fd82a8a4) shape. The value 0x0 specifies that this shape is not a connector shape. + +**fHaveAnchor:** A value that specifies whether this shape has an [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997). The value 0x1 specifies that this shape has an anchor. + +**fBackground:** A value that specifies whether this shape is a [**background shape**](#gt_35f68e44-a7fb-4b81-863a-a8ab1db2b016). The value 0x0 specifies that this shape is not a background shape. + +**fHaveSpt:** A value that specifies whether this shape has a shape type property, as specified by the **recInstance** property in the **OfficeArtRecordHeader** structure, as defined in section 2.2.1. The value 0x1 specifies that this shape has such a shape type property. + +**unused1:** A value that is undefined and needs to be ignored. + +### Shape Primary Options + +This section outlines the primary property options for the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) with effects that is specified in Shape Properties Example in section [3.2](#Section_d603e1cb84c04827907ee2754575247d). + +The following table shows the child-record hierarchy of the **OfficeArtFOPT** record, as defined in section [2.2.9](#officeartfopt), container for the shape. + +| **Offset** | **Size** | **Structure** | +|----|----|----| +| 00000DCB | 0074 | OfficeArtFOPT **- shapePrimaryOptions** | +| 00000DCB | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | +| 00000DD3 | 006C | [OfficeArtRGFOPTE](#officeartrgfopte) **- fopt** | +| 00000DD3 | 0006 | [Protection Boolean Properties](#protection-boolean-properties) **- Protection Boolean Properties** | +| 00000DD9 | 0006 | **A**: [lTxid](#ltxid) **- Text ID** | +| 00000DDF | 0006 | **B**: [WrapText](#wraptext) **- Wrap Text** | +| 00000DE5 | 0006 | **C**: [anchorText](#anchortext) **- Anchor Text** | +| 00000DEB | 0006 | **D**: [fillType](#filltype) **- Fill Type** | +| 00000DF1 | 0006 | [fillColor](#fillcolor) **- Fill Color** | +| 00000DF7 | 0006 | [fillBackColor](#fillbackcolor) **- Fill Back Color** | +| 00000DFD | 0006 | **E**: [fillFocus](#fillfocus) **- Fill Focus** | +| 00000E03 | 0006 | **F**: [fillShadeType](#fillshadetype) **- Shade Type** | +| 00000E09 | 0006 | [Fill Style Boolean Properties](#fill-style-boolean-properties) **- Fill Style Boolean Properties** | +| 00000E0F | 0006 | [lineColor](#linecolor) **- Line Color** | +| 00000E15 | 0006 | **G**: [lineWidth](#linewidth) **- Line Width** | +| 00000E1B | 0006 | **H**: [lineStyle](#linestyle) **- Line Style** | +| 00000E21 | 0006 | [Line Style Boolean Properties](#line-style-boolean-properties) **- Line Style Boolean Properties** | +| 00000E27 | 0006 | [shadowColor](#shadowcolor) **- Shadow Color** | +| 00000E2D | 0006 | **I**: [shadowOpacity](#shadowopacity) **- Shadow Opacity** | +| 00000E33 | 0006 | **J**: [Shadow Style Boolean Properties](#shadow-style-boolean-properties) **- Shadow Style Boolean Properties** | +| 00000E39 | 0006 | [3D-Object Boolean Properties](#d-object-boolean-properties) **- 3D Object Boolean Properties** | + +Figure 44: Child-Record Hierarchy of the OfficeArtFOPT Shape Primary Options + +The record types within the **OfficeArtFOPT** container that have not been explained in previous structure examples are specified as follows: + +**shapePrimaryOptions:** An **OfficeArtFOPT** record that specifies a table of **OfficeArtRGFOPTE** properties, as defined in section 2.3.1. + +**fopt:** An **OfficeArtRGFOPTE** record, as defined in section 2.3.1, specifying a table of properties that contains an array of fixed-size property table entries followed by a variable-length field of complex data. + +**fopt.Protection Boolean Properties:** A property specifying a 32-bit field of Boolean properties for the protection of the shape. + +**fopt.Text ID:** A property specifying an identifier for the text. + +**fopt.Wrap Text:** An **MSOWRAPMODE** enumeration value, as defined in section [2.4.3](#msowrapmode), that specifies the type of wrapping applied to the text. The default value for this property is **msowrapSquare**. + +**fopt.Anchor Text:** A property that specifies the type of [**anchor**](#gt_084d6638-17a5-4bf5-8bf1-70881bdeb997) applied to the text. + +**fopt.Fill Type:** A property that specifies either the fill attributes of the shape or the background of the [**slide**](#gt_dd8a2def-ebde-4fc7-b420-6e837b2059cc). + +**fopt.Fill Color:** A property that specifies the foreground color of the fill. + +**fopt.Fill Back Color:** A property that specifies the background color of the fill. + +**fopt.Fill Focus:** A property that specifies the relative position of the last color in the shaded fill. + +**fopt.Shade Type:** A property that specifies how the shaded fill is to be computed. + +**fopt.Fill Style Boolean Properties:** A property that specifies a 32-bit field of Boolean properties for the fill style. + +**fopt.Line Color:** A property that specifies the foreground color of the line. + +**fopt.Line Width:** A property that specifies the width of the line. + +**fopt.Line Style:** A property that specifies the style of the line. + +**fopt.Line Style Boolean Properties:** A property that specifies a 32-bit field of Boolean properties for the line style. + +**fopt.Shadow Color:** A property that specifies the primary color of the shadow. + +**fopt.Shadow Opacity:** A property that specifies the opacity level of the shadow. + +**fopt.Shadow Style Boolean Properties:** A property that specifies a 32-bit field of Boolean properties for the state of the shadow. + +**fopt.3D Object Boolean Properties:** A property that specifies a 32-bit field of Boolean properties for a 3-D object. + +The following 10 example structures show the records labeled **A**, **B**, **C**, **D**, **E**, **F**, **G**, **H**, **I**, and **J** from the **OfficeArtFOPT** container in more detail. + +The following table shows **lTxid** property **A**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000DD9 | 0006 | **A**: lTxid **- Text ID** | | +| 00000DD9 | 0002 | [OfficeArtFOPTEOPID](#officeartfopteopid) **- opid** | | +| 00000DDB | 0004 | LONG **- lTxid** | 0x01D82D38 | + +Figure 45: lTxid Shape Property Options + +**lTxid:** An identifier (0x01D82D38) for the text inside the shape. + +The following table shows **WrapText** property **B**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|---------------------------------|------------| +| 00000DDF | 0006 | **B**: WrapText **- Wrap Text** | | +| 00000DDF | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000DE1 | 0004 | MSOWRAPMODE **- WrapText** | 0x00000002 | + +Figure 46: WrapText Shape Property Options + +**WrapText:** An **MSOWRAPMODE** enumeration value, as defined in section 2.4.3, (0x00000002) specifying that a line of text will extend into or beyond a margin instead of continuing on subsequent lines. + +The following table shows **anchorText** property **C**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|------------------------------------------|------------| +| 00000DE5 | 0006 | **C**: anchorText **- Anchor Text** | | +| 00000DE5 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000DE7 | 0004 | [MSOANCHOR](#msoanchor) **- anchorText** | 0x00000001 | + +Figure 47: anchorText Shape Property Options + +**anchorText:** An **MSOANCHOR** enumeration value, as defined in section 2.4.4, (0x00000001) specifying that the vertical center of the text will coincide with the vertical midpoint of the internal margins of the text box area. + +The following table shows **fillType** property **D**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|--------------------------------------------|------------| +| 00000DEB | 0006 | **D**: fillType **- Fill Type** | | +| 00000DEB | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000DED | 0004 | [MSOFILLTYPE](#msofilltype) **- fillType** | 0x00000007 | + +Figure 48: fillType Shape Property Options + +**fillType:** An **MSOFILLTYPE** enumeration value, as defined in section 2.4.11, (0x00000007) specifying that the shape is filled with a gradient that starts on the outline and ends at a point defined within the shape. The fill angle is scaled by the aspect ratio of the shape. + +The following table shows **fillFocus** property **E**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------|------------| +| 00000DFD | 0006 | **E**: fillFocus **- Fill Focus** | | +| 00000DFD | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000DFF | 0004 | LONG **- fillFocus** | 0xFFFFFFCE | + +Figure 49: fillFocus Shape Property Options + +**fillFocus:** The relative position (0xFFFFFFCE) of the last color in the shaded fill. + +The following table shows **fillShadeType** property **F**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E03 | 0006 | **F**: fillShadeType **- Fill Shade Type** | | +| 00000E03 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E05 | 0004 | [MSOSHADETYPE](#msoshadetype) **- fillShadeType** | | +| 00000E05 | 1 bit | bit **- msoshadeNone** | 0x1 | +| 00000E05 | 1 bit | bit **- msoshadeGamma** | 0x1 | +| 00000E05 | 1 bit | bit **- msoshadeSigma** | 0x0 | +| 00000E05 | 1 bit | bit **- msoshadeBand** | 0x1 | +| 00000E05 | 1 bit | bit **- msoshadeOneColor** | 0x0 | +| 00000E05 | 27 bits | bit **- unused1** | 0x0200000 | + +Figure 50: fillShadeType Shape Property Options + +The **fillShadeType** properties that have not been explained in previous structure examples are specified as follows: + +**fillShadeType:** An **MSOSHADETYPE** record, as defined in section 2.2.50, that specifies the interpolation of colors between the color/position values that are stated for the fill. Values can be combined to produce compounded effects. + +**fillShadeType.msoshadeNone:** A value that specifies whether color correction will be performed after interpolation. The value 0x1 specifies that no color correction will be performed after interpolation. + +**fillShadeType.msoshadeGamma:** A value that specifies whether [**gamma correction**](#gt_60eaec33-bd4f-4e71-93e6-4ef382aa80f9) will be applied after interpolation. The value 0x1 specifies that gamma correction will be applied after interpolation. + +**fillShadeType.msoshadeSigma:** A value that specifies whether a [**sigma transfer function**](#gt_ec439672-c396-41e2-ae26-39964fa0e281) will be applied after interpolation. The value 0x0 specifies that no sigma transfer function will be applied after interpolation. + +**fillShadeType.msoshadeBand:** A value that specifies whether a flat band will be added at the start of the interpolation. The value 0x1 specifies that a flat band will be added at the start of the interpolation. + +**fillShadeType.msoshadeOneColor:** A value that specifies whether more than one color can be used to determine the fill. The value 0x0 specifies that more than one color can be used to determine the fill. + +**fillShadeType.unused1:** A value that is undefined and needs to be ignored. + +The following table shows **lineWidth** property **G**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------|------------| +| 00000E15 | 0006 | **G**: lineWidth **- Line Width** | | +| 00000E15 | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E17 | 0004 | LONG **- lineWidth** | 0x000094D4 | + +Figure 51: lineWidth Shape Property Options + +**lineWidth:** The width (0x000094D4), in [**EMUs**](#gt_264db3a3-b788-42b9-8a78-38ddc62ccd39), of the line. + +The following table shows **lineStyle** property **H**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E1B | 0006 | **H**: lineStyle **- Line Style** | | +| 00000E1B | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E1D | 0004 | [MSOLINESTYLE](#msolinestyle) **- lineStyle** | 0x00000001 | + +Figure 52: lineStyle Shape Property Options + +**lineStyle:** An **MSOLINESTYLE** enumeration value, as defined in section 2.4.14, (0x00000001) specifying that the line style for the shape outline is two lines of equal width. + +The following table shows **shadowOpacity** property **I**. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-------------------------------------------|------------| +| 00000E2D | 0006 | **I**: shadowOpacity **- Shadow Opacity** | | +| 00000E2D | 0002 | OfficeArtFOPTEOPID **- opid** | | +| 00000E2F | 0004 | FixedPoint **- shadowOpacity** | 0x00008000 | + +Figure 53: shadowOpacity Shape Property Options + +**shadowOpacity:** The opacity (0x00008000) of the shadow applied to the shape. + +The following table shows **Shadow Style Boolean Properties** record **J**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E33 | 0006 | **J**: Shadow Style Boolean Properties **- Shadow Style Boolean Properties** | | +| 00000E35 | 14 bits | bit **- unused2** | 0x0000 | +| 00000E35 | 1 bit | bit **- fUsefShadow** | 0x1 | +| 00000E35 | 1 bit | bit **- fUsefshadowObscured** | 0x0 | +| 00000E35 | 14 bits | bit **- unused1** | 0x0000 | +| 00000E35 | 1 bit | bit **- fShadow** | 0x1 | +| 00000E35 | 1 bit | bit **- fshadowObscured** | 0x0 | +| 00000E33 | 0002 | OfficeArtFOPTEOPID **- opid** | | + +Figure 54: Shadow Style Boolean Properties Options + +**unused2:** A value that is undefined and needs to be ignored. + +**fUsefShadow:** A value that specifies whether the **fShadow** bit is set. The value 0x1 specifies that the **fShadow** bit is set. + +**fUsefshadowObscured:** A value that specifies whether the **fshadowObscured** bit is set. The value 0x0 specifies the **fshadowObscured** bit is not set. + +**unused1:** A value that is undefined and needs to be ignored. + +**fShadow:** A value that specifies whether the shape has a shadow. The value 0x1 specifies that the shape has a shadow. + +**fshadowObscured:** A value that specifies whether the shadow is fully obscured by the shape. The value 0x0 specifies that the shadow is not fully obscured by the shape. + +### Shape Text Properties + +The text in a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is host-dependent, and not all the text properties are supported by each host application. + +The text-related fields and records in this section are defined by the host application. For more information, see [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) section 2.9.76. + +The following table shows the **OfficeArtClientTextbox** record. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000E5D | 0049 | OfficeArtClientTextbox **- clientTextbox** | | +| 00000E5D | 0008 | [OfficeArtRecordHeader](#officeartrecordheader) **- rh** | | +| 00000E65 | 0041 | TextClientDataRecordArray **- rgChildRec** | | +| 00000E65 | 000C | TextClientDataSubContainerOrAtom **- rec** | | +| 00000E65 | 000C | TextHeaderAtom **- case_of_RT_TextHeaderAtom** | | +| 00000E65 | 0008 | RecordHeader **- rh** | | +| 00000E6D | 0004 | TextTypeEnum **- textType** | 0x00000004 | +| 00000E71 | 0017 | TextClientDataSubContainerOrAtom **- rec** | | +| 00000E71 | 0017 | TextBytesAtom **- case_of_RT_TextBytesAtom** | | +| 00000E71 | 0008 | RecordHeader **- rh** | | +| 00000E79 | 000F | NarrowStringBufferEx **- textBytes** | Shape with text | +| 00000E88 | 001E | TextClientDataSubContainerOrAtom **- rec** | | +| 00000E88 | 001E | StyleTextPropAtom **- case_of_RT_StyleTextPropAtom** | | +| 00000E88 | 0008 | RecordHeader **- rh** | | +| 00000E90 | 000C | TextPFRunArray **- rgTextPFRun** | | +| 00000E9C | 000A | TextCFRunArray **- rgTextCFRun** | | + +Figure 55: OfficeArtClientTextbox Shape Text Properties + +The records contained within the **OfficeArtClientTextbox** container that have not been explained in previous structure examples are specified as follows: + +**clientTextbox:** A container that specifies text-related data for a shape. + +**rgChildRec:** An array of **TextClientDataSubContainerOrAtom** records that specifies text-related data. + +**rgChildRec.rec:** A variable-type record for which the type and meaning are dictated by the value of **rh.recType**. + +**rgChildRec.rec.case_of_RT_TextHeaderAtom:** An [**atom**](#gt_e0c68b3f-d976-411b-a247-7cef57e73728) that specifies the type of a text body. The presence of this atom indicates a text body that has properties specified by subsequent atoms and containers. + +**rgChildRec.rec.case_of_RT_TextHeaderAtom.textType:** A value that specifies the text type. The value 0x00000004 specifies that the text type is the **TextTypeEnum** enumeration value **Tx_TYPE_OTHER**, which means any other text. + +**rgChildRec.rec.case_of_RT_TextBytesAtom:** An atom that specifies Unicode characters. + +**rgChildRec.rec.case_of_RT_TextBytesAtom.textBytes:** An array of bytes that specifies the characters ("Shape with text") of the corresponding text within the shape. + +**rgChildRec.rec.case_of_RT_StyleTextPropAtom:** An atom that specifies both character-level and paragraph-level formatting. + +# Security Considerations + +This file format allows [**HTML**](#gt_549c4960-e8be-4c24-bc2b-b86530f1c1bf) code and associated script to be inserted into a [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e). When the shape is exported to an HTML format, it is possible that the associated script could be executed. Whether this happens is dependent on the nature of the script and how the HTML document is opened. + +The [Signature Line](#Section_6250d9a1921b4b48be30e64dc48be328) can contain personally identifiable information, such as the user's name or e-mail address. This information is not mandatory and can be replaced by defaults or omitted entirely. For privacy reasons, applications ought to provide users with a way to remove this information from files. Personally identifiable information in this file format is not backed by any kind of authentication system. For example, the signer's name does not need to be tied to the author's logon credentials nor to any other form of identity verification. Therefore, it is not advisable for applications to make security decisions based on this information. + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- Microsoft Office 97 + +- Microsoft Office 2000 + +- Microsoft Office XP + +- Microsoft Office 2003 + +- the 2007 Microsoft Office system + +- Microsoft Office 2010 suites + +- Microsoft Office 2013 + +- Microsoft Office 2016 + +- Microsoft Office 2019 + +- Microsoft Office 2021 + +- Microsoft Office LTSC 2024 + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 2.2.2](#Appendix_A_Target_1): This color can be dithered if the rendering system supports dithering or halftone dithering. + +[\<2\> Section 2.2.12](#Appendix_A_Target_2): The z-order of shapes in a diagram are determined by their order in the file. + +[\<3\> Section 2.2.13](#Appendix_A_Target_3): This array is supported only by Microsoft Word 97, Microsoft Word 2000, Microsoft Word 2002, and Microsoft Office Word 2003. + +[\<4\> Section 2.2.15](#Appendix_A_Target_4): Word 97, Word 2000, Word 2002, Office Word 2003, Microsoft Office Word 2007, and Microsoft Word 2010 do not ignore this record. + +[\<5\> Section 2.2.23](#Appendix_A_Target_5): 0xF02A is treated as 0xF01D. + +[\<6\> Section 2.2.33](#Appendix_A_Target_6): Microsoft Excel 97, Microsoft Excel 2000, Microsoft Excel 2002, and Microsoft Office Excel 2003 do not ignore this record. + +[\<7\> Section 2.2.35](#Appendix_A_Target_7): This record is not persisted in Microsoft Office Excel 2007, Microsoft Excel 2010, Microsoft Office PowerPoint 2007, or Microsoft PowerPoint 2010. This record is supported by Office Excel 2007 and Excel 2010 only if the [**shape**](#gt_d0e38aa4-2c71-4a6f-b5e6-75766fa9409e) is contained by a [**dialog sheet**](#gt_293d2e0c-de3d-4808-99fc-99fa824158a8), as specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.1.7.20.2. + +[\<8\> Section 2.2.36](#Appendix_A_Target_8): Word 97 and Word 2000 ignore this record. + +[\<9\> Section 2.2.37](#Appendix_A_Target_9): Word 97, Word 2000, Word 2002, and Office Word 2003 use this record. + +[\<10\> Section 2.3](#Appendix_A_Target_10): Microsoft PowerPoint 97, Word 97 and Excel 97 do not support these properties. + +[\<11\> Section 2.3](#Appendix_A_Target_11): PowerPoint 97, Word 97, Excel 97, Microsoft PowerPoint 2000, Excel 2000 and Word 2000 do not support this property.. + +[\<12\> Section 2.3](#Appendix_A_Target_12): PowerPoint 97, Word 97, Excel 97, PowerPoint 2000, Excel 2000, Word 2000, Microsoft PowerPoint 2002, Word 2002 and Excel 2002 do not support these properties. + +[\<13\> Section 2.3](#Appendix_A_Target_13): PowerPoint 97, Word 97, Excel 97, PowerPoint 2000, Excel 2000, Word 2000, PowerPoint 2002, Word 2002, Excel 2002, Microsoft Office PowerPoint 2003, Office Word 2003 and Office Excel 2003 do not support these properties. + +[\<14\> Section 2.3](#Appendix_A_Target_14): PowerPoint 97, Word 97, Excel 97, PowerPoint 2000, Excel 2000, Word 2000, PowerPoint 2002, Word 2002, Excel 2002, Office PowerPoint 2003, Office Word 2003, Office Excel 2003, Office PowerPoint 2007, Office Word 2007 and Office Excel 2007 do not support this property. + +[\<15\> Section 2.3.2.6](#Appendix_A_Target_15): Office 2000, Office XP, and Office 2003 use this field. + +[\<16\> Section 2.3.2.11](#Appendix_A_Target_16): Office Word 2007 and Word 2010 use this field. + +[\<17\> Section 2.3.2.12](#Appendix_A_Target_17): Office Excel 2007, Office PowerPoint 2007, Office Word 2007, Excel 2010, PowerPoint 2010, and Word 2010 use this bit. + +[\<18\> Section 2.3.2.12](#Appendix_A_Target_18): Office Excel 2007, Office PowerPoint 2007, Office Word 2007, Excel 2010, PowerPoint 2010, and Word 2010 use this bit. + +[\<19\> Section 2.3.2.12](#Appendix_A_Target_19): Excel 97, PowerPoint 97, Word 97, Excel 2000, PowerPoint 2000, and Word 2000 do not use this bit. + +[\<20\> Section 2.3.2.12](#Appendix_A_Target_20): Excel 97, PowerPoint 97, Word 97, Excel 2000, PowerPoint 2000, and Word 2000 do not use this bit. + +[\<21\> Section 2.3.4.19](#Appendix_A_Target_21): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 use this field. + +[\<22\> Section 2.3.4.20](#Appendix_A_Target_22): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 use this field. + +[\<23\> Section 2.3.4.21](#Appendix_A_Target_23): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 use this field. + +[\<24\> Section 2.3.4.22](#Appendix_A_Target_24): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 use this field. + +[\<25\> Section 2.3.4.23](#Appendix_A_Target_25): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 do not ignore this property. + +[\<26\> Section 2.3.4.24](#Appendix_A_Target_26): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 do not ignore this property. + +[\<27\> Section 2.3.4.25](#Appendix_A_Target_27): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 do not ignore this property. + +[\<28\> Section 2.3.4.26](#Appendix_A_Target_28): Word 2000, Word 2002, Office Word 2003, Office Word 2007 and Word 2010 do not ignore this property. + +[\<29\> Section 2.3.4.36](#Appendix_A_Target_29): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, and PowerPoint 2010 do not ignore this property. + +[\<30\> Section 2.3.4.37](#Appendix_A_Target_30): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, and PowerPoint 2010 do not ignore this property. + +[\<31\> Section 2.3.4.39](#Appendix_A_Target_31): This feature allowed integration to the now-obsolete FrontPage product, but the feature no longer functions. + +[\<32\> Section 2.3.4.41](#Appendix_A_Target_32): The 2007 Microsoft Office system and Office 2010 do not ignore this property. + +[\<33\> Section 2.3.4.43](#Appendix_A_Target_33): Office Word 2007 and Word 2010 do not ignore this property. + +[\<34\> Section 2.3.5.1](#Appendix_A_Target_34): Office Word 2007 and Word 2010 do not ignore this property. + +[\<35\> Section 2.3.5.2](#Appendix_A_Target_35): Office Word 2007 and Word 2010 do not ignore this property. + +[\<36\> Section 2.3.5.3](#Appendix_A_Target_36): Office Word 2007 and Word 2010 do not ignore this property. + +[\<37\> Section 2.3.5.4](#Appendix_A_Target_37): Office Word 2007 and Word 2010 do not ignore this property. + +[\<38\> Section 2.3.5.5](#Appendix_A_Target_38): Office Word 2007 and Word 2010 do not ignore this property. + +[\<39\> Section 2.3.5.6](#Appendix_A_Target_39): Office Word 2007 and Word 2010 do not ignore this property. + +[\<40\> Section 2.3.6.25](#Appendix_A_Target_40): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 do not show the adjust handles that are specified in the [pAdjustHandles](#padjusthandles) property. + +[\<41\> Section 2.3.7.8](#Appendix_A_Target_41): Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, and Excel 2010 do not ignore this property. + +[\<42\> Section 2.3.8.38](#Appendix_A_Target_42): Office 97 and Office 2000 do not render the [**line end decorations**](#gt_b1fb779c-d7ab-4dcb-ad74-1ae621ae80ab) if the line end decoration properties are specified and this bit is set to 0x0. + +[\<43\> Section 2.3.13.22](#Appendix_A_Target_43): Microsoft Office 2010 suites does not ignore this property. + +[\<44\> Section 2.3.13.22](#Appendix_A_Target_44): In Office 2010, the default value is 0x0000F80C. + +[\<45\> Section 2.3.16.23](#Appendix_A_Target_45): Values that are less than 0.0 will invert the lighting effect. Values that are greater than 1.0 can be used for brighter lighting effects. + +[\<46\> Section 2.3.16.27](#Appendix_A_Target_46): Values that are less than 0.0 will invert the lighting effect. Values that are greater than 1.0 can be used for brighter lighting effects. + +[\<47\> Section 2.3.17.4](#Appendix_A_Target_47): Prior to the beta release of Office 2003, the values stored in the **IMsoArray** were of type **MSOSPID** as defined in section [2.1.2](#msospid). To cover all documents, first the **MSOSPID** is used to locate a shape in the Relationship Table. If this is not successful, the CRC32 Hash of the shape name is used to locate the shape. + +[\<48\> Section 2.3.17.10](#Appendix_A_Target_48): Office 97, Office 2000, and Office XP ignore this property. + +[\<49\> Section 2.3.18.6](#Appendix_A_Target_49): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, and Word 2010 do not ignore this property. + +[\<50\> Section 2.3.19.6](#Appendix_A_Target_50): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010 do not ignore this property. + +[\<51\> Section 2.3.20.1](#Appendix_A_Target_51): Office 97 ignores this bit. + +[\<52\> Section 2.3.21.8](#Appendix_A_Target_52): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, and PowerPoint 2010 use this field. The [MSOANCHOR](#msoanchor) enumeration specifies exceptions for some individual values. + +[\<53\> Section 2.3.21.10](#Appendix_A_Target_53): This property is supported only by Office Excel 2007, Excel 2010, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, and PowerPoint 2010. + +[\<54\> Section 2.3.21.11](#Appendix_A_Target_54): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, and Word 2010 use this property. + +[\<55\> Section 2.3.21.12](#Appendix_A_Target_55): Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, and Excel 2010 use this property. + +[\<56\> Section 2.3.21.15](#Appendix_A_Target_56): Excel 97, PowerPoint 97, Excel 2000, PowerPoint 2000, Excel 2002, PowerPoint 2002, Office Excel 2003, and Office PowerPoint 2003 use this bit. + +[\<57\> Section 2.3.21.15](#Appendix_A_Target_57): Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 use this bit. Office Excel 2007 and Excel 2010 properly read and use the value of 0x1 but do not write it. + +[\<58\> Section 2.3.21.15](#Appendix_A_Target_58): Word 97 and Word 2000 do not use this bit. + +[\<59\> Section 2.3.22.3](#Appendix_A_Target_59): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 treat **msoalignTextStretch** as **msoalignTextCenter**. + +[\<60\> Section 2.3.22.3](#Appendix_A_Target_60): Office Excel 2007, Excel 2010, Office PowerPoint 2007 and PowerPoint 2010 do not use **msoalignTextLetterJust**. + +[\<61\> Section 2.3.22.3](#Appendix_A_Target_61): Office Excel 2007, Excel 2010, Office PowerPoint 2007 and PowerPoint 2010 do not use **msoalignTextWordJust**. + +[\<62\> Section 2.3.22.8](#Appendix_A_Target_62): Office 97 does not use this property. + +[\<63\> Section 2.3.22.10](#Appendix_A_Target_63): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 do not use this bit. + +[\<64\> Section 2.3.22.10](#Appendix_A_Target_64): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 ignore this bit. + +[\<65\> Section 2.3.22.10](#Appendix_A_Target_65): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 ignore this bit and apply scaling to the character advance width. + +[\<66\> Section 2.3.22.10](#Appendix_A_Target_66): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 ignore this bit. + +[\<67\> Section 2.3.22.10](#Appendix_A_Target_67): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 ignore this bit. + +[\<68\> Section 2.3.22.10](#Appendix_A_Target_68): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 ignore this bit. + +[\<69\> Section 2.3.22.10](#Appendix_A_Target_69): Office Excel 2007, Excel 2010, Office PowerPoint 2007 and PowerPoint 2010 ignore this bit. + +[\<70\> Section 2.3.22.10](#Appendix_A_Target_70): Office Excel 2007, Excel 2010, Office PowerPoint 2007 and PowerPoint 2010 do not ignore this bit. + +[\<71\> Section 2.3.22.10](#Appendix_A_Target_71): Office Excel 2007, Excel 2010, Office PowerPoint 2007 and PowerPoint 2010 do not ignore this bit. + +[\<72\> Section 2.3.22.10](#Appendix_A_Target_72): Office Excel 2007, Excel 2010, Office PowerPoint 2007, and PowerPoint 2010 do not ignore this bit. + +[\<73\> Section 2.3.24.1](#Appendix_A_Target_73): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<74\> Section 2.3.24.3](#Appendix_A_Target_74): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<75\> Section 2.3.24.5](#Appendix_A_Target_75): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<76\> Section 2.3.24.7](#Appendix_A_Target_76): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<77\> Section 2.3.24.9](#Appendix_A_Target_77): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<78\> Section 2.3.24.11](#Appendix_A_Target_78): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<79\> Section 2.3.24.13](#Appendix_A_Target_79): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<80\> Section 2.3.24.15](#Appendix_A_Target_80): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<81\> Section 2.3.24.17](#Appendix_A_Target_81): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<82\> Section 2.3.24.19](#Appendix_A_Target_82): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<83\> Section 2.3.24.21](#Appendix_A_Target_83): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<84\> Section 2.3.24.23](#Appendix_A_Target_84): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<85\> Section 2.3.24.25](#Appendix_A_Target_85): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<86\> Section 2.3.24.27](#Appendix_A_Target_86): Excel 97, PowerPoint 97, and Word 97 ignore this property. + +[\<87\> Section 2.3.25.1](#Appendix_A_Target_87): Office 97 and Office 2000 ignore this property. + +[\<88\> Section 2.3.25.3](#Appendix_A_Target_88): Office 97 and Office 2000 ignore this property. + +[\<89\> Section 2.3.25.5](#Appendix_A_Target_89): Office 97 and Office 2000 ignore this property. + +[\<90\> Section 2.3.25.7](#Appendix_A_Target_90): Office 97 and Office 2000 ignore this property. + +[\<91\> Section 2.3.27.1](#Appendix_A_Target_91): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, and Word 2010 do not ignore this property. + +[\<92\> Section 2.3.27.3](#Appendix_A_Target_92): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, and Word 2010 do not ignore this property. + +[\<93\> Section 2.3.27.5](#Appendix_A_Target_93): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<94\> Section 2.3.27.7](#Appendix_A_Target_94): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<95\> Section 2.3.27.9](#Appendix_A_Target_95): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<96\> Section 2.3.27.11](#Appendix_A_Target_96): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<97\> Section 2.3.27.13](#Appendix_A_Target_97): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<98\> Section 2.3.27.15](#Appendix_A_Target_98): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<99\> Section 2.3.27.17](#Appendix_A_Target_99): Office Excel 2007, Excel 2010, Office PowerPoint 2007, PowerPoint 2010, and Office Word 2007 do not ignore this property. + +[\<100\> Section 2.4.3](#Appendix_A_Target_100): Office Excel 2007, Excel 2010, PowerPoint 97, and PowerPoint 2010 read and use this value properly but do not write it. + +[\<101\> Section 2.4.3](#Appendix_A_Target_101): Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 use this value. + +[\<102\> Section 2.4.3](#Appendix_A_Target_102): Excel 97, Word 97, Excel 2000, Word 2000, Excel 2002, and Office Excel 2003 do not use this value. + +[\<103\> Section 2.4.4](#Appendix_A_Target_103): PowerPoint 97 and PowerPoint 2010 use these values. Exceptions are specified for some individual values. + +[\<104\> Section 2.4.4](#Appendix_A_Target_104): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 use this value. + +[\<105\> Section 2.4.4](#Appendix_A_Target_105): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 use this value. + +[\<106\> Section 2.4.4](#Appendix_A_Target_106): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 use this value. + +[\<107\> Section 2.4.4](#Appendix_A_Target_107): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 use this value. + +[\<108\> Section 2.4.5](#Appendix_A_Target_108): PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, and Word 2010 read and use this value properly but do not write it. Excel 97, Excel 2000, Excel 2002 and Office Excel 2003 convert this value to **msotxflVertN** when reading it. + +[\<109\> Section 2.4.5](#Appendix_A_Target_109): Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, and Excel 2010 convert this value to **msotxflVertN** when reading it. + +[\<110\> Section 2.4.5](#Appendix_A_Target_110): Office PowerPoint 2007 and PowerPoint 2010 do not use this value. PowerPoint 97, PowerPoint 2000, PowerPoint 2002 and Office PowerPoint 2003 interpret this value as **msotxflHorzN**. + +[\<111\> Section 2.4.5](#Appendix_A_Target_111): Office PowerPoint 2007 and PowerPoint 2010 do not use this value. PowerPoint 97, PowerPoint 2000, PowerPoint 2002 and Office PowerPoint 2003 interpret this value as **msotxflHorzN**. + +[\<112\> Section 2.4.5](#Appendix_A_Target_112): Office PowerPoint 2007 and PowerPoint 2010 do not use this value. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 interpret this value as **msotxflTtoBA**. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, and Excel 2010 remove this value upon reading it. + +[\<113\> Section 2.4.5](#Appendix_A_Target_113): Office PowerPoint 2007 and PowerPoint 2010 do not use this value. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 interpret this value as **msotxflHorzN**. Office Word 2007 and Word 2010 instead place subsequent lines of text to the right of antecedent lines of text. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, and Excel 2010 instead orient character glyphs such that their ascenders are closest to the top of the text body container, subsequent character glyphs are placed below antecedent character glyphs, and subsequent lines of text are placed to the right of antecedent lines of text. + +[\<114\> Section 2.4.7](#Appendix_A_Target_114): Office Excel 2007 and Excel 2010 use this value but do not save it. + +[\<115\> Section 2.4.7](#Appendix_A_Target_115): Office Excel 2007 and Excel 2010 use this value but do not save it. + +[\<116\> Section 2.4.24](#Appendix_A_Target_116): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextSimple** into text boxes that contain unstyled text. + +[\<117\> Section 2.4.24](#Appendix_A_Target_117): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextOctagon** into text boxes that contain unstyled text. + +[\<118\> Section 2.4.24](#Appendix_A_Target_118): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextHexagon** into text boxes that contain unstyled text. + +[\<119\> Section 2.4.24](#Appendix_A_Target_119): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextCurve** into text boxes that contain unstyled text. + +[\<120\> Section 2.4.24](#Appendix_A_Target_120): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextWave** into text boxes that contain unstyled text. + +[\<121\> Section 2.4.24](#Appendix_A_Target_121): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextRing** into text boxes that contain unstyled text. + +[\<122\> Section 2.4.24](#Appendix_A_Target_122): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextOnCurve** into text boxes that contain unstyled text. + +[\<123\> Section 2.4.24](#Appendix_A_Target_123): Office PowerPoint 2007, PowerPoint 2010, Office Word 2007, Word 2010, Office Excel 2007 and Excel 2010 convert shapes of type **msosptTextOnRing** into text boxes that contain unstyled text. + +[\<124\> Section 3](#Appendix_A_Target_124): Sample files were created by using Office PowerPoint 2003. + +[\<125\> Section 3](#Appendix_A_Target_125): Similar structures are created by using Office 97, Office 2000, Office XP, and Office 2003. + +[\<126\> Section 3.1](#Appendix_A_Target_126): This section pertains to Office 97, Office 2000, Office XP, and Office 2003 [**drawing objects**](#gt_51dfe494-9c84-4a0e-9d53-06068c5ce3ac). + +[\<127\> Section 3.2](#Appendix_A_Target_127): The properties are specific to Office 97, Office 2000, Office XP, and Office 2003 shapes. + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [2.3.6.31](#geometry-boolean-properties) Geometry Boolean Properties | Removed the product behavior. | Minor | + +# Index + +3 + +3D Object Style property + +[c3DCrMod](#c3dcrmod) 348 + +[c3DDiffuseAmt](#c3ddiffuseamt) 344 + +[c3DEdgeThickness](#c3dedgethickness) 345 + +[c3DExtrudeBackward](#c3dextrudebackward) 346 + +[c3DExtrudeForward](#c3dextrudeforward) 346 + +[c3DExtrusionColor](#c3dextrusioncolor) 347 + +[c3DExtrusionColorExt](#c3dextrusioncolorext) 349 + +[c3DExtrusionColorExtMod](#c3dextrusioncolorextmod) 350 + +[c3DShininess](#c3dshininess) 345 + +[c3DSpecularAmt](#c3dspecularamt) 344 + +[reserved646](#reserved646) 347 + +[reserved650](#reserved650) 349 + +[reserved652](#reserved652) 350 + +[reserved653](#reserved653) 351 + +3D Style property + +[c3DAmbientIntensity](#c3dambientintensity) 363 + +[c3DFillIntensity](#c3dfillintensity) 368 + +[c3DFillX](#c3dfillx) 366 + +[c3DFillY](#c3dfilly) 366 + +[c3DFillZ](#c3dfillz) 367 + +[c3DKeyIntensity](#c3dkeyintensity) 365 + +[c3DKeyX](#c3dkeyx) 364 + +[c3DKeyY](#c3dkeyy) 364 + +[c3DKeyZ](#c3dkeyz) 365 + +[c3DOriginX](#c3doriginx) 361 + +[c3DOriginY](#c3doriginy) 361 + +[c3DRenderMode](#c3drendermode) 358 + +[c3DRotationAngle](#c3drotationangle) 356 + +[c3DRotationAxisX](#c3drotationaxisx) 354 + +[c3DRotationAxisY](#c3drotationaxisy) 355 + +[c3DRotationAxisZ](#c3drotationaxisz) 355 + +[c3DRotationCenterX](#c3drotationcenterx) 356 + +[c3DRotationCenterY](#c3drotationcentery) 357 + +[c3DRotationCenterZ](#c3drotationcenterz) 357 + +[c3DSkewAmount](#c3dskewamount) 363 + +[c3DSkewAngle](#c3dskewangle) 362 + +[c3DTolerance](#c3dtolerance) 359 + +[c3DXRotationAngle](#c3dxrotationangle) 353 + +[c3DXViewpoint](#c3dxviewpoint) 359 + +[c3DYRotationAngle](#c3dyrotationangle) 353 + +[c3DYViewpoint](#c3dyviewpoint) 360 + +[c3DZViewpoint](#c3dzviewpoint) 360 + +[3D-Object Style Boolean properties](#d-object-boolean-properties) 351 + +3D-Object Style property + +[3D-Object Style Boolean properties](#d-object-boolean-properties) 351 + +[3D-Style Boolean properties](#d-style-boolean-properties) 368 + +3D-Style property + +[3D-Style Boolean properties](#d-style-boolean-properties) 368 + +[Diagram Boolean properties](#diagram-boolean-properties) 389 + +A + +[ADJH OfficeArtRecord type](#adjh) 85 + +[adjust2Value geometry property](#adjust2value) 170 + +[adjust3Value geometry property](#adjust3value) 170 + +[adjust4Value geometry property](#adjust4value) 171 + +[adjust5Value geometry property](#adjust5value) 172 + +[adjust6Value geometry property](#adjust6value) 172 + +[adjust7Value geometry property](#adjust7value) 173 + +[adjust8Value geometry property](#adjust8value) 174 + +[adjustValue geometry property](#adjustvalue) 169 + +Algorithm + +[DataforVtHyperlink](#data-for-vthyperlink) 543 + +[alignHR group shape property](#alignhr) 146 + +[anchorText Text property](#anchortext) 404 + +[Applicability](#applicability-statement) 25 + +B + +[Bit format overview](#bit-format) 24 + +[Blip Boolean properties](#blip-boolean-properties) 437 + +Blip property + +[Blip Boolean properties](#blip-boolean-properties) 437 + +[cropFromBottom](#cropfrombottom) 419 + +[cropFromLeft](#cropfromleft) 420 + +[cropFromRight](#cropfromright) 420 + +[cropFromTop](#cropfromtop) 419 + +[movie](#movie) 430 + +[movie_complex](#movie_complex) 430 + +[pib](#pib) 421 + +[pib_complex](#pib_complex) 422 + +[pibFlags](#pibflags) 423 + +[pibName](#pibname) 422 + +[pibName_complex](#pibname_complex) 423 + +[pibPrint](#pibprint) 427 + +[pibPrint_complex](#pibprint_complex) 428 + +[pibPrintFlags](#pibprintflags) 429 + +[pibPrintName](#pibprintname) 428 + +[pibPrintName_complex](#pibprintname_complex) 429 + +[pictureBrightness](#picturebrightness) 424 + +[pictureContrast](#picturecontrast) 424 + +[pictureDblCrMod](#picturedblcrmod) 426 + +[pictureFillCrMod](#picturefillcrmod) 426 + +[pictureId](#pictureid) 425 + +[pictureLineCrMod](#picturelinecrmod) 427 + +[pictureRecolor](#picturerecolor) 433 + +[pictureRecolorExt](#picturerecolorext) 434 + +[pictureRecolorExtMod](#picturerecolorextmod) 435 + +[pictureTransparent](#picturetransparent) 423 + +[pictureTransparentExt](#picturetransparentext) 431 + +[pictureTransparentExtMod](#picturetransparentextmod) 432 + +[reserved278](#reserved278) 431 + +[reserved280](#reserved280) 432 + +[reserved281](#reserved281) 433 + +[reserved284](#reserved284) 434 + +[reserved286](#reserved286) 435 + +[reserved287](#reserved287) 436 + +[borderBottomColor group shape property](#borderbottomcolor) 152 + +[borderLeftColor group shape property](#borderleftcolor) 152 + +[borderRightColor group shape property](#borderrightcolor) 153 + +[borderTopColor group shape property](#bordertopcolor) 151 + +[Bottom Line Style Boolean properties](#bottom-line-style-boolean-properties) 320 + +Bottom Line Style property + +[Bottom Line Style Boolean properties](#bottom-line-style-boolean-properties) 320 + +[lineBottomBackColor](#linebottombackcolor) 301 + +[lineBottomBackColorExt](#linebottombackcolorext) 317 + +[lineBottomBackColorExtMod](#linebottombackcolorextmod) 318 + +[lineBottomColor](#linebottomcolor) 300 + +[lineBottomColorExt](#linebottomcolorext) 315 + +[lineBottomColorExtMod](#linebottomcolorextmod) 316 + +[lineBottomCrMod](#linebottomcrmod) 302 + +[lineBottomDashing](#linebottomdashing) 309 + +[lineBottomDashStyle](#linebottomdashstyle) 309 + +[lineBottomDashStyle_complex](#linebottomdashstyle_complex) 310 + +[lineBottomEndArrowhead](#linebottomendarrowhead) 311 + +[lineBottomEndArrowLength](#linebottomendarrowlength) 313 + +[lineBottomEndArrowWidth](#linebottomendarrowwidth) 313 + +[lineBottomEndCapStyle](#linebottomendcapstyle) 314 + +[lineBottomFillBlip](#linebottomfillblip) 303 + +[lineBottomFillBlip_complex](#linebottomfillblip_complex) 304 + +[lineBottomFillBlipFlags](#linebottomfillblipflags) 305 + +[lineBottomFillBlipName](#linebottomfillblipname) 304 + +[lineBottomFillBlipName_complex](#linebottomfillblipname_complex) 305 + +[lineBottomFillDzType](#linebottomfilldztype) 307 + +[lineBottomFillHeight](#linebottomfillheight) 306 + +[lineBottomFillWidth](#linebottomfillwidth) 305 + +[lineBottomJoinStyle](#linebottomjoinstyle) 314 + +[lineBottomMiterLimit](#linebottommiterlimit) 308 + +[lineBottomOpacity](#linebottomopacity) 301 + +[lineBottomStartArrowhead](#linebottomstartarrowhead) 310 + +[lineBottomStartArrowLength](#linebottomstartarrowlength) 312 + +[lineBottomStartArrowWidth](#linebottomstartarrowwidth) 311 + +[lineBottomStyle](#linebottomstyle) 308 + +[lineBottomType](#linebottomtype) 302 + +[lineBottomWidth](#linebottomwidth) 307 + +[reserved1562](#reserved1562) 315 + +[reserved1564](#reserved1564) 316 + +[reserved1566](#reserved1566) 317 + +[reserved1568](#reserved1568) 318 + +[reserved1569](#reserved1569) 319 + +[reserved1570](#reserved1570) 320 + +[bottom Transform property](#bottom) 391 + +[bWMode shape property](#bwmode) 97 + +[bWModeBW shape property](#bwmodebw) 98 + +[bwModePureBW shape property](#bwmodepurebw) 97 + +C + +[c3DAmbientIntensity 3D Style property](#c3dambientintensity) 363 + +[c3DCrMod Perspective Style property](#c3dcrmod) 348 + +[c3DDiffuseAmt Perspective Style property](#c3ddiffuseamt) 344 + +[c3DEdgeThickness Perspective Style property](#c3dedgethickness) 345 + +[c3DExtrudeBackward Perspective Style property](#c3dextrudebackward) 346 + +[c3DExtrudeForward Perspective Style property](#c3dextrudeforward) 346 + +[c3DExtrusionColor Perspective Style property](#c3dextrusioncolor) 347 + +[c3DExtrusionColorExt Perspective Style property](#c3dextrusioncolorext) 349 + +[c3DExtrusionColorExtMod Perspective Style property](#c3dextrusioncolorextmod) 350 + +[c3DFillIntensity 3D Style property](#c3dfillintensity) 368 + +[c3DFillX 3D Style property](#c3dfillx) 366 + +[c3DFillY 3D Style property](#c3dfilly) 366 + +[c3DFillZ 3D Style property](#c3dfillz) 367 + +[c3DKeyIntensity 3D Style property](#c3dkeyintensity) 365 + +[c3DKeyX 3D Style property](#c3dkeyx) 364 + +[c3DKeyY 3D Style property](#c3dkeyy) 364 + +[c3DKeyZ 3D Style property](#c3dkeyz) 365 + +[c3DOriginX 3D Style property](#c3doriginx) 361 + +[c3DOriginY 3D Style property](#c3doriginy) 361 + +[c3DRenderMode 3D Style property](#c3drendermode) 358 + +[c3DRotationAngle 3D Style property](#c3drotationangle) 356 + +[c3DRotationAxisX 3D Style property](#c3drotationaxisx) 354 + +[c3DRotationAxisY 3D Style property](#c3drotationaxisy) 355 + +[c3DRotationAxisZ 3D Style property](#c3drotationaxisz) 355 + +[c3DRotationCenterX 3D Style property](#c3drotationcenterx) 356 + +[c3DRotationCenterY 3D Style property](#c3drotationcentery) 357 + +[c3DRotationCenterZ 3D Style property](#c3drotationcenterz) 357 + +[c3DShininess Perspective Style property](#c3dshininess) 345 + +[c3DSkewAmount 3D Style property](#c3dskewamount) 363 + +[c3DSkewAngle 3D Style property](#c3dskewangle) 362 + +[c3DSpecularAmt Perspective Style property](#c3dspecularamt) 344 + +[c3DTolerance 3D Style property](#c3dtolerance) 359 + +[c3DXRotationAngle 3D Style property](#c3dxrotationangle) 353 + +[c3DXViewpoint 3D Style property](#c3dxviewpoint) 359 + +[c3DYRotationAngle 3D Style property](#c3dyrotationangle) 353 + +[c3DYViewpoint 3D Style property](#c3dyviewpoint) 360 + +[c3DZViewpoint 3D Style property](#c3dzviewpoint) 360 + +[Callout Boolean properties](#callout-boolean-properties) 109 + +Callout property + +[Callout Boolean properties](#callout-boolean-properties) 109 + +[dxyCalloutDropSpecified](#dxycalloutdropspecified) 108 + +[dxyCalloutGap](#dxycalloutgap) 105 + +[dxyCalloutLengthSpecified](#dxycalloutlengthspecified) 109 + +[spcoa](#spcoa) 106 + +[spcod](#spcod) 107 + +[unused832](#unused832) 105 + +[cdirFont Text property](#cdirfont) 405 + +[Change tracking](#change-tracking) 599 + +[Container overview](#containers) 24 + +[cropFromBottom Blip property](#cropfrombottom) 419 + +[cropFromLeft Blip property](#cropfromleft) 420 + +[cropFromRight Blip property](#cropfromright) 420 + +[cropFromTop Blip property](#cropfromtop) 419 + +CustomOfficeArt types + +[FRID](#frid) 27 + +[MSODGID](#msodgid) 27 + +[MSOFO](#msofo) 27 + +[MSOSPID](#msospid) 27 + +cxk geometry property ([section 2.3.6.30](#cxk) 182, [section 3.1.3](#officeartspgrcontainer-1) 546) + +[cxstyle shape property](#cxstyle) 96 + +D + +[Data for VtHyperlink algorithm](#data-for-vthyperlink) 543 + +Details + +[3D Object property](#d-object) 344 + +[3D Style property](#d-style) 352 + +[Blip property](#blip) 418 + +[Bottom Line Style property](#bottom-line-style) 300 + +[callout property](#callout) 105 + +[CustomOfficeArt types](#msodgid) 27 + +[Diagram property](#diagram) 370 + +[Fill Style property](#fill-style) 184 + +[Geometry property](#geometry) 164 + +[Geometry Text property](#geometry-text) 409 + +[group shape 2 property](#group-shape-2) 160 + +[group shape property](#group-shape) 111 + +[Ink property](#ink) 454 + +[Left Line Style property](#left-line-style) 233 + +[Line Style property](#line-style) 210 + +[OfficeArtRecord type](#officeartrecordheader) 27 + +[Perspective Style property](#perspective-style) 336 + +[Properties](#properties-1) 92 + +[Protection property](#protection) 398 + +[Relative Transform property](#relative-transform) 394 + +[Right Line Style property](#right-line-style) 278 + +[Shadow Style property](#shadow-style) 322 + +[shape property](#shape) 96 + +[Signature Line property](#signature-line) 456 + +[Text property](#text) 400 + +[Top Line Style property](#top-line-style) 255 + +[Transform property](#transform) 390 + +[Unknown HTML property](#unknown-html) 438 + +[Web Component property](#web-component) 450 + +[dgmBaseTextScale Diagram property](#dgmbasetextscale) 388 + +[dgmConstrainBounds Diagram property](#dgmconstrainbounds) 387 + +[dgmConstrainBounds_complex Diagram property](#dgmconstrainbounds_complex) 388 + +[dgmDefaultFontSize Diagram property](#dgmdefaultfontsize) 387 + +[dgmlayout shape property](#dgmlayout) 99 + +[dgmLayoutMRU shape property](#dgmlayoutmru) 101 + +[dgmNodeKind shape property](#dgmnodekind) 99 + +[dgmScaleX Diagram property](#dgmscalex) 385 + +[dgmScaleY Diagram property](#dgmscaley) 386 + +[dgmStyle Diagram property](#dgmstyle) 370 + +[dgmt Diagram property](#dgmt) 370 + +[dhgt group shape property](#dhgt) 156 + +[Diagram Boolean properties](#diagram-boolean-properties) 389 + +[Diagram example](#diagram-1) 544 + +[DrawingContainer](#drawingcontainer) 545 + +[OfficeArtFDG](#officeartfdg-1) 545 + +[OfficeArtSolverContainer](#officeartsolvercontainer-1) 580 + +[OfficeArtSpContainer](#officeartspcontainer-1) 578 + +[OfficeArtSpgrContainer](#officeartspgrcontainer-1) 546 + +[overview](#diagram-1) 544 + +Diagram property + +[dgmBaseTextScale](#dgmbasetextscale) 388 + +[dgmConstrainBounds](#dgmconstrainbounds) 387 + +[dgmConstrainBounds_complex](#dgmconstrainbounds_complex) 388 + +[dgmDefaultFontSize](#dgmdefaultfontsize) 387 + +[dgmScaleX](#dgmscalex) 385 + +[dgmScaleY](#dgmscaley) 386 + +[dgmStyle](#dgmstyle) 370 + +[dgmt](#dgmt) 370 + +[pRelationTbl](#prelationtbl) 385 + +[pRelationTbl_complex](#prelationtbl_complex) 385 + +[DrawingContainer diagram example](#drawingcontainer) 545 + +[dxHeightHR group shape property](#dxheighthr) 148 + +[dxTextBottom Text property](#dytextbottom) 402 + +[dxTextLeft Text property](#dxtextleft) 401 + +[dxTextRight Text property](#dxtextright) 402 + +[dxWidthHR group shape property](#dxwidthhr) 148 + +[dxWrapDistBottom group shape property](#dywrapdistbottom) 116 + +[dxWrapDistLeft group shape property](#dxwrapdistleft) 114 + +[dxWrapDistRight group shape property](#dxwrapdistright) 116 + +[dxyCalloutDropSpecified callout property](#dxycalloutdropspecified) 108 + +[dxyCalloutGap callout property](#dxycalloutgap) 105 + +[dxyCalloutLengthSpecified callout property](#dxycalloutlengthspecified) 109 + +[dyTextTop Text property](#dytexttop) 401 + +[dyWrapDistTop group shape property](#dywrapdisttop) 115 + +E + +Enumeration + +[MSO3DRENDERMODE](#mso3drendermode) 502 + +[MSOANCHOR](#msoanchor) 487 + +[MSOBLIPFLAGS](#msoblipflags) 492 + +[MSOBLIPTYPE](#msobliptype) 465 + +[MSOBWMODE](#msobwmode) 536 + +[MSOCDIR](#msocdir) 491 + +[MSOCXK](#msocxk) 492 + +[MSOCXSTYLE](#msocxstyle) 535 + +[MSODGCID](#msodgcid) 465 + +[MSODGMLO](#msodgmlo) 538 + +[MSODGMT](#msodgmt) 536 + +[MSODGSLK](#msodgslk) 538 + +[MSODZTYPE](#msodztype) 495 + +[MSOFILLTYPE](#msofilltype) 493 + +[MSOLINECAP](#msolinecap) 500 + +[MSOLINEDASHING](#msolinedashing) 497 + +[MSOLINEEND](#msolineend) 498 + +[MSOLINEENDLENGTH](#msolineendlength) 499 + +[MSOLINEENDWIDTH](#msolineendwidth) 498 + +[MSOLINEJOIN](#msolinejoin) 499 + +[MSOLINESTYLE](#msolinestyle) 496 + +[MSOLINETYPE](#msolinetype) 496 + +[MSOPATHESCAPE](#msopathescape) 541 + +[MSOPATHTYPE](#msopathtype) 540 + +[MSOSHADOWTYPE](#msoshadowtype) 500 + +[MSOSHAPEPATH](#msoshapepath) 492 + +[MSOSPT](#msospt) 502 + +[MSOTXDIR](#msotxdir) 491 + +[MSOTXFL](#msotxfl) 490 + +[MSOWRAPMODE](#msowrapmode) 487 + +[MSOXFORMTYPE](#msoxformtype) 502 + +[equationXML shape property](#equationxml) 102 + +[equationXML_complex shape property](#equationxml_complex) 102 + +[Examples](#structure-examples) 544 + +[Diagram](#diagram-1) 544 + +[overview](#diagram-1) 544 + +[Shape Properties](#shape-properties) 581 + +[overview](#shape-properties) 581 + +[Extended colors overview](#extended-colors) 24 + +F + +[Fields - vendor-extensible](#vendor-extensible-fields) 26 + +[Fill Style Boolean properties](#fill-style-boolean-properties) 209 + +Fill Style property + +[Fill Style Boolean properties](#fill-style-boolean-properties) 209 + +[fillAngle](#fillangle) 192 + +[fillBackColor](#fillbackcolor) 187 + +[fillBackColorExt](#fillbackcolorext) 206 + +[fillBackColorExtMod](#fillbackcolorextmod) 207 + +[fillBackOpacity](#fillbackopacity) 187 + +[fillBlip](#fillblip) 188 + +[fillBlip_complex](#fillblip_complex) 189 + +[fillBlipFlags](#fillblipflags) 190 + +[fillBlipName](#fillblipname) 189 + +[fillBlipName_complex](#fillblipname_complex) 190 + +[fillColor](#fillcolor) 185 + +[fillColorExt](#fillcolorext) 204 + +[fillColorExtMod](#fillcolorextmod) 205 + +[fillCrMod](#fillcrmod) 188 + +[fillDzType](#filldztype) 199 + +[fillFocus](#fillfocus) 193 + +[fillHeight](#fillheight) 191 + +[fillOpacity](#fillopacity) 186 + +[fillOriginX](#filloriginx) 201 + +[fillOriginY](#filloriginy) 201 + +[fillRectBottom](#fillrectbottom) 198 + +[fillRectLeft](#fillrectleft) 196 + +[fillRectRight](#fillrectright) 198 + +[fillRectTop](#fillrecttop) 197 + +[fillShadeColors](#fillshadecolors) 200 + +[fillShadeColors_complex](#fillshadecolors_complex) 200 + +[fillShadePreset](#fillshadepreset) 199 + +[fillShadeType](#fillshadetype) 203 + +[fillShapeOriginX](#fillshapeoriginx) 202 + +[fillShapeOriginY](#fillshapeoriginy) 203 + +[fillToBottom](#filltobottom) 196 + +[fillToLeft](#filltoleft) 194 + +[fillToRight](#filltoright) 195 + +[fillToTop](#filltotop) 195 + +[fillType](#filltype) 184 + +[fillWidth](#fillwidth) 191 + +[reserved415](#reserved415) 204 + +[reserved417](#reserved417) 205 + +[reserved419](#reserved419) 206 + +[reserved421](#reserved421) 207 + +[reserved422](#reserved422) 208 + +[reserved423](#reserved423) 208 + +[fillAngle Fill Style property](#fillangle) 192 + +[fillBackColor Fill Style property](#fillbackcolor) 187 + +[fillBackColorExt Fill Style property](#fillbackcolorext) 206 + +[fillBackColorExtMod Fill Style property](#fillbackcolorextmod) 207 + +[fillBackOpacity Fill Style property](#fillbackopacity) 187 + +[fillBlip Fill Style property](#fillblip) 188 + +[fillBlip_complex Fill Style property](#fillblip_complex) 189 + +[fillBlipFlags Fill Style property](#fillblipflags) 190 + +[fillBlipName Fill Style property](#fillblipname) 189 + +[fillBlipName_complex Fill Style property](#fillblipname_complex) 190 + +[fillColor Fill Style property](#fillcolor) 185 + +[fillColorExt Fill Style property](#fillcolorext) 204 + +[fillColorExtMod Fill Style property](#fillcolorextmod) 205 + +[fillCrMod Fill Style property](#fillcrmod) 188 + +[fillDzType Fill Style property](#filldztype) 199 + +[fillFocus Fill Style property](#fillfocus) 193 + +[fillHeight Fill Style property](#fillheight) 191 + +[fillOpacity Fill Style property](#fillopacity) 186 + +[fillOriginX Fill Style property](#filloriginx) 201 + +[fillOriginY Fill Style property](#filloriginy) 201 + +[fillRectBottom Fill Style property](#fillrectbottom) 198 + +[fillRectLeft Fill Style property](#fillrectleft) 196 + +[fillRectRight Fill Style property](#fillrectright) 198 + +[fillRectTop Fill Style property](#fillrecttop) 197 + +[fillShadeColors Fill Style property](#fillshadecolors) 200 + +[fillShadeColors_complex Fill Style property](#fillshadecolors_complex) 200 + +[fillShadePreset Fill Style property](#fillshadepreset) 199 + +[fillShadeType Fill Style property](#fillshadetype) 203 + +[fillShapeOriginX Fill Style property](#fillshapeoriginx) 202 + +[fillShapeOriginY Fill Style property](#fillshapeoriginy) 203 + +[fillToBottom Fill Style property](#filltobottom) 196 + +[fillToLeft Fill Style property](#filltoleft) 194 + +[fillToRight Fill Style property](#filltoright) 195 + +[fillToTop Fill Style property](#filltotop) 195 + +[fillType Fill Style property](#filltype) 184 + +[fillWidth Fill Style property](#fillwidth) 191 + +[FRID CustomOfficeArt type](#frid) 27 + +G + +[geoBottom geometry property](#geobottom) 166 + +[geoLeft geometry property](#geoleft) 164 + +[Geometry Boolean properties](#geometry-boolean-properties) 183 + +Geometry property + +[adjust2Value](#adjust2value) 170 + +[adjust3Value](#adjust3value) 170 + +[adjust4Value](#adjust4value) 171 + +[adjust5Value](#adjust5value) 172 + +[adjust6Value](#adjust6value) 172 + +[adjust7Value](#adjust7value) 173 + +[adjust8Value](#adjust8value) 174 + +[adjustValue](#adjustvalue) 169 + +cxk ([section 2.3.6.30](#cxk) 182, [section 3.1.3](#officeartspgrcontainer-1) 546) + +[geoBottom](#geobottom) 166 + +[geoLeft](#geoleft) 164 + +[Geometry Boolean properties](#geometry-boolean-properties) 183 + +[geoRight](#georight) 165 + +[geoTop](#geotop) 164 + +[pAdjustHandles](#padjusthandles) 179 + +[pAdjustHandles_complex](#padjusthandles_complex) 180 + +[pConnectionSites](#pconnectionsites) 174 + +[pConnectionSites_complex](#pconnectionsites_complex) 175 + +[pConnectionSitesDir](#pconnectionsitesdir) 175 + +[pConnectionSitesDir_complex](#pconnectionsitesdir_complex) 176 + +[pGuides](#pguides) 180 + +[pGuides_complex](#pguides_complex) 180 + +[pInscribe](#pinscribe) 181 + +[pInscribe_complex](#pinscribe_complex) 181 + +[pSegmentInfo](#psegmentinfo) 168 + +[pSegmentInfo_complex](#psegmentinfo_complex) 169 + +[pVertices](#pvertices) 167 + +[pVertices_complex](#pvertices_complex) 168 + +[shapePath](#shapepath) 166 + +[xLimo](#xlimo) 176 + +[yLimo](#ylimo) 177 + +[Geometry Text Boolean properties](#geometry-text-boolean-properties) 414 + +Geometry Text property + +[Geometry Text Boolean properties](#geometry-text-boolean-properties) 414 + +[gtextAlign](#gtextalign) 410 + +[gtextCSSFont](#gtextcssfont) 413 + +[gtextCSSFont_complex](#gtextcssfont_complex) 414 + +[gtextFont](#gtextfont) 413 + +[gtextFont_complex](#gtextfont_complex) 413 + +[gtextSize](#gtextsize) 411 + +[gtextSpacing](#gtextspacing) 412 + +[gtextUNICODE](#gtextunicode) 409 + +[gtextUNICODE_complex](#gtextunicode_complex) 409 + +[geoRight geometry property](#georight) 165 + +[geoTop geometry property](#geotop) 164 + +[Glossary](#glossary) 17 + +Group Shape 2 property + +[pctHoriz](#pcthoriz) 160 + +[pctHorizPos](#pcthorizpos) 161 + +[pctVert](#pctvert) 160 + +[pctVertPos](#pctvertpos) 162 + +[sizerelh](#sizerelh) 162 + +[sizerelv](#sizerelv) 163 + +[Group Shape Boolean properties](#group-shape-boolean-properties) 157 + +Group Shape property + +[alignHR](#alignhr) 146 + +[borderBottomColor](#borderbottomcolor) 152 + +[borderLeftColor](#borderleftcolor) 152 + +[borderRightColor](#borderrightcolor) 153 + +[borderTopColor](#bordertopcolor) 151 + +[dhgt](#dhgt) 156 + +[dxHeightHR](#dxheighthr) 148 + +[dxWidthHR](#dxwidthhr) 148 + +[dxWrapDistBottom](#dywrapdistbottom) 116 + +[dxWrapDistLeft](#dxwrapdistleft) 114 + +[dxWrapDistRight](#dxwrapdistright) 116 + +[dyWrapDistTop](#dywrapdisttop) 115 + +[lidRegroup](#lidregroup) 117 + +[metroBlob](#metroblob) 156 + +[metroBlob_complex](#metroblob_complex) 156 + +[pctHR](#pcthr) 145 + +[pihlShape](#pihlshape) 113 + +[pihlShape_complex](#pihlshape_complex) 113 + +[posh](#posh) 119 + +[posrelh](#posrelh) 120 + +[posrelv](#posrelv) 133 + +[posv](#posv) 132 + +[pWrapPolygonVertices](#pwrappolygonvertices) 114 + +[pWrapPolygonVertices_complex](#pwrappolygonvertices_complex) 114 + +[scriptLang](#scriptlang) 150 + +[tableProperties](#tableproperties) 153 + +[tableRowProperties](#tablerowproperties) 154 + +[tableRowProperties_complex](#tablerowproperties_complex) 154 + +[unused906](#unused906) 117 + +[wzDescription](#wzdescription) 112 + +[wzDescription_complex](#wzdescription_complex) 112 + +[wzName](#wzname) 111 + +[wzName_complex](#wzname_complex) 112 + +[wzScript](#wzscript) 119 + +[wzScript_complex](#wzscript_complex) 119 + +[wzScriptExtAttr](#wzscriptextattr) 149 + +[wzScriptExtAttr_complex](#wzscriptextattr_complex) 149 + +[wzScriptLangAttr](#wzscriptlangattr) 150 + +[wzScriptLangAttr_complex](#wzscriptlangattr_complex) 151 + +[wzTooltip](#wztooltip) 118 + +[wzTooltip_complex](#wztooltip_complex) 118 + +[wzWebBot](#wzwebbot) 155 + +[wzWebBot_complex](#wzwebbot_complex) 155 + +[gtextAlign Geometry Text property](#gtextalign) 410 + +[gtextCSSFont Geometry Text property](#gtextcssfont) 413 + +[gtextCSSFont_complex Geometry Text property](#gtextcssfont_complex) 414 + +[gtextFont Geometry Text property](#gtextfont) 413 + +[gtextFont_complex Geometry Text property](#gtextfont_complex) 413 + +[gtextSize Geometry Text property](#gtextsize) 411 + +[gtextSpacing Geometry Text property](#gtextspacing) 412 + +[gtextUNICODE Geometry Text property](#gtextunicode) 409 + +[gtextUNICODE_complex Geometry Text property](#gtextunicode_complex) 409 + +[gvPage Transform property](#gvpage) 392 + +[gvRelPage Relative Transform property](#gvrelpage) 397 + +H + +[hspMaster shape property](#hspmaster) 96 + +[hspNext Text property](#hspnext) 405 + +I + +[idDiscussAnchor shape property](#iddiscussanchor) 98 + +[IHlink OfficeArtRecord type](#ihlink) 91 + +[Implementer - security considerations](#security-considerations) 591 + +[IMsoArray OfficeArtRecord type](#imsoarray) 82 + +[IMsoInkData OfficeArtRecord type](#imsoinkdata) 83 + +[Informative references](#informative-references) 22 + +[Ink Boolean properties](#ink-boolean-properties) 455 + +Ink property + +[Ink Boolean properties](#ink-boolean-properties) 455 + +[pInkData](#pinkdata) 454 + +[pInkData_complex](#pinkdata_complex) 455 + +[Introduction](#introduction) 17 + +L + +[Left Line Style Boolean properties](#left-line-style-boolean-properties) 253 + +Left Line Style property + +[Left Line Style Boolean properties](#left-line-style-boolean-properties) 253 + +[lineLeftBackColor](#lineleftbackcolor) 234 + +[lineLeftBackColorExt](#lineleftbackcolorext) 250 + +[lineLeftBackColorExtMod](#lineleftbackcolorextmod) 251 + +[lineLeftColor](#lineleftcolor) 233 + +[lineLeftColorExt](#lineleftcolorext) 248 + +[lineLeftColorExtMod](#lineleftcolorextmod) 249 + +[lineLeftCrMod](#lineleftcrmod) 234 + +[lineLeftDashing](#lineleftdashing) 242 + +[lineLeftDashStyle](#lineleftdashstyle) 242 + +[lineLeftDashStyle_complex](#lineleftdashstyle_complex) 243 + +[lineLeftEndArrowhead](#lineleftendarrowhead) 244 + +[lineLeftEndArrowLength](#lineleftendarrowlength) 246 + +[lineLeftEndArrowWidth](#lineleftendarrowwidth) 245 + +[lineLeftEndCapStyle](#lineleftendcapstyle) 247 + +[lineLeftFillBlip](#lineleftfillblip) 236 + +[lineLeftFillBlip_complex](#lineleftfillblip_complex) 236 + +[lineLeftFillBlipFlags](#lineleftfillblipflags) 238 + +[lineLeftFillBlipName](#lineleftfillblipname) 237 + +[lineLeftFillBlipName_complex](#lineleftfillblipname_complex) 237 + +[lineLeftFillDzType](#lineleftfilldztype) 239 + +[lineLeftFillHeight](#lineleftfillheight) 239 + +[lineLeftFillWidth](#lineleftfillwidth) 238 + +[lineLeftJoinStyle](#lineleftjoinstyle) 246 + +[lineLeftMiterLimit](#lineleftmiterlimit) 241 + +[lineLeftOpacity](#lineleftopacity) 233 + +[lineLeftStartArrowhead](#lineleftstartarrowhead) 243 + +[lineLeftStartArrowLength](#lineleftstartarrowlength) 245 + +[lineLeftStartArrowWidth](#lineleftstartarrowwidth) 244 + +[lineLeftStyle](#lineleftstyle) 241 + +[lineLeftType](#linelefttype) 235 + +[lineLeftWidth](#lineleftwidth) 240 + +[left Transform property](#left) 390 + +[lidRegroup group shape property](#lidregroup) 117 + +[Line Style Boolean properties](#line-style-boolean-properties) 231 + +Line Style property + +[Line Style Boolean properties](#line-style-boolean-properties) 231 + +[lineBackColor](#linebackcolor) 212 + +[lineBackColorExt](#linebackcolorext) 228 + +[lineBackColorExtMod](#linebackcolorextmod) 229 + +[lineColor](#linecolor) 210 + +[lineColorExt](#linecolorext) 226 + +[lineColorExtMod](#linecolorextmod) 227 + +[lineCrMod](#linecrmod) 212 + +[lineDashing](#linedashing) 220 + +[lineDashStyle](#linedashstyle) 220 + +[lineDashStyle_complex](#linedashstyle_complex) 221 + +[lineEndArrowhead](#lineendarrowhead) 222 + +[lineEndArrowLength](#lineendarrowlength) 224 + +[lineEndArrowWidth](#lineendarrowwidth) 223 + +[lineEndCapStyle](#lineendcapstyle) 225 + +[lineFillBlip](#linefillblip) 213 + +[lineFillBlip_complex](#linefillblip_complex) 214 + +[lineFillBlipFlags](#linefillblipflags) 215 + +[lineFillBlipName](#linefillblipname) 214 + +[lineFillBlipName_complex](#linefillblipname_complex) 215 + +[lineFillDzType](#linefilldztype) 217 + +[lineFillHeight](#linefillheight) 216 + +[lineFillWidth](#linefillwidth) 216 + +[lineJoinStyle](#linejoinstyle) 225 + +[lineMiterLimit](#linemiterlimit) 218 + +[lineOpacity](#lineopacity) 211 + +[lineStartArrowhead](#linestartarrowhead) 221 + +[lineStartArrowLength](#linestartarrowlength) 223 + +[lineStartArrowWidth](#linestartarrowwidth) 222 + +[lineStyle](#linestyle) 219 + +[lineType](#linetype) 213 + +[lineWidth](#linewidth) 217 + +[reserved1370](#reserved1370) 248 + +[reserved1372](#reserved1372) 249 + +[reserved1374](#reserved1374) 250 + +[reserved1376](#reserved1376) 251 + +[reserved1377](#reserved1377) 252 + +[reserved1378](#reserved1378) 252 + +[reserved474](#reserved474) 226 + +reserved476 ([section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272) + +[reserved478](#reserved478) 228 + +[reserved480](#reserved480) 229 + +[reserved481](#reserved481) 230 + +[reserved482](#reserved482) 230 + +[lineBackColor Line Style property](#linebackcolor) 212 + +[lineBackColorExt Line Style property](#linebackcolorext) 228 + +[lineBackColorExtMod Line Style property](#linebackcolorextmod) 229 + +[lineBottomBackColor Bottom Line Style property](#linebottombackcolor) 301 + +[lineBottomBackColorExt Bottom Line Style property](#linebottombackcolorext) 317 + +[lineBottomBackColorExtMod Bottom Line Style property](#linebottombackcolorextmod) 318 + +[lineBottomColor Bottom Line Style property](#linebottomcolor) 300 + +[lineBottomColorExt Bottom Line Style property](#linebottomcolorext) 315 + +[lineBottomColorExtMod Bottom Line Style property](#linebottomcolorextmod) 316 + +[lineBottomCrMod Bottom Line Style property](#linebottomcrmod) 302 + +[lineBottomDashing Bottom Line Style property](#linebottomdashing) 309 + +[lineBottomDashStyle Bottom Line Style property](#linebottomdashstyle) 309 + +[lineBottomDashStyle_complex Bottom Line Style property](#linebottomdashstyle_complex) 310 + +[lineBottomEndArrowhead Bottom Line Style property](#linebottomendarrowhead) 311 + +[lineBottomEndArrowLength Bottom Line Style property](#linebottomendarrowlength) 313 + +[lineBottomEndArrowWidth Bottom Line Style property](#linebottomendarrowwidth) 313 + +[lineBottomEndCapStyle Bottom Line Style property](#linebottomendcapstyle) 314 + +[lineBottomFillBlip Bottom Line Style property](#linebottomfillblip) 303 + +[lineBottomFillBlip_complex Bottom Line Style property](#linebottomfillblip_complex) 304 + +[lineBottomFillBlipFlags Bottom Line Style property](#linebottomfillblipflags) 305 + +[lineBottomFillBlipName Bottom Line Style property](#linebottomfillblipname) 304 + +[lineBottomFillBlipName_complex Bottom Line Style property](#linebottomfillblipname_complex) 305 + +[lineBottomFillDzType Bottom Line Style property](#linebottomfilldztype) 307 + +[lineBottomFillHeight Bottom Line Style property](#linebottomfillheight) 306 + +[lineBottomFillWidth Bottom Line Style property](#linebottomfillwidth) 305 + +[lineBottomJoinStyle Bottom Line Style property](#linebottomjoinstyle) 314 + +[lineBottomMiterLimit Bottom Line Style property](#linebottommiterlimit) 308 + +[lineBottomOpacity Bottom Line Style property](#linebottomopacity) 301 + +[lineBottomStartArrowhead Bottom Line Style property](#linebottomstartarrowhead) 310 + +[lineBottomStartArrowLength Bottom Line Style property](#linebottomstartarrowlength) 312 + +[lineBottomStartArrowWidth Bottom Line Style property](#linebottomstartarrowwidth) 311 + +[lineBottomStyle Bottom Line Style property](#linebottomstyle) 308 + +[lineBottomType Bottom Line Style property](#linebottomtype) 302 + +[lineBottomWidth Bottom Line Style property](#linebottomwidth) 307 + +[lineColor Line Style property](#linecolor) 210 + +[lineColorExt Line Style property](#linecolorext) 226 + +[lineColorExtMod Line Style property](#linecolorextmod) 227 + +[lineCrMod Line Style property](#linecrmod) 212 + +[lineDashing Line Style property](#linedashing) 220 + +[lineDashStyle Line Style property](#linedashstyle) 220 + +[lineDashStyle_complex Line Style property](#linedashstyle_complex) 221 + +[lineEndArrowhead Line Style property](#lineendarrowhead) 222 + +[lineEndArrowLength Line Style property](#lineendarrowlength) 224 + +[lineEndArrowWidth Line Style property](#lineendarrowwidth) 223 + +[lineEndCapStyle Line Style property](#lineendcapstyle) 225 + +[lineFillBlip Line Style property](#linefillblip) 213 + +[lineFillBlip_complex Line Style property](#linefillblip_complex) 214 + +[lineFillBlipFlags Line Style property](#linefillblipflags) 215 + +[lineFillBlipName Line Style property](#linefillblipname) 214 + +[lineFillBlipName_complex Line Style property](#linefillblipname_complex) 215 + +[lineFillDzType Line Style property](#linefilldztype) 217 + +[lineFillHeight Line Style property](#linefillheight) 216 + +[lineFillWidth Line Style property](#linefillwidth) 216 + +[lineJoinStyle Line Style property](#linejoinstyle) 225 + +[lineLeftBackColor Left Line Style property](#lineleftbackcolor) 234 + +[lineLeftBackColorExt Left Line Style property](#lineleftbackcolorext) 250 + +[lineLeftBackColorExtMod Left Line Style property](#lineleftbackcolorextmod) 251 + +[lineLeftColor Left Line Style property](#lineleftcolor) 233 + +[lineLeftColorExt Left Line Style property](#lineleftcolorext) 248 + +[lineLeftColorExtMod Left Line Style property](#lineleftcolorextmod) 249 + +[lineLeftCrMod Left Line Style property](#lineleftcrmod) 234 + +[lineLeftDashing Left Line Style property](#lineleftdashing) 242 + +[lineLeftDashStyle Left Line Style property](#lineleftdashstyle) 242 + +[lineLeftDashStyle_complex Left Line Style property](#lineleftdashstyle_complex) 243 + +[lineLeftEndArrowhead Left Line Style property](#lineleftendarrowhead) 244 + +[lineLeftEndArrowLength Left Line Style property](#lineleftendarrowlength) 246 + +[lineLeftEndArrowWidth Left Line Style property](#lineleftendarrowwidth) 245 + +[lineLeftEndCapStyle Left Line Style property](#lineleftendcapstyle) 247 + +[lineLeftFillBlip Left Line Style property](#lineleftfillblip) 236 + +[lineLeftFillBlip_complex Left Line Style property](#lineleftfillblip_complex) 236 + +[lineLeftFillBlipFlags Left Line Style property](#lineleftfillblipflags) 238 + +[lineLeftFillBlipName Left Line Style property](#lineleftfillblipname) 237 + +[lineLeftFillBlipName_complex Left Line Style property](#lineleftfillblipname_complex) 237 + +[lineLeftFillDzType Left Line Style property](#lineleftfilldztype) 239 + +[lineLeftFillHeight Left Line Style property](#lineleftfillheight) 239 + +[lineLeftFillWidth Left Line Style property](#lineleftfillwidth) 238 + +[lineLeftJoinStyle Left Line Style property](#lineleftjoinstyle) 246 + +[lineLeftMiterLimit Left Line Style property](#lineleftmiterlimit) 241 + +[lineLeftOpacity Left Line Style property](#lineleftopacity) 233 + +[lineLeftStartArrowhead Left Line Style property](#lineleftstartarrowhead) 243 + +[lineLeftStartArrowLength Left Line Style property](#lineleftstartarrowlength) 245 + +[lineLeftStartArrowWidth Left Line Style property](#lineleftstartarrowwidth) 244 + +[lineLeftStyle Left Line Style property](#lineleftstyle) 241 + +[lineLeftType Left Line Style property](#linelefttype) 235 + +[lineLeftWidth Left Line Style property](#lineleftwidth) 240 + +[lineMiterLimit Line Style property](#linemiterlimit) 218 + +[lineOpacity Line Style property](#lineopacity) 211 + +[lineRightBackColor Right Line Style property](#linerightbackcolor) 279 + +[lineRightBackColorExt Right Line Style property](#linerightbackcolorext) 294 + +[lineRightBackColorExtMod Right Line Style property](#linerightbackcolorextmod) 295 + +[lineRightColor Right Line Style property](#linerightcolor) 278 + +[lineRightColorExt Right Line Style property](#linerightcolorext) 292 + +[lineRightColorExtMod Right Line Style property](#linerightcolorextmod) 293 + +[lineRightCrMod Right Line Style property](#linerightcrmod) 279 + +[lineRightDashing Right Line Style property](#linerightdashing) 286 + +[lineRightDashStyle Right Line Style property](#linerightdashstyle) 287 + +[lineRightDashStyle_complex Right Line Style property](#linerightdashstyle_complex) 288 + +[lineRightEndArrowhead Right Line Style property](#linerightendarrowhead) 288 + +[lineRightEndArrowLength Right Line Style property](#linerightendarrowlength) 291 + +[lineRightEndArrowWidth Right Line Style property](#linerightendarrowwidth) 290 + +[lineRightEndCapStyle Right Line Style property](#linerightendcapstyle) 292 + +[lineRightFillBlip Right Line Style property](#linerightfillblip) 280 + +[lineRightFillBlip_complex Right Line Style property](#linerightfillblip_complex) 281 + +[lineRightFillBlipFlags Right Line Style property](#linerightfillblipflags) 282 + +[lineRightFillBlipName Right Line Style property](#linerightfillblipname) 282 + +[lineRightFillBlipName_complex Right Line Style property](#linerightfillblipname_complex) 282 + +[lineRightFillDzType Right Line Style property](#linerightfilldztype) 284 + +[lineRightFillHeight Right Line Style property](#linerightfillheight) 284 + +[lineRightFillWidth Right Line Style property](#linerightfillwidth) 283 + +[lineRightJoinStyle Right Line Style property](#linerightjoinstyle) 291 + +[lineRightMiterLimit Right Line Style property](#linerightmiterlimit) 285 + +[lineRightOpacity Right Line Style property](#linerightopacity) 278 + +[lineRightStartArrowhead Right Line Style property](#linerightstartarrowhead) 288 + +[lineRightStartArrowLength Right Line Style property](#linerightstartarrowlength) 290 + +[lineRightStartArrowWidth Right Line Style property](#linerightstartarrowwidth) 289 + +[lineRightStyle Right Line Style property](#linerightstyle) 286 + +[lineRightType Right Line Style property](#linerighttype) 280 + +[lineRightWidth Right Line Style property](#linerightwidth) 285 + +[lineStartArrowhead Line Style property](#linestartarrowhead) 221 + +[lineStartArrowLength Line Style property](#linestartarrowlength) 223 + +[lineStartArrowWidth Line Style property](#linestartarrowwidth) 222 + +[lineStyle Line Style property](#linestyle) 219 + +[lineTopBackColor Top Line Style property](#linetopbackcolor) 256 + +[lineTopBackColorExt Top Line Style property](#linetopbackcolorext) 272 + +[lineTopBackColorExtMod Top Line Style property](#linetopbackcolorextmod) 273 + +[lineTopColor Top Line Style property](#linetopcolor) 255 + +[lineTopColorExt Top Line Style property](#linetopcolorext) 270 + +[lineTopColorExtMod Top Line Style property](#linetopcolorextmod) 271 + +[lineTopCrMod Top Line Style property](#linetopcrmod) 257 + +[lineTopDashing Top Line Style property](#linetopdashing) 264 + +[lineTopDashStyle Top Line Style property](#linetopdashstyle) 265 + +[lineTopDashStyle_complex Top Line Style property](#linetopdashstyle_complex) 265 + +[lineTopEndArrowhead Top Line Style property](#linetopendarrowhead) 266 + +[lineTopEndArrowLength Top Line Style property](#linetopendarrowlength) 268 + +[lineTopEndArrowWidth Top Line Style property](#linetopendarrowwidth) 268 + +[lineTopEndCapStyle Top Line Style property](#linetopendcapstyle) 269 + +[lineTopFillBlip Top Line Style property](#linetopfillblip) 258 + +[lineTopFillBlip_complex Top Line Style property](#linetopfillblip_complex) 259 + +[lineTopFillBlipFlags Top Line Style property](#linetopfillblipflags) 260 + +[lineTopFillBlipName Top Line Style property](#linetopfillblipname) 259 + +[lineTopFillBlipName_complex Top Line Style property](#linetopfillblipname_complex) 260 + +[lineTopFillDzType Top Line Style property](#linetopfilldztype) 262 + +[lineTopFillHeight Top Line Style property](#linetopfillheight) 261 + +[lineTopFillWidth Top Line Style property](#linetopfillwidth) 261 + +[lineTopJoinStyle Top Line Style property](#linetopjoinstyle) 269 + +[lineTopMiterLimit Top Line Style property](#linetopmiterlimit) 263 + +[lineTopOpacity Top Line Style property](#linetopopacity) 256 + +[lineTopStartArrowhead Top Line Style property](#linetopstartarrowhead) 266 + +[lineTopStartArrowLength Top Line Style property](#linetopstartarrowlength) 267 + +[lineTopStartArrowWidth Top Line Style property](#linetopstartarrowwidth) 267 + +[lineTopStyle Top Line Style property](#linetopstyle) 263 + +[lineTopType Top Line Style property](#linetoptype) 257 + +[lineTopWidth Top Line Style property](#linetopwidth) 262 + +[lineType Line Style property](#linetype) 213 + +[lineWidth Line Style property](#linewidth) 217 + +[Localization](#versioning-and-localization) 25 + +[lTxid Text property](#ltxid) 400 + +M + +[metroBlob group shape property](#metroblob) 156 + +[metroBlob_complex group shape property](#metroblob_complex) 156 + +[movie Blip property](#movie) 430 + +[movie_complex Blip property](#movie_complex) 430 + +[MSO3DRENDERTYPE enumeration](#mso3drendermode) 502 + +[MSOANCHOR enumeration](#msoanchor) 487 + +[MSOBLIPFLAGS enumeration](#msoblipflags) 492 + +[MSOBLIPTYPE enumeration](#msobliptype) 465 + +[MSOBWMODE enumeration](#msobwmode) 536 + +[MSOCDIR enumeration](#msocdir) 491 + +[MSOCOLORMODUNDEFINED OfficeArtRecord type](#msocolormodundefined) 31 + +[MSOCR OfficeArtRecord type](#msocr) 78 + +[MSOCXK enumeration](#msocxk) 492 + +[MSOCXSTYLE enumeration](#msocxstyle) 535 + +[MSODGCID enumeration](#msodgcid) 465 + +[MSODGID CustomOfficeArt type](#msodgid) 27 + +[MSODGMLO enumeration](#msodgmlo) 538 + +[MSODGMT enumeration](#msodgmt) 536 + +[MSODGSLK enumeration](#msodgslk) 538 + +[MSODZTYPE enumeration](#msodztype) 495 + +[MSOFILLTYPE enumeration](#msofilltype) 493 + +[MSOFO CustomOfficeArt type](#msofo) 27 + +[MSOLINECAP enumeration](#msolinecap) 500 + +[MSOLINEDASHING enumeration](#msolinedashing) 497 + +[MSOLINEEND enumeration](#msolineend) 498 + +[MSOLINEENDLENGTH enumeration](#msolineendlength) 499 + +[MSOLINEENDWIDTH enumeration](#msolineendwidth) 498 + +[MSOLINEJOIN enumeration](#msolinejoin) 499 + +[MSOLINESTYLE enumeration](#msolinestyle) 496 + +[MSOLINETYPE enumeration](#msolinetype) 496 + +[MSOPATHESCAPE enumeration](#msopathescape) 541 + +[MSOPATHESCAPEINFO OfficeArtRecord type](#msopathescapeinfo) 83 + +[MSOPATHINFO OfficeArtRecord type](#msopathinfo) 83 + +[MSOPATHTYPE enumeration](#msopathtype) 540 + +[MSOSHADE OfficeArtRecord type](#msoshade) 31 + +[MSOSHADECOLOR OfficeArtRecord type](#msoshadecolor) 92 + +[MSOSHADETYPE OfficeArtRecord type](#msoshadetype) 81 + +[MSOSHADOWTYPE enumeration](#msoshadowtype) 500 + +[MSOSHAPEPATH enumeration](#msoshapepath) 492 + +[MSOSPID CustomOfficeArt type](#msospid) 27 + +[MSOSPT enumeration](#msospt) 502 + +[MSOTINT OfficeArtRecord type](#msotint) 31 + +[MSOTINTSHADE OfficeArtRecord type](#msotintshade) 31 + +[MSOTXDIR enumeration](#msotxdir) 491 + +[MSOTXFL enumeration](#msotxfl) 490 + +[MSOWRAPMODE enumeration](#msowrapmode) 487 + +[MSOXFORMTYPE enumeration](#msoxformtype) 502 + +N + +[Normative references](#normative-references) 21 + +O + +[OfficeArtBlip OfficeArtRecord type](#officeartblip) 58 + +[OfficeArtBlipDIB OfficeArtRecord type](#officeartblipdib) 65 + +[OfficeArtBlipEMF OfficeArtRecord type](#officeartblipemf) 59 + +[OfficeArtBlipJPEG OfficeArtRecord type](#officeartblipjpeg) 62 + +[OfficeArtBlipPICT OfficeArtRecord type](#officeartblippict) 61 + +[OfficeArtBlipPNG OfficeArtRecord type](#officeartblippng) 64 + +[OfficeArtBlipTIFF OfficeArtRecord type](#officeartbliptiff) 66 + +[OfficeArtBlipWMF OfficeArtRecord type](#officeartblipwmf) 60 + +[OfficeArtBStoreContainer OfficeArtRecord type](#officeartbstorecontainer) 57 + +[OfficeArtBStoreContainerFileBlock OfficeArtRecord type](#officeartbstorecontainerfileblock) 58 + +[OfficeArtBStoreDelay OfficeArtRecord type](#officeartbstoredelay) 58 + +[OfficeArtChildAnchor OfficeArtRecord type](#officeartchildanchor) 74 + +[OfficeArtColorMRUContainer OfficeArtRecord type](#officeartcolormrucontainer) 77 + +[OfficeArtCOLORREF OfficeArtRecord type](#officeartcolorref) 28 + +[OfficeArtDgContainer OfficeArtRecord type](#officeartdgcontainer) 51 + +[OfficeArtDggContainer OfficeArtRecord type](#officeartdggcontainer) 50 + +[OfficeArtFArcRule OfficeArtRecord type](#officeartfarcrule) 71 + +[OfficeArtFBSE OfficeArtRecord type](#officeartfbse) 68 + +[OfficeArtFCalloutRule OfficeArtRecord type](#officeartfcalloutrule) 70 + +[OfficeArtFConnectorRule OfficeArtRecord type](#officeartfconnectorrule) 72 + +[OfficeArtFDG diagram example](#officeartfdg-1) 545 + +[OfficeArtFDG OfficeArtRecord type](#officeartfdg) 81 + +[OfficeArtFDGG OfficeArtRecord type](#officeartfdgg) 79 + +[OfficeArtFDGGBlock OfficeArtRecord type](#officeartfdggblock) 80 + +[OfficeArtFDGSL OfficeArtRecord type](#officeartfdgsl) 69 + +[OfficeArtFOPT OfficeArtRecord type](#officeartfopt) 34 + +[OfficeArtFOPTE OfficeArtRecord type](#officeartfopte) 32 + +[OfficeArtFOPTEOPID OfficeArtRecord type](#officeartfopteopid) 32 + +[OfficeArtFPSPL OfficeArtRecord type](#officeartfpspl) 73 + +[OfficeArtFRIT OfficeArtRecord type](#officeartfrit) 77 + +[OfficeArtFRITContainer OfficeArtRecord type](#officeartfritcontainer) 76 + +[OfficeArtFSP OfficeArtRecord type](#officeartfsp) 75 + +[OfficeArtFSPGR OfficeArtRecord type](#officeartfspgr) 73 + +[OfficeArtIDCL OfficeArtRecord type](#officeartidcl) 79 + +[OfficeArtInlineSpContainer OfficeArtRecord type](#officeartinlinespcontainer) 55 + +[OfficeArtMetafileHeader OfficeArtRecord type](#officeartmetafileheader) 67 + +OfficeArtRecord type + +[ADJH](#adjh) 85 + +[IHlink](#ihlink) 91 + +[IMsoArray](#imsoarray) 82 + +[IMsoInkData](#imsoinkdata) 83 + +[MSOCOLORMODUNDEFINED](#msocolormodundefined) 31 + +[MSOCR](#msocr) 78 + +[MSOPATHESCAPEINFO](#msopathescapeinfo) 83 + +[MSOPATHINFO](#msopathinfo) 83 + +[MSOSHADE](#msoshade) 31 + +[MSOSHADECOLOR](#msoshadecolor) 92 + +[MSOSHADETYPE](#msoshadetype) 81 + +[MSOTINT](#msotint) 31 + +[MSOTINTSHADE](#msotintshade) 31 + +[OfficeArtBlip](#officeartblip) 58 + +[OfficeArtBlipDIB](#officeartblipdib) 65 + +[OfficeArtBlipEMF](#officeartblipemf) 59 + +[OfficeArtBlipJPEG](#officeartblipjpeg) 62 + +[OfficeArtBlipPICT](#officeartblippict) 61 + +[OfficeArtBlipPNG](#officeartblippng) 64 + +[OfficeArtBlipTIFF](#officeartbliptiff) 66 + +[OfficeArtBlipWMF](#officeartblipwmf) 60 + +[OfficeArtBStoreContainer](#officeartbstorecontainer) 57 + +[OfficeArtBStoreContainerFileBlock](#officeartbstorecontainerfileblock) 58 + +[OfficeArtBStoreDelay](#officeartbstoredelay) 58 + +[OfficeArtChildAnchor](#officeartchildanchor) 74 + +[OfficeArtColorMRUContainer](#officeartcolormrucontainer) 77 + +[OfficeArtCOLORREF](#officeartcolorref) 28 + +[OfficeArtDgContainer](#officeartdgcontainer) 51 + +[OfficeArtDggContainer](#officeartdggcontainer) 50 + +[OfficeArtFArcRule](#officeartfarcrule) 71 + +[OfficeArtFBSE](#officeartfbse) 68 + +[OfficeArtFCalloutRule](#officeartfcalloutrule) 70 + +[OfficeArtFConnectorRule](#officeartfconnectorrule) 72 + +[OfficeArtFDG](#officeartfdg) 81 + +[OfficeArtFDGG](#officeartfdgg) 79 + +[OfficeArtFDGGBlock](#officeartfdggblock) 80 + +[OfficeArtFDGSL](#officeartfdgsl) 69 + +[OfficeArtFOPT](#officeartfopt) 34 + +[OfficeArtFOPTE](#officeartfopte) 32 + +[OfficeArtFOPTEOPID](#officeartfopteopid) 32 + +[OfficeArtFPSPL](#officeartfpspl) 73 + +[OfficeArtFRIT](#officeartfrit) 77 + +[OfficeArtFRITContainer](#officeartfritcontainer) 76 + +[OfficeArtFSP](#officeartfsp) 75 + +[OfficeArtFSPGR](#officeartfspgr) 73 + +[OfficeArtIDCL](#officeartidcl) 79 + +[OfficeArtInlineSpContainer](#officeartinlinespcontainer) 55 + +[OfficeArtMetafileHeader](#officeartmetafileheader) 67 + +[OfficeArtRecordHeader](#officeartrecordheader) 27 + +[OfficeArtSecondaryFOPT](#officeartsecondaryfopt) 41 + +[OfficeArtSolverContainer](#officeartsolvercontainer) 56 + +[OfficeArtSolverContainerFileBlock](#officeartsolvercontainerfileblock) 57 + +[OfficeArtSpContainer](#officeartspcontainer) 52 + +[OfficeArtSpgrContainer](#officeartspgrcontainer) 55 + +[OfficeArtSpgrContainerFileBlock](#officeartspgrcontainerfileblock) 56 + +[OfficeArtSplitMenuColorContainer](#officeartsplitmenucolorcontainer) 78 + +[OfficeArtTertiaryFOPT](#officearttertiaryfopt) 42 + +[POINT](#point) 84 + +[RECT](#rect) 84 + +[SG](#sg) 88 + +[TABLEFLAGS](#tableflags) 91 + +[OfficeArtRecordHeader OfficeArtRecord type](#officeartrecordheader) 27 + +[OfficeArtRGFOPTE properties](#officeartrgfopte) 95 + +[OfficeArtSecondaryFOPT OfficeArtRecord type](#officeartsecondaryfopt) 41 + +[OfficeArtSolverContainer diagram example](#officeartsolvercontainer-1) 580 + +[OfficeArtSolverContainer OfficeArtRecord type](#officeartsolvercontainer) 56 + +[OfficeArtSolverContainerFileBlock OfficeArtRecord type](#officeartsolvercontainerfileblock) 57 + +[OfficeArtSpContainer diagram example](#officeartspcontainer-1) 578 + +[OfficeArtSpContainer OfficeArtRecord type](#officeartspcontainer) 52 + +[OfficeArtSpgrContainer diagram example](#officeartspgrcontainer-1) 546 + +[OfficeArtSpgrContainer OfficeArtRecord type](#officeartspgrcontainer) 55 + +[OfficeArtSpgrContainerFileBlock OfficeArtRecord type](#officeartspgrcontainerfileblock) 56 + +[OfficeArtSplitMenuColorContainer OfficeArtRecord type](#officeartsplitmenucolorcontainer) 78 + +[OfficeArtTertiaryFOPT OfficeArtRecord type](#officearttertiaryfopt) 42 + +Overview + +[bit format](#bit-format) 24 + +[container](#containers) 24 + +[extended colors](#extended-colors) 24 + +[properties](#properties) 24 + +[record header](#record-headers) 24 + +[records](#records) 23 + +[Overview (synopsis)](#structure-overview-synopsis) 22 + +P + +[pAdjustHandles geometry property](#padjusthandles) 179 + +[pAdjustHandles_complex geometry property](#padjusthandles_complex) 180 + +[pConnectionSites geometry property](#pconnectionsites) 174 + +[pConnectionSites_complex geometry property](#pconnectionsites_complex) 175 + +[pConnectionSitesDir geometry property](#pconnectionsitesdir) 175 + +[pConnectionSitesDir_complex geometry property](#pconnectionsitesdir_complex) 176 + +[pctHoriz group shape 2 property](#pcthoriz) 160 + +[pctHorizPos group shape 2 property](#pcthorizpos) 161 + +[pctHR group shape property](#pcthr) 145 + +[pctVert group shape 2 property](#pctvert) 160 + +[pctVertPos group shape 2 property](#pctvertpos) 162 + +[Perspective Style Boolean properties](#perspective-style-boolean-properties) 343 + +Perspective Style property + +[Perspective Style Boolean properties](#perspective-style-boolean-properties) 343 + +[perspectiveOffsetX](#perspectiveoffsetx) 337 + +[perspectiveOffsetY](#perspectiveoffsety) 337 + +[perspectiveOriginX](#perspectiveoriginx) 342 + +[perspectiveOriginY](#perspectiveoriginy) 342 + +[perspectivePerspectiveX](#perspectiveperspectivex) 340 + +[perspectivePerspectiveY](#perspectiveperspectivey) 341 + +[perspectiveScaleXToX](#perspectivescalextox) 338 + +[perspectiveScaleXToY](#perspectivescalextoy) 339 + +[perspectiveScaleYToX](#perspectivescaleytox) 338 + +[perspectiveScaleYToY](#perspectivescaleytoy) 340 + +[perspectiveType](#perspectivetype) 336 + +[perspectiveWeight](#perspectiveweight) 341 + +[perspectiveOffsetX Perspective Style property](#perspectiveoffsetx) 337 + +[perspectiveOffsetY Perspective Style property](#perspectiveoffsety) 337 + +[perspectiveOriginX Perspective Style property](#perspectiveoriginx) 342 + +[perspectiveOriginY Perspective Style property](#perspectiveoriginy) 342 + +[perspectivePerspectiveX Perspective Style property](#perspectiveperspectivex) 340 + +[perspectivePerspectiveY Perspective Style property](#perspectiveperspectivey) 341 + +[perspectiveScaleXToX Perspective Style property](#perspectivescalextox) 338 + +[perspectiveScaleXToY Perspective Style property](#perspectivescalextoy) 339 + +[perspectiveScaleYToX Perspective Style property](#perspectivescaleytox) 338 + +[perspectiveScaleYToY Perspective Style property](#perspectivescaleytoy) 340 + +[perspectiveType Perspective Style property](#perspectivetype) 336 + +[perspectiveWeight Perspective Style property](#perspectiveweight) 341 + +[pGuides geometry property](#pguides) 180 + +[pGuides_complex geometry property](#pguides_complex) 180 + +[pib Blip property](#pib) 421 + +[pib_complex Blip property](#pib_complex) 422 + +[pibFlags Blip property](#pibflags) 423 + +[pibName Blip property](#pibname) 422 + +[pibName_complex Blip property](#pibname_complex) 423 + +[pibPrint Blip property](#pibprint) 427 + +[pibPrint_complex Blip property](#pibprint_complex) 428 + +[pibPrintFlags Blip property](#pibprintflags) 429 + +[pibPrintName Blip property](#pibprintname) 428 + +[pibPrintName_complex Blip property](#pibprintname_complex) 429 + +[pictureBrightness Blip property](#picturebrightness) 424 + +[pictureContrast Blip property](#picturecontrast) 424 + +[pictureDblCrMod Blip property](#picturedblcrmod) 426 + +[pictureFillCrMod Blip property](#picturefillcrmod) 426 + +[pictureId Blip property](#pictureid) 425 + +[pictureLineCrMod Blip property](#picturelinecrmod) 427 + +[pictureRecolor Blip property](#picturerecolor) 433 + +[pictureRecolorExt Blip property](#picturerecolorext) 434 + +[pictureRecolorExtMod Blip property](#picturerecolorextmod) 435 + +[pictureTransparent Blip property](#picturetransparent) 423 + +[pictureTransparentExt Blip property](#picturetransparentext) 431 + +[pictureTransparentExtMod Blip property](#picturetransparentextmod) 432 + +[pihlShape group shape property](#pihlshape) 113 + +[pihlShape_complex group shape property](#pihlshape_complex) 113 + +[pInkData Ink property](#pinkdata) 454 + +[pInkData_complex Ink property](#pinkdata_complex) 455 + +[pInscribe geometry property](#pinscribe) 181 + +[pInscribe_complex geometry property](#pinscribe_complex) 181 + +[POINT OfficeArtRecord type](#point) 84 + +[posh group shape property](#posh) 119 + +[posrelh group shape property](#posrelh) 120 + +[posrelv group shape property](#posrelv) 133 + +[posv group shape property](#posv) 132 + +[pRelationTbl Diagram property](#prelationtbl) 385 + +[pRelationTbl_complex Diagram property](#prelationtbl_complex) 385 + +[Product behavior](#appendix-a-product-behavior) 592 + +Properties + +[OfficeArtRGFOPTE](#officeartrgfopte) 95 + +[Properties overview](#properties) 24 + +[Protection Boolean properties](#protection-boolean-properties) 398 + +[pSegmentInfo geometry property](#psegmentinfo) 168 + +[pSegmentInfo_complex geometry property](#psegmentinfo_complex) 169 + +[pVertices geometry property](#pvertices) 167 + +[pVertices_complex geometry property](#pvertices_complex) 168 + +[pWrapPolygonVertices group shape property](#pwrappolygonvertices) 114 + +[pWrapPolygonVertices_complex group shape property](#pwrappolygonvertices_complex) 114 + +R + +[Record header overview](#record-headers) 24 + +[Records overview](#records) 23 + +[RECT OfficeArtRecord type](#rect) 84 + +[References](#references) 21 + +[informative](#informative-references) 22 + +[normative](#normative-references) 21 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 25 + +[Relative Transform Boolean properties](#relative-transform-boolean-properties) 397 + +Relative Transform property + +[gvRelPage](#gvrelpage) 397 + +[Relative Transform Boolean properties](#relative-transform-boolean-properties) 397 + +[relBottom](#relbottom) 396 + +[relLeft](#relleft) 394 + +[relRight](#relright) 395 + +[relRotation](#relrotation) 396 + +[relTop](#reltop) 394 + +[relBottom Relative Transform property](#relbottom) 396 + +[relLeft Relative Transform property](#relleft) 394 + +[relRight Relative Transform property](#relright) 395 + +[relRotation Relative Transform property](#relrotation) 396 + +[relTop Relative Transform property](#reltop) 394 + +[reserved1370 Line Style property](#reserved1370) 248 + +[reserved1372 Line Style property](#reserved1372) 249 + +[reserved1374 Line Style property](#reserved1374) 250 + +[reserved1376 Line Style property](#reserved1376) 251 + +[reserved1377 Line Style property](#reserved1377) 252 + +[reserved1378 Line Style property](#reserved1378) 252 + +[reserved1434 Top Line Style property](#reserved1434) 270 + +[reserved1436 Top Line Style property](#reserved1436) 272 + +[reserved1438 Top Line Style property](#reserved1438) 273 + +[reserved1440 Top Line Style property](#reserved1440) 274 + +[reserved1441 Top Line Style property](#reserved1441) 274 + +[reserved1442 Top Line Style property](#reserved1442) 275 + +[reserved1498 Right Line Style property](#reserved1498) 293 + +reserved1500 Right Line Style property ([section 2.3.7.36](#reserved417) 205, [section 2.3.7.40](#reserved421) 207, [section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272, [section 2.3.11.31](#reserved1500) 294, [section 2.3.11.35](#reserved1504) 296) + +[reserved1502 Right Line Style property](#reserved1502) 295 + +reserved1504 Right Line Style property ([section 2.3.7.36](#reserved417) 205, [section 2.3.7.40](#reserved421) 207, [section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272, [section 2.3.11.35](#reserved1504) 296) + +[reserved1505 Right Line Style property](#reserved1505) 297 + +[reserved1506 Right Line Style property](#reserved1506) 297 + +[reserved1562 Bottom Line Style property](#reserved1562) 315 + +[reserved1564 Bottom Line Style property](#reserved1564) 316 + +[reserved1566 Bottom Line Style property](#reserved1566) 317 + +[reserved1568 Bottom Line Style property](#reserved1568) 318 + +[reserved1569 Bottom Line Style property](#reserved1569) 319 + +[reserved1570 Bottom Line Style property](#reserved1570) 320 + +[reserved278 Blip property](#reserved278) 431 + +[reserved280 Blip property](#reserved280) 432 + +[reserved281 Blip property](#reserved281) 433 + +[reserved284 Blip property](#reserved284) 434 + +[reserved286 Blip property](#reserved286) 435 + +[reserved287 Blip property](#reserved287) 436 + +[reserved415 Fill Style property](#reserved415) 204 + +[reserved417 Fill Style property](#reserved417) 205 + +[reserved419 Fill Style property](#reserved419) 206 + +[reserved421 Fill Style property](#reserved421) 207 + +[reserved422 Fill Style property](#reserved422) 208 + +[reserved423 Fill Style property](#reserved423) 208 + +[reserved474 Line Style property](#reserved474) 226 + +reserved476 Line Style property ([section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272) + +[reserved478 Line Style property](#reserved478) 228 + +[reserved480 Line Style property](#reserved480) 229 + +[reserved481 Line Style property](#reserved481) 230 + +[reserved482 Line Style property](#reserved482) 230 + +[reserved531 Shadow Style property](#reserved531) 329 + +reserved533 Shadow Style property ([section 2.3.7.36](#reserved417) 205, [section 2.3.7.40](#reserved421) 207, [section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272, [section 2.3.13.15](#reserved533) 330) + +[reserved535 Shadow Style property](#reserved535) 332 + +[reserved537 Shadow Style property](#reserved537) 333 + +[reserved538 Shadow Style property](#reserved538) 333 + +[reserved539 Shadow Style property](#reserved539) 334 + +[reserved646 3D Object Style property](#reserved646) 347 + +[reserved650 3D Object Style property](#reserved650) 349 + +[reserved652 3D Object Style property](#reserved652) 350 + +[reserved653 3D Object Style property](#reserved653) 351 + +[Right Line Style Boolean properties](#right-line-style-boolean-properties) 298 + +Right Line Style property + +[lineRightBackColor](#linerightbackcolor) 279 + +[lineRightBackColorExt](#linerightbackcolorext) 294 + +[lineRightBackColorExtMod](#linerightbackcolorextmod) 295 + +[lineRightColor](#linerightcolor) 278 + +[lineRightColorExt](#linerightcolorext) 292 + +[lineRightColorExtMod](#linerightcolorextmod) 293 + +[lineRightCrMod](#linerightcrmod) 279 + +[lineRightDashing](#linerightdashing) 286 + +[lineRightDashStyle](#linerightdashstyle) 287 + +[lineRightDashStyle_complex](#linerightdashstyle_complex) 288 + +[lineRightEndArrowhead](#linerightendarrowhead) 288 + +[lineRightEndArrowLength](#linerightendarrowlength) 291 + +[lineRightEndArrowWidth](#linerightendarrowwidth) 290 + +[lineRightEndCapStyle](#linerightendcapstyle) 292 + +[lineRightFillBlip](#linerightfillblip) 280 + +[lineRightFillBlip_complex](#linerightfillblip_complex) 281 + +[lineRightFillBlipFlags](#linerightfillblipflags) 282 + +[lineRightFillBlipName](#linerightfillblipname) 282 + +[lineRightFillBlipName_complex](#linerightfillblipname_complex) 282 + +[lineRightFillDzType](#linerightfilldztype) 284 + +[lineRightFillHeight](#linerightfillheight) 284 + +[lineRightFillWidth](#linerightfillwidth) 283 + +[lineRightJoinStyle](#linerightjoinstyle) 291 + +[lineRightMiterLimit](#linerightmiterlimit) 285 + +[lineRightOpacity](#linerightopacity) 278 + +[lineRightStartArrowhead](#linerightstartarrowhead) 288 + +[lineRightStartArrowLength](#linerightstartarrowlength) 290 + +[lineRightStartArrowWidth](#linerightstartarrowwidth) 289 + +[lineRightStyle](#linerightstyle) 286 + +[lineRightType](#linerighttype) 280 + +[lineRightWidth](#linerightwidth) 285 + +[reserved1498](#reserved1498) 293 + +reserved1500 ([section 2.3.7.36](#reserved417) 205, [section 2.3.7.40](#reserved421) 207, [section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272, [section 2.3.11.31](#reserved1500) 294, [section 2.3.11.35](#reserved1504) 296) + +[reserved1502](#reserved1502) 295 + +reserved1504 ([section 2.3.7.36](#reserved417) 205, [section 2.3.7.40](#reserved421) 207, [section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272, [section 2.3.11.35](#reserved1504) 296) + +[reserved1505](#reserved1505) 297 + +[reserved1506](#reserved1506) 297 + +[Right Line Style Boolean properties](#right-line-style-boolean-properties) 298 + +[right Transform property](#right) 391 + +[rotation Transform property](#rotation) 392 + +S + +[scriptLang group shape property](#scriptlang) 150 + +[Security - implementer considerations](#security-considerations) 591 + +[SG OfficeArtRecord type](#sg) 88 + +[Shadow Style Boolean properties](#shadow-style-boolean-properties) 335 + +Shadow Style property + +[reserved531](#reserved531) 329 + +reserved533 ([section 2.3.7.36](#reserved417) 205, [section 2.3.7.40](#reserved421) 207, [section 2.3.8.31](#reserved476) 227, [section 2.3.10.31](#reserved1436) 272, [section 2.3.13.15](#reserved533) 330) + +[reserved535](#reserved535) 332 + +[reserved537](#reserved537) 333 + +[reserved538](#reserved538) 333 + +[reserved539](#reserved539) 334 + +[Shadow Style Boolean properties](#shadow-style-boolean-properties) 335 + +[shadowColor](#shadowcolor) 323 + +[shadowColorExt](#shadowcolorext) 329 + +[shadowColorExtMod](#shadowcolorextmod) 330 + +[shadowCrMod](#shadowcrmod) 324 + +[shadowHighlight](#shadowhighlight) 324 + +[shadowHighlightExt](#shadowhighlightext) 331 + +[shadowHighlightExtMod](#shadowhighlightextmod) 332 + +[shadowOffsetX](#shadowoffsetx) 325 + +[shadowOffsetY](#shadowoffsety) 326 + +[shadowOpacity](#shadowopacity) 325 + +[shadowOriginX](#shadoworiginx) 328 + +[shadowOriginY](#shadoworiginy) 328 + +[shadowSecondOffsetX](#shadowsecondoffsetx) 326 + +[shadowSecondOffsetY](#shadowsecondoffsety) 327 + +[shadowSoftness](#shadowsoftness) 334 + +[shadowType](#shadowtype) 323 + +[shadowColor Shadow Style property](#shadowcolor) 323 + +[shadowColorExt Shadow Style property](#shadowcolorext) 329 + +[shadowColorExtMod Shadow Style property](#shadowcolorextmod) 330 + +[shadowCrMod Shadow Style property](#shadowcrmod) 324 + +[shadowHighlight Shadow Style property](#shadowhighlight) 324 + +[shadowHighlightExt Shadow Style property](#shadowhighlightext) 331 + +[shadowHighlightExtMod Shadow Style property](#shadowhighlightextmod) 332 + +[shadowOffsetX Shadow Style property](#shadowoffsetx) 325 + +[shadowOffsetY Shadow Style property](#shadowoffsety) 326 + +[shadowOpacity Shadow Style property](#shadowopacity) 325 + +[shadowOriginX Shadow Style property](#shadoworiginx) 328 + +[shadowOriginY Shadow Style property](#shadoworiginy) 328 + +[shadowSecondOffsetX Shadow Style property](#shadowsecondoffsetx) 326 + +[shadowSecondOffsetY Shadow Style property](#shadowsecondoffsety) 327 + +[shadowSoftness Shadow Style property](#shadowsoftness) 334 + +[shadowType Shadow Style property](#shadowtype) 323 + +[Shape Boolean properties](#shape-boolean-properties) 103 + +[Shape Properties example](#shape-properties) 581 + +[overview](#shape-properties) 581 + +[shape primary options](#shape-primary-options) 583 + +[shape text properties](#shape-text-properties) 588 + +[shape type properties](#shape-type-properties) 582 + +Shape property + +[bWMode](#bwmode) 97 + +[bWModeBW](#bwmodebw) 98 + +[bWModePureBW](#bwmodepurebw) 97 + +[cxstyle](#cxstyle) 96 + +[dgmlayout](#dgmlayout) 99 + +[dgmLayoutMRU](#dgmlayoutmru) 101 + +[dgmNodeKind](#dgmnodekind) 99 + +[equationXML](#equationxml) 102 + +[equationXML_complex](#equationxml_complex) 102 + +[Group Shape Boolean properties](#group-shape-boolean-properties) 157 + +[hspMaster](#hspmaster) 96 + +[idDiscussAnchor](#iddiscussanchor) 98 + +[Shape Boolean properties](#shape-boolean-properties) 103 + +[shapePath geometry property](#shapepath) 166 + +[Signature Line Boolean properties](#signature-line-boolean-properties) 464 + +Signature Line property + +[Signature Line Boolean properties](#signature-line-boolean-properties) 464 + +[wzSigSetupAddlXml](#wzsigsetupaddlxml) 462 + +[wzSigSetupAddlXml_complex](#wzsigsetupaddlxml_complex) 462 + +[wzSigSetupId](#wzsigsetupid) 456 + +[wzSigSetupId_complex](#wzsigsetupid_complex) 457 + +[wzSigSetupProvId](#wzsigsetupprovid) 457 + +[wzSigSetupProvId_complex](#wzsigsetupprovid_complex) 458 + +[wzSigSetupProvUrl](#wzsigsetupprovurl) 463 + +[wzSigSetupProvUrl_complex](#wzsigsetupprovurl_complex) 463 + +[wzSigSetupSignInst](#wzsigsetupsigninst) 461 + +[wzSigSetupSignInst_complex](#wzsigsetupsigninst_complex) 461 + +[wzSigSetupSuggSigner](#wzsigsetupsuggsigner) 458 + +[wzSigSetupSuggSigner_complex](#wzsigsetupsuggsigner_complex) 459 + +[wzSigSetupSuggSigner2](#wzsigsetupsuggsigner2) 459 + +[wzSigSetupSuggSigner2_complex](#wzsigsetupsuggsigner2_complex) 460 + +[wzSigSetupSuggSignerEmail](#wzsigsetupsuggsigneremail) 460 + +[wzSigSetupSuggSignerEmail_complex](#wzsigsetupsuggsigneremail_complex) 461 + +[sizerelh group shape 2 property](#sizerelh) 162 + +[sizerelv group shape 2 property](#sizerelv) 163 + +[spcoa callout property](#spcoa) 106 + +[spcod callout property](#spcod) 107 + +T + +[TABLEFLAGS OfficeArtRecord type](#tableflags) 91 + +[tableProperties group shape property](#tableproperties) 153 + +[tableRowProperties group shape property](#tablerowproperties) 154 + +[tableRowProperties_complex group shape property](#tablerowproperties_complex) 154 + +[Text Boolean properties](#text-boolean-properties) 408 + +Text property + +[anchorText](#anchortext) 404 + +[cdirFont](#cdirfont) 405 + +[dxTextBottom](#dytextbottom) 402 + +[dxTextLeft](#dxtextleft) 401 + +[dxTextRight](#dxtextright) 402 + +[dyTextTop](#dytexttop) 401 + +[hspNext](#hspnext) 405 + +[lTxid](#ltxid) 400 + +[Text Boolean properties](#text-boolean-properties) 408 + +[txdir](#txdir) 406 + +[txflTextFlow](#txfltextflow) 404 + +[unused134](#unused134) 403 + +[unused140](#unused140) 407 + +[unused141](#unused141) 407 + +[WrapText](#wraptext) 403 + +[Top Line Style Boolean properties](#top-line-style-boolean-properties) 275 + +Top Line Style property + +[lineTopBackColor](#linetopbackcolor) 256 + +[lineTopBackColorExt](#linetopbackcolorext) 272 + +[lineTopBackColorExtMod](#linetopbackcolorextmod) 273 + +[lineTopColor](#linetopcolor) 255 + +[lineTopColorExt](#linetopcolorext) 270 + +[lineTopColorExtMod](#linetopcolorextmod) 271 + +[lineTopCrMod](#linetopcrmod) 257 + +[lineTopDashing](#linetopdashing) 264 + +[lineTopDashStyle](#linetopdashstyle) 265 + +[lineTopDashStyle_complex](#linetopdashstyle_complex) 265 + +[lineTopEndArrowhead](#linetopendarrowhead) 266 + +[lineTopEndArrowLength](#linetopendarrowlength) 268 + +[lineTopEndArrowWidth](#linetopendarrowwidth) 268 + +[lineTopEndCapStyle](#linetopendcapstyle) 269 + +[lineTopFillBlip](#linetopfillblip) 258 + +[lineTopFillBlip_complex](#linetopfillblip_complex) 259 + +[lineTopFillBlipFlags](#linetopfillblipflags) 260 + +[lineTopFillBlipName](#linetopfillblipname) 259 + +[lineTopFillBlipName_complex](#linetopfillblipname_complex) 260 + +[lineTopFillDzType](#linetopfilldztype) 262 + +[lineTopFillHeight](#linetopfillheight) 261 + +[lineTopFillWidth](#linetopfillwidth) 261 + +[lineTopJoinStyle](#linetopjoinstyle) 269 + +[lineTopMiterLimit](#linetopmiterlimit) 263 + +[lineTopOpacity](#linetopopacity) 256 + +[lineTopStartArrowhead](#linetopstartarrowhead) 266 + +[lineTopStartArrowLength](#linetopstartarrowlength) 267 + +[lineTopStartArrowWidth](#linetopstartarrowwidth) 267 + +[lineTopStyle](#linetopstyle) 263 + +[lineTopType](#linetoptype) 257 + +[lineTopWidth](#linetopwidth) 262 + +[reserved1434](#reserved1434) 270 + +[reserved1436](#reserved1436) 272 + +[reserved1438](#reserved1438) 273 + +[reserved1440](#reserved1440) 274 + +[reserved1441](#reserved1441) 274 + +[reserved1442](#reserved1442) 275 + +[Top Line Style Boolean properties](#top-line-style-boolean-properties) 275 + +[top Transform property](#top) 390 + +[Tracking changes](#change-tracking) 599 + +[Transform Boolean properties](#transform-boolean-properties) 393 + +Transform property + +[bottom](#bottom) 391 + +[gvPage](#gvpage) 392 + +[left](#left) 390 + +[right](#right) 391 + +[rotation](#rotation) 392 + +[top](#top) 390 + +[Transform Boolean properties](#transform-boolean-properties) 393 + +[txdir Text property](#txdir) 406 + +[txflTextFlow Text property](#txfltextflow) 404 + +U + +[Unknown HTML Boolean properties](#unknown-html-boolean-properties) 450 + +Unknown HTML property + +[Unknown HTML Boolean properties](#unknown-html-boolean-properties) 450 + +[wzCalloutId](#wzcalloutid) 446 + +[wzCalloutId_complex](#wzcalloutid_complex) 447 + +[wzFillId](#wzfillid) 439 + +[wzFillId_complex](#wzfillid_complex) 440 + +[wzFormulaeId](#wzformulaeid) 444 + +[wzFormulaeId_complex](#wzformulaeid_complex) 445 + +[wzGTextId](#wzgtextid) 443 + +[wzGtextId_complex](#wzgtextid_complex) 444 + +[wzHandlesId](#wzhandlesid) 445 + +[wzHandlesId_complex](#wzhandlesid_complex) 446 + +[wzLineId](#wzlineid) 438 + +[wzLineId_complex](#wzlineid_complex) 439 + +[wzLockId](#wzlockid) 447 + +[wzLockId_complex](#wzlockid_complex) 447 + +[wzPathId](#wzpathid) 441 + +[wzPathId_complex](#wzpathid_complex) 441 + +[wzPerspectiveId](#wzperspectiveid) 442 + +[wzPerspectiveId_complex](#wzperspectiveid_complex) 443 + +[wzPictureId](#wzpictureid) 440 + +[wzPictureId_complex](#wzpictureid_complex) 440 + +[wzShadowId](#wzshadowid) 442 + +[wzShadowId_complex](#wzshadowid_complex) 442 + +[wzTextId](#wztextid) 448 + +[wzTextId_complex](#wztextid_complex) 448 + +[wzThreeDId](#wzthreedid) 449 + +[wzThreeDId_complex](#wzthreedid_complex) 449 + +[unused134 Text property](#unused134) 403 + +[unused140 Text property](#unused140) 407 + +[unused141 Text property](#unused141) 407 + +[unused832 callout property](#unused832) 105 + +[unused906 group shape property](#unused906) 117 + +V + +[Vendor-extensible fields](#vendor-extensible-fields) 26 + +[Versioning](#versioning-and-localization) 25 + +W + +[Web Component Boolean properties](#web-component-boolean-properties) 453 + +Web Component property + +[Web Component Boolean properties](#web-component-boolean-properties) 453 + +[wzHtml](#webcomponentwzhtml) 451 + +[wzHtml_complex](#webcomponentwzhtml_complex) 451 + +[wzName](#webcomponentwzname) 451 + +[wzName_complex](#webcomponentwzname_complex) 452 + +[wzUrl](#webcomponentwzurl) 452 + +[wzUrl_complex](#webcomponentwzurl_complex) 453 + +[WrapText Text property](#wraptext) 403 + +[wzCalloutId Unknown HTML property](#wzcalloutid) 446 + +[wzCalloutId_complex Unknown HTML property](#wzcalloutid_complex) 447 + +[wzDescription group shape property](#wzdescription) 112 + +[wzDescription_complex group shape property](#wzdescription_complex) 112 + +[wzFillId Unknown HTML property](#wzfillid) 439 + +[wzFillId_complex Unknown HTML property](#wzfillid_complex) 440 + +[wzFormulaeId Unknown HTML property](#wzformulaeid) 444 + +[wzFormulaeId_complex Unknown HTML property](#wzformulaeid_complex) 445 + +[wzGtextId Unknown HTML property](#wzgtextid) 443 + +[wzGtextId_complex Unknown HTML property](#wzgtextid_complex) 444 + +[wzHandlesId Unknown HTML property](#wzhandlesid) 445 + +[wzHandlesId_complex Unknown HTML property](#wzhandlesid_complex) 446 + +[wzHtml Web Component property](#webcomponentwzhtml) 451 + +[wzHtml_complex Web Component property](#webcomponentwzhtml_complex) 451 + +[wzLineId Unknown HTML property](#wzlineid) 438 + +[wzLineId_complex Unknown HTML property](#wzlineid_complex) 439 + +[wzLockId Unknown HTML property](#wzlockid) 447 + +[wzLockId_complex Unknown HTML property](#wzlockid_complex) 447 + +[wzName group shape property](#wzname) 111 + +[wzName Web Component property](#webcomponentwzname) 451 + +[wzName_complex group shape property](#wzname_complex) 112 + +[wzName_complex Web Component property](#webcomponentwzname_complex) 452 + +[wzPathId Unknown HTML property](#wzpathid) 441 + +[wzPathId_complex Unknown HTML property](#wzpathid_complex) 441 + +[wzPerspectiveId Unknown HTML property](#wzperspectiveid) 442 + +[wzPerspectiveId_complex Unknown HTML property](#wzperspectiveid_complex) 443 + +[wzPictureId Unknown HTML property](#wzpictureid) 440 + +[wzPictureId_complex Unknown HTML property](#wzpictureid_complex) 440 + +[wzScript group shape property](#wzscript) 119 + +[wzScript_complex group shape property](#wzscript_complex) 119 + +[wzScriptExtAttr group shape property](#wzscriptextattr) 149 + +[wzScriptExtAttr_complex group shape property](#wzscriptextattr_complex) 149 + +[wzScriptLangAttr group shape property](#wzscriptlangattr) 150 + +[wzScriptLangAttr_complex group shape property](#wzscriptlangattr_complex) 151 + +[wzShadowId Unknown HTML property](#wzshadowid) 442 + +[wzShadowId_complex Unknown HTML property](#wzshadowid_complex) 442 + +[wzSigSetupAddlXml Signature Line property](#wzsigsetupaddlxml) 462 + +[wzSigSetupAddlXml_complex Signature Line property](#wzsigsetupaddlxml_complex) 462 + +[wzSigSetupId Signature Line property](#wzsigsetupid) 456 + +[wzSigSetupId_complex Signature Line property](#wzsigsetupid_complex) 457 + +[wzSigSetupProvId Signature Line property](#wzsigsetupprovid) 457 + +[wzSigSetupProvId_complex Signature Line property](#wzsigsetupprovid_complex) 458 + +[wzSigSetupProvUrl Signature Line property](#wzsigsetupprovurl) 463 + +[wzSigSetupProvUrl_complex Signature Line property](#wzsigsetupprovurl_complex) 463 + +[wzSigSetupSignInst Signature Line property](#wzsigsetupsigninst) 461 + +[wzSigSetupSignInst_complex Signature Line property](#wzsigsetupsigninst_complex) 461 + +[wzSigSetupSuggSigner Signature Line property](#wzsigsetupsuggsigner) 458 + +[wzSigSetupSuggSigner_complex Signature Line property](#wzsigsetupsuggsigner_complex) 459 + +[wzSigSetupSuggSigner2 Signature Line property](#wzsigsetupsuggsigner2) 459 + +[wzSigSetupSuggSigner2_complex Signature Line property](#wzsigsetupsuggsigner2_complex) 460 + +[wzSigSetupSuggSignerEmail Signature Line property](#wzsigsetupsuggsigneremail) 460 + +[wzSigSetupSuggSignerEmail_complex Signature Line property](#wzsigsetupsuggsigneremail_complex) 461 + +[wzTextId Unknown HTML property](#wztextid) 448 + +[wzTextId_complex Unknown HTML property](#wztextid_complex) 448 + +[wzThreeDId Unknown HTML property](#wzthreedid) 449 + +[wzThreeDId_complex Unknown HTML property](#wzthreedid_complex) 449 + +[wzTooltip group shape property](#wztooltip) 118 + +[wzTooltip_complex group shape property](#wztooltip_complex) 118 + +[wzUrl Web Component property](#webcomponentwzurl) 452 + +[wzUrl_complex Web Component property](#webcomponentwzurl_complex) 453 + +[wzWebBot group shape property](#wzwebbot) 155 + +[wzWebBot_complex group shape property](#wzwebbot_complex) 155 + +X + +[xLimo geometry property](#xlimo) 176 + +Y + +[yLimo geometry property](#ylimo) 177 diff --git a/docs/standards/doc/ms-offcrypto.md b/docs/standards/doc/ms-offcrypto.md new file mode 100644 index 0000000..43b384b --- /dev/null +++ b/docs/standards/doc/ms-offcrypto.md @@ -0,0 +1,5733 @@ +**\[MS-OFFCRYPTO\]:** + +**Office Document Cryptography Structure** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 4/4/2008 | 0.1 | New | Initial Availability | +| 6/27/2008 | 1.0 | Major | Revised and edited the technical content | +| 10/6/2008 | 1.01 | Editorial | Revised and edited the technical content | +| 12/12/2008 | 1.02 | Editorial | Revised and edited the technical content | +| 3/18/2009 | 1.03 | Editorial | Revised and edited the technical content | +| 7/13/2009 | 1.04 | Major | Revised and edited the technical content | +| 8/28/2009 | 1.05 | Major | Updated and revised the technical content | +| 11/6/2009 | 1.06 | Editorial | Revised and edited the technical content | +| 2/19/2010 | 2.0 | Editorial | Revised and edited the technical content | +| 3/31/2010 | 2.01 | Editorial | Revised and edited the technical content | +| 4/30/2010 | 2.02 | Editorial | Revised and edited the technical content | +| 6/7/2010 | 2.03 | Editorial | Revised and edited the technical content | +| 6/29/2010 | 2.04 | Editorial | Changed language and formatting in the technical content. | +| 7/23/2010 | 2.05 | Minor | Clarified the meaning of the technical content. | +| 9/27/2010 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/15/2010 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/17/2010 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/18/2011 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/10/2011 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/20/2012 | 2.6 | Minor | Clarified the meaning of the technical content. | +| 4/11/2012 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/16/2012 | 2.7 | Minor | Clarified the meaning of the technical content. | +| 10/8/2012 | 2.8 | Minor | Clarified the meaning of the technical content. | +| 2/11/2013 | 2.8 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/30/2013 | 2.8 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/18/2013 | 2.8 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/10/2014 | 2.8 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/30/2014 | 3.0 | Major | Significantly changed the technical content. | +| 7/31/2014 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/30/2014 | 3.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/16/2015 | 4.0 | Major | Significantly changed the technical content. | +| 9/4/2015 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/15/2016 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/14/2016 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/20/2017 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/12/2017 | 4.1 | Minor | Clarified the meaning of the technical content. | +| 4/27/2018 | 5.0 | Major | Significantly changed the technical content. | +| 8/28/2018 | 6.0 | Major | Significantly changed the technical content. | +| 12/11/2018 | 6.1 | Minor | Clarified the meaning of the technical content. | +| 11/17/2020 | 7.0 | Major | Significantly changed the technical content. | +| 2/16/2021 | 7.1 | Minor | Clarified the meaning of the technical content. | +| 4/22/2021 | 8.0 | Major | Significantly changed the technical content. | +| 7/20/2021 | 9.0 | Major | Significantly changed the technical content. | +| 8/17/2021 | 10.0 | Major | Significantly changed the technical content. | +| 10/5/2021 | 10.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/16/2023 | 10.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 8/15/2023 | 11.0 | Major | Significantly changed the technical content. | +| 4/16/2024 | 12.0 | Major | Significantly changed the technical content. | +| 8/20/2024 | 13.0 | Major | Significantly changed the technical content. | +| 2/17/2026 | 14.0 | Major | Significantly changed the technical content. | + +Table of Contents + +[1 Introduction [8](#introduction)](#introduction) + +[1.1 Glossary [8](#glossary)](#glossary) + +[1.2 References [12](#references)](#references) + +[1.2.1 Normative References [12](#normative-references)](#normative-references) + +[1.2.2 Informative References [14](#informative-references)](#informative-references) + +[1.3 Overview [14](#overview)](#overview) + +[1.3.1 Data Spaces [14](#data-spaces)](#data-spaces) + +[1.3.2 Information Rights Management Data Space [15](#information-rights-management-data-space)](#information-rights-management-data-space) + +[1.3.3 Encryption [17](#encryption)](#encryption) + +[1.3.3.1 XOR Obfuscation [17](#xor-obfuscation)](#xor-obfuscation) + +[1.3.3.2 40-bit RC4 Encryption [17](#bit-rc4-encryption)](#bit-rc4-encryption) + +[1.3.3.3 CryptoAPI RC4 Encryption [17](#cryptoapi-rc4-encryption)](#cryptoapi-rc4-encryption) + +[1.3.3.4 ECMA-376 Document Encryption [17](#ecma-376-document-encryption)](#ecma-376-document-encryption) + +[1.3.4 Write Protection [18](#write-protection)](#write-protection) + +[1.3.5 Digital Signatures [18](#digital-signatures)](#digital-signatures) + +[1.3.6 Byte Ordering [18](#byte-ordering)](#byte-ordering) + +[1.3.7 String Encoding [18](#string-encoding)](#string-encoding) + +[1.3.8 OLE Compound File Path Encoding [18](#ole-compound-file-path-encoding)](#ole-compound-file-path-encoding) + +[1.3.9 Pseudocode Standard Objects [18](#pseudocode-standard-objects)](#pseudocode-standard-objects) + +[1.3.9.1 Array [19](#array)](#array) + +[1.3.9.2 String [19](#string)](#string) + +[1.3.9.3 Storage [19](#storage)](#storage) + +[1.3.9.4 Stream [19](#stream)](#stream) + +[1.4 Relationship to Protocols and Other Structures [19](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [19](#applicability-statement)](#applicability-statement) + +[1.5.1 Data Spaces [19](#data-spaces-1)](#data-spaces-1) + +[1.5.2 Information Rights Management Data Space [20](#information-rights-management-data-space-1)](#information-rights-management-data-space-1) + +[1.5.3 Encryption [20](#encryption-1)](#encryption-1) + +[1.6 Versioning and Localization [20](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [20](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [21](#structures)](#structures) + +[2.1 Data Spaces [21](#data-spaces-2)](#data-spaces-2) + +[2.1.1 File [21](#file)](#file) + +[2.1.2 Length-Prefixed Padded Unicode String (UNICODE-LP-P4) [22](#length-prefixed-padded-unicode-string-unicode-lp-p4)](#length-prefixed-padded-unicode-string-unicode-lp-p4) + +[2.1.3 Length-Prefixed UTF-8 String (UTF-8-LP-P4) [23](#length-prefixed-utf-8-string-utf-8-lp-p4)](#length-prefixed-utf-8-string-utf-8-lp-p4) + +[2.1.4 Version [23](#version)](#version) + +[2.1.5 DataSpaceVersionInfo [23](#dataspaceversioninfo)](#dataspaceversioninfo) + +[2.1.6 DataSpaceMap [24](#dataspacemap)](#dataspacemap) + +[2.1.6.1 DataSpaceMapEntry Structure [25](#dataspacemapentry-structure)](#dataspacemapentry-structure) + +[2.1.6.2 DataSpaceReferenceComponent Structure [25](#dataspacereferencecomponent-structure)](#dataspacereferencecomponent-structure) + +[2.1.7 DataSpaceDefinition [26](#dataspacedefinition)](#dataspacedefinition) + +[2.1.8 TransformInfoHeader [27](#transforminfoheader)](#transforminfoheader) + +[2.1.9 EncryptionTransformInfo [27](#encryptiontransforminfo)](#encryptiontransforminfo) + +[2.2 Information Rights Management Data Space [28](#information-rights-management-data-space-2)](#information-rights-management-data-space-2) + +[2.2.1 \0x06DataSpaces\DataSpaceMap Stream [28](#x06dataspacesdataspacemap-stream)](#x06dataspacesdataspacemap-stream) + +[2.2.2 \0x06DataSpaces\DataSpaceInfo Storage [29](#x06dataspacesdataspaceinfo-storage)](#x06dataspacesdataspaceinfo-storage) + +[2.2.3 \0x06DataSpaces\TransformInfo Storage for Office Binary Documents [29](#x06dataspacestransforminfo-storage-for-office-binary-documents)](#x06dataspacestransforminfo-storage-for-office-binary-documents) + +[2.2.4 \0x06DataSpaces\TransformInfo Storage for ECMA-376 Documents [30](#x06dataspacestransforminfo-storage-for-ecma-376-documents)](#x06dataspacestransforminfo-storage-for-ecma-376-documents) + +[2.2.5 ExtensibilityHeader [31](#extensibilityheader)](#extensibilityheader) + +[2.2.6 IRMDSTransformInfo [31](#irmdstransforminfo)](#irmdstransforminfo) + +[2.2.7 End-User License Stream [31](#end-user-license-stream)](#end-user-license-stream) + +[2.2.8 LicenseID [32](#licenseid)](#licenseid) + +[2.2.9 EndUserLicenseHeader [32](#enduserlicenseheader)](#enduserlicenseheader) + +[2.2.10 Protected Content Stream [32](#protected-content-stream)](#protected-content-stream) + +[2.2.11 Viewer Content Stream [33](#viewer-content-stream)](#viewer-content-stream) + +[2.3 Encryption [33](#encryption-2)](#encryption-2) + +[2.3.1 EncryptionHeaderFlags [34](#encryptionheaderflags)](#encryptionheaderflags) + +[2.3.2 EncryptionHeader [34](#encryptionheader)](#encryptionheader) + +[2.3.3 EncryptionVerifier [36](#encryptionverifier)](#encryptionverifier) + +[2.3.4 ECMA-376 Document Encryption [38](#ecma-376-document-encryption-1)](#ecma-376-document-encryption-1) + +[2.3.4.1 \0x06DataSpaces\DataSpaceMap Stream [38](#x06dataspacesdataspacemap-stream-1)](#x06dataspacesdataspacemap-stream-1) + +[2.3.4.2 \0x06DataSpaces\DataSpaceInfo Storage [38](#x06dataspacesdataspaceinfo-storage-1)](#x06dataspacesdataspaceinfo-storage-1) + +[2.3.4.3 \0x06DataSpaces\TransformInfo Storage [38](#x06dataspacestransforminfo-storage)](#x06dataspacestransforminfo-storage) + +[2.3.4.4 \EncryptedPackage Stream [39](#encryptedpackage-stream)](#encryptedpackage-stream) + +[2.3.4.5 \EncryptionInfo Stream (Standard Encryption) [39](#encryptioninfo-stream-standard-encryption)](#encryptioninfo-stream-standard-encryption) + +[2.3.4.6 \EncryptionInfo Stream (Extensible Encryption) [40](#encryptioninfo-stream-extensible-encryption)](#encryptioninfo-stream-extensible-encryption) + +[2.3.4.7 ECMA-376 Document Encryption Key Generation (Standard Encryption) [42](#ecma-376-document-encryption-key-generation-standard-encryption)](#ecma-376-document-encryption-key-generation-standard-encryption) + +[2.3.4.8 Password Verifier Generation (Standard Encryption) [43](#password-verifier-generation-standard-encryption)](#password-verifier-generation-standard-encryption) + +[2.3.4.9 Password Verification (Standard Encryption) [43](#password-verification-standard-encryption)](#password-verification-standard-encryption) + +[2.3.4.10 \EncryptionInfo Stream (Agile Encryption) [44](#encryptioninfo-stream-agile-encryption)](#encryptioninfo-stream-agile-encryption) + +[2.3.4.11 Encryption Key Generation (Agile Encryption) [49](#encryption-key-generation-agile-encryption)](#encryption-key-generation-agile-encryption) + +[2.3.4.12 Initialization Vector Generation (Agile Encryption) [50](#initialization-vector-generation-agile-encryption)](#initialization-vector-generation-agile-encryption) + +[2.3.4.13 PasswordKeyEncryptor Generation (Agile Encryption) [50](#passwordkeyencryptor-generation-agile-encryption)](#passwordkeyencryptor-generation-agile-encryption) + +[2.3.4.14 DataIntegrity Generation (Agile Encryption) [52](#dataintegrity-generation-agile-encryption)](#dataintegrity-generation-agile-encryption) + +[2.3.4.15 Data Encryption (Agile Encryption) [52](#data-encryption-agile-encryption)](#data-encryption-agile-encryption) + +[2.3.5 Office Binary Document RC4 CryptoAPI Encryption [53](#office-binary-document-rc4-cryptoapi-encryption)](#office-binary-document-rc4-cryptoapi-encryption) + +[2.3.5.1 RC4 CryptoAPI Encryption Header [53](#rc4-cryptoapi-encryption-header)](#rc4-cryptoapi-encryption-header) + +[2.3.5.2 RC4 CryptoAPI Encryption Key Generation [54](#rc4-cryptoapi-encryption-key-generation)](#rc4-cryptoapi-encryption-key-generation) + +[2.3.5.3 RC4 CryptoAPI EncryptedStreamDescriptor Structure [55](#rc4-cryptoapi-encryptedstreamdescriptor-structure)](#rc4-cryptoapi-encryptedstreamdescriptor-structure) + +[2.3.5.4 RC4 CryptoAPI Encrypted Summary Stream [55](#rc4-cryptoapi-encrypted-summary-stream)](#rc4-cryptoapi-encrypted-summary-stream) + +[2.3.5.5 Password Verifier Generation [57](#password-verifier-generation)](#password-verifier-generation) + +[2.3.5.6 Password Verification [57](#password-verification)](#password-verification) + +[2.3.6 Office Binary Document RC4 Encryption [58](#office-binary-document-rc4-encryption)](#office-binary-document-rc4-encryption) + +[2.3.6.1 RC4 Encryption Header [58](#rc4-encryption-header)](#rc4-encryption-header) + +[2.3.6.2 Encryption Key Derivation [59](#encryption-key-derivation)](#encryption-key-derivation) + +[2.3.6.3 Password Verifier Generation [59](#password-verifier-generation-1)](#password-verifier-generation-1) + +[2.3.6.4 Password Verification [59](#password-verification-1)](#password-verification-1) + +[2.3.7 XOR Obfuscation [60](#xor-obfuscation-1)](#xor-obfuscation-1) + +[2.3.7.1 Binary Document Password Verifier Derivation Method 1 [60](#binary-document-password-verifier-derivation-method-1)](#binary-document-password-verifier-derivation-method-1) + +[2.3.7.2 Binary Document XOR Array Initialization Method 1 [60](#binary-document-xor-array-initialization-method-1)](#binary-document-xor-array-initialization-method-1) + +[2.3.7.3 Binary Document XOR Data Transformation Method 1 [62](#binary-document-xor-data-transformation-method-1)](#binary-document-xor-data-transformation-method-1) + +[2.3.7.4 Binary Document Password Verifier Derivation Method 2 [63](#binary-document-password-verifier-derivation-method-2)](#binary-document-password-verifier-derivation-method-2) + +[2.3.7.5 Binary Document XOR Array Initialization Method 2 [64](#binary-document-xor-array-initialization-method-2)](#binary-document-xor-array-initialization-method-2) + +[2.3.7.6 Binary Document XOR Data Transformation Method 2 [65](#binary-document-xor-data-transformation-method-2)](#binary-document-xor-data-transformation-method-2) + +[2.3.7.7 Password Verification [65](#password-verification-2)](#password-verification-2) + +[2.4 Document Write Protection [65](#document-write-protection)](#document-write-protection) + +[2.4.1 ECMA-376 Document Write Protection [65](#ecma-376-document-write-protection)](#ecma-376-document-write-protection) + +[2.4.2 Binary Document Write Protection [65](#binary-document-write-protection)](#binary-document-write-protection) + +[2.4.2.1 Binary Document Write Protection Method 1 [65](#binary-document-write-protection-method-1)](#binary-document-write-protection-method-1) + +[2.4.2.2 Binary Document Write Protection Method 2 [65](#binary-document-write-protection-method-2)](#binary-document-write-protection-method-2) + +[2.4.2.3 Binary Document Write Protection Method 3 [66](#binary-document-write-protection-method-3)](#binary-document-write-protection-method-3) + +[2.4.2.4 ISO Write Protection Method [66](#iso-write-protection-method)](#iso-write-protection-method) + +[2.5 Binary Document Digital Signatures [67](#binary-document-digital-signatures)](#binary-document-digital-signatures) + +[2.5.1 CryptoAPI Digital Signature Structures and Streams [67](#cryptoapi-digital-signature-structures-and-streams)](#cryptoapi-digital-signature-structures-and-streams) + +[2.5.1.1 TimeEncoding Structure [67](#timeencoding-structure)](#timeencoding-structure) + +[2.5.1.2 CryptoAPI Digital Signature CertificateInfo Structure [68](#cryptoapi-digital-signature-certificateinfo-structure)](#cryptoapi-digital-signature-certificateinfo-structure) + +[2.5.1.3 CryptoAPI Digital Signature Structure [70](#cryptoapi-digital-signature-structure)](#cryptoapi-digital-signature-structure) + +[2.5.1.4 \\signatures Stream [70](#signatures-stream)](#signatures-stream) + +[2.5.1.5 CryptoAPI Digital Signature Generation [70](#cryptoapi-digital-signature-generation)](#cryptoapi-digital-signature-generation) + +[2.5.2 Xmldsig Digital Signature Elements [72](#xmldsig-digital-signature-elements)](#xmldsig-digital-signature-elements) + +[2.5.2.1 SignedInfo Element [72](#signedinfo-element)](#signedinfo-element) + +[2.5.2.2 SignatureValue Element [72](#signaturevalue-element)](#signaturevalue-element) + +[2.5.2.3 KeyInfo Element [73](#keyinfo-element)](#keyinfo-element) + +[2.5.2.4 idPackageObject Object Element [73](#idpackageobject-object-element)](#idpackageobject-object-element) + +[2.5.2.5 idOfficeObject Object Element [73](#idofficeobject-object-element)](#idofficeobject-object-element) + +[2.5.2.6 XAdES Elements [76](#xades-elements)](#xades-elements) + +[2.5.3 \_xmlsignatures Storage [77](#xmlsignatures-storage)](#xmlsignatures-storage) + +[2.6 Sensitivity Labels [77](#sensitivity-labels)](#sensitivity-labels) + +[2.6.1 Sensitivity Label Metadata [77](#sensitivity-label-metadata)](#sensitivity-label-metadata) + +[2.6.2 LabelInfo Stream Locations [78](#labelinfo-stream-locations)](#labelinfo-stream-locations) + +[2.6.3 LabelInfo versus Custom Document Properties [78](#labelinfo-versus-custom-document-properties)](#labelinfo-versus-custom-document-properties) + +[2.6.4 LabelInfo Stream Schema [79](#labelinfo-stream-schema)](#labelinfo-stream-schema) + +[2.6.4.1 Namespaces [80](#namespaces)](#namespaces) + +[2.6.4.2 xml Preprocessor Directive [80](#xml-preprocessor-directive)](#xml-preprocessor-directive) + +[2.6.4.3 labelList Element [80](#labellist-element)](#labellist-element) + +[2.6.4.4 label Element [80](#label-element)](#label-element) + +[2.6.4.5 extLst Element [81](#extlst-element)](#extlst-element) + +[2.6.4.6 ext Element [81](#ext-element)](#ext-element) + +[2.6.5 LabelInfo Stream Structures [81](#labelinfo-stream-structures)](#labelinfo-stream-structures) + +[2.6.5.1 ST_ClassificationGuid [81](#st_classificationguid)](#st_classificationguid) + +[2.6.5.2 CT_ClassificationExtension [81](#ct_classificationextension)](#ct_classificationextension) + +[2.6.5.3 CT_ClassificationExtenstionList [82](#ct_classificationextenstionlist)](#ct_classificationextenstionlist) + +[2.6.5.4 CT_ClassificationLabel [82](#ct_classificationlabel)](#ct_classificationlabel) + +[2.6.5.5 CT_ClassificationLabelList [83](#ct_classificationlabellist)](#ct_classificationlabellist) + +[2.6.6 LabelInfo Stream Extensions [83](#labelinfo-stream-extensions)](#labelinfo-stream-extensions) + +[2.7 MsoDataStore [83](#msodatastore)](#msodatastore) + +[2.7.1 IsRedundantDataStorePromotion Storage [84](#isredundantdatastorepromotion-storage)](#isredundantdatastorepromotion-storage) + +[2.7.2 IsModifiedDataStorePromotion Storage [84](#ismodifieddatastorepromotion-storage)](#ismodifieddatastorepromotion-storage) + +[2.8 EncryptedSIHash Stream [85](#encryptedsihash-stream)](#encryptedsihash-stream) + +[2.9 EncryptedDSIHash Stream [85](#encrypteddsihash-stream)](#encrypteddsihash-stream) + +[2.10 EncryptedPropertyStreamInfo Structure [85](#encryptedpropertystreaminfo-structure)](#encryptedpropertystreaminfo-structure) + +[3 Structure Examples [87](#structure-examples)](#structure-examples) + +[3.1 Version Stream [87](#version-stream)](#version-stream) + +[3.2 DataSpaceMap Stream [88](#dataspacemap-stream)](#dataspacemap-stream) + +[3.2.1 DataSpaceMapEntry Structure [89](#dataspacemapentry-structure-1)](#dataspacemapentry-structure-1) + +[3.3 DRMEncryptedDataSpace Stream [90](#drmencrypteddataspace-stream)](#drmencrypteddataspace-stream) + +[3.4 0x06Primary Stream [90](#x06primary-stream)](#x06primary-stream) + +[3.5 EUL-ETRHA1143ZLUDD412YTI3M5CTZ Stream [92](#eul-etrha1143zludd412yti3m5ctz-stream)](#eul-etrha1143zludd412yti3m5ctz-stream) + +[3.5.1 EndUserLicenseHeader Structure [93](#enduserlicenseheader-structure)](#enduserlicenseheader-structure) + +[3.5.2 Certificate Chain [93](#certificate-chain)](#certificate-chain) + +[3.6 EncryptionHeader Structure [94](#encryptionheader-structure)](#encryptionheader-structure) + +[3.7 EncryptionVerifier Structure [96](#encryptionverifier-structure)](#encryptionverifier-structure) + +[3.8 \EncryptionInfo Stream [96](#encryptioninfo-stream)](#encryptioninfo-stream) + +[3.9 \EncryptionInfo Stream (Third-Party Extensible Encryption) [98](#encryptioninfo-stream-third-party-extensible-encryption)](#encryptioninfo-stream-third-party-extensible-encryption) + +[3.10 Office Binary Document RC4 Encryption [99](#office-binary-document-rc4-encryption-1)](#office-binary-document-rc4-encryption-1) + +[3.10.1 Encryption Header [99](#encryption-header)](#encryption-header) + +[3.11 PasswordKeyEncryptor (Agile Encryption) [100](#passwordkeyencryptor-agile-encryption)](#passwordkeyencryptor-agile-encryption) + +[3.12 LabelInfo Stream [103](#labelinfo-stream)](#labelinfo-stream) + +[4 Security [104](#security)](#security) + +[4.1 Security Considerations for Implementers [104](#security-considerations-for-implementers)](#security-considerations-for-implementers) + +[4.1.1 Data Spaces [104](#data-spaces-3)](#data-spaces-3) + +[4.1.2 Information Rights Management [104](#information-rights-management)](#information-rights-management) + +[4.1.3 Encryption [104](#encryption-3)](#encryption-3) + +[4.1.3.1 ECMA-376 Document Encryption [104](#ecma-376-document-encryption-2)](#ecma-376-document-encryption-2) + +[4.1.3.2 Office Binary Document RC4 CryptoAPI Encryption [104](#office-binary-document-rc4-cryptoapi-encryption-1)](#office-binary-document-rc4-cryptoapi-encryption-1) + +[4.1.3.3 Office Binary Document RC4 Encryption [105](#office-binary-document-rc4-encryption-2)](#office-binary-document-rc4-encryption-2) + +[4.1.3.4 XOR Obfuscation [105](#xor-obfuscation-2)](#xor-obfuscation-2) + +[4.1.3.5 Information Rights Management Cypher Block Chaining [105](#information-rights-management-cypher-block-chaining)](#information-rights-management-cypher-block-chaining) + +[4.1.4 Document Write Protection [106](#document-write-protection-1)](#document-write-protection-1) + +[4.1.5 Binary Document Digital Signatures [106](#binary-document-digital-signatures-1)](#binary-document-digital-signatures-1) + +[4.2 Index of Security Fields [106](#index-of-security-fields)](#index-of-security-fields) + +[5 Appendix A: Product Behavior [107](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [114](#change-tracking)](#change-tracking) + +[7 Index [115](#index)](#index) + +# Introduction + +The Office Document Cryptography Structure is relevant to documents that have Information Rights Management (IRM) policies, document encryption, or signing and write protection applied. More specifically, this file format describes the following: + +- A structure that acts as a generic mechanism for storing data that has been transformed along with information about that data. + +- A structure for storing rights management policies that have been applied to a particular document. + +- Encryption, signing, and write protection structures. + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **Advanced Encryption Standard (AES)**: A block cipher that supersedes the [**Data Encryption Standard (DES)**](#gt_f5de5dd3-8f77-46a7-8756-05fbc0dcd9a9). AES can be used to protect electronic data. The AES algorithm can be used to encrypt (encipher) and decrypt (decipher) information. [**Encryption**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) converts data to an unintelligible form called ciphertext; decrypting the ciphertext converts the data back into its original form, called plaintext. AES is used in symmetric-key cryptography, meaning that the same key is used for the encryption and decryption operations. It is also a block cipher, meaning that it operates on fixed-size blocks of plaintext and ciphertext, and requires the size of the plaintext as well as the ciphertext to be an exact multiple of this block size. AES is also known as the Rijndael symmetric encryption algorithm [\[FIPS197\]](https://go.microsoft.com/fwlink/?LinkId=89870). +> +> **ASCII**: The American Standard Code for Information Interchange (ASCII) is an 8-bit character-encoding scheme based on the English alphabet. ASCII codes represent text in computers, communications equipment, and other devices that work with text. ASCII refers to a single 8-bit ASCII character or an array of 8-bit ASCII characters with the high bit of each character set to zero. +> +> **Azure Active Directory (Azure AD)**: The identity service in Microsoft Azure that provides identity management and access control capabilities through a REST-based API, an Azure portal, or a PowerShell command window. +> +> **base64 encoding**: A binary-to-text encoding scheme whereby an arbitrary sequence of bytes is converted to a sequence of printable [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters, as described in [\[RFC4648\]](https://go.microsoft.com/fwlink/?LinkId=90487). +> +> **block cipher**: A cryptographic algorithm that transforms a group of plaintext bits, referred to as a block, into a fixed-size block of cipher text. When the process is reversed, a fixed-size block of cipher text is transformed into a block of plaintext bits. See also stream cipher. +> +> **certificate**: A certificate is a collection of attributes and extensions that can be stored persistently. The set of attributes in a certificate can vary depending on the intended usage of the certificate. A certificate securely binds a public key to the entity that holds the corresponding private key. A certificate is commonly used for authentication and secure exchange of information on open networks, such as the Internet, extranets, and intranets. Certificates are digitally signed by the issuing certification authority (CA) and can be issued for a user, a computer, or a service. The most widely accepted format for certificates is defined by the ITU-T X.509 version 3 international standards. For more information about attributes and extensions, see [\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414) and [\[X509\]](https://go.microsoft.com/fwlink/?LinkId=90590) sections 7 and 8. +> +> **certificate chain**: A sequence of [**certificates**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879), where each certificate in the sequence is signed by the subsequent certificate. The last certificate in the chain is normally a self-signed certificate. +> +> **child**: An object that is immediately below the current object in a hierarchy. +> +> **cipher block chaining (CBC)**: A method of encrypting multiple blocks of plaintext with a block cipher such that each ciphertext block is dependent on all previously processed plaintext blocks. In the CBC mode of operation, the first block of plaintext is XOR'd with an Initialization Vector (IV). Each subsequent block of plaintext is XOR'd with the previously generated ciphertext block before encryption with the underlying block cipher. To prevent certain attacks, the IV has to be unpredictable, and no IV is used more than once with the same key. CBC is specified in [\[SP800-38A\]](https://go.microsoft.com/fwlink/?LinkId=128809) section 6.2. +> +> **Component Object Model (COM)**: An object-oriented programming model that defines how objects interact within a single process or between processes. In [**COM**](#gt_ef2ebebc-1760-407a-9ace-af48f9050e02), clients have access to an object through interfaces implemented on the object. For more information, see [\[MS-DCOM\]](%5bMS-DCOM%5d.pdf#Section_4a893f3dbd2948cd9f43d9777a4415b0). +> +> **compound file**: (1) A structure for storing a file system, similar to a simplified FAT file system inside a single file, by dividing the single file into sectors. +> +> \(2\) A file that is created as defined in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b) and that is capable of storing data that is structured as storage and streams. +> +> **Coordinated Universal Time (UTC)**: A high-precision atomic time standard that approximately tracks Universal Time (UT). It is the basis for legal, civil time all over the Earth. Time zones around the world are expressed as positive and negative offsets from UTC. In this role, it is also referred to as Zulu time (Z) and Greenwich Mean Time (GMT). In these specifications, all references to UTC refer to the time at UTC-0 (or GMT). +> +> **Cryptographic Application Programming Interface (CAPI) or CryptoAPI**: The Microsoft cryptographic application programming interface (API). An API that enables application developers to add authentication, encoding, and encryption to Windows-based applications. +> +> **cryptographic service provider (CSP)**: A software module that implements cryptographic functions for calling applications that generates digital signatures. Multiple CSPs can be installed. A CSP is identified by a name represented by a NULL-terminated Unicode string. +> +> **cyclic redundancy check (CRC)**: An algorithm used to produce a checksum (a small, fixed number of bits) against a block of data, such as a packet of network traffic or a block of a computer file. The CRC is a broad class of functions used to detect errors after transmission or storage. A CRC is designed to catch random errors, as opposed to intentional errors. If errors might be introduced by a motivated and intelligent adversary, a cryptographic hash function has to be used instead. +> +> **Data Encryption Standard (DES)**: A specification for [**encryption**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) of computer data that uses a 56-bit key developed by IBM and adopted by the U.S. government as a standard in 1976. For more information see [\[FIPS46-3\]](https://go.microsoft.com/fwlink/?LinkId=89872). +> +> **data space**: A series of transforms that operate on original document content in a specific order. The first transform in a data space takes untransformed data as input and passes the transformed output to the next transform. The last transform in the data space produces data that is stored in the compound file. When the process is reversed, each transform in the data space is applied in reverse order to return the data to its original state. +> +> **data space reader**: A software component that extracts [**protected content**](#gt_20bf39db-fca4-4ccc-9640-5f2731026693) to perform an operation on the content or to display the content to users. A data space reader does not modify or create data spaces. +> +> **data space updater**: A software component that can read and update [**protected content**](#gt_20bf39db-fca4-4ccc-9640-5f2731026693). A data space updater cannot change data space definitions. +> +> **data space writer**: A software component that can read, update, or create a data space definition or [**protected content**](#gt_20bf39db-fca4-4ccc-9640-5f2731026693). +> +> **decryption**: In cryptography, the process of transforming encrypted information to its original clear text form. +> +> **Distinguished Encoding Rules (DER)**: A method for encoding a data object based on Basic Encoding Rules (BER) encoding but with additional constraints. DER is used to encode X.509 certificates that need to be digitally signed or to have their signatures verified. +> +> **document**: An object in a content database such as a file, folder, list, or site. Each object is identified by a [**URI**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95). +> +> **document library**: A type of list that is a container for documents and folders. +> +> **document property**: A name/value pair that serves as metadata for a document. +> +> **document stream**: A byte stream that is associated with a document, such as the content of a file. Some documents do not have document streams. +> +> **electronic codebook (ECB)**: A [**block cipher**](#gt_ad4769f2-3c31-4be5-83f0-7d1afab14e23) mode that does not use feedback and encrypts each block individually. Blocks of identical plaintext, either in the same message or in a different message that is encrypted with the same key, are transformed into identical ciphertext blocks. Initialization vectors cannot be used. +> +> **encrypted document**: A document that was converted from plaintext into cipher text to disguise the content of the document when it is stored or sent. +> +> **encryption**: In cryptography, the process of obscuring information to make it unreadable without special knowledge. +> +> **encryption key**: One of the input parameters to an [**encryption**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) algorithm. Generally speaking, an encryption algorithm takes as input a clear-text message and a key, and results in a cipher-text message. The corresponding [**decryption**](#gt_8bf79983-1325-42db-8e2c-520c8ab2ae74) algorithm takes a cipher-text message, and the key, and results in the original clear-text message. +> +> **globally unique identifier (GUID)**: A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [\[RFC4122\]](https://go.microsoft.com/fwlink/?LinkId=90460) or [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824) have to be used for generating the GUID. See also universally unique identifier (UUID). +> +> **Hash-based Message Authentication Code (HMAC)**: A mechanism for message authentication using cryptographic hash functions. HMAC can be used with any iterative cryptographic hash function (for example, [**MD5**](#gt_1535fdac-8d46-4605-96af-252907c4a593) and [**SHA-1**](#gt_fd3168c9-145e-49ad-ba80-2b838a184cbd)) in combination with a secret shared key. The cryptographic strength of HMAC depends on the properties of the underlying hash function. +> +> **Information Rights Management (IRM)**: A technology that provides persistent protection to digital data by using encryption, [**certificates**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879), and authentication. Authorized recipients or users acquire a license to gain access to the protected files according to the rights or business rules that are set by the content owner. +> +> **language code identifier (LCID)**: A 32-bit number that identifies the user interface human language dialect or variation that is supported by an application or a client computer. +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **MD5**: A one-way, 128-bit hashing scheme that was developed by RSA Data Security, Inc., as described in [\[RFC1321\]](https://go.microsoft.com/fwlink/?LinkId=90275). +> +> **OLE compound file**: A form of structured storage, as described in \[MS-CFB\]. A compound file allows independent storages and streams to exist within a single file. +> +> **OPC package**: A .ZIP file archive \[PKZIP\] that follows the Open Packaging Conventions (OPC). +> +> **protected content**: Any content or information, such as a file, Internet message, or other object type, to which a rights-management usage policy is assigned and is encrypted according to that policy. See also [**Information Rights Management (IRM)**](#gt_ff35237a-a497-42aa-b0d5-7a0116328759). +> +> **publishing license**: An XrML 1.2 license that defines the usage policy for protected content and contains the content key with which that content is encrypted. The usage policy identifies all authorized users and the actions that they are authorized to take with the content, in addition to any usage conditions. The publishing license tells a server which usage policies apply to a specific piece of content and grants a server the right to issue use licenses (ULs) based on that policy. The publishing license is created when content is protected. Also referred to as "Issuance License (IL)." +> +> **RC4**: Means Rivest Cipher 4 invented by Ron Rivest in 1987 for RSA Security. It is a variable key-length symmetric encryption algorithm stream cipher that operates on a stream of data byte by byte. It's simple to apply, does not consume more memory, and works quickly on very large pieces of data such as WEP/WPA for wireless network encryption and SSL/ TLS for internet security. RC4 stream ciphers cannot be implemented on small streams of data. RC4 weaknesses make it vulnerable to various cryptographic attacks. For more information, see \[SCHNEIER\] section 17.1. +> +> **root storage object**: A storage object in a compound file that has to be accessed before any other storage objects and stream objects are referenced. It is the uppermost parent object in the storage object and stream object hierarchy. +> +> **salt**: An additional random quantity, specified as input to an encryption function that is used to increase the strength of the encryption. +> +> **sensitivity label**: An identifier that correlates content with associated data classifications and their related relative sensitivity. It is defined by administrative policy as integrated via the Microsoft Information Protection SDK. +> +> **sensitivity label metadata**: Information specific to a particular instance of one or more [**sensitivity labels**](#gt_a1b4b3d0-e8a3-49a6-a5de-51f86ed117c7) as applied to content. +> +> **SHA-1**: An algorithm that generates a 160-bit hash value from an arbitrary amount of input data, as described in [\[RFC3174\]](https://go.microsoft.com/fwlink/?LinkId=90408). SHA-1 is used with the Digital Signature Algorithm (DSA) in the Digital Signature Standard (DSS), in addition to other algorithms and standards. +> +> **site identifier**: A GUID that is used to identify a site in a site collection. +> +> **storage**: An element of a compound file that is a unit of containment for one or more storages and streams, analogous to directories in a file system, as described in \[MS-CFB\]. +> +> **stream**: (1) An element of a compound file, as described in \[MS-CFB\]. A stream contains a sequence of bytes that can be read from or written to by an application, and they can exist only in storages. +> +> \(2\) A sequence of bytes written to a file on the target file system. Every file stored on a volume that uses the file system contains at least one stream, which is normally used to store the primary contents of the file. Additional streams within the file can be used to store file attributes, application parameters, or other information specific to that file. Every file has a default data stream, which is unnamed by default. That data stream, and any other data stream associated with a file, can optionally be named. +> +> **stream schema**: A numeric selector that specifies the format of a file's stream binary pieces. +> +> **transform**: An operation that is performed on data to change it from one form to another. Two examples of transforms are compression and encryption. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **Uniform Resource Identifier (URI)**: A string that identifies a resource. The URI is an addressing mechanism defined in Internet Engineering Task Force (IETF) Uniform Resource Identifier (URI): Generic Syntax [\[RFC3986\]](https://go.microsoft.com/fwlink/?LinkId=90453). +> +> **Uniform Resource Locator (URL)**: A string of characters in a standardized format that identifies a document or resource on the World Wide Web. The format is as specified in [\[RFC1738\]](https://go.microsoft.com/fwlink/?LinkId=90287). +> +> **UTF-8**: A byte-oriented standard for encoding Unicode characters, defined in the Unicode standard. Unless specified otherwise, this term refers to the UTF-8 encoding form specified in \[UNICODE5.0.0/2007\] section 3.9. +> +> **X.509**: An ITU-T standard for public key infrastructure subsequently adapted by the IETF, as specified in \[RFC3280\]. +> +> **XOR obfuscation**: A type of file encryption that helps protect private data by using an exclusive or bitwise operation. This is done by adding a mathematical expression that prevents a simple reverse-engineering process. +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[BCMO800-38A\] National Institute of Standards and Technology, "Recommendation for Block Cipher Modes of Operation: Methods and Techniques", NIST Special Publication 800-38A, December 2001, [http://csrc.nist.gov/publications/nistpubs/800-38a/sp800-38a.pdf](https://go.microsoft.com/fwlink/?LinkId=113491) + +\[Can-XML-1.0\] Boyer, J., "Canonical XML Version 1.0", W3C Recommendation, March 2001, [http://www.w3.org/TR/2001/REC-xml-c14n-20010315](https://go.microsoft.com/fwlink/?LinkId=120197) + +\[DRAFT-DESX\] Simpson, W.A. and Baldwin R., "The ESP DES-XEX3-CBC Transform", July 1997, [http://tools.ietf.org/html/draft-ietf-ipsec-ciph-desx-00](https://go.microsoft.com/fwlink/?LinkId=128905) + +\[ECMA-376\] ECMA International, "Office Open XML File Formats", [https://www.ecma-international.org/publications-and-standards/standards/ecma-376/](https://go.microsoft.com/fwlink/?LinkId=200054) + +\[ISO/IEC 10118\] International Organization for Standardization, "Hash-functions -- Part 3: Dedicated hash-functions", March 2004, [http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=39876](https://go.microsoft.com/fwlink/?LinkID=141969&clcid=0x409) + +\[ISO/IEC29500-1:2016\] ISO/IEC, "Information technology -- Document description and processing languages -- Office Open XML File Formats -- Part 1: Fundamentals and Markup Language Reference", ISO/IEC 29500-1:2016, [https://www.iso.org/standard/71691.html](https://go.microsoft.com/fwlink/?linkid=861065) + +\[ITUX680-1994\] ITU-T, "Information Technology - Abstract Syntax Notation One (ASN.1): Specification of Basic Notation", ITU-T Recommendation X.680, July 1994, [http://www.itu.int/rec/T-REC-X.680-199407-S/en](https://go.microsoft.com/fwlink/?LinkId=120478) + +\[MS-CFB\] Microsoft Corporation, "[Compound File Binary File Format](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b)". + +\[MS-DOC\] Microsoft Corporation, "[Word (.doc) Binary File Format](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22)". + +\[MS-DTYP\] Microsoft Corporation, "[Windows Data Types](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2)". + +\[MS-OI29500\] Microsoft Corporation, "[Office Implementation Information for ISO/IEC 29500 Standards Support](%5bMS-OI29500%5d.pdf#Section_1fd4a662862349c082f018fa91b413b8)". + +\[MS-ONE\] Microsoft Corporation, "[OneNote File Format](%5bMS-ONE%5d.pdf#Section_73d22548a61343508c2307d15576be50)". + +\[MS-OSHARED\] Microsoft Corporation, "[Office Common Data Types and Objects Structures](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d)". + +\[MS-PPT\] Microsoft Corporation, "[PowerPoint (.ppt) Binary File Format](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662)". + +\[MS-RMPR\] Microsoft Corporation, "[Rights Management Services (RMS): Client-to-Server Protocol](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e)". + +\[MS-UCODEREF\] Microsoft Corporation, "[Windows Protocols Unicode Reference](%5bMS-UCODEREF%5d.pdf#Section_4a045e08fc294f22baf416f38c2825fb)". + +\[MS-XLSB\] Microsoft Corporation, "[Excel (.xlsb) Binary File Format](%5bMS-XLSB%5d.pdf#Section_acc8aa921f02416799f584f9f676b95a)". + +\[MS-XLS\] Microsoft Corporation, "[Excel Binary File Format (.xls) Structure](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06)". + +\[RFC1319\] Kaliski, B., "The MD2 Message-Digest Algorithm", RFC 1319, April 1992, [https://www.rfc-editor.org/info/rfc1319](https://go.microsoft.com/fwlink/?LinkId=90273) + +\[RFC1320\] Rivest, R., "The MD4 Message-Digest Algorithm", RFC 1320, April 1992, [https://www.rfc-editor.org/info/rfc1320](https://go.microsoft.com/fwlink/?LinkId=90274) + +\[RFC1851\] Karn, P., Metzger, P., and Simpson, W., "The ESP Triple DES Transform", RFC 1851, September 1995, [http://www.rfc-editor.org/rfc/rfc1851.txt](https://go.microsoft.com/fwlink/?LinkId=128901) + +\[RFC2104\] Krawczyk, H., Bellare, M., and Canetti, R., "HMAC: Keyed-Hashing for Message Authentication", RFC 2104, February 1997, [https://www.rfc-editor.org/info/rfc2104](https://go.microsoft.com/fwlink/?LinkId=90314) + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[RFC2268\] Rivest, R., "A Description of the RC2(r) Encryption Algorithm", RFC 2268, March 1998, [https://www.rfc-editor.org/info/rfc2268](https://go.microsoft.com/fwlink/?LinkId=90330) + +\[RFC2822\] Resnick, P., Ed., "Internet Message Format", RFC 2822, April 2001, [https://www.rfc-editor.org/info/rfc2822](https://go.microsoft.com/fwlink/?LinkId=90385) + +\[RFC2898\] Kaliski, B., "PKCS \#5: Password-Based Cryptography Specification Version 2.0", RFC 2898, September 2000, [https://www.rfc-editor.org/info/rfc2898](https://go.microsoft.com/fwlink/?LinkId=119708) + +\[RFC3280\] Housley, R., Polk, W., Ford, W., and Solo, D., "Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile", RFC 3280, April 2002, [http://www.rfc-editor.org/info/rfc3280](https://go.microsoft.com/fwlink/?LinkId=90414) + +\[RFC3447\] Jonsson, J. and Kaliski, B., "Public-Key Cryptography Standards (PKCS) \#1: RSA Cryptography Specifications Version 2.1", RFC 3447, February 2003, [https://www.rfc-editor.org/info/rfc3447](https://go.microsoft.com/fwlink/?LinkId=90422) + +\[RFC4634\] Eastlake III, D. and Hansen, T., "US Secure Hash Algorithms (SHA and HMAC-SHA)", RFC 4634, July 2006, [https://www.rfc-editor.org/info/rfc4634](https://go.microsoft.com/fwlink/?LinkId=90486) + +\[W3C-XSD\] World Wide Web Consortium, "XML Schema Part 2: Datatypes Second Edition", 28 October 2004, [http://www.w3.org/TR/2004/REC-xmlschema-2-20041028](https://go.microsoft.com/fwlink/?LinkId=90563) + +\[XAdES\] ETSI, "XML Advanced Electronic Signatures (XAdES)", ETSI TS 101 903 V1.3.2, [http://uri.etsi.org/01903/v1.3.2/](https://go.microsoft.com/fwlink/?LinkId=151586) + +\[XMLDSig\] Bartel, M., Boyer, J., Fox, B., et al., "XML-Signature Syntax and Processing", W3C Recommendation, February 2002, [http://www.w3.org/TR/2002/REC-xmldsig-core-20020212/](https://go.microsoft.com/fwlink/?LinkId=130861) + +### Informative References + +\[ISO/IEC29500-1:2011\] ISO/IEC, "Information Technology -- Document description and processing languages -- Office Open XML File Formats -- Part 1: Fundamentals and Markup Language Reference", ISO/IEC 29500-1:2011, 2011, [http://www.iso.org/iso/iso_catalogue/catalogue_tc/catalogue_detail.htm?csnumber=59575](https://go.microsoft.com/fwlink/?LinkId=252374) + +\[MSDN-CAB\] Microsoft Corporation, "Microsoft Cabinet Format", March 1997, [http://msdn.microsoft.com/en-us/library/bb417343.aspx](https://go.microsoft.com/fwlink/?LinkId=226293) + +\[SCHNEIER\] Schneier, B., "Applied Cryptography, Second Edition", John Wiley and Sons, 1996, ISBN: 0471117099. + +## Overview + +### Data Spaces + +The data spaces structure describes a consistent method of storing content in [**OLE compound files**](#gt_b39d4d3a-2d16-4bab-b9fd-ba8e1f16e6a4) that has been transformed in some way. The structure stores both the [**protected content**](#gt_20bf39db-fca4-4ccc-9640-5f2731026693) and information about the [**transforms**](#gt_fdca4a96-8e04-4dc0-acad-1d01e1384a5b) that have been applied to the content. By storing all of this information inside an OLE compound file, client software has all of the information required to read, write, or manipulate the content. A standard structure of [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and [**storages**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) allows various software components to interact with the data in a consistent manner. + +The data spaces structure allows client applications to describe one or more arbitrary transforms. Each transform represents a single arbitrary operation to be performed on a set of storages or streams (1) in the original document content. One or more transforms can then be composited into a [**data space**](#gt_b09bd680-03fe-47a5-b27d-90e73c5cd80f) definition. Data space definitions can then be applied to arbitrary storages or streams (1) in the original document content in the data space map (section [2.1](#Section_84ad4035c4244ce48746031911a7cabb)). + +Because of the layers of indirection between transforms and document content, different transforms can be applied to different parts of the document content, and transforms can be composited in any order. + +The following figure illustrates the relationships between the **DataSpaceMap** stream (1), the **DataSpaceInfo** storage, the **TransformInfo** storages, and the protected content. Note that other streams (1) and storages exist in this file format; this figure describes only the relationships between these storages and streams (1). + +![Relationships among the DataSpaceMap stream, the DataSpaceInfo storage, the TransformInfo storages, and the protected content](media/image1.bin "Relationships among the DataSpaceMap stream, the DataSpaceInfo storage, the TransformInfo storages, and the protected content") + +Figure 1: Relationships among the DataSpaceMap stream, the DataSpaceInfo storage, the TransformInfo storages, and the protected content + +### Information Rights Management Data Space + +The Information Rights Management Data Space (IRMDS) structure is used to enforce a rights management policy applied to a document. The structure defines a transform that is used to encrypt document content, and it defines a second transform that can be used for certain document types to compress document content. + +The original document content is transformed through encryption and placed in a storage not normally accessed by the application. When needed, the application uses the transforms defined in the document to decrypt the protected content. + +This structure is an implementation of the data spaces structure. Therefore, implementing the structure implies storing document content in an OLE compound file. + +Applications that implement this structure will typically store a second document in the OLE compound file called the *placeholder document*. The placeholder document is place into the [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or storages normally identified by the application as containing document content, such that an application that does not detect the IRMDS structure will instead open the placeholder document. + +Applications that implement this structure will typically try to follow the licensing limitations placed on a document. Typical licensing limitations include the right to view, print, edit, forward, or view rights data, as described in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). + +The following figure shows the specific storages, streams (1), structures, and relationships among them that are created when the IRMDS structure is used in an ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054). + +![An ECMA-376 word processing document with the IRMDS structure applied](media/image2.bin "An ECMA-376 word processing document with the IRMDS structure applied") + +Figure 2: An ECMA-376 word processing document with the IRMDS structure applied + +### Encryption + +Password-protected documents can be created by using one of four mechanisms: + +- [**XOR obfuscation**](#gt_cbfd1a35-e8c9-4c5a-bc26-e618633d2f50). + +- 40-bit [**RC4**](#gt_d57eac33-f561-4a08-b148-dfcf29cfb4d8) encryption. + +- [**Cryptographic Application Programming Interface (CAPI) or CryptoAPI**](#gt_7ddf051d-9105-430a-8a89-f551dd4dd0ee) encryption. + +- ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054), which can include one of three approaches: + + - **Standard encryption:** This approach uses a binary **EncryptionInfo** structure. It uses [**Advanced Encryption Standard (AES)**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e) as an encryption algorithm and [**SHA-1**](#gt_fd3168c9-145e-49ad-ba80-2b838a184cbd) as a hashing algorithm. + + - **Agile encryption:** This approach uses an XML **EncryptionInfo** structure. The encryption and hashing algorithms are specified in the structure and can be for any encryption supported on the host computer. + + - **Extensible encryption:** This approach uses an extensible mechanism to allow arbitrary cryptographic modules to be used. + +#### XOR Obfuscation + +XOR obfuscation is performed on portions of Office binary documents. The normal [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contained within the document are modified in place. For more information about how an application can determine whether XOR obfuscation is being used and the placement of the password verifier see [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) and [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22). + +There are two methods for performing XOR obfuscation, known as Method 1 and Method 2. Method 1 specifies structures and procedures used by the Excel Binary File Format (.xls) Structure \[MS-XLS\], and Method 2 specifies structures and procedures used by the Word Binary File Format (.doc) Structure \[MS-DOC\]. + +#### 40-bit RC4 Encryption + +40-bit RC4 encryption is performed on portions of Office binary documents. For more information about how to determine whether 40-bit RC4 encryption is being used and the placement of the password verifier, see [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) and [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22). The same mechanisms for generating the password verifier, deriving the [**encryption key**](#gt_fbdcfa70-e954-4dbd-bafa-0f9c4bcf90dd), and encrypting data are used for all file formats supporting 40-bit RC4 encryption. + +#### CryptoAPI RC4 Encryption + +CryptoAPI RC4 encryption is performed on portions of Office binary documents. The documents will contain a new [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) to contain encrypted information but can also encrypt other streams (1) in place. For more information about how to determine whether CryptoAPI RC4 encryption is being used and the placement of the password verifier, see [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06), [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22), and [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662). The same mechanisms for generating the password verifier, storing data specifying the cryptography, deriving the encryption key, and encrypting data are used for all file formats supporting CryptoAPI RC4 encryption. + +#### ECMA-376 Document Encryption + +Encrypted ECMA-376 documents [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) use the data spaces functionality (section [1.3.1](#Section_51a47a0573a24e2bb7eef7b4bcb8876d)) to contain the entire document as a single [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) in an OLE compound file. All ECMA-376 documents \[ECMA-376\] adhere to the approaches specified in this document and do not require knowledge of application-specific behavior to perform encryption operations. The overall approach is very similar to that used by IRMDS (section [1.3.2](#Section_fc50f864d012465bbd94d35abce01420)). + +### Write Protection + +The application of password-based write protection for Office binary documents is specified in section [2.4.2](#Section_ac1600f3bed44a2b83300fb24d268d41). Write-protected binary documents vary according to the file format. A summary of each type follows: + +- The Excel Binary File Format (.xls) [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06)**:** The password is converted to a 16-bit password verifier, stored in the document as described in \[MS-XLS\], and the document is then encrypted as described in \[MS-XLS\] and in this specification. If the user does not supply an encryption password, a fixed password is used. + +- The Word (.doc) Binary File Format [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22)**:** The password is stored in the clear, as described in \[MS-DOC\], and the document is not encrypted. + +- The PowerPoint (.ppt) Binary File Format [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662)**:** The password is stored in the clear, as described in \[MS-PPT\], and the document can then be encrypted as described in \[MS-PPT\] and in this specification. If encryption is used and the user does not supply an encryption password, a fixed password is used. + +### Digital Signatures + +Office binary documents can be signed by using one of the following methods: + +- A binary format stored in a **\_signatures** storage. This approach is described in section [2.5.1](#Section_fdb729a075264c618ed2ef328bc774df). + +- A format that uses XML-Signature Syntax and Processing, as described in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861), stored in an **\_xmlsignatures** storage. This approach is described in sections [2.5.2](#Section_81b2e49e9fb947f49ddac38082a972e0) and [2.5.3](#Section_02e156c385614dc9a5c82440ab7fe65d). + +### Byte Ordering + +All data and structures in this file format are assumed to be in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) format. + +### String Encoding + +In this file format, several storages and [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) names include the strings "0x01", "0x05", "0x06", and "0x09".These strings are not literally included in the name. Instead, they represent the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters with hexadecimal values 0x01, 0x05, 0x06, and 0x09 respectively. + +### OLE Compound File Path Encoding + +Paths to specific storages and [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) in an OLE compound file are separated by the backslash (\\. The backslash is a delimiter between parts of the path and, therefore, is not part of the name of any specific storage or stream (1). Paths that begin with a backslash signify the root storage of the OLE compound file. + +### Pseudocode Standard Objects + +The pseudocode in this document refers to several objects with associated properties. Accessing a property of an object is denoted with the following syntax: Object.Property. This section describes the properties of each object as it is used in this document. + +#### Array + +An array is a collection of zero or more child objects of uniform type, where each child is addressable by using an unsigned integer index. Referencing a child object of an array is denoted by using the following syntax: array\[index\]. + +Indexes are zero-based and monotonically increase by 1. Therefore, Index 0 references the first element in an array, and Index 1 references the second child in the array. + +Arrays have the following property: + +- **Length:** The number of child objects in the array. + +#### String + +A string is an array of ASCII characters. As in arrays, individual characters in the string are addressable by using a zero-based index. + +#### Storage + +A storage is an OLE storage as described by [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). Storages have the following properties: + +- **Name:** A unique identifier for the storage within its parent, as described in \[MS-CFB\]. + +- **GUID:** A 16-byte identifier associated with the storage, as described in \[MS-CFB\]. + +- **Children:** Zero or more child storages or [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). Each child is addressable by its name. + +#### Stream + +A [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) is an OLE storage as described in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). Streams (1) have the following properties: + +- **Name:** A unique identifier for the stream (1) within its parent, as described in \[MS-CFB\]. + +- **Data:** An array of zero or more unsigned 8-bit integers containing the data in the stream (1). + +## Relationship to Protocols and Other Structures + +This file format builds on the file format as described in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). + +Some structures in this specification reference structures described in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). In addition, the protocols described in \[MS-RMPR\] are necessary for obtaining the information required to understand the transformed data in a document with a rights management policy applied. + +For encryption operations, this specification also requires an understanding of the file formats as described in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06), [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662), or [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22). + +For labeling operations, this specification requires an understanding of the file format as described in [\[MS-ONE\]](%5bMS-ONE%5d.pdf#Section_73d22548a61343508c2307d15576be50). + +## Applicability Statement + +### Data Spaces + +The data spaces structure specifies a set of storages and [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) within an OLE compound file, the structures contained in them, and relationships among them. OLE compound files that conform to the data spaces structure can also have other storages or streams (1) in them that are not specified by this file format. + +### Information Rights Management Data Space + +The IRMDS structure is required when reading, modifying, or creating documents with rights management policies applied. + +### Encryption + +The ECMA-376 [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) encryption structure, [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6), and storages are required when encrypting ECMA-376 documents. When binary file types are encrypted, either CryptoAPI RC4 encryption, RC4 encryption, or XOR obfuscation is required. + +## Versioning and Localization + +None. + +## Vendor-Extensible Fields + +The data spaces structure allows vendors to implement arbitrary transforms, data space definitions, and data space maps. In this way, the structure can be used to represent any arbitrary transformation to any arbitrary data. + +The IRMDS structure does not contain any vendor-extensible fields. + +ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) can be extended if either additional CryptoAPI providers are installed or extensible encryption is used. + +# Structures + +## Data Spaces + +The data spaces structure consists of a set of interrelated storages and [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) in an OLE compound file as specified in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). + +Software components that interact with data spaces MUST check the **DataSpaceVersionInfo** structure (section [2.1.5](#Section_78a22c61178c4496941056e574271b6c)) contained in the **\0x06DataSpaces\Version** stream (1) for the version numbers and respect the following rules. + +**Data space readers:** + +- [**Data space readers**](#gt_e2e904be-02ff-4db0-9e7c-1e4c4f4ff4c1) MUST read the protected content when the reader version is less than or equal to the highest data spaces structure version understood by the software component. + +- Readers MUST NOT read the protected content when the reader version is greater than the highest data spaces structure version understood by the software component. + +**Data space updaters:** + +- [**Data space updaters**](#gt_f11d010c-626b-4373-ae62-868978421cbc) MUST preserve the format of the protected content when the updater version is less than or equal to the highest data spaces structure version understood by the software component. + +- Updaters MUST NOT change the protected content when the updater version is greater than the highest data spaces structure version understood by the software component. + +**Data space writers:** + +- [**Data space writers**](#gt_3d3010b3-1fbd-492b-8a3b-f155cf066544) MUST set the writer version to "1.0". + +- Writers MUST set the updater version to "1.0". + +- Writers MUST set the reader version to "1.0". + +### File + +Every document that conforms to the data spaces structure (section [2.1](#Section_84ad4035c4244ce48746031911a7cabb)) MUST be an OLE compound **File** structure as specified in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). The **File** structure MUST contain the following storages and [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6): + +- **\0x06DataSpaces storage:** A storage that contains all of the necessary information to understand the transforms applied to original document content in a given OLE compound file. + +- **\0x06DataSpaces\Version stream:** A stream (1) containing the **DataSpaceVersionInfo** structure, as specified in section [2.1.5](#Section_78a22c61178c4496941056e574271b6c). This stream (1) specifies the version of the data spaces structure used in the file. + +- **\0x06DataSpaces\DataSpaceMap stream:** A stream (1) containing a **DataSpaceMap** structure as specified in section [2.1.6](#Section_a9dd21241f1047d2873febdc37965ab6). This stream (1) associates protected content with the data space definition used to transform it. + +- **\0x06DataSpaces\DataSpaceInfo storage:** A storage containing the data space definitions used in the file. This storage MUST contain one or more streams (1), each of which contains a **DataSpaceDefinition** structure as specified in section [2.1.7](#Section_9c59e994388841cc9f98ca986a2803c3). The storage MUST contain exactly one stream (1) for each **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)) in the **\0x06DataSpaces\DataSpaceMap** stream (1) (section [2.2.1](#Section_dd37820d8056446086c0066953c64743)). The name of each stream (1) MUST be equal to the **DataSpaceName** field of exactly one **DataSpaceMapEntry** structure contained in the **\0x06DataSpaces\DataSpaceMap** stream (1). + +- **Transformed content streams and storages:** One or more storages or streams (1) containing protected content. The transformed content is associated with a data space definition by an entry in the **\0x06DataSpaces\DataSpaceMap** stream (1). + +- **\0x06DataSpaces\TransformInfo storage:** A storage containing definitions for the transforms used in the data space definitions stored in the **\0x06DataSpaces\DataSpaceInfo** storage as specified in section [2.2.2](#Section_7b65cd15d09c4393a9f43ad673b1821b). The stream (1) contains zero or more definitions for the possible transforms that can be applied to the data in content streams (1). + +Every transform referenced from a data space MUST be defined in a child storage of the **\0x06DataSpaces\TransformInfo** storage (section [2.2.3](#Section_038fa5b0a0964f21ba45e48a03ec43cd)), each of which is called a *transform storage*. Transform storages MUST have a valid storage name. + +Each transform storage identifies an algorithm used to transform data and any parameters needed by that algorithm. Transform storages do not contain actual implementations of transform algorithms but merely definitions and parameters. It is presumed that all software components that interact with the protected content have access to an existing implementation of the transform algorithm. + +Every transform storage MUST contain a stream (1) named "0x06Primary". The 0x06Primary stream (1) MUST begin with a **TransformInfoHeader** structure (section [2.1.8](#Section_c0bfd080ef2a433481a8d1af95dee5e5)). Transform storages can contain other streams (1) or storages if needed by a particular transform. + +This does not apply to the Microsoft OneNote file[\<1\>](#Appendix_A_1) if it is protected by a sensitivity label but the label does not specify encryption. The **TransformInfo storage** (section 2.2.3) must only contain a **LabelInfo stream** as specified in section [2.6.2](#Section_0c4ec12daba04dd48fd1710da6735219). In addition, the sensitivity label protected content must be present in a single stream in the [\[MS-ONE\]](%5bMS-ONE%5d.pdf#Section_73d22548a61343508c2307d15576be50) format called UnencryptedPackage at the root of the File structure. + +### Length-Prefixed Padded Unicode String (UNICODE-LP-P4) + +The Length-Prefixed Padded Unicode String structure (**UNICODE-LP-P4**) contains a length-prefixed [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string, which MUST be padded so it is a multiple of 4 bytes. + +[TABLE] + +**Length (4 bytes):** An unsigned integer that specifies the size, in bytes, of the **Data** field. It MUST be a multiple of 2 bytes. + +**Data (variable):** A Unicode string containing the value of the **UNICODE-LP-P4** structure. It MUST NOT be null-terminated. + +**Padding (variable):** A set of bytes that MUST be of the correct size such that the size of the **UNICODE-LP-P4** structure is a multiple of 4 bytes. If **Padding** is present, it MUST be exactly 2 bytes long, and each byte MUST be 0x00. + +### Length-Prefixed UTF-8 String (UTF-8-LP-P4) + +The Length-Prefixed UTF-8 String structure (**UTF-8-LP-P4**) contains a length-prefixed [**UTF-8**](#gt_409411c4-b4ed-4ab6-b0ee-6d7815f85a35) string, padded to use a multiple of 4 bytes. + +[TABLE] + +**Length (4 bytes):** An unsigned integer that specifies the size, in bytes, of the **Data** field. + +**Data (variable):** A UTF-8 string that specifies the value of the **UTF-8-LP-P4** structure. It MUST NOT be null-terminated. + +**Padding (variable):** A set of bytes that MUST be of correct size such that the size of the **UTF-8-LP-P4** structure is a multiple of 4 bytes. If **Padding** is present, each byte MUST be 0x00. If the value of the **Length** field is exactly 0x00000000, the **Data** field specifies a null string, and the entire structure uses exactly 4 bytes. If the value of the **Length** field is exactly 0x00000004, the **Data** field specifies an empty string, and the entire structure also uses exactly 4 bytes. + +### Version + +The **Version** structure specifies the version of a product or feature. It contains a major and a minor version number. When comparing version numbers, **vMajor** MUST be considered the most significant component and **vMinor** MUST be considered the least significant component. + +[TABLE] + +**vMajor (2 bytes):** An unsigned integer that specifies the major version number. + +**vMinor (2 bytes):** An unsigned integer that specifies the minor version number. + +### DataSpaceVersionInfo + +The **DataSpaceVersionInfo** structure indicates the version of the data spaces structure used in a given file. + +[TABLE] + +**FeatureIdentifier (variable):** A **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)) that specifies the functionality for which the **DataSpaceVersionInfo** structure specifies version information. It MUST be "Microsoft.Container.DataSpaces". + +**ReaderVersion (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)) that specifies the reader version of the data spaces structure (section [2.1](#Section_84ad4035c4244ce48746031911a7cabb)). **ReaderVersion.vMajor** MUST be 1. **ReaderVersion.vMinor** MUST be 0. + +**UpdaterVersion (4 bytes):** A **Version** structure that specifies the updater version of the data spaces structure. **UpdaterVersion.vMajor** MUST be 1. **UpdaterVersion.vMinor** MUST be 0. + +**WriterVersion (4 bytes):** A **Version** structure that specifies the writer version of the data spaces structure. **WriterVersion.vMajor** MUST be 1. **WriterVersion.vMinor** MUST be 0. + +### DataSpaceMap + +The **DataSpaceMap** structure associates protected content with data space definitions. The data space definition, in turn, describes the series of transforms that MUST be applied to that protected content to restore it to its original form. + +By using a map to associate data space definitions with content, a single data space definition can be used to define the transforms applied to more than one piece of protected content. However, a given piece of protected content can be referenced only by a single data space definition. + +[TABLE] + +**HeaderLength (4 bytes):** An unsigned integer that specifies the number of bytes in the **DataSpaceMap** structure before the first entry in the **MapEntries** array. It MUST be equal to 0x00000008. + +**EntryCount (4 bytes):** An unsigned integer that specifies the number of **DataSpaceMapEntry** items (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)) in the **MapEntries** array. + +**MapEntries (variable):** An array of one or more **DataSpaceMapEntry** structures. + +#### DataSpaceMapEntry Structure + +The **DataSpaceMapEntry** structure associates protected content with a specific data space definition. It is contained within the **DataSpaceMap** structure (section [2.1.6](#Section_a9dd21241f1047d2873febdc37965ab6)). + +Reference components MUST be listed from the most general—that is, storages—to the most specific—that is, [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). For example, a stream (1) titled "Chapter 1" in a substorage called "Book" off the root storage of an OLE compound file would have two reference components: "Book" and "Chapter 1", in that order. The simplest content stream (1) reference is one with a single reference component indicating the name of a stream (1) in the root storage of the OLE compound file. + +[TABLE] + +**Length (4 bytes):** An unsigned integer that specifies the size, in bytes, of the **DataSpaceMapEntry** structure. + +**ReferenceComponentCount (4 bytes):** An unsigned integer that specifies the number of **DataSpaceReferenceComponent** items (section [2.1.6.2](#Section_5b88af5509c24b459a83b1da1a8f9935)) in the **ReferenceComponents** array. + +**ReferenceComponents (variable):** An array of one or more **DataSpaceReferenceComponent** structures. Each **DataSpaceReferenceComponent** structure specifies the name of a storage or stream (1) containing protected content that is associated with the data space definition named in the **DataSpaceName** field. + +**DataSpaceName (variable):** A **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)) that specifies the name of the data space definition associated with the protected content specified in the **ReferenceComponents** field. It MUST be equal to the name of a stream (1) in the **\0x06DataSpaces\DataSpaceInfo** storage as specified in section [2.2.2](#Section_7b65cd15d09c4393a9f43ad673b1821b). + +#### DataSpaceReferenceComponent Structure + +The **DataSpaceReferenceComponent** structure stores the name of a specific storage or [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) containing protected content. It is contained within the **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)). + +[TABLE] + +**ReferenceComponentType (4 bytes):** An unsigned integer that specifies whether the referenced component is a stream (1) or storage. It MUST be 0x00000000 for a stream (1) or 0x00000001 for a storage. + +**ReferenceComponent (variable):** A **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)) that specifies the name of the stream (1) or storage containing the protected content to be transformed. If **ReferenceComponentType** is 0x00000000, then **ReferenceComponent** MUST be equal to the name of a stream (1) contained in the root storage of the OLE compound file. If **ReferenceComponentType** is 0x00000001, then **ReferenceComponent** MUST be equal to the name of a storage contained in the root storage of the OLE compound file. + +### DataSpaceDefinition + +Each **DataSpaceDefinition** structure stores a data space definition. A document can contain more than one data space definition—for example, if one content [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) is both compressed and encrypted while a second stream (1) is merely encrypted. + +Each **DataSpaceDefinition** structure MUST be stored in a stream (1) in the **\0x06DataSpaces\DataSpaceInfo** storage (section [2.2.2](#Section_7b65cd15d09c4393a9f43ad673b1821b)). The name of the stream (1) MUST be referenced by a **DataSpaceReferenceComponent** structure (section [2.1.6.2](#Section_5b88af5509c24b459a83b1da1a8f9935)) within a **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)) stored in the **\0x06DataSpaces\DataSpaceMap** stream (1) (section [2.2.1](#Section_dd37820d8056446086c0066953c64743)). + +**TransformReferences** MUST be stored in the reverse order in which they have been applied to the protected content. When reversing the transformation, a software component will apply the transforms in the order specified in the **TransformReferences** array. + +[TABLE] + +**HeaderLength (4 bytes):** An unsigned integer that specifies the number of bytes in the **DataSpaceDefinition** structure before the **TransformReferences** field. It MUST be 0x00000008. + +**TransformReferenceCount (4 bytes):** An unsigned integer that specifies the number of items in the **TransformReferences** array. + +**TransformReferences (variable):** An array of one or more **UNICODE-LP-P4** structures (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)) that specify the transforms associated with this data space definition. Each transform MUST be equal to the name of a storage contained in the **\0x06DataSpaces\TransformInfo** storage (section [2.2.3](#Section_038fa5b0a0964f21ba45e48a03ec43cd) and [2.2.4](#Section_dc6708bbe85244b1acbaf74614155191)). + +### TransformInfoHeader + +The **TransformInfoHeader** structure specifies the identity of a transform. Additional data or structures can follow this header in a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). See section [2.2.6](#Section_fc0b604adb9c477d98352fc0e2aa50ac) for an example of the usage of additional data. + +[TABLE] + +**TransformLength (4 bytes):** An unsigned integer that specifies the number of bytes in this structure before the **TransformName** field. + +**TransformType (4 bytes):** An unsigned integer that specifies the type of transform to be applied. It MUST be 0x00000001. + +**TransformID (variable):** A **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)) that specifies an identifier associated with a specific transform. + +**TransformName (variable):** A **UNICODE-LP-P4** structure that specifies the friendly name of the transform. + +**ReaderVersion (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)) that specifies the reader version. + +**UpdaterVersion (4 bytes):** A **Version** structure that specifies the updater version. + +**WriterVersion (4 bytes):** A **Version** structure that specifies the writer version. + +### EncryptionTransformInfo + +The **EncryptionTransformInfo** structure specifies the encryption used for ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054). + +[TABLE] + +**EncryptionName (variable):** A **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)) that specifies the name of the encryption algorithm. The name MUST be the name of an encryption algorithm, such as "AES 128", "AES 192", or "AES 256". When used with extensible encryption, this value is specified by the extensible encryption module. + +**EncryptionBlockSize (4 bytes):** An unsigned integer that specifies the block size for the encryption algorithm specified by **EncryptionName**. It MUST be 0x00000010 as specified by the [**Advanced Encryption Standard (AES)**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e). When used with extensible encryption, this value is specified by the extensible encryption module. + +**CipherMode (4 bytes):** A value that MUST be 0x00000000, except when used with extensible encryption. When used with extensible encryption, this value is specified by the extensible encryption module. + +**Reserved (4 bytes):** A value that MUST be 0x00000004. + +## Information Rights Management Data Space + +IRMDS defines several data space definitions used to enforce rights management policies that have been applied to a document. This structure is an extension of the data spaces structure specified in section [2.1](#Section_84ad4035c4244ce48746031911a7cabb). + +IRMDS can be applied to the following types of documents: + +- Office binary documents + +- ECMA-376 documents [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) + +In each case, the protected content contains the original document transformed as specified by the IRMDS structure.[\<2\>](#Appendix_A_2) + +### \0x06DataSpaces\DataSpaceMap Stream + +If the original document content is an Office binary document: + +- The **\0x06DataSpaces\DataSpaceMap** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST contain a **DataSpaceMap** structure (section [2.1.6](#Section_a9dd21241f1047d2873febdc37965ab6)) containing at least one **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)). The **DataSpaceMapEntry** structure: + + - MUST have a **DataSpaceName** equal to "0x09DRMDataSpace". + + - MUST have exactly one **ReferenceComponents** entry with the name "0x09DRMContent" and the type 0x00000000, which signifies a stream (1). + +- The **\0x06DataSpaces\DataSpaceMap** stream (1) MAY[\<3\>](#Appendix_A_3) contain a second **DataSpaceMapEntry** structure in the **DataSpaceMap** structure. The second **DataSpaceMapEntry** structure: + + - MUST have a **DataSpaceName** equal to "0x09LZXDRMDataSpace". + + - MUST have exactly one **ReferenceComponents** entry with the name "0x09DRMViewerContent" and the type 0x00000000, which signifies a stream (1). + +If the original document content is an ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054): + +- The **\0x06DataSpaces\DataSpaceMap** stream (1) MUST contain a **DataSpaceMap** structure containing exactly one **DataSpaceMapEntry** structure. + +- The **DataSpaceMapEntry** substructure: + + - MUST have a **DataSpaceName** equal to "DRMEncryptedDataSpace". + + - MUST have exactly one **ReferenceComponents** entry with the name "EncryptedPackage" and the type 0x00000000, which signifies a stream (1). + +### \0x06DataSpaces\DataSpaceInfo Storage + +If the original document content is an Office binary document: + +- The **\0x06DataSpaces\DataSpaceInfo** storage MUST contain a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) named "0x09DRMDataSpace", which MUST contain a **DataSpaceDefinition** structure (section [2.1.7](#Section_9c59e994388841cc9f98ca986a2803c3)): + + - The **DataSpaceDefinition** structure MUST have exactly one **TransformReferences** entry, which MUST be "0x09DRMTransform". + +- The **\0x06DataSpaces\DataSpaceInfo** storage MAY[\<4\>](#Appendix_A_4) contain a stream (1) named "0x09LZXDRMDataSpace". If this stream (1) exists, it MUST contain a **DataSpaceDefinition** structure: + + - The **DataSpaceDefinition** structure MUST have exactly two **TransformReferences** entries. + + - The first **TransformReferences** entry MUST be "0x09DRMTransform". + + - The second **TransformReferences** entry MUST be "0x09LZXTransform". + +If the original document content is an ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054): + +- The **\0x06DataSpaces\DataSpaceInfo** storage MUST contain a stream (1) named "DRMEncryptedDataSpace", which MUST contain a **DataSpaceDefinition** structure. + +- The **DataSpaceDefinition** structure MUST have exactly one **TransformReferences** entry, which MUST be "DRMEncryptedTransform". + +### \0x06DataSpaces\TransformInfo Storage for Office Binary Documents + +If the original document content is an Office binary document, the **\0x06DataSpaces\TransformInfo** storage MUST contain one storage named "0x09DRMTransform". The "0x09DRMTransform" storage MUST contain a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) named "0x06Primary". The "0x06Primary" stream (1) MUST contain an **IRMDSTransformInfo** structure (section [2.2.6](#Section_fc0b604adb9c477d98352fc0e2aa50ac)). Within the **IRMDSTransformInfo** structure, the following values MUST be set: + +- **TransformInfoHeader.TransformType** MUST be 0x00000001. + +- **TransformInfoHeader.TransformID** MUST be "{C73DFACD-061F-43B0-8B64-0C620D2A8B50}". + +- **TransformInfoHeader.TransformName** MUST be "Microsoft.Metadata.DRMTransform". + +- **TransformInfoHeader.ReaderVersion** MUST be "1.0". + +- **TransformInfoHeader.UpdaterVersion** MUST be "1.0". + +- **TransformInfoHeader.WriterVersion** MUST be "1.0". + +The 0x09DRMTransform storage MUST also contain one or more end-user license streams (1) as specified in section [2.2.7](#Section_64fb4612b4dc45e7bfb40759d8e66770). + +The **\0x06DataSpaces\TransformInfo** storage MAY[\<5\>](#Appendix_A_5) contain a substorage named "0x09LZXTransform". If the 0x09LZXTransform storage exists, it MUST contain a stream (1) named "0x06Primary". The **0x06Primary** stream (1) MUST contain a **TransformInfoHeader** structure (section [2.1.8](#Section_c0bfd080ef2a433481a8d1af95dee5e5)). Within the **TransformInfoHeader** structure, the following values MUST be set: + +- **TransformType** MUST be 0x00000001. + +- **TransformID** MUST be "{86DE7F2B-DDCE-486d-B016-405BBE82B8BC}". + +- **TransformName** MUST be "Microsoft.Metadata.CompressionTransform". + +- **ReaderVersion** MUST be "1.0". + +- **UpdaterVersion** MUST be "1.0". + +- **WriterVersion** MUST be "1.0". + +### \0x06DataSpaces\TransformInfo Storage for ECMA-376 Documents + +If the original document is an ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) conforming to the IRMDS structure, the **\0x06DataSpaces\TransformInfo** storage MUST contain one storage named "DRMEncryptedTransform". The "DRMEncryptedTransform" storage MUST contain a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) named "0x06Primary". The "0x06Primary" stream (1) MUST contain an **IRMDSTransformInfo** structure (section [2.2.6](#Section_fc0b604adb9c477d98352fc0e2aa50ac)). Within the **IRMDSTransformInfo** structure, the following values MUST be set: + +- **TransformInfoHeader.TransformType** MUST be 0x00000001. + +- **TransformInfoHeader.TransformID** MUST be "{C73DFACD-061F-43B0-8B64-0C620D2A8B50}". + +  + +- **TransformInfoHeader.TransformName** MUST be "Microsoft.Metadata.DRMTransform". + +- **TransformInfoHeader.ReaderVersion** MUST be 1.0. + +- **TransformInfoHeader.UpdaterVersion** MUST be 1.0. + +- **TransformInfoHeader.WriterVersion** MUST be 1.0. + +The DRMEncryptedTransform storage MUST also contain one or more end-user license streams (1) as specified in section [2.2.7](#Section_64fb4612b4dc45e7bfb40759d8e66770).[\<6\>](#Appendix_A_6) + +### ExtensibilityHeader + +The **ExtensibilityHeader** structure provides a facility to allow an updated header with more information to be inserted into a larger structure in the future. This structure consists of a single element. + +[TABLE] + +**Length (4 bytes):** An unsigned integer that specifies the size of the **ExtensibilityHeader** structure. It MUST be 0x00000004. + +### IRMDSTransformInfo + +The **IRMDSTransformInfo** structure specifies a specific transform that has been applied to protected content to enforce rights management policies applied to the document. + +[TABLE] + +**TransformInfoHeader (variable):** A **TransformInfoHeader** structure (section [2.1.8](#Section_c0bfd080ef2a433481a8d1af95dee5e5)) that specifies the identity of the transform applied. + +**ExtensibilityHeader (4 bytes):** An **ExtensibilityHeader** structure (section [2.2.5](#Section_d30116f420f646a388068120ab924409)). + +**XrMLLicense (variable):** A **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)) containing a valid XrML signed issuance license as specified in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e) section [2.2.9.9](http://msdn.microsoft.com/en-us/library/f2adc901-a61c-48ed-9cac-95ad61751230/). The signed issuance license MAY[\<7\>](#Appendix_A_7) contain the application-specific name-value attribute pairs **name** and **id**, as specified in \[MS-RMPR\] section [2.2.9.7.6](http://msdn.microsoft.com/en-us/library/77752c42-9ce8-44a8-862b-222f780eb3a1/), as part of the **AUTHENTICATEDDATA** element. + +### End-User License Stream + +The end-user license [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains cached use licenses. + +The end-user license stream (1) name MUST be prefixed with "EUL-", with a base-32-encoded [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) as the remainder of the stream (1) name. + +The license stream (1) MUST consist of an **EndUserLicenseHeader** structure (section [2.2.9](#Section_20576d97ef414c3cbf1ff23e168ea65f)), followed by a **UTF-8-LP-P4** string (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)) containing XML specifying a [**certificate chain**](#gt_4c9526d0-366f-45c3-928f-6097a1eb5533). The certificate chain MUST include a use license with an **enablingbits** element containing the symmetric content key encrypted with the user's RAC public key, as specified in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e) section [2.2.9.1.13](http://msdn.microsoft.com/en-us/library/4b093a0a-a16f-4f11-9866-eca874b1598a/). The XML in this string is derived from a **certificatechain** element as specified in \[MS-RMPR\] section [2.2.3.2](http://msdn.microsoft.com/en-us/library/328ee37c-c01d-4683-90ee-b7804ab5705d/). Each XrML [**certificate**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879) or license from a **certificate** element as specified in \[MS-RMPR\] section [2.2.3.1](http://msdn.microsoft.com/en-us/library/3b9a3021-c765-48b2-914e-af7fa811d091/) is encoded as a [**base64**](#gt_179b9392-9019-45a3-880b-26f6890522b7)-encoded Unicode string. + +The certificate chain has been transformed in the following manner: + +1. For each **certificate** element in the certificate chain: + + 1. The XrML content of the **certificate** element is encoded as Unicode. + + 2. Each resulting string is subsequently base64-encoded. + + 3. Each resulting string is then placed in a **certificate** element. + +2. The resulting collection of new **certificate** elements is accumulated in a **certificatechain** element. + +3. The XML header \ is prefixed to the resulting **certificatechain** element. + +4. The resulting XML is stored in the stream (1) as a **UTF-8-LP-P4** string. + +### LicenseID + +A **LicenseID** specifies the identity of a user as a Unicode string. The string MUST be of the form "Windows:\<*emailaddr*\>" or "Passport:\<*emailaddr*\>", where *emailaddr* represents a valid email address as specified in [\[RFC2822\]](https://go.microsoft.com/fwlink/?LinkId=90385). + +### EndUserLicenseHeader + +The **EndUserLicenseHeader** structure is a container for a **LicenseID** (section [2.2.8](#Section_174522386e264f70aa283f98d16a2f26)) as specified in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). + +[TABLE] + +**Length (4 bytes):** An unsigned integer that specifies the size of the **EndUserLicenseHeader** structure. + +**ID_String (variable):** A **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)) that contains a base64-encoded Unicode **LicenseID**. + +### Protected Content Stream + +The protected content [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST be contained within the root storage. If the original document content is an ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054), the stream (1) MUST be named "EncryptedPackage". For all other original document content types, it MUST be named "\0x09DRMContent". + +The protected content stream (1) has the following structure. + +[TABLE] + +**Length (8 bytes):** An unsigned 64-bit integer that specifies the size, in bytes, of the plaintext data that is stored encrypted in the **Contents** field. + +**Contents (variable):** Specifies the protected content. The protected content MUST be encrypted or decrypted with the content symmetric key encrypted for the user in the end-user license as specified in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). Protected content MUST be encrypted or decrypted using AES-128, a 16-byte block size, [**electronic codebook (ECB)**](#gt_c44ff0b3-baac-4993-879f-d72ed61239aa) mode, and an initialization vector of all zeros. + +### Viewer Content Stream + +The viewer content [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MAY[\<8\>](#Appendix_A_8) be present. The purpose of the viewer content stream (1) is to provide a MIME Encapsulation of Aggregate HTML Documents (MHTML) representation of the document to enable an application that cannot parse the protected content stream (1) (section [2.2.10](#Section_278b0e42908048fc806f7d4f6b264fb0)) to present a read-only representation of the document to the user. If the viewer content stream (1) is present, the stream (1) MUST be named "\0x09DRMViewerContent". + +The viewer content stream (1) has the following structure. + +[TABLE] + +**Length (8 bytes):** An unsigned 64-bit integer that specifies the size, in bytes, of the compressed plaintext data stored encrypted in the **Contents** field. + +**Contents (variable):** The MHTML representation of the protected content. The protected content MUST be encrypted or decrypted as specified in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). Once decrypted, the plaintext MUST be decompressed with the LZX compression algorithm, as described in [\[MSDN-CAB\]](https://go.microsoft.com/fwlink/?LinkId=226293). + +## Encryption + +This section specifies encryption and obfuscation. The four different techniques are: + +- ECMA-376 encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054), which leverages the data spaces storages specified in section [2.1](#Section_84ad4035c4244ce48746031911a7cabb). + +- CryptoAPI RC4 encryption. + +- RC4 encryption. + +- XOR obfuscation. + +ECMA-376 encryption \[ECMA-376\] also includes encryption using a third-party cryptography extension, which will be called *extensible encryption* in the remainder of this document. + +### EncryptionHeaderFlags + +The **EncryptionHeaderFlags** structure specifies properties of the encryption algorithm used. It MUST be contained within an **EncryptionHeader** structure (section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f)). + +If the **fCryptoAPI** bit is set and the **fAES** bit is not set, RC4 encryption MUST be used. If the **fAES** encryption bit is set, a [**block cipher**](#gt_ad4769f2-3c31-4be5-83f0-7d1afab14e23) that supports [**ECB**](#gt_c44ff0b3-baac-4993-879f-d72ed61239aa) mode MUST be used. For compatibility with current implementations, [**AES**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e) encryption with a key length of 128, 192, or 256 bits SHOULD[\<9\>](#Appendix_A_9) be used. + +[TABLE] + +**A – Reserved1 (1 bit):** A value that MUST be 0 and MUST be ignored. + +**B – Reserved2 (1 bit):** A value that MUST be 0 and MUST be ignored. + +**C – fCryptoAPI (1 bit):** A flag that specifies whether CryptoAPI RC4 or ECMA-376 encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) is used. It MUST be 1 unless **fExternal** is 1. If **fExternal** is 1, it MUST be 0. + +**D – fDocProps (1 bit):** A value that MUST be 0 if document properties are encrypted. The encryption of document properties is specified in section [2.3.5.4](#Section_032c21fb1dd942d68440f7d74baa21e7). + +**E – fExternal (1 bit):** A value that MUST be 1 if extensible encryption is used. If this value is 1, the value of every other field in this structure MUST be 0. + +**F – fAES (1 bit):** A value that MUST be 1 if the protected content is an ECMA-376 document \[ECMA-376\]; otherwise, it MUST be 0. If the **fAES** bit is 1, the **fCryptoAPI** bit MUST also be 1. + +**Unused (26 bits):** A value that is undefined and MUST be ignored. + +### EncryptionHeader + +The **EncryptionHeader** structure is used by ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) and Office binary document RC4 CryptoAPI encryption, as defined in section [2.3.5](#Section_071a449be45349f3b0d14738dca899e3), to specify encryption properties for an encrypted [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +[TABLE] + +**Flags (4 bytes):** An **EncryptionHeaderFlags** structure, as specified in section [2.3.1](#Section_200a3d611ab44402ae110290b28ab9cb), that specifies properties of the encryption algorithm used. + +**SizeExtra (4 bytes):** A field that is reserved and for which the value MUST be 0x00000000. + +**AlgID (4 bytes):** A signed integer that specifies the encryption algorithm. It MUST be one of the values described in the following table. + +| Value | Algorithm | +|------------|-------------------------| +| 0x00000000 | Determined by **Flags** | +| 0x00006801 | RC4 | +| 0x0000660E | 128-bit AES | +| 0x0000660F | 192-bit AES | +| 0x00006610 | 256-bit AES | + +The **Flags** field and **AlgID** field contain related values and MUST be set to one of the combinations in the following table. + +| Flags.fCryptoAPI | Flags.fAES | Flags.fExternal | AlgID | Algorithm | +|----|----|----|----|----| +| 0 | 0 | 1 | 0x00000000 | Determined by the application | +| 1 | 0 | 0 | 0x00000000 | RC4 | +| 1 | 0 | 0 | 0x00006801 | RC4 | +| 1 | 1 | 0 | 0x00000000 | 128-bit AES | +| 1 | 1 | 0 | 0x0000660E | 128-bit AES | +| 1 | 1 | 0 | 0x0000660F | 192-bit AES | +| 1 | 1 | 0 | 0x00006610 | 256-bit AES | + +**AlgIDHash (4 bytes):** A signed integer that specifies the hashing algorithm together with the **Flags.fExternal** bit. It MUST be one of the combinations in the following table. + +| AlgIDHash | Flags.fExternal | Algorithm | +|------------|-----------------|-------------------------------| +| 0x00000000 | 1 | Determined by the application | +| 0x00000000 | 0 | SHA-1 | +| 0x00008004 | 0 | SHA-1 | + +**KeySize (4 bytes):** An unsigned integer that specifies the number of bits in the encryption key. It MUST be a multiple of 8 and MUST be one of the values in the following table. + +| Algorithm | Value | Comment | +|-----------|-------------------------------------|------------------------------| +| Any | 0x00000000 | Determined by **Flags** | +| RC4 | 0x00000028 – 0x00000080 (inclusive) | 8-bit increments | +| AES | 0x00000080, 0x000000C0, 0x00000100 | 128-bit, 192-bit, or 256-bit | + +If the **Flags** field does not have the **fCryptoAPI** bit set, the **KeySize** field MUST be 0x00000000. If RC4 is used, the value MUST be compatible with the chosen [**cryptographic service provider (CSP)**](#gt_c9b94107-addb-4246-85b2-6c1cab7d492e). + +**ProviderType (4 bytes):** An implementation-specific value that corresponds to constants accepted by the specified CSP. It MUST be compatible with the chosen CSP. It SHOULD[\<10\>](#Appendix_A_10) be one of the following values. + +| Algorithm | Value | Comment | +|-----------|------------|-------------------------| +| Any | 0x00000000 | Determined by **Flags** | +| RC4 | 0x00000001 | | +| AES | 0x00000018 | | + +If the **Flags** field does not have the **fCryptoAPI** bit set, the **ProviderType** field MUST be 0x00000000. + +**Reserved1 (4 bytes):** A value that is undefined and MUST be ignored. + +**Reserved2 (4 bytes):** A value that MUST be 0x00000000 and MUST be ignored. + +**CSPName (variable):** A null-terminated Unicode string that specifies the CSP name. + +### EncryptionVerifier + +The **EncryptionVerifier** structure is used by Office Binary Document RC4 CryptoAPI Encryption (section [2.3.5](#Section_071a449be45349f3b0d14738dca899e3)) and ECMA-376 Document Encryption (section [2.3.4](#Section_4f2e28a1624a4bedb3ec816f0df484ff)). Every usage of this structure MUST specify the hashing algorithm and encryption algorithm used in the **EncryptionVerifier** structure. + +**Verifier** can be 16 bytes of data randomly generated each time the structure is created. **Verifier** is not stored in this structure directly. + +The **EncryptionVerifier** structure MUST be set by using the following process: + +1. Generate random data and write it into the **Salt** field. + +2. Derive the encryption key from the password and [**salt**](#gt_1672c769-f184-404a-9575-e637fd3a43ed), as specified in either section [2.3.4.7](#Section_84f1cce11e824e05bc8e91456ad44823) or section [2.3.5.2](#Section_12ec1195af2d44e68c73003e79e635d5), with block number 0. + +3. Generate 16 bytes of additional random data as the **Verifier**. + +4. Encrypt the result of step 3 and write it into the **EncryptedVerifier** field. + +5. For the chosen hashing algorithm, obtain the size of the hash data and write this value into the **VerifierHashSize** field. + +6. Obtain the hashing algorithm output by using as input the data generated in step 3. + +7. Encrypt the hashing algorithm output from step 6 by using the chosen encryption algorithm, and write the output into the **EncryptedVerifierHash** field. + +[TABLE] + +**SaltSize (4 bytes):** An unsigned integer that specifies the size of the **Salt** field. It MUST be 0x00000010. + +**Salt (16 bytes):** An array of bytes that specifies the salt value used during password hash generation. It MUST NOT be the same data used for the verifier stored encrypted in the **EncryptedVerifier** field. + +**EncryptedVerifier (16 bytes):** A value that MUST be the randomly generated **Verifier** value encrypted using the algorithm chosen by the implementation. + +**VerifierHashSize (4 bytes):** An unsigned integer that specifies the number of bytes needed to contain the hash of the data used to generate the **EncryptedVerifier** field. + +**EncryptedVerifierHash (variable):** An array of bytes that contains the encrypted form of the hash of the randomly generated **Verifier** value. The length of the array MUST be the size of the encryption block size multiplied by the number of blocks needed to encrypt the hash of the **Verifier**. If the encryption algorithm is RC4, the length MUST be 20 bytes. If the encryption algorithm is [**AES**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e), the length MUST be 32 bytes. After decrypting the **EncryptedVerifierHash** field, only the first **VerifierHashSize** bytes MUST be used. + +### ECMA-376 Document Encryption + +When an ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) is encrypted as specified in \[ECMA-376\] Part 2 Annex C Table C-5 BIT 0, a structured storage utilizing the data spaces construct as specified in section [2.1](#Section_84ad4035c4244ce48746031911a7cabb) MUST be used. Unless exceptions are noted in the following subsections, [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and storages contained within the **\0x06DataSpaces** storage MUST be present as specified in section [2.1.1](#Section_11dfbc00031a44bca836e7b9872438fd). + +#### \0x06DataSpaces\DataSpaceMap Stream + +The data space map MUST contain the following structure: + +- The **\0x06DataSpaces\DataSpaceMap** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST contain a **DataSpaceMap** structure (section [2.1.6](#Section_a9dd21241f1047d2873febdc37965ab6)) containing exactly one **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)). + +- The **DataSpaceMapEntry** structure: + +  + +- MUST have a **DataSpaceName** equal to "StrongEncryptionDataSpace". + +- MUST have exactly one **ReferenceComponents** entry with the name "EncryptedPackage" and the type 0x00000000, which signifies a stream (1). + +#### \0x06DataSpaces\DataSpaceInfo Storage + +The **DataSpaceInfo** storage MUST contain a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that is defined as follows: + +- The **\0x06DataSpaces\DataSpaceInfo** storage MUST contain a stream (1) named "StrongEncryptionDataSpace", which MUST contain a **DataSpaceDefinition** structure (section [2.1.7](#Section_9c59e994388841cc9f98ca986a2803c3)). + +- The **DataSpaceDefinition** structure MUST have exactly one **TransformReferences** entry, which MUST be "StrongEncryptionTransform". + +#### \0x06DataSpaces\TransformInfo Storage + +The **\0x06DataSpaces\TransformInfo** storage MUST contain one storage named "StrongEncryptionTransform". The "StrongEncryptionTransform" storage MUST contain a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) named "0x06Primary". The "0x06Primary" stream (1) MUST contain an **IRMDSTransformInfo** structure (section [2.2.6](#Section_fc0b604adb9c477d98352fc0e2aa50ac)). Within the **IRMDSTransformInfo** structure, the following values MUST be set: + +- **TransformInfoHeader.TransformType** MUST be 0x00000001. + +- **TransformInfoHeader.TransformID** MUST be "{FF9A3F03-56EF-4613-BDD5-5A41C1D07246}". + +- **TransformInfoHeader.TransformName** MUST be "Microsoft.Container.EncryptionTransform". + +- **TransformInfoHeader.ReaderVersion** MUST be "1.0". + +- **TransformInfoHeader.UpdaterVersion** MUST be "1.0". + +- **TransformInfoHeader.WriterVersion** MUST be "1.0". + +Following the **IRMDSTransformInfo** structure, an **EncryptionTransformInfo** structure (section [2.1.9](#Section_14edd7526c2a419e906385ed700c6568)) MUST exist that specifies the encryption algorithms to be used. However, if the algorithms specified in the **EncryptionTransformInfo** structure differ from the algorithms specified in the **EncryptionInfo** stream (1) (as specified in section [2.3.4.5](#Section_2895eba1acb146249bde2cdad3fea015), section [2.3.4.6](#Section_a922e41e63f2470185217f5d221a7ce0), and section [2.3.4.10](#Section_87020a34e73f413999bcbbdf6cf6fa55)), the **EncryptionInfo** stream (1) MUST be considered authoritative. If the agile encryption method is used, the **EncryptionName** field of the **EncryptionTransformInfo** structure MUST be a null string (0x00000000). + +#### \EncryptedPackage Stream + +The **\EncryptedPackage** stream is an encrypted [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) of bytes containing the entire ECMA-376 source file [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) in compressed form. + +[TABLE] + +**StreamSize (8 bytes):** An unsigned integer that specifies the number of bytes used by data encrypted within the **EncryptedData** field, not including the size of the **StreamSize** field. Note that the actual size of the **\EncryptedPackage** stream (1) can be larger than this value, depending on the block size of the chosen encryption algorithm + +**EncryptedData (variable):** A block of data that is encrypted by using the algorithm specified within the **\EncryptionInfo** stream (1) (section [2.3.4.5](#Section_2895eba1acb146249bde2cdad3fea015)). + +#### \EncryptionInfo Stream (Standard Encryption) + +The **\EncryptionInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains detailed information that is used to initialize the cryptography used to encrypt the **\EncryptedPackage** stream (1), as specified in section [2.3.4.4](#Section_b60c8b352db24409871059d88a793f83), when standard encryption is used. + +If an external encryption provider is used, see section [2.3.4.6](#Section_a922e41e63f2470185217f5d221a7ce0). + +[TABLE] + +**EncryptionVersionInfo (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)) where **Version.vMajor** MUST be 0x0002, 0x0003 or 0x0004[\<11\>](#Appendix_A_11), and **Version.vMinor** MUST be 0x0002. + +**EncryptionHeader.Flags (4 bytes):** A copy of the **Flags** stored in the **EncryptionHeader** field of this structure. + +**EncryptionHeaderSize (4 bytes):** An unsigned integer that specifies the size, in bytes, of the **EncryptionHeader** field of this structure. + +**EncryptionHeader (variable):** An **EncryptionHeader** structure (section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f)) that specifies parameters used to encrypt data. The values MUST be set as specified in the following table. + +| Field | Value | +|----|----| +| **Flags** | The **fCryptoAPI** and **fAES** bits MUST be set. The **fDocProps** bit MUST be 0. | +| **SizeExtra** | This value MUST be 0x00000000. | +| **AlgID** | This value MUST be 0x0000660E (AES-128), 0x0000660F (AES-192), or 0x00006610 (AES-256). | +| **AlgIDHash** | This value MUST be 0x00008004 (SHA-1). | +| **KeySize** | This value MUST be 0x00000080 (AES-128), 0x000000C0 (AES-192), or 0x00000100 (AES-256). | +| **ProviderType** | This value SHOULD[\<12\>](#Appendix_A_12) be 0x00000018 (AES). | +| **Reserved1** | This value is undefined and MUST be ignored. | +| **Reserved2** | This value MUST be 0x00000000 and MUST be ignored. | +| **CSPName** | This value SHOULD[\<13\>](#Appendix_A_13) be set to either "Microsoft Enhanced RSA and AES Cryptographic Provider" or "Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype)" as a null-terminated Unicode string. | + +**EncryptionVerifier (variable):** An **EncryptionVerifier** structure, as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6), that is generated as specified in section [2.3.4.8](#Section_cbd8019d2bb4495b872bf80b960f7e4f). + +#### \EncryptionInfo Stream (Extensible Encryption) + +ECMA-376 documents [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) can optionally use user-provided custom (extensible) encryption modules. When extensible encryption is used, the **\EncryptionInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST contain the structure described in the following table. + +[TABLE] + +**EncryptionVersionInfo (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)) where **Version.vMajor** MUST be 0x0003 or 0x0004 and **Version.vMinor** MUST be 0x0003. + +**EncryptionHeader.Flags (4 bytes):** A copy of the **Flags** stored in the **EncryptionHeader** field of this structure as specified in section [2.3.1](#Section_200a3d611ab44402ae110290b28ab9cb). It MUST have the **fExternal** bit set to 1. All other bits in this field MUST be set to 0. + +**EncryptionHeaderSize (4 bytes):** An unsigned integer that specifies the size, in bytes, of the **EncryptionHeader** field of this structure, including the [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) specifying the extensible encryption module. + +**EncryptionHeader (variable):** An **EncryptionHeader** structure (section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f)) used to encrypt the structure. The values MUST be set as described in the following table. + +| Field | Value | +|----|----| +| **Flags** | A value that MUST have the **fExternal** bit set to 1. All other bits MUST be set to 0. | +| **SizeExtra** | A value that MUST be 0x00000000. | +| **AlgID** | A value that MUST be 0x00000000. | +| **AlgIDHash** | A value that MUST be 0x00000000. | +| **KeySize** | A value that MUST be 0x00000000. | +| **ProviderType** | A value that MUST be 0x00000000. | +| **Reserved1** | A value that is undefined and MUST be ignored. | +| **Reserved2** | A value that MUST be 0x00000000 and MUST be ignored. | +| **CSPName** | A unique identifier of an encryption module.[\<14\>](#Appendix_A_14) | + +**EncryptionInfo (variable):** A Unicode string that specifies an **EncryptionData** element. The first Unicode code point MUST be 0xFEFF. + +The **EncryptionData** XML element MUST conform to the following XMLSchema namespace as specified by [\[W3C-XSD\]](https://go.microsoft.com/fwlink/?LinkId=90563). + +1. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +| Element | Parent | Attribute | Value | +|----|----|----|----| +| **EncryptionData** | | | | +| **EncryptionProvider** | **EncryptionData** | | | +| | | **Id** | The GUID of the extensible encryption module, expressed as a string. | +| | | **Url** | A [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) where the extensible encryption module can be obtained. | +| **EncryptionProviderData** | **EncryptionProvider** | | Base64-encoded data used by the extensible module. | + +**EncryptionVerifier (variable):** An **EncryptionVerifier** structure, as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6), that is generated as specified in section [2.3.4.8](#Section_cbd8019d2bb4495b872bf80b960f7e4f). + +#### ECMA-376 Document Encryption Key Generation (Standard Encryption) + +The encryption key for ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) MUST be generated by using the following method, which is derived from PKCS \#5: Password-Based Cryptography Version 2.0 [\[RFC2898\]](https://go.microsoft.com/fwlink/?LinkId=119708). + +Let H() be a hashing algorithm as determined by the **EncryptionHeader.AlgIDHash** field, H_(n) be the hash data of the n^(th) iteration, and a plus sign (+) represent concatenation. This hashing algorithm MUST be [**SHA-1**](#gt_fd3168c9-145e-49ad-ba80-2b838a184cbd). The password MUST be provided as an array of Unicode characters. Limitations on the length of the password and the characters used by the password are implementation-dependent. The initial password hash is generated as follows: + +- H₀ = H(salt + password) + +The salt used MUST be generated randomly and MUST be 16 bytes in size. The salt MUST be stored in the **EncryptionVerifier.Salt** field contained within the **\EncryptionInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) as specified in section [2.3.4.5](#Section_2895eba1acb146249bde2cdad3fea015). The hash is then iterated by using the following approach: + +- H_(n) = H(iterator + H_(n-1)) + +where **iterator** is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented monotonically on each iteration until 50,000 iterations have been performed. The value of **iterator** on the last iteration MUST be 49,999. + +After the final hash data has been obtained, the encryption key MUST be generated by using the final hash data, and the block number MUST be 0x00000000. The encryption algorithm MUST be specified in the **EncryptionHeader.AlgID** field. The encryption algorithm MUST use [**ECB**](#gt_c44ff0b3-baac-4993-879f-d72ed61239aa) mode. The method used to generate the hash data that is the input into the key derivation algorithm is as follows: + +- H_(final) = H(H_(n) + block) + +The encryption key derivation method is specified by the following steps: + +1. Let **cbRequiredKeyLength** be equal to the size, in bytes, of the required key length for the relevant encryption algorithm as specified by the **EncryptionHeader** structure. Note that **cbRequiredKeyLength** MUST be less than or equal to 40. + +2. Let **cbHash** be the number of bytes output by the hashing algorithm H. + +3. Form a 64-byte buffer by repeating the constant 0x36 64 times. XOR H_(final) into the first **cbHash** bytes of this buffer, and compute a hash of the resulting 64-byte buffer by using hashing algorithm H. This will yield a hash value of length **cbHash**. Let the resulting value be called **X1**. + +4. Form another 64-byte buffer by repeating the constant 0x5C 64 times. XOR H_(final) into the first **cbHash** bytes of this buffer, and compute a hash of the resulting 64-byte buffer by using hash algorithm H. This yields a hash value of length **cbHash**. Let the resulting value be called **X2**. + +5. Concatenate **X1** with **X2** to form **X3**, which will yield a value twice the length of **cbHash**. + +6. Let **keyDerived** be equal to the first **cbRequiredKeyLength** bytes of **X3**. + +#### Password Verifier Generation (Standard Encryption) + +The password verifier uses an **EncryptionVerifier** structure as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6). The password verifier **Salt** field MUST be equal to the salt created during password key generation, as specified in section [2.3.4.7](#Section_84f1cce11e824e05bc8e91456ad44823). A randomly generated verifier is then hashed using the SHA-1 hashing algorithm specified in the **EncryptionHeader** structure, and encrypted using the key generated as specified in section 2.3.4.7, with a block number of 0x00000000. + +#### Password Verification (Standard Encryption) + +Passwords MUST be verified by using the following steps: + +1. Generate an encryption key as specified in section [2.3.4.7](#Section_84f1cce11e824e05bc8e91456ad44823). + +2. Decrypt the **EncryptedVerifier** field of the **EncryptionVerifier** structure as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6), and generated as specified in section [2.3.4.8](#Section_cbd8019d2bb4495b872bf80b960f7e4f), to obtain the **Verifier** value. The resulting **Verifier** value MUST be an array of 16 bytes. + +3. Decrypt the **EncryptedVerifierHash** field of the **EncryptionVerifier** structure to obtain the hash of the **Verifier** value. The number of bytes used by the encrypted **Verifier** hash MUST be 32. The number of bytes used by the decrypted **Verifier** hash is given by the **VerifierHashSize** field, which MUST be 20. + +4. Calculate the [**SHA-1**](#gt_fd3168c9-145e-49ad-ba80-2b838a184cbd) hash value of the **Verifier** value calculated in step 2. + +5. Compare the results of step 3 and step 4. If the two hash values do not match, the password is incorrect. + +#### \EncryptionInfo Stream (Agile Encryption) + +The **\EncryptionInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains detailed information about the cryptography used to encrypt the **\EncryptedPackage** stream (1) (section [2.3.4.4](#Section_b60c8b352db24409871059d88a793f83)) when agile encryption is used. + +[TABLE] + +**EncryptionVersionInfo (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)), where **Version.vMajor** MUST be 0x0004 and **Version.vMinor** MUST be 0x0004. + +**Reserved (4 bytes):** A value that MUST be 0x00000040. + +**XmlEncryptionDescriptor (variable):** An XML element that MUST conform to the following XML schema namespace, as specified in [\[W3C-XSD\]](https://go.microsoft.com/fwlink/?LinkId=90563): + +32. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +**SaltSize:** An unsigned integer that specifies the number of bytes used by a salt. It MUST be at least 1 and no greater than 65,536. + +**BlockSize:** An unsigned integer that specifies the number of bytes used to encrypt one block of data. It MUST be at least 2, no greater than 4096, and a multiple of 2. + +**KeyBits:** An unsigned integer that specifies the number of bits used by an encryption algorithm. It MUST be at least 8 and a multiple of 8. + +**HashSize:** An unsigned integer that specifies the number of bytes used by a hash value. It MUST be at least 1, no greater than 65,536, and the same number of bytes as the hash algorithm emits. + +**SpinCount:** An unsigned integer that specifies the number of times to iterate on a hash of a password. It MUST NOT be greater than 10,000,000. + +**CipherAlgorithm:** A string that specifies the cipher algorithm. The values in the following table are defined. + +| Value | Cipher algorithm | +|----|----| +| AES | MUST conform to the [**AES**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e) algorithm. | +| RC2 | MUST conform to the algorithm as specified in [\[RFC2268\]](https://go.microsoft.com/fwlink/?LinkId=90330).[\<15\>](#Appendix_A_15) | +| [**RC4**](#gt_d57eac33-f561-4a08-b148-dfcf29cfb4d8) | MUST NOT be used. | +| DES | MUST conform to the [**DES**](#gt_f5de5dd3-8f77-46a7-8756-05fbc0dcd9a9) algorithm.[\<16\>](#Appendix_A_16) | +| DESX | MUST conform to the algorithm as specified in [\[DRAFT-DESX\]](https://go.microsoft.com/fwlink/?LinkId=128905).[\<17\>](#Appendix_A_17) | +| 3DES | MUST conform to the algorithm as specified in [\[RFC1851\]](https://go.microsoft.com/fwlink/?LinkId=128901).[\<18\>](#Appendix_A_18) | +| 3DES_112 | MUST conform to the algorithm as specified in \[RFC1851\].[\<19\>](#Appendix_A_19) | + +Values that are not defined MAY[\<20\>](#Appendix_A_20) be used, and a compliant implementation is not required to support all defined values. The string MUST be at least 1 character. + +**CipherChaining:** A string that specifies the chaining mode used by **CipherAlgorithm**. For more details about chaining modes, see [\[BCMO800-38A\]](https://go.microsoft.com/fwlink/?LinkId=113491). It MUST be one of the values described in the following table. + +| Value | Chaining mode | +|----|----| +| ChainingModeCBC | [**Cipher block chaining (CBC)**](#gt_5d31e40d-bc6a-4813-8087-056aaafa4f01) | +| ChainingModeCFB | Cipher feedback chaining (CFB), with an 8-bit window | + +**HashAlgorithm:** A string specifying a hashing algorithm. The values described in the following table are defined. + +| Value | Hash algorithm | +|----|----| +| SHA-1 | MUST conform to the algorithm as specified in [\[RFC4634\]](https://go.microsoft.com/fwlink/?LinkId=90486). | +| SHA256 | MUST conform to the algorithm as specified in \[RFC4634\]. | +| SHA384 | MUST conform to the algorithm as specified in \[RFC4634\]. | +| SHA512 | MUST conform to the algorithm as specified in \[RFC4634\]. | +| MD5 | MUST conform to [**MD5**](#gt_1535fdac-8d46-4605-96af-252907c4a593). | +| MD4 | MUST conform to the algorithm as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274). | +| MD2 | MUST conform to the algorithm as specified in [\[RFC1319\]](https://go.microsoft.com/fwlink/?LinkId=90273). | +| RIPEMD-128 | MUST conform to the hash functions specified in [\[ISO/IEC 10118\]](https://go.microsoft.com/fwlink/?LinkID=141969&clcid=0x409). | +| RIPEMD-160 | MUST conform to the hash functions specified in \[ISO/IEC 10118\]. | +| WHIRLPOOL | MUST conform to the hash functions specified in \[ISO/IEC 10118\]. | + +Values that are not defined MAY[\<21\>](#Appendix_A_21) be used, and a compliant implementation is not required to support all defined values. The string MUST be at least 1 character. For more information, see section [4](#Section_98fd40b50dc04b92aca3cbe28c375e84). + +**KeyData:** A complex type that specifies the encryption used within this element. The **saltValue** attribute is a base64-encoded binary value that is randomly generated. The number of bytes required to decode the **saltValue** attribute MUST be equal to the value of the **saltSize** attribute. + +**DataIntegrity:** A complex type that specifies data used to verify whether the encrypted data passes an integrity check. It MUST be generated using the method specified in section [2.3.4.14](#Section_63d9c26282b94fa3a06dd087b93e3b00). This type is composed of the following simple types: + +- **encryptedHmacKey:** A base64-encoded value that specifies an encrypted key used in calculating the **encryptedHmacValue**. + +- **encryptedHmacValue:** A base64-encoded value that specifies an [**HMAC**](#gt_ba024019-a866-41df-99a5-764b7eab2e1e) derived from **encryptedHmacKey** and the encrypted data. + +**KeyEncryptor:** A complex type that specifies the parameters used to encrypt an intermediate key, which is used to perform the final encryption of the document. To ensure extensibility, arbitrary elements can be defined to encrypt the intermediate key. The intermediate key MUST be the same for all **KeyEncryptor** elements. **PasswordKeyEncryptor** and **CertificateKeyEncryptor** are defined later in this section. + +**KeyEncryptors:** A sequence of **KeyEncryptor** elements. Exactly one **KeyEncryptors** element MUST be present, and the **KeyEncryptors** element MUST contain at least one **KeyEncryptor**. + +**Encryption:** A complex type composed of the following elements that specify the encryption properties: + +- **keyData:** One **KeyData** element MUST be present. + +- **dataIntegrity:** One **DataIntegrity** element SHOULD[\<22\>](#Appendix_A_22) be present. + +- **keyEncryptors:** One **KeyEncryptors** sequence MUST be present. + +The **KeyEncryptor** element, which MUST be used when encrypting password-protected agile encryption documents, is either a **PasswordKeyEncryptor** or a **CertificateKeyEncryptor**. Exactly one **PasswordKeyEncryptor** MUST be present. Zero or more **CertificateKeyEncryptor** elements are contained within the **KeyEncryptors** element. The **PasswordKeyEncryptor** is specified by the following schema: + +129. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +**saltSize:** A **SaltSize** that specifies the size of the salt for a **PasswordKeyEncryptor**. + +**blockSize:** A **BlockSize** that specifies the block size for a **PasswordKeyEncryptor**. + +**keyBits:** A **KeyBits** that specifies the number of bits for a **PasswordKeyEncryptor**. + +**hashSize:** A **HashSize** that specifies the size of the binary form of the hash for a **PasswordKeyEncryptor**. + +**cipherAlgorithm:** A **CipherAlgorithm** that specifies the cipher algorithm for a **PasswordKeyEncryptor**. The cipher algorithm specified MUST be the same as the cipher algorithm specified for the **Encryption.keyData** element. + +**cipherChaining:** A **CipherChaining** that specifies the cipher chaining mode for a **PasswordKeyEncryptor**. + +**hashAlgorithm:** A **HashAlgorithm** that specifies the hashing algorithm for a **PasswordKeyEncryptor**. The hashing algorithm specified MUST be the same as the hashing algorithm specified for the **Encryption.keyData** element. + +**saltValue:** A base64-encoded binary byte array that specifies the salt value for a **PasswordKeyEncryptor**. The number of bytes required by the decoded form of this element MUST be **saltSize**. + +**spinCount:** A **SpinCount** that specifies the spin count for a **PasswordKeyEncryptor**. + +**encryptedVerifierHashInput:** A base64-encoded value that specifies the encrypted verifier hash input for a **PasswordKeyEncryptor** used in password verification. + +**encryptedVerifierHashValue:** A base64-encoded value that specifies the encrypted verifier hash value for a **PasswordKeyEncryptor** used in password verification. + +**encryptedKeyValue:** A base64-encoded value that specifies the encrypted form of the intermediate key. + +The **CertificateKeyEncryptor** is specified by the following schema: + +161. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +**encryptedKeyValue:** A base64-encoded value that specifies the encrypted form of the intermediate key, which is encrypted with the public key contained within the **X509Certificate** attribute. + +**X509Certificate:** A base64-encoded value that specifies a [**DER**](#gt_25428624-f292-4134-8f6c-85ba65a6d472)-encoded [**X.509**](#gt_2069b65d-b546-4198-abfd-768badc2258e) [**certificate**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879) used to encrypt the intermediate key. The certificate MUST contain only the public portion of the public-private key pair. + +**certVerifier:** A base64-encoded value that specifies the HMAC of the binary data obtained by base64-decoding the **X509Certificate** attribute. The hashing algorithm used to derive the HMAC MUST be the hashing algorithm specified for the **Encryption.keyData** element. The secret key used to derive the HMAC MUST be the intermediate key. + +If the intermediate key is reset, any **CertificateKeyEncryptor** elements are also reset to contain the new intermediate key, except that the **certVerifier** attribute MUST match the value calculated using the current intermediate key, to verify that the **CertificateKeyEncryptor** element actually encrypted the current intermediate key. If a **CertificateKeyEncryptor** element does not have a correct **certVerifier** attribute, it MUST be discarded. + +#### Encryption Key Generation (Agile Encryption) + +The encryption key for ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) using agile encryption MUST be generated by using the following method, which is derived from PKCS \#5: Password-Based Cryptography Version 2.0 [\[RFC2898\]](https://go.microsoft.com/fwlink/?LinkId=119708). + +Let H() be a hashing algorithm as determined by the **PasswordKeyEncryptor.hashAlgorithm** element, H_(n) be the hash data of the n^(th) iteration, and a plus sign (+) represent concatenation. The password MUST be provided as an array of Unicode characters. Limitations on the length of the password and the characters used by the password are implementation-dependent. The initial password hash is generated as follows: + +- H₀ = H(salt + password) + +The salt used MUST be generated randomly. The salt MUST be stored in the **PasswordKeyEncryptor.saltValue** element contained within the **\EncryptionInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) as specified in section [2.3.4.10](#Section_87020a34e73f413999bcbbdf6cf6fa55). The hash is then iterated by using the following approach: + +- H_(n) = H(iterator + H_(n-1)) + +where **iterator** is an unsigned 32-bit value that is initially set to 0x00000000 and then incremented monotonically on each iteration until **PasswordKeyEncryptor.spinCount** iterations have been performed. The value of **iterator** on the last iteration MUST be one less than **PasswordKeyEncryptor.spinCount**. + +The final hash data that is used for an encryption key is then generated by using the following method: + +- H_(final) = H(H_(n) + blockKey) + +where **blockKey** represents an array of bytes used to prevent two different blocks from encrypting to the same cipher text. + +If the size of the resulting H_(final) is smaller than that of **PasswordKeyEncryptor.keyBits**, the key MUST be padded by appending bytes with a value of 0x36. If the hash value is larger in size than **PasswordKeyEncryptor.keyBits**, the key is obtained by truncating the hash value. + +#### Initialization Vector Generation (Agile Encryption) + +Initialization vectors are used in all cases for agile encryption. An initialization vector MUST be generated by using the following method, where H() is a hash function that MUST be the same as specified in section [2.3.4.11](#Section_74d60145a0f044be99cec65d211b4eb7) and a plus sign (+) represents concatenation: + +1. If a **blockKey** is provided, let **IV** be a hash of the **KeySalt** and the following value: + + 1. blockKey:IV = H(KeySalt + blockKey) + +2. If a **blockKey** is not provided, let **IV** be equal to the following value: + + 1. KeySalt:IV = KeySalt. + +3. If the number of bytes in the value of **IV** is less than the value of the **blockSize** attribute corresponding to the **cipherAlgorithm** attribute, pad the array of bytes by appending 0x36 until the array is **blockSize** bytes. If the array of bytes is larger than **blockSize** bytes, truncate the array to **blockSize** bytes. + +#### PasswordKeyEncryptor Generation (Agile Encryption) + +For agile encryption, the password key encryptor XML element specified in section [2.3.4.10](#Section_87020a34e73f413999bcbbdf6cf6fa55) MUST be created as follows: + +**saltSize:** Set this attribute to the number of bytes used by the binary form of the **saltValue** attribute. It MUST conform to a **SaltSize** type. + +**blockSize:** Set this attribute to the number of bytes needed to contain an encrypted block of data, as defined by the **cipherAlgorithm** used. It MUST conform to a **BlockSize** type. + +**keyBits:** Set this attribute to the number of bits needed to contain an encryption key, as defined by the **cipherAlgorithm** used. It MUST conform to a **KeyBits** type. + +**hashSize:** Set this attribute to the number of bytes needed to contain the output of the hashing algorithm defined by the **hashAlgorithm** element. It MUST conform to a **HashSize** type. + +**cipherAlgorithm:** Set this attribute to a string containing the cipher algorithm used to encrypt the **encryptedVerifierHashInput**, **encryptedVerifierHashValue**, and **encryptedKeyValue**. It MUST conform to a **CipherAlgorithm** type. + +**cipherChaining:** Set this attribute to the cipher chaining mode used to encrypt **encryptedVerifierHashInput**, **encryptedVerifierHashValue**, and **encryptedKeyValue**. It MUST conform to a **CipherChaining** type. + +**hashAlgorithm:** Set this attribute to the hashing algorithm used to derive the encryption key from the password and that is also used to obtain the **encryptedVerifierHashValue**. It MUST conform to a **HashAlgorithm** type. + +**saltValue:** Set this attribute to a base64-encoded, randomly generated array of bytes. It MUST conform to a **SaltValue** type. The number of bytes required by the decoded form of this element MUST be **saltSize**. + +**spinCount:** Set this attribute to the number of times to iterate the password hash when creating the key used to encrypt the **encryptedVerifierHashInput**, **encryptedVerifierHashValue**, and **encryptedKeyValue**. It MUST conform to a **SpinCount** type. + +**encryptedVerifierHashInput:** This attribute MUST be generated by using the following steps: + +1. Generate a random array of bytes with the number of bytes used specified by the **saltSize** attribute. + +2. Generate an encryption key as specified in section [2.3.4.11](#Section_74d60145a0f044be99cec65d211b4eb7) by using the user-supplied password, the binary byte array used to create the **saltValue** attribute, and a **blockKey** byte array consisting of the following bytes: 0xfe, 0xa7, 0xd2, 0x76, 0x3b, 0x4b, 0x9e, and 0x79. + +3. Encrypt the random array of bytes generated in step 1 by using the binary form of the **saltValue** attribute as an initialization vector as specified in section [2.3.4.12](#Section_11672b8cb9f04bb79b2d3f1695286436). If the array of bytes is not an integral multiple of **blockSize** bytes, pad the array with 0x00 to the next integral multiple of **blockSize** bytes. + +4. Use base64 to encode the result of step 3. + +**encryptedVerifierHashValue:** This attribute MUST be generated by using the following steps: + +1. Obtain the hash value of the random array of bytes generated in step 1 of the steps for **encryptedVerifierHashInput**. + +2. Generate an encryption key as specified in section 2.3.4.11 by using the user-supplied password, the binary byte array used to create the **saltValue** attribute, and a **blockKey** byte array consisting of the following bytes: 0xd7, 0xaa, 0x0f, 0x6d, 0x30, 0x61, 0x34, and 0x4e. + +3. Encrypt the hash value obtained in step 1 by using the binary form of the **saltValue** attribute as an initialization vector as specified in section 2.3.4.12. If **hashSize** is not an integral multiple of **blockSize** bytes, pad the hash value with 0x00 to an integral multiple of **blockSize** bytes. + +4. Use base64 to encode the result of step 3. + +**encryptedKeyValue:** This attribute MUST be generated by using the following steps: + +1. Generate a random array of bytes that is the same size as specified by the **Encryptor.KeyData.keyBits** attribute of the parent element. + +2. Generate an encryption key as specified in section 2.3.4.11, using the user-supplied password, the binary byte array used to create the **saltValue** attribute, and a **blockKey** byte array consisting of the following bytes: 0x14, 0x6e, 0x0b, 0xe7, 0xab, 0xac, 0xd0, and 0xd6. + +3. Encrypt the random array of bytes generated in step 1 by using the binary form of the **saltValue** attribute as an initialization vector as specified in section 2.3.4.12. If the array of bytes is not an integral multiple of **blockSize** bytes, pad the array with 0x00 to an integral multiple of **blockSize** bytes. + +4. Use base64 to encode the result of step 3. + +#### DataIntegrity Generation (Agile Encryption) + +The **DataIntegrity** element contained within an **Encryption** element MUST be generated by using the following steps: + +1. Obtain the intermediate key by decrypting the **encryptedKeyValue** from a **KeyEncryptor** contained within the **KeyEncryptors** sequence. Use this key for encryption operations in the remaining steps of this section. + +2. Generate a random array of bytes, known as **Salt**, of the same length as the value of the **KeyData.saltSize** attribute. + +3. Encrypt the random array of bytes generated in step 2 by using the binary form of the **KeyData.saltValue** attribute and a **blockKey** byte array consisting of the following bytes: 0x5f, 0xb2, 0xad, 0x01, 0x0c, 0xb9, 0xe1, and 0xf6 used to form an initialization vector as specified in section [2.3.4.12](#Section_11672b8cb9f04bb79b2d3f1695286436). If the array of bytes is not an integral multiple of **blockSize** bytes, pad the array with 0x00 to the next integral multiple of **blockSize** bytes. + +4. Assign the **encryptedHmacKey** attribute to the base64-encoded form of the result of step 3. + +5. Generate an [**HMAC**](#gt_ba024019-a866-41df-99a5-764b7eab2e1e), as specified in [\[RFC2104\]](https://go.microsoft.com/fwlink/?LinkId=90314), of the encrypted form of the data (message), which the **DataIntegrity** element will verify by using the **Salt** generated in step 2 as the key. Note that the entire **EncryptedPackage** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6), including the **StreamSize** field, MUST be used as the message. + +6. Encrypt the HMAC as in step 3 by using a **blockKey** byte array consisting of the following bytes: 0xa0, 0x67, 0x7f, 0x02, 0xb2, 0x2c, 0x84, and 0x33. + +7. Assign the **encryptedHmacValue** attribute to the base64-encoded form of the result of step 6. + +#### Data Encryption (Agile Encryption) + +The **EncryptedPackage** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST be encrypted in 4096-byte segments to facilitate nearly random access while allowing [**CBC**](#gt_5d31e40d-bc6a-4813-8087-056aaafa4f01) modes to be used in the encryption process. + +The initialization vector for the encryption process MUST be obtained by using the zero-based segment number as a **blockKey** and the binary form of the **KeyData.saltValue** as specified in section [2.3.4.12](#Section_11672b8cb9f04bb79b2d3f1695286436). The block number MUST be represented as a 32-bit unsigned integer. + +Data blocks MUST then be encrypted by using the initialization vector and the intermediate key obtained by decrypting the **encryptedKeyValue** from a **KeyEncryptor** contained within the **KeyEncryptors** sequence as specified in section [2.3.4.10](#Section_87020a34e73f413999bcbbdf6cf6fa55). The final data block MUST be padded to the next integral multiple of the **KeyData.blockSize** value. Any padding bytes can be used. Note that the **StreamSize** field of the **EncryptedPackage** stream (1) specifies the number of bytes of unencrypted data as specified in section [2.3.4.4](#Section_b60c8b352db24409871059d88a793f83). + +### Office Binary Document RC4 CryptoAPI Encryption + +The storages and [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) encrypted by Office binary document RC4 CryptoAPI encryption are specified in the documentation for the relevant application; for more information see [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22), [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06), and [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662). The following subsections specify the structures and key generation methods used by the application. + +#### RC4 CryptoAPI Encryption Header + +The encryption header structure used for RC4 CryptoAPI encryption is specified as shown in the following diagram. + +[TABLE] + +**EncryptionVersionInfo (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)) that specifies the encryption version used to create the document and the encryption version required to open the document. **Version.vMajor** MUST be 0x0002, 0x0003, or 0x0004[\<23\>](#Appendix_A_23) and **Version.vMinor** MUST be 0x0002. + +**EncryptionHeader.Flags (4 bytes):** A copy of the **Flags** stored in the **EncryptionHeader** structure (section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f)) that is stored in this [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +**EncryptionHeaderSize (4 bytes):** An unsigned integer that specifies the size, in bytes, of the **EncryptionHeader** structure. + +**EncryptionHeader (variable):** An **EncryptionHeader** structure (section 2.3.2) used to encrypt the structure. The values MUST be set as described in the following table. + +| Field | Value | +|----|----| +| **Flags** | The **fCryptoAPI** bit MUST be set. The **fDocProps** bit MUST be set if the document properties are not encrypted. | +| **SizeExtra** | MUST be 0x00000000. | +| **AlgID** | MUST be 0x00006801 (RC4 encryption). | +| **AlgIDHash** | MUST be 0x00008004 (SHA-1). | +| **KeySize** | MUST be greater than or equal to 0x00000028 bits and less than or equal to 0x00000080 bits, in increments of 8 bits. If set to 0x00000000, it MUST be interpreted as 0x00000028 bits. It MUST be compatible with the chosen cryptographic service provider (CSP). | +| **ProviderType** | MUST be 0x00000001. | +| **Reserved1** | Undefined and MUST be ignored. | +| **Reserved2** | MUST be 0x00000000 and MUST be ignored. | +| **CSPName** | MUST be set to a recognized CSP name that supports RC4 and SHA-1 algorithms with a key length compatible with the **KeySize** field value.[\<24\>](#Appendix_A_24) | + +**EncryptionVerifier (variable):** An **EncryptionVerifier** structure as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6) that is generated as specified in section [2.3.5.5](#Section_3916b6b1fa384cd7b87978e1ddc6d670). + +#### RC4 CryptoAPI Encryption Key Generation + +The encryption key for RC4 CryptoAPI binary document encryption MUST be generated by using the following approach. + +Let H() be a hashing algorithm as determined by the **EncryptionHeader.AlgIDHash** field, and a plus sign (+) represents concatenation. The password MUST be provided as an array of Unicode characters. + +Limitations on the length of the password and the characters used by the password are implementation-dependent. For details about behavior variations, see [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22), [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06), and [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662). Unless otherwise specified, the maximum password length MUST be 255 Unicode characters. + +The password hash is generated as follows: + +- H₀ = H(salt + password) + +The **salt** used MUST be generated randomly and MUST be 16 bytes in size. The **salt** MUST be stored in the **EncryptionVerifier.Salt** field as specified in section [2.3.4.5](#Section_2895eba1acb146249bde2cdad3fea015). Note that the hash MUST NOT be iterated. See section [4](#Section_98fd40b50dc04b92aca3cbe28c375e84) for additional notes. + +After the hash has been obtained, the encryption key MUST be generated by using the hash data and a block number that is provided by the application. The encryption algorithm MUST be specified in the **EncryptionHeader.AlgID** field. + +The method used to generate the hash data that is the input into the key derivation algorithm is as follows: + +- H_(final) = H(H₀ + block) + +The block number MUST be a 32-bit unsigned value provided by the application. + +Let **keyLength** be the key length, in bits, as specified by the RC4 CryptoAPI Encryption Header **KeySize** field. + +The first **keyLength** bits of H_(final) MUST be considered the derived encryption key, unless **keyLength** is exactly 40 bits long. An SHA-1 hash is 160 bits long, and the maximum RC4 key length is 128 bits; therefore, **keyLength** MUST be less than or equal to 128 bits. If **keyLength** is exactly 40 bits, the encryption key MUST be composed of the first 40 bits of H_(final) and 88 bits set to zero, creating a 128-bit key. + +#### RC4 CryptoAPI EncryptedStreamDescriptor Structure + +The RC4 CryptoAPI **EncryptedStreamDescriptor** structure specifies information about encrypted [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and storages contained within an RC4 CryptoAPI Encrypted Summary stream (1) as specified in section [2.3.5.4](#Section_032c21fb1dd942d68440f7d74baa21e7). It is specified as shown in the following diagram. + +[TABLE] + +**StreamOffset (4 bytes):** An unsigned integer that specifies the offset, in bytes, within the summary stream (1) where the encrypted stream (1) is written. + +**StreamSize (4 bytes):** An unsigned integer that specifies the size, in bytes, of the encrypted stream (1). + +**Block (2 bytes):** An unsigned integer that specifies the block number used to derive the encryption key for this encrypted stream (1). + +**NameSize (1 byte):** An unsigned integer that specifies the number of characters used by the **StreamName** field, not including the terminating NULL character. + +**A – fStream (1 bit):** A value that MUST be 1 if the encrypted data is a stream (1). It MUST be 0 if the encrypted data is a storage. + +**B – Reserved1 (1 bit):** A value that MUST be 0 and MUST be ignored. + +**Unused (6 bits):** A value that MUST be ignored. + +**Reserved2 (4 bytes):** A value that MUST be ignored. + +**StreamName (variable):** A null-terminated Unicode string specifying the name of the stream (1) (or storage) stored within the encrypted summary stream (1). + +#### RC4 CryptoAPI Encrypted Summary Stream + +When RC4 CryptoAPI encryption is used, an encrypted summary [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MAY[\<25\>](#Appendix_A_25) be created. The name of the stream (1) MUST be specified by the application. If the encrypted summary stream (1) is present, the **\0x05DocumentSummaryInformation** stream (1) MUST be present, MUST conform to the details as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.3.3.2, and MUST contain no properties. The **\0x05SummaryInformation** stream (1) MUST NOT be present. + +For details about the contents of the **\0x05SummaryInformation** and **\0x05DocumentSummaryInformation** streams (1), see \[MS-OSHARED\] section 2.3.3.2.1 and \[MS-OSHARED\] section 2.3.3.2.2. + +For brevity, this section refers to the RC4 CryptoAPI Encrypted Summary stream (1) as the *encrypted summary* stream (1). + +The stream (1) MUST have the format that is shown in the following diagram. + +[TABLE] + +**StreamDescriptorArrayOffset (4 bytes):** An unsigned integer that specifies the offset within the encrypted summary stream (1) where the **EncryptedStreamDescriptorCount** structure is found. + +**StreamDescriptorArraySize (4 bytes):** An unsigned integer that specifies the number of bytes used by the **EncryptedStreamDescriptorArray** structure. + +**EncryptedStreamData (variable):** One or more encrypted streams (1) stored within the encrypted summary stream (1). + +**EncryptedStreamDescriptorCount (4 bytes):** An encrypted unsigned integer specifying the count of **EncryptedStreamDescriptor** structures (section [2.3.5.3](#Section_b13d4d2869b24ba0884e44449be17884)). + +**EncryptedStreamDescriptorArray (variable):** One or more **EncryptedStreamDescriptor** structures that specify the offsets and names of the encrypted streams (1) and storages contained within the encrypted summary stream (1). + +The encrypted summary stream (1) MUST be written as specified in the following steps: + +1. Seek forward from the start of the encrypted summary stream (1) by 8 bytes to provide space for the **StreamDescriptorArrayOffset** and **StreamDescriptorArraySize** fields, which will be written in step 8. Let **BlockNumber** initially be 0x00000000. + +2. If additional streams (1) or storages are provided by the application, for each stream (1) or storage the following steps MUST be performed: + + 1. If the data is contained within a stream (1), retrieve the contents of the stream (1). Initialize the encryption key as specified in section [2.3.5.2](#Section_12ec1195af2d44e68c73003e79e635d5), using a block number of 0x00000000, and encrypt the stream (1) data. Write the encrypted bytes into the encrypted summary stream (1). + + 2. If the data is contained within a storage, convert the storage into a file as specified in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). Initialize the encryption key as specified in section 2.3.5.2, using a block number of **BlockNumber**, and encrypt the storage data as a stream (1) of bytes. Write the encrypted bytes into the encrypted summary stream (1). + + 3. Set the fields within the associated **EncryptedStreamDescriptor** for the stream (1) or storage. Do not write it to the encrypted summary stream (1) yet. + + 4. Increment **BlockNumber**. + +3. Generate or retrieve the entire contents of the **\0x05SummaryInformation** stream (1). Initialize the encryption key as specified in section 2.3.5.2, using a block number of **BlockNumber**, and encrypt the **\0x05SummaryInformationStream** data. Write the encrypted bytes into the encrypted summary stream (1). Increment **BlockNumber**. + +4. Set the fields within the associated **EncryptedStreamDescriptor** for the **\0x05SummaryInformation** stream (1). Do not write it to the encrypted summary stream (1) yet. + +5. Generate or retrieve data contained within the **\0x05DocumentSummaryInformation** stream (1). Initialize the encryption key as specified in section 2.3.5.2, using a block number of **BlockNumber**, and encrypt the **\0x05DocumentSummaryInformationStream** data. Write the encrypted bytes into the encrypted summary stream (1) immediately following the data written in step 2. + +6. Set the fields within the associated **EncryptedStreamDescriptor** for the **\0x05DocumentSummaryInformation** stream (1). Do not write it to the encrypted summary stream (1) yet. + +7. Write the **EncryptedStreamDescriptorCount** and **EncryptedStreamDescriptorArray** by initializing the encryption key as specified in section 2.3.5.2, using a block number of 0x00000000. Concatenate and encrypt the **EncryptedStreamDescriptorCount** and the **EncryptedStreamDescriptor**. Write the encrypted bytes into the encrypted summary stream (1). + +8. Initialize the **StreamDescriptorArrayOffset** and **StreamDescriptorArraySize** fields to specify the encrypted location of the **EncryptedStreamDescriptorCount** and size of the **EncryptedStreamDescriptorCount** and **EncryptedStreamDescriptorArray** within the encrypted summary stream (1). Initialize the encryption key as specified in section 2.3.5.2, using a block number of 0x00000000. + +#### Password Verifier Generation + +The password verifier uses an **EncryptionVerifier** structure, as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6). The password verifier **Salt** field MUST be populated with the salt created during password key generation, as specified in section [2.3.5.2](#Section_12ec1195af2d44e68c73003e79e635d5). An additional 16-byte verifier is then hashed using the SHA-1 hashing algorithm specified in the encryption header structure, and encrypted using the key generated in section 2.3.5.2, with a block number of 0x00000000. + +#### Password Verification + +The password verification process is specified by the following steps: + +1. Generate an encryption key as specified in section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6), using a block number of 0x00000000. + +2. Decrypt the **EncryptedVerifier** field of the **EncryptionVerifier** structure to obtain the **Verifier** value. The resulting **Verifier** value MUST be an array of 16 bytes. + +3. Decrypt the **EncryptedVerifierHash** field of the **EncryptionVerifier** structure to obtain the hash of the **Verifier** value. The number of bytes used by the encrypted **Verifier** hash MUST be 20. + +4. Calculate the SHA-1 hash value of the **Verifier** value calculated in step 2. + +5. Compare the results of step 3 and step 4. If the two hash values do not match, the password is incorrect. + +The RC4 decryption [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST NOT be reset between the two decryption operations specified in steps 2 and 3. + +### Office Binary Document RC4 Encryption + +Office binary document RC4 encryption does not alter the storages and [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) used. If a stream (1) is encrypted, it is encrypted in place. The following subsections specify the structures and key generation methods used by the application. + +#### RC4 Encryption Header + +The encryption header used for RC4 encryption is specified as shown in the following diagram. + +[TABLE] + +**EncryptionVersionInfo (4 bytes):** A **Version** structure (section [2.1.4](#Section_122d11d99aff47bd8ae82996bdda3bdd)), where **Version.vMajor** MUST be 0x0001 and **Version.vMinor** MUST be 0x0001. + +**Salt (16 bytes):** A randomly generated array of bytes that specifies the salt value used during password hash generation. It MUST NOT be the same data used for the verifier stored encrypted in the **EncryptedVerifier** field. + +**EncryptedVerifier (16 bytes):** An additional 16-byte verifier encrypted using a 40-bit RC4 cipher initialized as specified in section [2.3.6.2](#Section_09a537cc44ba4ffeaf8ae1c866ed4221), with a block number of 0x00000000. + +**EncryptedVerifierHash (16 bytes):** A 40-bit RC4 encrypted [**MD5**](#gt_1535fdac-8d46-4605-96af-252907c4a593) hash of the verifier used to generate the **EncryptedVerifier** field. + +#### Encryption Key Derivation + +The encryption key for Office binary document RC4 encryption is generated by using the following method: Let H() be the MD5 hashing algorithm, H_(n) be the hash data of the n^(th) iteration, and a plus sign (+) represent concatenation. The password MUST be provided as an array of Unicode characters. + +Limitations on the length of the password and the characters used by the password are implementation-dependent. For details about behavior variations, see [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) and [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06). Unless otherwise specified, the maximum password length MUST be 255 Unicode characters. + +The initial password hash is generated as follows. + +- H₀ = H(password) + +The salt used MUST be generated randomly and MUST be 16 bytes in size. The salt MUST be stored in the **Salt** field of the **RC4 Encryption Header** structure (section [2.3.6.1](#Section_76aeedb04d59487f8bd8fb6860a60df7)). The hash is then computed by using the following approach: + +1. Let **TruncatedHash** be the first 5 bytes of H₀. + +2. Let **IntermediateBuffer** be a 336-byte buffer. + +3. Form a 21-byte buffer by concatenating **TruncatedHash** plus the salt. Initialize **IntermediateBuffer** by copying the 21-byte buffer into **IntermediateBuffer** a total of 16 times. + +4. Use the following: H₁ = H(IntermediateBuffer). + +After the final hash has been obtained, the encryption key MUST be generated by using the first 5 bytes of the final hash data and a block number that is provided by the application. The encryption algorithm MUST be RC4. The method used to generate the hash data that is the input into the key derivation algorithm is the following: + +- Let **TruncatedHash** be the first 5 bytes of H₁. + +- Use the following: H_(final) equals H(TruncatedHash + block). + +The block number MUST be a 32-bit unsigned value provided by the application. + +The first 128 bits of H_(final) MUST then be used as the derived encryption key. + +#### Password Verifier Generation + +The password verifier uses a **RC4 Encryption Header** structure, as specified in section [2.3.6.1](#Section_76aeedb04d59487f8bd8fb6860a60df7). The password verifier **Salt** field MUST be populated with the salt created during password key generation, as specified in section [2.3.6.2](#Section_09a537cc44ba4ffeaf8ae1c866ed4221). An additional 16-byte verifier is then hashed by using the MD5 hashing algorithm and encrypted by using the key generated in section 2.3.6.2, with a block number of 0x00000000. + +The RC4 decryption [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST NOT be reset between decrypting **EncryptedVerifier** and **EncryptedVerifierHash**. + +#### Password Verification + +The password verification process is specified by the following steps: + +1. Generate an encryption key as specified in section [2.3.6.2](#Section_09a537cc44ba4ffeaf8ae1c866ed4221), using a block number of 0x00000000. + +2. Decrypt the **EncryptedVerifier** field of the RC4 Encryption Header structure to obtain the **Verifier** value. The resulting **Verifier** value MUST be an array of 16 bytes. + +3. Decrypt the **EncryptedVerifierHash** field of the RC4 Encryption Header structure to obtain the hash of the **Verifier** value. The number of bytes used by the encrypted **Verifier** hash MUST be 16. + +4. Calculate the MD5 hash value of the results of step 2. + +5. Compare the results of step 3 and step 4. If the two hash values do not match, the password is incorrect. + +The RC4 decryption [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST NOT be reset between decrypting **EncryptedVerifier** and **EncryptedVerifierHash**. + +### XOR Obfuscation + +XOR obfuscation is supported for backward compatibility with older file formats. + +#### Binary Document Password Verifier Derivation Method 1 + +The **CreatePasswordVerifier_Method1** procedure specifies how a 16-bit password verifier is obtained from an ASCII password string. The password verifier is used in XOR obfuscation as well as for document write protection. + +The **CreatePasswordVerifier_Method1** procedure takes the following parameter: + +- **Password:** An ASCII string that specifies the password to be used when generating the verifier. + +180. FUNCTION CreatePasswordVerifier_Method1 + +     PARAMETERS Password + +     RETURNS 16-bit unsigned integer + + DECLARE Verifier AS 16-bit unsigned integer + + DECLARE PasswordArray AS array of 8-bit unsigned integers + +     SET Verifier TO 0x0000 + +     SET PasswordArray TO (empty array of bytes) + +     SET PasswordArray\[0\] TO Password.Length + +     APPEND Password TO PasswordArray + +     FOR EACH PasswordByte IN PasswordArray IN REVERSE ORDER + +        IF (Verifier BITWISE AND 0x4000) is 0x0000 + +           SET Intermediate1 TO 0 + +        ELSE + +           SET Intermediate1 TO 1 + +        ENDIF + +        SET Intermediate2 TO Verifier MULTIPLED BY 2 + +        SET most significant bit of Intermediate2 TO 0 + +        SET Intermediate3 TO Intermediate1 BITWISE OR Intermediate2 + +        SET Verifier TO Intermediate3 BITWISE XOR PasswordByte + +     ENDFOR + +     RETURN Verifier BITWISE XOR 0xCE4B + + END FUNCTION + +For more information, see section [4](#Section_98fd40b50dc04b92aca3cbe28c375e84). + +#### Binary Document XOR Array Initialization Method 1 + +The **CreateXorArray_Method1** procedure specifies how a 16-byte XOR obfuscation array is initialized. The procedure takes the following parameter: + +- **Password:** An ASCII string that specifies the password to be used to encrypt the data. *Password* MUST NOT be longer than 15 characters. + +208. SET PadArray TO ( 0xBB, 0xFF, 0xFF, 0xBA, 0xFF, 0xFF, 0xB9, 0x80, + + 0x00, 0xBE, 0x0F, 0x00, 0xBF, 0x0F, 0x00 ) + + SET InitialCode TO ( 0xE1F0, 0x1D0F, 0xCC9C, 0x84C0, 0x110C, + + 0x0E10, 0xF1CE, 0x313E, 0x1872, 0xE139, + + 0xD40F, 0x84F9, 0x280C, 0xA96A, 0x4EC3 ) + + SET XorMatrix TO ( 0xAEFC, 0x4DD9, 0x9BB2, 0x2745, 0x4E8A, 0x9D14, 0x2A09, + + 0x7B61, 0xF6C2, 0xFDA5, 0xEB6B, 0xC6F7, 0x9DCF, 0x2BBF, + + 0x4563, 0x8AC6, 0x05AD, 0x0B5A, 0x16B4, 0x2D68, 0x5AD0, + + 0x0375, 0x06EA, 0x0DD4, 0x1BA8, 0x3750, 0x6EA0, 0xDD40, + + 0xD849, 0xA0B3, 0x5147, 0xA28E, 0x553D, 0xAA7A, 0x44D5, + + 0x6F45, 0xDE8A, 0xAD35, 0x4A4B, 0x9496, 0x390D, 0x721A, + + 0xEB23, 0xC667, 0x9CEF, 0x29FF, 0x53FE, 0xA7FC, 0x5FD9, + + 0x47D3, 0x8FA6, 0x0F6D, 0x1EDA, 0x3DB4, 0x7B68, 0xF6D0, + + 0xB861, 0x60E3, 0xC1C6, 0x93AD, 0x377B, 0x6EF6, 0xDDEC, + + 0x45A0, 0x8B40, 0x06A1, 0x0D42, 0x1A84, 0x3508, 0x6A10, + + 0xAA51, 0x4483, 0x8906, 0x022D, 0x045A, 0x08B4, 0x1168, + + 0x76B4, 0xED68, 0xCAF1, 0x85C3, 0x1BA7, 0x374E, 0x6E9C, + + 0x3730, 0x6E60, 0xDCC0, 0xA9A1, 0x4363, 0x86C6, 0x1DAD, + + 0x3331, 0x6662, 0xCCC4, 0x89A9, 0x0373, 0x06E6, 0x0DCC, + + 0x1021, 0x2042, 0x4084, 0x8108, 0x1231, 0x2462, 0x48C4 ) + + FUNCTION CreateXorArray_Method1 + + PARAMETERS Password + + RETURNS array of 8-bit unsigned integers + + DECLARE XorKey AS 16-bit unsigned integer + + DECLARE ObfuscationArray AS array of 8-bit unsigned integers + + SET XorKey TO CreateXorKey_Method1(Password) + + SET Index TO Password.Length + + SET ObfuscationArray TO (0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) + + IF Index MODULO 2 IS 1 + + SET Temp TO most significant byte of XorKey + + SET ObfuscationArray\[Index\] TO XorRor(PadArray\[0\], Temp) + + DECREMENT Index + + SET Temp TO least significant byte of XorKey + + SET PasswordLastChar TO Password\[Password.Length MINUS 1\] + + SET ObfuscationArray\[Index\] TO XorRor(PasswordLastChar, Temp) + + END IF + + WHILE Index IS GREATER THAN to 0 + + DECREMENT Index + + SET Temp TO most significant byte of XorKey + + SET ObfuscationArray\[Index\] TO XorRor(Password\[Index\], Temp) + + DECREMENT Index + + SET Temp TO least significant byte of XorKey + + SET ObfuscationArray\[Index\] TO XorRor(Password\[Index\], Temp) + + END WHILE + + SET Index TO 15 + + SET PadIndex TO 15 MINUS Password.Length + + WHILE PadIndex IS greater than 0 + + SET Temp TO most significant byte of XorKey + + SET ObfuscationArray\[Index\] TO XorRor(PadArray\[PadIndex\], Temp) + + DECREMENT Index + + DECREMENT PadIndex + + SET Temp TO least significant byte of XorKey + + SET ObfuscationArray\[Index\] TO XorRor(PadArray\[PadIndex\], Temp) + + DECREMENT Index + + DECREMENT PadIndex + + END WHILE + + RETURN ObfuscationArray + + END FUNCTION + + FUNCTION CreateXorKey_Method1 + + PARAMETERS Password + + RETURNS 16-bit unsigned integer + + DECLARE XorKey AS 16-bit unsigned integer + + SET XorKey TO InitialCode\[Password.Length MINUS 1\] + + SET CurrentElement TO 0x00000068 + + FOR EACH Char IN Password IN REVERSE ORDER + + FOR 7 iterations + + IF (Char BITWISE AND 0x40) IS NOT 0 + + SET XorKey TO XorKey BITWISE XOR XorMatrix\[CurrentElement\] + + END IF + + SET Char TO Char MULTIPLIED BY 2 + + DECREMENT CurrentElement + + END FOR + + END FOR + + RETURN XorKey + + END FUNCTION + + FUNCTION XorRor + + PARAMETERS byte1, byte2 + + RETURNS 8-bit unsigned integer + + RETURN Ror(byte1 XOR byte2) + + END FUNCTION + + FUNCTION Ror + + PARAMETERS byte + + RETURNS 8-bit unsigned integer + + SET temp1 TO byte DIVIDED BY 2 + + SET temp2 TO byte MULTIPLIED BY 128 + + SET temp3 TO temp1 BITWISE OR temp2 + + RETURN temp3 MODULO 0x100 + + END FUNCTION + +#### Binary Document XOR Data Transformation Method 1 + +Data transformed by Binary Document XOR Data Transformation Method 1 for encryption MUST be as specified in the **EncryptData_Method1** procedure. This procedure takes the following parameters: + +- **Password:** An ASCII string that specifies the password to be used to encrypt the data. + +- **Data:** An array of unsigned 8-bit integers that specifies the data to be encrypted. + +- **XorArrayIndex:** An unsigned integer that specifies the initial index into the XOR obfuscation array to be used. + +326. FUNCTION EncryptData_Method1 + + PARAMETERS Password, Data, XorArrayIndex + + DECLARE XorArray as array of 8-bit unsigned integers + + SET XorArray TO CreateXorArray_Method1(Password) + + FOR Index FROM 0 TO Data.Length + + SET Value TO Data\[Index\] + + SET Value TO (Value rotate left 5 bits) + + SET Value TO Value BITWISE XOR XorArray\[XorArrayIndex\] + + SET DATA\[Index\] TO Value + + INCREMENT XorArrayIndex + + SET XorArrayIndex TO XorArrayIndex MODULO 16 + + END FOR + + END FUNCTION + +Data transformed by the Binary Document XOR Data Transformation Method 1 for decryption MUST be as specified in the **DecryptData_Method1** procedure. This procedure takes the following parameters: + +- **Password:** An ASCII string that specifies the password to be used to decrypt the data. + +- **Data:** An array of unsigned 8-bit integers that specifies the data to be decrypted. + +- **XorArrayIndex:** An unsigned integer that specifies the initial index into the XOR obfuscation array to be used. + +342. FUNCTION DecryptData_Method1 + + PARAMETERS Password, Data, XorArrayIndex + + DECLARE XorArray as array of 8-bit unsigned integers + + SET XorArray TO CreateXorArray_Method1(Password) + + FOR Index FROM 0 to Data.Length + + SET Value TO Data\[Index\] + + SET Value TO Value BITWISE XOR XorArray\[XorArrayIndex\] + + SET Value TO (Value rotate right 5 bits) + + SET Data\[Index\] TO Value + + INCREMENT XorArrayIndex + + SET XorArrayIndex TO XorArrayIndex MODULO 16 + + END FOR + + END FUNCTION + +#### Binary Document Password Verifier Derivation Method 2 + +The **CreatePasswordVerifier_Method2** procedure specifies how a 32-bit password verifier is obtained from a string of single-byte characters that has been transformed from a Unicode string. The password verifier is used in XOR obfuscation. + +Two different approaches exist for preprocessing the password string to convert it from Unicode to single-byte characters: + +- Using the current [**language code identifier (LCID)**](#gt_c7f99c66-592f-4053-b62a-878c189653b6), convert Unicode input into an ANSI string, as specified in [\[MS-UCODEREF\]](%5bMS-UCODEREF%5d.pdf#Section_4a045e08fc294f22baf416f38c2825fb). Truncate the resulting string to 15 single-byte characters. + +- For each input Unicode character, copy the least significant byte into the single-byte string, unless the least significant byte is 0x00. If the least significant byte is 0x00, copy the most significant byte. Truncate the resulting string to 15 characters. + +When writing files, the second approach MUST be used. When reading files, both methods MUST be tried, and the password MUST be considered correct if either approach results in a match. + +The **CreatePasswordVerifier_Method2** procedure takes the following parameter: + +- **Password:** A string of single-byte characters that specifies the password to be used to encrypt the data. *Password* MUST NOT be longer than 15 characters. *Password* MUST be transformed from Unicode to single-byte characters by using the method specified in this section. + +358. FUNCTION CreatePasswordVerifier_Method2 + + PARAMETERS Password + + RETURNS 32-bit unsigned integer + + DECLARE Verifier as 32-bit unsigned integer + + DECLARE KeyHigh as 16-bit unsigned integer + + DECLARE KeyLow as 16-bit unsigned integer + + SET KeyHigh TO CreateXorKey_Method1(Password) + + SET KeyLow TO CreatePasswordVerifier_Method1(Password) + + SET most significant 16 bits of Verifier TO KeyHigh + + SET least significant 16 bits of Verifier TO KeyLow + + RETURN Verifier + + END FUNCTION + +#### Binary Document XOR Array Initialization Method 2 + +The **CreateXorArray_Method2** procedure specifies how a 16-byte XOR obfuscation array is initialized. The procedure takes the following parameter: + +- **Password:** A string of single-byte characters that specifies the password to be used to encrypt the data. *Password* MUST NOT be longer than 15 characters. *Password* MUST be transformed from Unicode to single-byte characters by using the method specified in section [2.3.7.4](#Section_0752a14e70ed4965b8fb193223223445), which results in the password verifier matching. + +374. FUNCTION CreateXorArray_Method2 + + PARAMETERS Password + + RETURNS array of 8-bit unsigned integers + + DECLARE Verifier as 32-bit unsigned integer + + DECLARE VerifierHighWord as 16-bit unsigned integer + + DECLARE KeyHigh as 8-bit unsigned integer + + DECLARE KeyLow as 8-bit unsigned integer + + SET Verifier TO CreatePasswordVerifier_Method2(Password) + + SET VerifierHighWord TO 16 most significant bits of Verifier + + SET KeyHigh TO 8 most significant bits of VerifierHighWord + + SET KeyLow TO 8 least significant bits of VerifierHighWord + + SET PadArray TO (0xBB, 0xFF, 0xFF, 0xBA, 0xFF, 0xFF, 0xB9, 0x80, + + 0x00, 0xBE, 0x0F, 0x00, 0xBF, 0x0F, 0x00) + + SET ObfuscationArray TO (0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, + + 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00) + + SET Index TO 0 + + WHILE Index IS LESS THAN Password.Length + + SET ObfuscationArray\[Index\] TO Password\[Index\] + + INCREMENT Index + + END WHILE + + WHILE Index IS LESS THAN 16 + + SET ObfuscationArray\[Index\] TO PadArray\[Index MINUS Password.Length\] + + INCREMENT Index + + END WHILE + + SET Index TO 0 + + WHILE Index IS LESS THAN 16 + + SET Temp1 TO ObfuscationArray\[Index\] BITWISE XOR KeyLow + + SET ObfuscationArray\[Index\] TO Ror(Temp1) + + INCREMENT Index + + SET Temp1 TO ObfuscationArray\[Index\] BITWISE XOR KeyHigh + + SET ObfuscationArray\[Index\] TO Ror(Temp1) + + INCREMENT Index + + END WHILE + + RETURN ObfuscationArray + + END FUNCTION + +#### Binary Document XOR Data Transformation Method 2 + +Data transformed by Binary Document XOR data transformation method 2 takes the result of an XOR operation on each byte of input in sequence and the 16-byte XOR obfuscation array that is initialized as specified in section [2.3.7.2](#Section_72c141a75f274a608164448bed90546f), except when the byte of input is 0x00 or the binary XOR of the input and the obfuscation array element is 0x00, in which case the byte of input is not modified. When the end of the XOR obfuscation array is reached, start again at the beginning. + +#### Password Verification + +Calculate the password verifier for the applicable password verifier derivation method, as specified in section [2.3.7.1](#Section_fb2d125c10124999b5ef15a2bd4bec36) or section [2.3.7.4](#Section_0752a14e70ed4965b8fb193223223445), depending on the document type. Compare the derived password verifier with the password verifier stored in the file. If the two do not match, the password is incorrect. + +## Document Write Protection + +Document write protection is meant to discourage tampering with the file or sections of the file by users. See section [4.1.4](#Section_9ea31cee72834a82ac2f2051988070f0) for more information. + +Limitations on the length of the password and the characters used by the password are implementation-dependent. For more details about behavior variations, see [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) and [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06). Unless otherwise specified, the maximum password length MUST be 255 Unicode characters. + +### ECMA-376 Document Write Protection + +ECMA-376 document write protection [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) is as specified in \[ECMA-376\] Part 4 Sections 2.15.1.28, 2.15.1.94, 3.2.12, and 4.3.1.17.[\<26\>](#Appendix_A_26) + +### Binary Document Write Protection + +#### Binary Document Write Protection Method 1 + +Binary documents that conform to the file format as specified in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) MUST store the write protection password in the file in plaintext as specified in \[MS-DOC\] section 2.9.276. + +#### Binary Document Write Protection Method 2 + +Binary documents that conform to the file format as specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) MUST store the write protection password verifier in the file, as specified in \[MS-XLS\] section 2.2.9 and created by using the method specified in section [2.3.7.1](#Section_fb2d125c10124999b5ef15a2bd4bec36). When a binary document using write protection method 2 is write protected, the document can also be encrypted by using one of the methods specified in section [2.3](#Section_e47faaedee584309903388b342df5469).[\<27\>](#Appendix_A_27) + +#### Binary Document Write Protection Method 3 + +Binary documents that conform to the file format as specified in [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) MUST store the write protection password in the file in plaintext, as specified in \[MS-PPT\] section 2.4.7. When a binary document using write protection method 3 is write protected, it SHOULD NOT[\<28\>](#Appendix_A_28) also be encrypted by using one of the methods specified in section [2.3](#Section_e47faaedee584309903388b342df5469). + +If the user has not supplied an encryption password and the document is encrypted, the default encryption choice using the techniques specified in section 2.3 MUST be the following password: "\x2f\x30\x31\x48\x61\x6e\x6e\x65\x73\x20\x52\x75\x65\x73\x63\x68\x65\x72\x2f\x30\x31". + +#### ISO Write Protection Method + +Cases where binary documents use the following hashing algorithm, intended to be compatible with ISO/IEC 29500 (for more information, see [\[ISO/IEC29500-1:2011\]](https://go.microsoft.com/fwlink/?LinkId=252374)), are specified in [\[MS-XLSB\]](%5bMS-XLSB%5d.pdf#Section_acc8aa921f02416799f584f9f676b95a). The ISO password hashing algorithm takes the following parameters: + +- **Password:** An array of Unicode characters specifying the write protection password. The password MUST be a minimum of 1 and a maximum of 255 Unicode characters. + +**AlgorithmName:** A Unicode string specifying the name of the cryptographic hash algorithm used to compute the password hash value. The values in the following table are reserved. (Values that are not defined MAY[\<29\>](#Appendix_A_29) be used, and a compliant implementation is not required to support all defined values. The string MUST be at least 1 character. See section [4](#Section_98fd40b50dc04b92aca3cbe28c375e84) for additional information.) + +| Value | Hash algorithm | +|----|----| +| SHA-1 | MUST conform to the details as specified in [\[RFC4634\]](https://go.microsoft.com/fwlink/?LinkId=90486). | +| SHA-256 | MUST conform to the details as specified in \[RFC4634\]. | +| SHA-384 | MUST conform to the details as specified in \[RFC4634\]. | +| SHA-512 | MUST conform to the details as specified in \[RFC4634\]. | +| MD5 | MUST conform to [**MD5**](#gt_1535fdac-8d46-4605-96af-252907c4a593). | +| MD4 | MUST conform to the details as specified in [\[RFC1320\]](https://go.microsoft.com/fwlink/?LinkId=90274). | +| MD2 | MUST conform to the details as specified in [\[RFC1319\]](https://go.microsoft.com/fwlink/?LinkId=90273). | +| RIPEMD-128 | MUST conform to the details as specified in [\[ISO/IEC 10118\]](https://go.microsoft.com/fwlink/?LinkID=141969&clcid=0x409). | +| RIPEMD-160 | MUST conform to the details as specified in \[ISO/IEC 10118\]. | +| WHIRLPOOL | MUST conform to the details as specified in \[ISO/IEC 10118\]. | + +- **Salt:** An array of bytes that specifies the [**salt**](#gt_1672c769-f184-404a-9575-e637fd3a43ed) value used during password hash generation. When computing hashes for new passwords, this MUST be generated using an arbitrary pseudorandom function. When verifying a password, the salt value retrieved from the document MUST be used. The salt MUST NOT be larger than 65,536 bytes. + +- **SpinCount:** A 32-bit unsigned integer that specifies the number of times to iterate on a hash of a password. It MUST NOT be greater than 10,000,000. + +Let H() be an implementation of the hashing algorithm specified by **AlgorithmName**, iterator be an unsigned 32-bit integer, H_(n) be the hash data of the n^(th) iteration, and a plus sign (+) represent concatenation. The initial password hash is generated as follows. + +- H₀ = H(salt + password) + +The hash is then iterated using the following approach. + +- H_(n) = H(H_(n-1) + iterator) + +where **iterator** is initially set to 0 and is incremented monotonically on each iteration until **SpinCount** iterations have been performed. The value of **iterator** on the last iteration MUST be one less than **SpinCount**. The final hash is then H_(final) = H_(SpinCount-1). + +## Binary Document Digital Signatures + +This section specifies the process used to create and store digital signatures within Office binary documents, and it specifies XML Advanced Electronic Signatures [\[XAdES\]](https://go.microsoft.com/fwlink/?LinkId=151586) support for all documents using xmldsig digital signatures. There are two digital signature formats. The first is referred to as a CryptoAPI digital signature, and the second is referred to as an xmldsig digital signature. + +The process used by ECMA-376 documents [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) for xmldsig digital signatures is very similar to the process used by xmldsig digital signatures when applied to Office binary documents, as specified in \[ECMA-376\] Part 2 Section 12. Both document types use an XML signature format as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861). For details about a schema reference, see \[ECMA-376\] Part 2 Section 12.2.4. + +### CryptoAPI Digital Signature Structures and Streams + +#### TimeEncoding Structure + +The **TimeEncoding** structure specifies a date and time in [**Coordinated Universal Time (UTC)**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7), with the most significant 32 bits and the least significant 32 bits of the structure swapped. To be processed as a valid UTC time, **HighDateTime** and **LowDateTime** MUST be assigned to a **FILETIME** structure as specified in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2). Because of the reverse ordering, the **HighDateTime** field MUST be assigned to the **dwHighDateTime** field of the **FILETIME** structure, and the **LowDateTime** field MUST be assigned to the **dwLowDateTime** field of the **FILETIME** structure. After the **HighDateTime** and **LowDateTime** fields are correctly assigned to a **FILETIME** structure, the UTC time can be obtained. + +[TABLE] + +**HighDateTime (4 bytes):** An unsigned integer specifying the high order 32 bits of a **UTCTime**. + +**LowDateTime (4 bytes):** An unsigned integer specifying the low order 32 bits of a **UTCTime**. + +#### CryptoAPI Digital Signature CertificateInfo Structure + +The **CertificateInfo** structure has the format that is shown in the following diagram. + +[TABLE] + +**CertificateInfoSize (4 bytes):** An unsigned integer specifying the number of bytes used by the remainder of this structure, not including **CertificateInfoSize**. + +**SignerLength (4 bytes):** An unsigned integer specifying the number of characters needed to store the **SignerName** field, not including the terminating null character. + +**IssuerLength (4 bytes):** An unsigned integer specifying the number of characters needed to store the **IssuerName** field, not including the terminating null character. + +**ExpireTime (8 bytes):** A **TimeEncoding** structure (section [2.5.1.1](#Section_c22ab52261b543efb4eb5e23741bb0f9)) specifying the expiration time of this signature. + +**SignTime (8 bytes):** A **TimeEncoding** structure specifying the time this signature was created. + +**AlgIDHash (4 bytes):** A signed integer specifying the algorithm identifier. It MUST be 0x00008003 (MD5). + +**SignatureSize (4 bytes):** An unsigned integer specifying the number of bytes used by the **Signature** field. + +**EncodedCertificateSize (4 bytes):** An unsigned integer specifying the number of bytes used by the **EncodedCertificate** field. + +**Version (4 bytes):** A value that MUST be 0x00000000. + +**SerialNumberSize (4 bytes):** An unsigned integer specifying the number of bytes used by the **SerialNumber** field. + +**IssuerBlobSize (4 bytes):** An unsigned integer specifying the number of bytes used by the **IssuerBlob** field. + +**Reserved (4 bytes):** A value that MUST be 0x00000000. + +**SignerName (variable):** A null-terminated Unicode string specifying the name of the signer. + +**IssuerName (variable):** A null-terminated Unicode string specifying the name of the issuer. + +**Signature (variable):** A binary representation of the signature, generated as specified in [\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414), except stored in little-endian form. + +**EncodedCertificate (variable):** An encoded representation of the [**certificate**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879). MUST contain the ASN.1 [\[ITUX680-1994\]](https://go.microsoft.com/fwlink/?LinkId=120478) DER encoding of an X.509 certificate. For more details, see \[RFC3280\]. + +**SerialNumber (variable):** An array of bytes specifying the serial number of the certificate as specified in \[RFC3280\], with the least significant byte first. Any leading 0x00 bytes MUST be truncated. + +**IssuerBlob (variable):** An ASN.1 structure as specified in IETF \[RFC3280\] section 4.1.2.4. + +#### CryptoAPI Digital Signature Structure + +A CryptoAPI digital signature structure MUST contain exactly one **IntermediateCertificatesStore** and MUST contain at least one CryptoAPI Digital Signature **CertificateInfo** structure (section [2.5.1.2](#Section_60b19830f3864035b82974cebcb35371)). + +[TABLE] + +**CertificateSize (4 bytes):** An unsigned integer specifying the number of bytes in the **IntermediateCertificatesStore** field. + +**IntermediateCertificatesStore (variable):** A binary representation of the certificates in the certificate chains of the certificates used to sign the document, excluding the self-signed root CA certificates and end-entity certificates. This store is generated as specified in [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.3.9.1. + +**Reserved (4 bytes):** A value that MUST be 0x00000000. + +**CertificateInfoArray (variable):** An array that MUST contain a single **CertificateInfo** structure for every signature included in this [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +**EndMarker (4 bytes):** A value that MUST be 0x00000000. + +#### \\signatures Stream + +A binary document containing a CryptoAPI digital signature MUST have a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) named "\_signatures" in the root storage. The contents of the **\\signatures** stream (1) MUST contain exactly one CryptoAPI Digital Signature structure (section [2.5.1.3](#Section_3834d315b62f45888803597646686041)). + +#### CryptoAPI Digital Signature Generation + +The hash used to generate a document signature is created by recursively traversing the OLE compound file [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and storages. Certain streams (1) and storages MUST NOT be used, as specified later in this section. A document can have more than one signature, each of which MUST be generated by using the **GenerateSignature** function. Each individual [**certificate**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879) MUST be stored in the **CertificateInfoArray** of the CryptoAPI Digital Signature structure. + +Let H() be a hashing function, which MUST be **MD5**, and a plus sign (+) represent concatenation. Let **HashObject** be an object that can be initialized, that can append data in blocks into the object, and that can finalize to extract the resultant hash value H_(final). + +Let **ClsID** be the GUID identifier for an OLE compound file storage as specified in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). + +Let **TimeStamp** be a **FILETIME** structure as specified in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2), containing the current system time, expressed in Coordinated Universal Time (UTC). **TimeStamp** MUST be stored in the CryptoAPI Digital Signature Structure **SignTime** field, as specified in section [2.5.1.3](#Section_3834d315b62f45888803597646686041). + +Let **ExcludedStorages** be defined as follows: + +- 0x06DataSpaces + +- 0x05Bagaaqy23kudbhchAaq5u2chNd + +Let **ExcludedStreams** be defined as follows: + +- \_signatures + +- 0x09DRMContent + +418. FUNCTION GenerateSignature + + PARAMETERS Storage, Certificate + + RETURNS Signature + + CALL HashObject.Initialize + + CALL GenerateSignatureHash(Storage, HashObject, IsFiltered, AppFilter) + + SET Hdata TO HashObject.Finalize + + SET Hfinal TO H(Hdata + TimeStamp) + + SET Signature TO RFC3447(Hfinal, Certificate) + + RETURN Signature + + END FUNCTION + +In the **GenerateSignatureHash** function, **IsFiltered** MUST be **true** if the document conforms to the details as specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) and the stream (1) name is "Workbook" or if the document conforms to the details as specified in [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) and the stream (1) name is "Current User". It MUST be **false** for all other document types and streams (1). + +For documents that conform to the details as specified in \[MS-XLS\], let **AppFilter** be defined as the process specified in \[MS-XLS\] section 2.1.7.15, which appends data to **HashObject**, excluding a portion of the stream (1) from being used in the hashing operation. + +For documents that conform to the details as specified in \[MS-PPT\], let **AppFilter** be defined as a process that returns without appending data to **HashObject**. The result is that the name of the **CurrentUser** stream (1) MUST be appended to the **HashObject**, but the data contained within the **CurrentUser** stream (1) MUST NOT be appended to the **HashObject**. + +When stream (1) or storage names are appended to a **HashObject**, the terminating Unicode null character MUST NOT be included. + +Let **SORT** be a string sorting method that is case sensitive and ascending and that skips any nonprintable characters, such that if two streams (1) named "Data" and "0x05DocumentSummaryInformation" are input, the stream (1) named "Data" is ordered first. + +429. FUNCTION GenerateSignatureHash + +     PARAMETERS Storage, HashObject, IsFiltered, AppFilter + +     RETURNS VOID + + DECLARE StorageNameArray as (empty array of Unicode strings) + + DECLARE StreamNameArray as (empty array of Unicode strings) + +     SET ClsID TO Storage.GUID + + CALL HashObject.AppendData(ClsID) + + FOR EACH Child IN Storage.Children + + IF Child IS a storage AND Child.Name NOT IN ExcludedStorages + + APPEND Child.Name to StorageNameArray + + END IF + + IF Child IS a stream AND Child.Name NOT IN ExcludedStreams + + APPEND Child.Name to StreamNameArray + + END IF + + END FOR + + SORT StorageNameArray SORT StreamNameArray + + FOR EACH StreamName IN StreamNameArray + + CALL HashObject.AppendData(StreamName) + + SET ChildStream TO Storage.Children\[StreamName\] + + IF IsFiltered IS true + + CALL AppFilter(ChildStream, HashObject) + + ELSE + + CALL HashObject.AppendData(ChildStream.Data) + + ENDIF + + ENDFOR + + FOR EACH StorageName IN StorageNameArray + + CALL HashObject.AppendData(StorageName) + + SET ChildStorage TO Storage.Children\[StorageName\] + + CALL GenerateSignatureHash(ChildStorage, HashObject, IsFiltered, AppFilter) + + END FOR + + END FUNCTION + +When signing H_(final), the certificate MUST be an RSA certificate as specified in [\[RFC3447\]](https://go.microsoft.com/fwlink/?LinkId=90422), and the signing operation MUST be performed as specified in \[RFC3447\] section 9.2. + +If a document is protected as specified in section [2.2](#Section_518785bca76d410eb6f29f6b6b077d23), the hash MUST be created by first appending the unencrypted form of the storage that is decrypted from the **0x09DRMContent** stream (1), followed by the entire original encrypted file storage with the **0x09DRMContent** stream (1) excluded as noted previously. + +### Xmldsig Digital Signature Elements + +A binary document digital signature is specified as containing the elements that are specified in the following subsections. If not explicitly stated in each subsection, the content of an element MUST be generated as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861). + +#### SignedInfo Element + +The **SignedInfo** element MUST contain the following elements: + +- **CanonicalizationMethod**, where the algorithm MUST be as specified in [\[Can-XML-1.0\]](https://go.microsoft.com/fwlink/?LinkId=120197). + +- **Reference**, where the [**URI**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95) attribute MUST be "#idPackageObject", and **DigestMethod** is provided by the application.[\<30\>](#Appendix_A_30) + +- **Reference**, where the URI attribute MUST be "#idOfficeObject", and **DigestMethod** is provided by the application.[\<31\>](#Appendix_A_31) + +#### SignatureValue Element + +The **SignatureValue** element contains the value of the signature, as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861). + +#### KeyInfo Element + +The **KeyInfo** element contains the key information, as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861). + +#### idPackageObject Object Element + +The **idPackageObject** element contains the following: + +- A **Manifest** element as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861), which contains **Reference** elements corresponding to each [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that is signed. Except for streams (1) and storages enumerated later in this section, all streams (1) and storages MUST be included in the **Manifest** element. **DigestMethod** is provided by the application.[\<32\>](#Appendix_A_32) + +- A **SignatureProperties** element containing a **SignatureProperty** element with a time stamp, as specified in [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) Part 2 Section 12.2.4.20. + +When constructing the **Manifest** element, the following storages and any storages or streams (1) contained within listed storages MUST be excluded: + +- 0x05Bagaaqy23kudbhchAaq5u2chNd + +- 0x06DataSpaces + +- Xmlsignatures + +- MsoDataStore + +The following streams (1) MUST also be excluded: + +- 0x09DRMContent + +- \_signatures + +- 0x05SummaryInformation + +- 0x05DocumentSummaryInformation + +If the document conforms to the details as specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06), and the name of the stream (1) is Workbook, the stream (1) MUST be filtered as specified in \[MS-XLS\] section 2.1.7.21. + +If the document conforms to the details as specified in [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662), the hash of the **CurrentUser** stream (1) MUST be calculated when verifying the signature as if the stream (1) were empty, which would be the result of hashing 0 bytes. + +#### idOfficeObject Object Element + +The **idOfficeObject** element contains the following: + +- A **SignatureProperties** element containing a **SignatureProperty** element, which MUST contain a **SignatureInfoV1** element that specifies the details of a digital signature in a document. The following XML Schema specifies the contents of the **SignatureProperty** element: + +470. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \\ + + \\ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \\ + + \ + + \ + + \ + + \ + + \\ + + \\ + + \\ + + \\ + + \ + + \ + + \ + + \ + + \\ + + \\ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ \ + + \ + + \ + + \\ + + \\ + + \ + +The child elements of the **SignatureInfoV1** element are further specified as follows: + +**ApplicationVersion:** The version of the application that created the digital signature. + +**ColorDepth:** The color depth of the primary monitor of the computer on which the digital signature was created. + +**HorizontalResolution:** The horizontal resolution of the primary monitor of the computer on which the digital signature was created. + +**ManifestHashAlgorithm:** An optional element containing a URI that identifies the particular hash algorithm for the signature. The value of this element MUST be ignored. + +**Monitors:** The count of monitors on the computer where the digital signature was created. + +**OfficeVersion:** The version of the application suite that created the digital signature. The version can be appended with a ‘/’ followed by a signing version represented by an unsigned integer. The signing version can be used to ensure that future application versions do not attempt to verify relationships that did not exist in the signing version. Not including the ‘/’ results in all signed relationships being verified which is consistent with previous behavior. + +**SetupID:** A GUID that can be cross-referenced with the identifier of the signature line stored in the document content. + +**SignatureComments:** The comments on the digital signature. + +**SignatureImage:** An image for the digital signature. + +**SignatureProviderDetails:** The details of the signature provider. The value MUST be an integer computed from a bitmask of the flags that are described in the following table. + +| Value | Description | +|----|----| +| 0x00000000 | Specifies that there are no restrictions on the provider's usage. | +| 0x00000001 | Specifies that the provider MUST only be used for the user interface (UI). | +| 0x00000002 | Specifies that the provider MUST only be used for invisible signatures. | +| 0x00000004 | Specifies that the provider MUST only be used for visible signatures. | +| 0x00000008 | Specifies that the application UI MUST be used for the provider. | +| 0x00000010 | Specifies that the application stamp UI MUST be used for the provider. | + +**SignatureProviderId:** The class identifier of the signature provider.[\<33\>](#Appendix_A_33) + +**SignatureProviderUrl:** The URL of the software used to generate the digital signature. + +**SignatureText:** The text of actual signature in the digital signature. + +**SignatureType:** The type of the digital signature. Its value MUST be one of those in the following table. + +| Value | Description | +|-------|--------------------------------------------| +| 1 | The digital signature MUST NOT be printed. | +| 2 | The digital signature MUST be printed. | + +If set to 2, there MUST be two additional objects in the signature with the following identifier values: + +- **idValidSigLnImg:** The image of a valid signature. + +- **idInvalidSigLnImg:** The image of an invalid signature. + +**VerticalResolution:** The vertical resolution of the primary monitor of the computer on which the digital signature was created. + +**WindowsVersion:** The version of the operating system on which the digital signature was created. + +**DelegateSuggestedSigner:** The name of a person to whom the signature has been delegated. + +**DelegateSuggestedSigner2:** The title of a person to whom the signature has been delegated. + +**DelegateSuggestedSignerEmail:** The email address of a person to whom the signature has been delegated. + +The child elements of the **SignatureInfoV2** element are specified as follows: + +**Address1:** The location at which the signature was created. + +**Address2:** The location at which the signature was created. + +The optional **SignatureInfoV2** element is used to provide additional information to the **SignatureProductionPlace** element, which is specified in [\[XAdES\]](https://go.microsoft.com/fwlink/?LinkId=151586) section 7.2.7. + +#### XAdES Elements + +XML Advanced Electronic Signatures [\[XAdES\]](https://go.microsoft.com/fwlink/?LinkId=151586) extensions to xmldsig signatures MAY[\<34\>](#Appendix_A_34) be present in either binary or ECMA-376 documents [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) when using xmldsig signatures. XAdES-EPES through XAdES-X-L extensions are specified within a signature. Unless otherwise specified, any optional elements as specified in \[XAdES\] are ignored. + +The **Object** element containing the information as specified in \[XAdES\] has a number of optional elements, and many of the elements have more than one method specified. A document compliant with this file format uses the following options: + +- The **SignedSignatureProperties** element MUST contain a **SigningCertificate** property as specified in \[XAdES\] section 7.2.2. + +- A **SigningTime** element MUST be present as specified in \[XAdES\] section 7.2.1. + +- A **SignaturePolicyIdentifier** element MUST be present as specified in \[XAdES\] section 7.2.3. + +- If the information as specified in \[XAdES\] contains a time stamp as specified by the requirements for XAdES-T, the time stamp information MUST be specified as an **EncapsulatedTimeStamp** element containing DER encoded ASN.1. data. + +- If the information as specified in \[XAdES\] contains references to validation data, the certificates used in the certificate chain, except for the signing [**certificate**](#gt_7a0f4b71-23ba-434f-b781-28053ed64879), MUST be contained within the **CompleteCertificateRefs** element as specified in \[XAdES\] section 7.4.1. In addition, for the signature to be considered a well-formed XAdES-C signature, a **CompleteRevocationRefs** element MUST be present, as specified in \[XAdES\] section 7.4.2. + +- If the information as specified in \[XAdES\] contains time stamps on references to validation data, the **SigAndRefsTimestamp** element as specified in \[XAdES\] section 7.5.1 and \[XAdES\] section 7.5.1.1 MUST be used. The **SigAndRefsTimestamp** element MUST specify the time stamp information as an **EncapsulatedTimeStamp** element containing DER encoded ASN.1. data. + +- If the information as specified in \[XAdES\] contains properties for data validation values, the **CertificateValues** and **RevocationValues** elements MUST be constructed as specified in \[XAdES\] section 7.6.1 and \[XAdES\] section 7.6.2. Except for the signing certificate, all certificates used in the validation chain MUST be entered into the **CertificateValues** element. + +There MUST be a **Reference** element specifying the digest of the **SignedProperties** element, as specified in \[XAdES\], section 6.2.1. A **Reference** element is placed in one of two parent elements, as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861): + +- The **SignedInfo** element of the top-level Signature XML. + +- A **Manifest** element contained within an **Object** element. + +A document compliant with this file format SHOULD[\<35\>](#Appendix_A_35) place the **Reference** element specifying the digest of the **SignedProperties** element within the **SignedInfo** element. If the **Reference** element is instead placed in a **Manifest** element, the containing **Object** element MUST have an **id** attribute set to "idXAdESReferenceObject". + +### \_xmlsignatures Storage + +Digital signatures MUST be stored as [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contained in a storage named "\_xmlsignatures", based on the root of the compound document. Streams (1) containing a signature MUST be named using a base-10 string representation of a random number. The name of the stream (1) MUST NOT be the same as an existing signature contained within the storage. A single signature is stored directly into each stream (1), as UTF-8 characters, with no leading header. The content of each stream (1) MUST be a valid signature as specified in [\[XMLDSig\]](https://go.microsoft.com/fwlink/?LinkId=130861) and generated as specified in section [2.5.2](#Section_81b2e49e9fb947f49ddac38082a972e0). More than one signature can be present in the "\_xmlsignatures" storage. + +## Sensitivity Labels + +This section covers details about how and where [**sensitivity label metadata**](#gt_ae6b3334-fd18-48b8-81a1-70580357c7ea) is stored. + +### Sensitivity Label Metadata + +When a [**sensitivity label**](#gt_a1b4b3d0-e8a3-49a6-a5de-51f86ed117c7) is applied to content, certain [**sensitivity label metadata**](#gt_ae6b3334-fd18-48b8-81a1-70580357c7ea) is generated at the time the label is associated with the content. The sensitivity label metadata applied to a particular document shall be stored within the same document content as specified in section [2.6.2](#Section_0c4ec12daba04dd48fd1710da6735219) and section [2.6.3](#Section_13939de6c83344abb213e0088bf02341). + +Note that in all cases if sensitivity label metadata conflicts with the label in the [**publishing license**](#gt_93329fb8-0dfe-43c4-96f4-717b2ab79da0) that the label defined in the publishing license shall be construed to be the label applied to the content. + +### LabelInfo Stream Locations + +The **LabelInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) comprised of XML described in section [2.6.4](#Section_b75503d0ada14ecaadc1adeb643ab813) shall be written in the **\0x06DataSpaces\TransformInfo** [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) when [**Information Rights Management (IRM)**](#gt_ff35237a-a497-42aa-b0d5-7a0116328759) is applied to the document and the [**publishing license**](#gt_93329fb8-0dfe-43c4-96f4-717b2ab79da0) is present in the file and there is at least one qualifying [**sensitivity label**](#gt_a1b4b3d0-e8a3-49a6-a5de-51f86ed117c7) per section [2.6.3](#Section_13939de6c83344abb213e0088bf02341) to have corresponding [**sensitivity label metadata**](#gt_ae6b3334-fd18-48b8-81a1-70580357c7ea) written to the **LabelInfo** stream (2). + +The **LabelInfo** stream (2) comprised of XML described in section 2.6.4 shall be written to the [**OPC package**](#gt_fdc022ee-ca0c-41c4-be66-a1c35e304143) in the Sensitivity Label Information part ([\[MS-OI29500\]](%5bMS-OI29500%5d.pdf#Section_1fd4a662862349c082f018fa91b413b8) section 3.4.1.5) when Information Rights Management (IRM) is not applied to the document or the publishing license is not present in the file and there is at least one qualifying sensitivity label per section 2.6.3 to have corresponding sensitivity label metadata written to the **LabelInfo** stream (2). + +For either location an implementation might write an empty **labelList** element per section [2.6.4.3](#Section_b3d2a98a4b134dd0a78df2ea9f376654) if there are no qualifying sensitivity labels. + +Files ought not to contain sensitivity labels in both places, and implementations reading shall ignore sensitivity label metadata written to the encrypted OPC package if the **\0x06DataSpaces\TransformInfo** storage contains a valid **LabelInfo** stream (1). + +### LabelInfo versus Custom Document Properties + +When reading [**sensitivity label metadata**](#gt_ae6b3334-fd18-48b8-81a1-70580357c7ea) from a persisted document, it shall exist in custom document properties ([\[MS-OI29500\]](%5bMS-OI29500%5d.pdf#Section_1fd4a662862349c082f018fa91b413b8) section 2.1.31) or a **LabelInfo** [**stream (2)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) location specified in section [2.6.2](#Section_0c4ec12daba04dd48fd1710da6735219). Implementations shall use both [**sensitivity label**](#gt_a1b4b3d0-e8a3-49a6-a5de-51f86ed117c7) policy and actual location of the sensitivity label metadata to determine where to read and write sensitivity label metadata as follows. + +When reading sensitivity label metadata, for each sensitivity label implementations have these cases to consider: + +1\. If the sensitivity label policy opts in to the **LabelInfo** stream (2) then all applicable sensitivity label metadata shall be first read from the **LabelInfo** location (section 2.6.2), and subsequently metadata shall only be read for custom document properties where there is no **label** element (section [2.6.4.4](#Section_118e2e99e25949f09f160abbb3c5cf4a)). This preserves the sensitivity label metadata so the sensitivity label policy can change from opted out to opted in without losing applicable sensitivity label metadata for content created and persisted prior to the policy change. + +2\. If the sensitivity label policy is known and does not opt in to the **LabelInfo** stream (2) then all applicable sensitivity label metadata shall only be read from custom document properties. + +3\. If the sensitivity label policy is not known, then it shall be inferred to be opted in to the **LabelInfo** stream (2) or not by the presence or absence of sensitivity label metadata in the **LabelInfo** stream (2) per [**Azure AD**](#gt_c0bffab4-4731-4db6-92b7-43aaef4103bc) tenant as given by the **siteId** attribute value of the corresponding **label** element (section 2.6.4.4). + +When writing, for each sensitivity label implementations have these cases to consider: + +1\. If the sensitivity label policy opts in to the **LabelInfo** stream (2) OR is unknown but the sensitivity label metadata originally was present in the **LabelInfo** stream (2) then the sensitivity label metadata shall be written to the **LabelInfo** stream (2) and any sensitivity label metadata associated with the same Azure AD tenant that was present in custom document properties shall be preserved as-is in the custom document properties even if the sensitivity label was removed or changed. + +2\. If the sensitivity label policy is known and does not opt in to the **LabelInfo** stream (2) OR is unknown and the sensitivity label metadata originally was not present in the **LabelInfo** stream (2) then the sensitivity label metadata shall be written to the custom document properties. + +Note that for the case where sensitivity label policy opts in to the **LabelInfo** stream (2) but there is sensitivity label metadata present only in custom document properties, on read this custom document property sensitivity label metadata shall be read and on write it shall be written as-is to the custom document property stream (2) AND it shall be written to the **LabelInfo** stream (2). Any metadata that existed in custom document properties and for which there is no LabelInfo stream (2) schema (section 2.6.4.4) for (such as parent labels, Application, Owner, Name, SetDate, and others) shall not be written to the **LabelInfo** stream (2) and any sensitivity label metadata formats shall be converted to be compatible. For example, Enabled value in custom document properties being True shall be written as enabled="1" or Method of Auto shall be written as method="Standard" to conform to the **LabelInfo** schema detailed in section [2.6.4](#Section_b75503d0ada14ecaadc1adeb643ab813), especially section 2.6.4.4. The same conversion shall be done regardless of the source of the sensitivity label metadata when writing to the **LabelInfo** stream (2). + +Implementations shall not read the sensitivity label metadata from the **LabelInfo** stream (2) if policy is known for the sensitivity labels from that Azure AD tenant to not opt in to the **LabelInfo** stream (2). The presence of a **label** element in the **LabelInfo** stream (2) and absence of corresponding sensitivity label metadata for the same Azure AD tenant in the custom document properties shall not result in the transfer of sensitivity label metadata from the **LabelInfo** stream (2) to the custom document properties for any cases, since it would render older or unaware implementations or implementations which chose to ignore the policy unable to remove sensitivity label metadata. + +All implementations which read sensitivity label metadata from the **LabelInfo** stream (2) and subsequently remove the sensitivity label and corresponding sensitivity label metadata shall write a **label** element (section 2.6.4.4) with removed="1" on write. The presence of the **label** element (section 2.6.4.4) with removed="1" shall indicate on subsequent read that corresponding sensitivity label metadata shall not be read from custom document properties for that Azure AD tenant given by the **siteId** attribute (section 2.6.4.4). In the absence of label policy the **SiteId** sensitivity label metadata value included in custom document property (\[MS-OI29500\] section 2.1.31) might be used, if present. + +### LabelInfo Stream Schema + +The following describes the schema for the XML in the **LabelInfo [stream (2)](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6)**, where **labelList** (see section [2.6.4.3](#Section_b3d2a98a4b134dd0a78df2ea9f376654)) is the root element. + +554. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +#### Namespaces + +Content in the LabelInfo [**stream (2)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) shall be in namespace http://schemas.microsoft.com/office/2020/mipLabelMetadata unless otherwise specified. + +#### xml Preprocessor Directive + +The initial **LabelInfo** [**stream (2)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) bytes shall comprise of an **xml** preprocessor directive for example: + +596. \ + +The value of the **version** attribute might be updated in the future to reflect files written with schema updates. + +#### labelList Element + +The **labelList** element shall comprise the one and only root element of the XML in the **LabelInfo** [**stream (2)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) (see section [2.6.4](#Section_b75503d0ada14ecaadc1adeb643ab813)) and shall contain **CT_ClassificationLabelList** (see section [2.6.5.5](#Section_c4de274fba5545e0a279b67212c8990a)). + +597. \ + +An empty **labelList** element example: + +598. \ + +#### label Element + +Each **label** element shall contain **CT_ClassificationLabel** (see section [2.6.5.4](#Section_80e2b2e1bd48415da3b9aa61a108f651)). + +599. \ + +#### extLst Element + +The **extLst** element, if present, shall contain **CT_ClassificationExtenstionList** (see section [2.6.5.3](#Section_5f01e8229e7442eea2077da41fa07e7a)). + +The content in the **extLst** element shall be preserved for all XML that is not understood or currently documented in order to provide a mechanism whereby future file format changes might be introduced and existing clients, while not interpreting the content, shall preserve it. + +600. \ + +#### ext Element + +Each **ext** element shall contain **CT_ClassificationExtension** (see section [2.6.5.2](#Section_80d09e49ac5e4c458a271dd38ef0863b)). + +601. \ + +### LabelInfo Stream Structures + +This section details structures which describe elements in section [2.6.4](#Section_b75503d0ada14ecaadc1adeb643ab813). + +#### ST_ClassificationGuid + +A 128 bit unsigned value which shall be expressed in the following format. + +602. \ + + \ + + \ + +#### CT_ClassificationExtension + +The **CT_ClassificationExtension** type describes contents of the **ext** element (see section [2.6.4.6](#Section_d49c1d622fc84067b363a4414e54fa1c)). Additional specific contents of this element shall be defined and documented as needed in the future in section [2.6.6](#Section_a50fb40f8d204ec993a929553b74be0c) and other sections as appropriate. All content present shall be preserved except to implement corresponding features as they are described in section 2.6.6. Implementations which understand some **ext** elements shall preserve all **ext** elements which are not implemented, including any not yet documented. + +605. \ + + \ + + \ + + \ + + \ + + \ + +The **uri** attribute value shall be a value specified to indicate the **CT_ClassificationExtension** includes XML for a particular feature which was not defined when the **LabelInfo** [**stream (2)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) was first introduced, to allow for extensibility of the file format within the **LabelInfo** stream (2) on a feature by feature basis. As extensions are added to the schema, they will be listed in section 2.6.6 wherein the schema of the **ext** element along with its corresponding **uri** attribute value shall be specified. Each **uri** attribute value shall correspond to one of the valid extensions listed in section 2.6.6. + +The **uri** attribute value shall not be empty. + +#### CT_ClassificationExtenstionList + +The **CT_ClassificationExtensionList** type describes the contents of the **extLst** element (see section [2.6.4.5](#Section_792c5bdb59314818a238776039c414f8)). + +609. \ + + \ + + \ + + \ + + \ + +#### CT_ClassificationLabel + +The **CT_ClassificationLabel** type describes the contents of the **label** element (see section [2.6.4.4](#Section_118e2e99e25949f09f160abbb3c5cf4a)). + +Each **CT_ClassificationLabel** contains [**sensitivity label metadata**](#gt_ae6b3334-fd18-48b8-81a1-70580357c7ea) that was added as part of classifying content using one or more [**sensitivity label**](#gt_a1b4b3d0-e8a3-49a6-a5de-51f86ed117c7). The attributes shall be written in the order presented here. Unless otherwise specified, these all shall be written exactly as specified when the sensitivity label was created and not updated in any way subsequent to that until the sensitivity label is removed or a different sensitivity label is associated with the corresponding content. Unless otherwise specified, the values are case sensitive. Optional values shall be omitted and shall not be present with an empty value except as noted with the descriptions for particular attributes. + +614. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +[TABLE] + +#### CT_ClassificationLabelList + +The **CT_ClassificationLabelList** type describes the contents of the **labelList** element (see section [2.6.4.3](#Section_b3d2a98a4b134dd0a78df2ea9f376654)). + +622. \ + + \ + + \ + + \ + + \ + + \ + +### LabelInfo Stream Extensions + +There are currently no extensions defined for the **CT_ClassificationExtensionList** type (see section [2.6.5.3](#Section_5f01e8229e7442eea2077da41fa07e7a)). + +## MsoDataStore + +Writers shall not create both an **IsRedundantDataStorePromotion** (section [2.7.1](#Section_1a7e9736ec8a4f3e998504d81bb97d25)) [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) and an **IsModifiedDataStorePromotion** (section [2.7.2](#Section_9a11a7dc126149b7aa70617fbe6fd1d3)) storage. + +If a process changes any value in any **MsoDataStore** subordinate [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) without an associated change to the **Custom XML Data Storage** and related ([\[ISO/IEC29500-1:2016\]](https://go.microsoft.com/fwlink/?linkid=861065) sections 15.2.5 and 15.2.6) within the [**encrypted**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) streams (1) of the [**compound file (1)**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) referred to by the IRMDS (section [1.3.2](#Section_fc50f864d012465bbd94d35abce01420)) structure therein, writers: + +- Shall remove the **IsRedundantDataStorePromotion** storage as the **MsoDataStore** subordinate streams (1) are no longer completely represented in the encrypted streams (1). + +- Shall create the **IsModifiedDataStorePromotion** storage as the **MsoDataStore** subordinate streams (1) represent updated content that was originally represented in the encrypted streams (1). + +**NOTE:** The presence or absence of **IsRedundantDataStorePromotion** and **IsModifiedDataStorePromotion** storages allow a process to determine if it can safely [**decrypt**](#gt_8bf79983-1325-42db-8e2c-520c8ab2ae74) the IRMDS object and discard the IRMDS structures (if **IsRedundantDataStorePromotion** is present), if it considers the streams (1) subordinate to the **MsoDataStore** storage as superseding the content in the IRMDS structures (if **IsModifiedDataStorePromotion** is present), or if it retains the IRMDS structures for interoperability (if neither storage is present). + +**Example 1:** If a [**document**](#gt_7b9a05f4-888b-4176-b00a-115046299e1b) represented by an IRMDS object is uploaded to a Microsoft SharePoint Online [**document library**](#gt_d9f07822-aeb0-4642-ab51-95cb724fbf35) protected by [**Information Rights Management (IRM)**](#gt_ff35237a-a497-42aa-b0d5-7a0116328759), and the **IsRedundantDataStorePromotion** storage *is* *not* present, then SharePoint Online will not decrypt the IRMDS object and will operate solely on the IRMDS object itself. + +**Example 2:** If a document represented by an IRMDS object is uploaded to a SharePoint document library protected by Information Rights Management (IRM), and the **IsReduntantDataStorePromotion** storage *is* present, a SharePoint Online process modifies a stream (1) subordinate to the **MsoDataStore** storage and removes the **IsRedundantDataStorePromotion** storage and creates the **IsModifiedDataStorePromotion** storage. The content for the **Custom XML Data Storage** (\[ISO/IEC29500-1:2016\] sections 15.2.5 and 15.2.6) in the encrypted streams (1) of the IRMDS object is now out-of-date, and the streams (1) subordinate to the **MsoDataStore** storage MUST now supersede the content in the encrypted streams (1). + +### IsRedundantDataStorePromotion Storage + +The **IsRedundantDataStorePromotion [storage](#gt_63525252-3f66-4459-9b64-5b77f57b2f84)**, when present as a [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) of the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4), indicates the subordinate [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) of the **MsoDataStore** storage represent content that is identically represented in the [**encrypted**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) streams (1) of the [**compound file (1)**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) referred to by the IRMDS (section [1.3.2](#Section_fc50f864d012465bbd94d35abce01420)) structure therein. + +Readers can choose to preserve, edit, or discard the subordinate streams (1) when the **IsRedundantDataStorePromotion** storage is present. + +Writers shall not create the **IsRedundantDataStorePromotion** storage if the subordinate **MsoDataStore** streams (1) are not completely represented in the encrypted streams (1). + +### IsModifiedDataStorePromotion Storage + +The **IsModifiedDataStorePromotion** [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84), when present as a [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) of the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4), indicates the subordinate [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) of the **MsoDataStore** storage represent subsequently updated content that was originally represented in the [**encrypted**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) streams (1) of the [**compound file (1)**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) referred to by the IRMDS (section [1.3.2](#Section_fc50f864d012465bbd94d35abce01420)) structure therein. + +Readers shall consider the streams (1) subordinate to the **MsoDataStore** storage as superseding any Custom XML Data Storage **MsoDataStore** (ISO29500-1:2016 §15.2.4 and §15.2.6.) content represented in the encrypted streams (1). + +Writers shall not create the **IsModifiedDataStorePromotion** storage if the unmodified subordinate **MsoDataStore** streams (1) are not completely represented in the encrypted streams (1). + +## EncryptedSIHash Stream + +The **EncryptedSIHash [stream (1)](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6)**, when present as a [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) of the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4), indicates information about the **\x05SummaryInformation** stream (1) ([\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.3.3.2.1). + +The **EncryptedSIHash** stream (1) shall only be present on [**encrypted**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) files. + +The **EncryptedSIHash** stream (1), when created or updated, shall be composed entirely of one **EncryptedPropertyStreamInfo** structure (section [2.10](#Section_64979b8259c04ed5abfaad8503cf1b25)), with a **Checksum** (section 2.10) computed using the entire **\x05SummaryInformation** stream (1) contents, exclusive of stream (1) properties. + +Writers that do not write the **\x05SummaryInformation** stream (1) shall not write the **EncryptedSIHash** stream (1). + +Writers that update the **\x05SummaryInformation** stream (1) without an associated change to any applicable related [**document properties**](#gt_8a1ae83d-4c23-4801-9c87-07f8a62e9075) within the encrypted streams (1) of the [**compound file (2)**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) referred to by the IRMDS structure therein shall not update the **EncryptedSIHash** stream (1). + +**NOTE:** The presence and contents of the **EncryptedSIHash** stream (1) allows a process to determine if it can safely [**decrypt**](#gt_8bf79983-1325-42db-8e2c-520c8ab2ae74) the IRMDS and discard the **\x05SummaryInformation** stream (1) (**EncryptedSIHash** stream (1) is present and the [**CRC32**](#gt_9cb45a36-92bb-4c14-b2fd-2ad7e2979bfd) matches the computed CRC32 of the **\x05SummaryInformation** stream (1)). + +## EncryptedDSIHash Stream + +The **EncryptedDSIHash [stream (1)](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6)**, when present as a [**child**](#gt_bc38f35b-d253-4f8f-8dcc-095e3a211ae0) of the [**root storage object**](#gt_d49237e3-04dd-4823-a0a5-5e23f750a5f4), indicates information about the **\x05DocumentSummaryInformation** stream (1) ([\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.3.3.2.2 and \[MS-OSHARED\] section 2.3.3.2.3). + +The **EncryptedDSIHash** stream (1) shall only be present on encrypted files. + +The **EncryptedDSIHash** stream (1), when created or updated, shall be composed entirely of one **EncryptedPropertyStreamInfo** structure (section [2.10](#Section_64979b8259c04ed5abfaad8503cf1b25)), with a **Checksum** (section 2.10) computed using the entire **\x05DocumentSummaryInformation** stream (1) contents, exclusive of stream (1) properties. + +Writers that do not write the **\x05DocumentSummaryInformation** stream (1) shall not write the **EncryptedDSIHash** stream (1). + +Writers that update the **\x05DocumentSummaryInformation** stream (1) without an associated change to any applicable related [**document properties**](#gt_8a1ae83d-4c23-4801-9c87-07f8a62e9075) within the [**encrypted**](#gt_8312d817-fdc5-4a49-8894-729b7b9e0ce5) streams (1) of the [**compound file (2)**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) referred to by the IRMDS structure therein shall not update the **EncryptedDSIHash** stream (1). + +**NOTE:** The presence and contents of the **EncryptedDSIHash** stream (1) allows a process to determine if it can safely [**decrypt**](#gt_8bf79983-1325-42db-8e2c-520c8ab2ae74) the IRMDS and discard the **\x05DocumentSummaryInformation** stream (1) (**EncryptedDSIHash** stream (1) is present and the [**CRC32**](#gt_9cb45a36-92bb-4c14-b2fd-2ad7e2979bfd) matches the computed CRC32 of the **\x05DocumentSummaryInformation** stream (1)). + +## EncryptedPropertyStreamInfo Structure + +[TABLE] + +**StreamId (1 byte):** A number which identifies this structure as content in either the **EncryptedSIHash** (section [2.8](#Section_a400e462a0cb4b208e28bd2e2a08c43c)) or **EncryptedDSIHash** (section [2.9](#Section_b7a9eb3034bd447c8776e6a5c9c35d48)) [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). The value shall be 0xAB. The **EncryptedPropertyStreamInfo** shall be considered invalid for all other values. + +**Version (1 byte):** A number which identifies the [**stream schema**](#gt_db212291-f190-42cd-bf59-f39759502ab0). A value of 0x00 indicates the format given here. Readers shall ignore the stream (1) if some other value is present. + +**Checksum (4 bytes):** A value that shall be a [**CRC32**](#gt_9cb45a36-92bb-4c14-b2fd-2ad7e2979bfd) computed using the **MsoCrc32Compute** ([\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) section 2.4.3) algorithm of the entire contents of the corresponding **\x05SummaryInformation** *or* **\x05DocumentSummaryInformation** stream (1), stored [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7). + +**Reserved (variable):** Undefined and shall be ignored if **Version** is 0x00; reserved for future use. + +# Structure Examples + +This section provides examples of the following structures: + +- An ECMA-376 document [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) conforming to the **IRMDS** structure. + +- Office binary data file structures with corresponding hexadecimal and graphical representation. + +The example for the ECMA-376 document \[ECMA-376\] contains the following [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and storages: + +- **0x06DataSpaces** storage: + + - **Version** stream (1) containing a **DataSpaceVersionInfo** structure as specified in section [3.1](#Section_86bc78625b484249b9953e4a26f5d410). + + - **DataSpaceMap** stream (1) containing a **DataSpaceMap** structure as specified in section [3.2](#Section_037128681662492a899072b60e4ee5eb). + + - **DataSpaceInfo** storage: + + - **DRMEncryptedDataSpace** stream (1) containing a **DataSpaceDefinition** structure as described in section [3.3](#Section_c04677c759dd46aaa892edb88bbfa763). + +   + + - **TransformInfo** storage: + + - **0x06Primary** stream (1) containing an **IRMDSTransformInfo** structure as described in section [3.4](#Section_ab6418acf42a4cff9956c16f5c72194f). + + - **EUL-ETRHA1143ZLUDD412YTI3M5CTZ** stream (1) containing an **EndUserLicenseHeader** structure and a certificate chain as described in section [3.5](#Section_74cf76546f3040d4bd256c532531efc2). + +- **EncryptedPackage** stream (1). + +- **0x05SummaryInformation** stream (1). + +- **0x05DocumentSummaryInformation** stream (1). + +Note that not all of the streams (1) and storages in the file, including the **0x05SummaryInformation** stream (1) and **0x05DocumentSummaryInformation** stream (1), are specified in the **IRMDS** structure, and examples are not provided for those streams (1) in this section. OLE compound files conforming to this structure frequently contain other storages and streams (1). + +## Version Stream + +This section provides an example of a **Version** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that contains a **DataSpaceVersionInfo** structure (section [2.1.5](#Section_78a22c61178c4496941056e574271b6c)). + +628. 00000000: 3C 00 00 00 4D 00 69 00 63 00 72 00 6F 00 73 00 + + 00000010: 6F 00 66 00 74 00 2E 00 43 00 6F 00 6E 00 74 00 + + 00000020: 61 00 69 00 6E 00 65 00 72 00 2E 00 44 00 61 00 + + 00000030: 74 00 61 00 53 00 70 00 61 00 63 00 65 00 73 00 + + 00000040: 01 00 00 00 01 00 00 00 01 00 00 00 + +[TABLE] + +**FeatureIdentifier (variable):** "Microsoft.Container.DataSpaces" specifies the functionality for which this version information applies. This string is contained in a **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)); therefore, the first 4 bytes of the structure contain 0x0000003C, which specifies the length, in bytes, of the string. The string is not null-terminated. + +**ReaderVersion.vMajor (2 bytes):** 0x0001 specifies the major component of the reader version of the software component that created this structure. + +**ReaderVersion.vMinor (2 bytes):** 0x0000 specifies the minor component of the reader version of the software component that created this structure. + +**UpdaterVersion.vMajor (2 bytes):** 0x0001 specifies the major component of the updater version of the software component that created this structure. + +**UpdaterVersion.vMinor (2 bytes):** 0x0000 specifies the minor component of the updater version of the software component that created this structure. + +**WriterVersion.vMajor (2 bytes):** 0x0001 specifies the major component of the writer version of the software component that created this structure. + +**WriterVersion.vMinor (2 bytes):** 0x0000 specifies the minor component of the writer version of the software component that created this structure. + +## DataSpaceMap Stream + +This section provides an example of a **DataSpaceMap** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that contains a **DataSpaceMap** structure (section [2.1.6](#Section_a9dd21241f1047d2873febdc37965ab6)). The **DataSpaceMap** structure, in turn, contains a **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)). + +633. 00000000: 08 00 00 00 01 00 00 00 60 00 00 00 01 00 00 00 + + 00000010: 00 00 00 00 20 00 00 00 45 00 6E 00 63 00 72 00 + + 00000020: 79 00 70 00 74 00 65 00 64 00 50 00 61 00 63 00 + + 00000030: 6B 00 61 00 67 00 65 00 2A 00 00 00 44 00 52 00 + + 00000040: 4D 00 45 00 6E 00 63 00 72 00 79 00 70 00 74 00 + + 00000050: 65 00 64 00 44 00 61 00 74 00 61 00 53 00 70 00 + + 00000060: 61 00 63 00 65 00 00 00 + +[TABLE] + +**HeaderLength (4 bytes):** 0x00000008 specifies the number of bytes in the **DataSpaceMap** structure before the first **DataSpaceMapEntry**. + +**EntryCount (4 bytes):** 0x00000001 specifies the number of **DataSpaceMapEntry** items in the **MapEntries** array. + +**MapEntries (variable):** The contents of the **DataSpaceMapEntry** array. For more information, see section [3.2.1](#Section_fdfee56f5ce146bdab2ff62d5b4768fb). + +### DataSpaceMapEntry Structure + +This section provides an example of a **DataSpaceMapEntry** structure (section [2.1.6.1](#Section_1902a39e5f9a41b8b8d32aa1f51519d5)). + +640. 00000000: 60 00 00 00 01 00 00 00 + + 00000010: 00 00 00 00 20 00 00 00 45 00 6E 00 63 00 72 00 + + 00000020: 79 00 70 00 74 00 65 00 64 00 50 00 61 00 63 00 + + 00000030: 6B 00 61 00 67 00 65 00 2A 00 00 00 44 00 52 00 + + 00000040: 4D 00 45 00 6E 00 63 00 72 00 79 00 70 00 74 00 + + 00000050: 65 00 64 00 44 00 61 00 74 00 61 00 53 00 70 00 + + 00000060: 61 00 63 00 65 00 00 00 + +[TABLE] + +**Length (4 bytes):** 0x00000060 specifies the size, in bytes, of the **DataSpaceMapEntry** structure. + +**ReferenceComponentCount (4 bytes):** 0x00000001 specifies the number of **DataSpaceReferenceComponent** items (section [2.1.6.2](#Section_5b88af5509c24b459a83b1da1a8f9935)) in the **ReferenceComponents** array. + +**ReferenceComponent.ReferenceComponentType (4 bytes):** 0x00000000 specifies that the referenced component is a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +**ReferenceComponent.ReferenceComponent (variable):** "EncryptedPackage" specifies the functionality for which this version information applies. This string is contained in a **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)); therefore, the first 4 bytes of the structure contain 0x00000020, which specifies the length, in bytes, of the string. The string is not null-terminated. "EncryptedPackage" matches the name of the stream (1) in the OLE compound file that contains the protected contents. + +**DataSpaceName (variable):** "DRMEncryptedDataSpace" specifies the functionality that this version information applies to. This string is contained in a **UNICODE-LP-P4** structure; therefore, the first 4 bytes of the structure contain 0x0000002A, which specifies the length, in bytes, of the string. The string is not null-terminated; however, the structure is padded with 2 bytes to ensure that its length is a multiple of 4 bytes. + +## DRMEncryptedDataSpace Stream + +This section provides an example of a [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) in the **\0x06DataSpaces\DataSpaceInfo** storage (section [2.2.2](#Section_7b65cd15d09c4393a9f43ad673b1821b)) that contains a **DataSpaceDefinition** structure (section [2.1.7](#Section_9c59e994388841cc9f98ca986a2803c3)). + +647. 00000000: 08 00 00 00 01 00 00 00 2A 00 00 00 44 00 52 00 + + 00000010: 4D 00 45 00 6E 00 63 00 72 00 79 00 70 00 74 00 + + 00000020: 65 00 64 00 54 00 72 00 61 00 63 00 73 00 66 00 + + 00000030: 6F 00 72 00 6D 00 00 00 + +[TABLE] + +**HeaderLength (4 bytes):** 0x00000008 specifies the number of bytes in the **DataSpaceDefinition** before the **TransformReferences** field. + +**TransformReferenceCount (4 bytes):** 0x00000001 specifies the number of items in the **TransformReferences** array. + +**TransformReferences (variable):** "DRMEncryptedTransform" specifies the transform associated with this **DataSpaceDefinition** structure. This string is contained in a **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)); therefore, the first 4 bytes of the structure contain 0x0000002A, which specifies the length, in bytes, of the string. The string is not null-terminated; however, the structure is padded with 2 bytes to ensure that its length is a multiple of 4 bytes. "DRMEncryptedTransform" matches the name of the transform storage contained in the **\0x06DataSpaces\TransformInfo** storage (section [2.2.3](#Section_038fa5b0a0964f21ba45e48a03ec43cd)). + +## 0x06Primary Stream + +This section provides an example of a **0x06Primary** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that contains an **IRMDSTransformInfo** structure (section [2.2.6](#Section_fc0b604adb9c477d98352fc0e2aa50ac)). Note that the first portion of this structure consists of a **TransformInfoHeader** structure (section [2.1.8](#Section_c0bfd080ef2a433481a8d1af95dee5e5)). + +651. 00000000: 58 00 00 00 01 00 00 00 4C 00 00 00 7B 00 43 00 + + 00000010: 37 00 33 00 44 00 46 00 41 00 43 00 44 00 2D 00 + + 00000020: 30 00 36 00 31 00 46 00 2D 00 34 00 33 00 42 00 + + 00000030: 30 00 2D 00 38 00 42 00 36 00 34 00 2D 00 30 00 + + 00000040: 43 00 36 00 32 00 30 00 44 00 32 00 41 00 38 00 + + 00000050: 42 00 35 00 30 00 7D 00 3E 00 00 00 4D 00 69 00 + + 00000060: 63 00 72 00 69 00 73 00 6F 00 66 00 74 00 2E 00 + + 00000070: 4D 00 65 00 74 00 61 00 64 00 61 00 74 00 61 00 + + 00000080: 2E 00 44 00 52 00 4D 00 54 00 72 00 61 00 6E 00 + + 00000090: 73 00 66 00 6F 00 72 00 6D 00 00 00 01 00 00 00 + + 000000A0: 01 00 00 00 01 00 00 00 04 00 00 00 26 2F 00 00 + + 000000B0: 3C 3F 78 6D 6C 20 76 65 72 73 69 6F 6E 3D 22 31 + +[TABLE] + +**TransformInfoHeader.TransformLength (4 bytes):** 0x00000058 specifies the number of bytes in this structure before **TransformInfoHeader.TransformName**. + +**TransformInfoHeader.TransformType (4 bytes):** 0x00000001 specifies the type of transform to be applied. + +**TransformInfoHeader.TransformID (variable):** "{C73DFACD-061F-43B0-8B64-0C620D2A8B50}" specifies a unique, invariant identifier associated with this transform. This string is contained in a **UNICODE-LP-P4** structure (section [2.1.2](#Section_87415b557d53498aad535ed648a1a196)); therefore, the first 4 bytes of the structure contain 0x0000004C, which specifies the length, in bytes, of the string. The string is not null-terminated. + +**TransformInfoHeader.TransformName (variable):** "Microsoft.Metadata.DRMTransform" specifies the logical name of the transform. This string is contained in a **UNICODE-LP-P4** structure; therefore, the first 4 bytes of the structure contain 0x0000003E, which specifies the length, in bytes, of the string. The string is not null-terminated; however, the structure is padded with 2 bytes to ensure that its length is a multiple of 4 bytes. + +**TransformInfoHeader.ReaderVersion.vMajor (2 bytes):** 0x0001 specifies the major component of the reader version of the software component that created this structure. + +**TransformInfoHeader.ReaderVersion.vMinor (2 bytes):** 0x0000 specifies the minor component of the reader version of the software component that created this structure. + +**TransformInfoHeader.UpdaterVersion.vMajor (2 bytes):** 0x0001 specifies the major component of the updater version of the software component that created this structure. + +**TransformInfoHeader.UpdaterVersion.vMinor (2 bytes):** 0x0000 specifies the minor component of the updater version of the software component that created this structure. + +**TransformInfoHeader.WriterVersion.vMajor (2 bytes):** 0x0001 specifies the major component of the writer version of the software component that created this structure. + +**TransformInfoHeader.WriterVersion.vMinor (2 bytes):** 0x0000 specifies the minor component of the writer version of the software component that created this structure. + +**ExtensibilityHeader (4 bytes):** 0x00000004 specifies that no further information exists in the **ExtensibilityHeader** structure (section [2.2.5](#Section_d30116f420f646a388068120ab924409)). + +**XrMLLicense (variable):** An XrML license as described in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). This string is contained in a **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)); therefore, the first 4 bytes of the structure contain 0x00002F26, which specifies the length, in bytes, of the string. The string is not null-terminated; however, the structure is padded with 2 bytes to ensure that its length is a multiple of 4 bytes. + +## EUL-ETRHA1143ZLUDD412YTI3M5CTZ Stream + +This section provides an example of an end-user license [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) (section [2.2.7](#Section_64fb4612b4dc45e7bfb40759d8e66770)), which contains an **EndUserLicenseHeader** structure (section [2.2.9](#Section_20576d97ef414c3cbf1ff23e168ea65f)) followed by a certificate chain containing one use license. + +663. 00000000: 48 00 00 00 40 00 00 00 56 77 42 70 41 47 34 41 + + 00000010: 5A 41 42 76 41 48 63 41 63 77 41 36 41 48 55 41 + + 00000020: 63 77 42 6C 41 48 49 41 51 41 42 6A 41 47 38 41 + + 00000030: 62 67 42 30 41 47 38 41 63 77 42 76 41 43 34 41 + + 00000040: 59 77 42 76 41 47 30 41 94 BE 00 00 3C 3F 78 6D + + 00000050: 6C 20 76 65 72 73 69 6F 6E 3D 22 31 2E 30 22 3F + + 00000060: 3E 3C 43 45 52 54 49 46 49 43 41 54 45 43 48 41 + + 00000070: 49 4E 3E 3C 43 45 52 54 49 46 49 43 41 54 45 3E + + 00000080: 50 41 42 59 41 48 49 41 54 51 42 4D 41 43 41 41 + + 00000090: 64 67 42 6C 41 48 49 41 63 77 42 70 41 47 38 41 + + 000000a0: 62 67 41 39 41 43 49 41 4D 51 41 75 41 44 49 41 + + 000000b0: 49 67 41 67 41 48 67 41 62 51 42 73 41 47 34 41 + + 000000c0: 63 77 41 39 41 43 49 41 49 67 41 67 41 48 41 41 + + 000000d0: 64 51 42 79 41 48 41 41 62 77 42 7A 41 47 55 41 + + 000000e0: 50 51 41 69 41 45 4D 41 62 77 42 75 41 48 51 41 + + 000000f0: 5A 51 42 75 41 48 51 41 4C 51 42 4D 41 47 6B 41 + + 00000100: 59 77 42 6C 41 47 34 41 63 77 42 6C 41 43 49 41 + + 00000110: 50 67 41 38 41 45 49 41 54 77 42 45 41 46 6B 41 + + 00000120: 49 41 42 30 41 48 6B 41 63 41 42 6C 41 44 30 41 + + 00000130: 49 67 42 4D 41 45 6B 41 51 77 42 46 41 45 34 41 + + 00000140: 55 77 42 46 41 43 49 41 49 41 42 32 41 47 55 41 + + 00000150: 63 67 42 7A 41 47 6B 41 62 77 42 75 41 44 30 41 + + 00000160: 49 67 41 7A 41 43 34 41 4D 41 41 69 41 44 34 41 + + 00000170: 50 41 42 4A 41 46 4D 41 55 77 42 56 41 45 55 41 + + 00000180: 52 41 42 55 41 45 6B 41 54 51 42 46 + +Bytes 0x00000000 through 0x000000047 specify an **EndUserLicenseHeader** structure (section 2.2.9). The contents of this section are illustrated in section [3.5.1](#Section_5b8b98f1cb15424d952dc00efe859579). + +Byte 0x00000048 through the end of this stream (1) specify a certificate chain stored in a **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)). The contents of this section are illustrated in section [3.5.2](#Section_8605d8fa7e534d628cf6634d3e4b34fd). + +### EndUserLicenseHeader Structure + +This section provides an example of an **EndUserLicenseHeader** structure (section [2.2.9](#Section_20576d97ef414c3cbf1ff23e168ea65f)) containing one **LicenseId** (section [2.2.8](#Section_174522386e264f70aa283f98d16a2f26)). + +688. 00000000: 48 00 00 00 40 00 00 00 56 77 42 70 41 47 34 41 + + 00000010: 5A 41 42 76 41 48 63 41 63 77 41 36 41 48 55 41 + + 00000020: 63 77 42 6C 41 48 49 41 51 41 42 6A 41 47 38 41 + + 00000030: 62 67 42 30 41 47 38 41 63 77 42 76 41 43 34 41 + + 00000040: 59 77 42 76 41 47 30 41 + +[TABLE] + +**Length (4 bytes):** 0x00000048 specifies the size of the **EndUserLicenseHeader** structure. + +**ID_String.Length (variable):** 0x00000040 specifies the size of the ASCII string that follows. Note that **ID_String.Length** and **ID_String.Data** together form a **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)). + +**ID_String.Data (variable):** "VwBpAG4AZABvAHcAcwA6AHUAcwBlAHIAQABjAG8AbgB0AG8AcwBvAC4AYwBvAG0A" specifies a base64-encoded **LicenseId** that has the value "Windows:user@contoso.com". + +### Certificate Chain + +This section provides an example of a certificate chain contained in an end-user license [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) (section [2.2.7](#Section_64fb4612b4dc45e7bfb40759d8e66770)). + +693. 00000040: 94 BE 00 00 3C 3F 78 6D + + 00000050: 6C 20 76 65 72 73 69 6F 6E 3D 22 31 2E 30 22 3F + + 00000060: 3E 3C 43 45 52 54 49 46 49 43 41 54 45 43 48 41 + + 00000070: 49 4E 3E 3C 43 45 52 54 49 46 49 43 41 54 45 3E + + 00000080: 50 41 42 59 41 48 49 41 54 51 42 4D 41 43 41 41 + + 00000090: 64 67 42 6C 41 48 49 41 63 77 42 70 41 47 38 41 + + 000000a0: 62 67 41 39 41 43 49 41 4D 51 41 75 41 44 49 41 + + 000000b0: 49 67 41 67 41 48 67 41 62 51 42 73 41 47 34 41 + + 000000c0: 63 77 41 39 41 43 49 41 49 67 41 67 41 48 41 41 + + 000000d0: 64 51 42 79 41 48 41 41 62 77 42 7A 41 47 55 41 + + 000000e0: 50 51 41 69 41 45 4D 41 62 77 42 75 41 48 51 41 + + 000000f0: 5A 51 42 75 41 48 51 41 4C 51 42 4D 41 47 6B 41 + + 00000100: 59 77 42 6C 41 47 34 41 63 77 42 6C 41 43 49 41 + + 00000110: 50 67 41 38 41 45 49 41 54 77 42 45 41 46 6B 41 + + 00000120: 49 41 42 30 41 48 6B 41 63 41 42 6C 41 44 30 41 + + 00000130: 49 67 42 4D 41 45 6B 41 51 77 42 46 41 45 34 41 + + 00000140: 55 77 42 46 41 43 49 41 49 41 42 32 41 47 55 41 + + 00000150: 63 67 42 7A 41 47 6B 41 62 77 42 75 41 44 30 41 + + 00000160: 49 67 41 7A 41 43 34 41 4D 41 41 69 41 44 34 41 + + 00000170: 50 41 42 4A 41 46 4D 41 55 77 42 56 41 45 55 41 + + 00000180: 52 41 42 55 41 45 6B 41 54 51 42 46 + +[TABLE] + +**Length (4 bytes):** 0x0000BE94 specifies the size of the ASCII string that follows. Note that **Length** and **Data** together form a **UTF-8-LP-P4** structure (section [2.1.3](#Section_82592730321b4ec4bb3e87748976af33)). + +**Data (variable):** \\\PABYAH IATQBMACAAdgBlAHIAcwBp… specifies an encoded certificate chain. + +The **Data** field has been transformed from the form of certificate chain, as described in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e), in the following way: + +1. The original SOAP response contained the following certificate chain: + +  + +714. \\\\\… + +  + +2. The body of the **Certificate** element was then base64-encoded to yield the following: + +  + +715. PABYAHIATQBMACAAdgBlAHIAcwBpAG8AbgA9ACIAMQAuADIAIgAgAHgAbQBsAG4AcwA9ACIAIgAgAHAAdQByAHAAbwBzAGUAPQAiAEMAbwBuAHQAZQBuAHQALQBMAGkAYwBlAG4AcwBlACIAPgA8AEIATwBEAFkAIAB0AHkAcABlAD0AIgBMAEkAQwBFAE4AUwBFACIAIAB2AGUAcgBzAGkAbwBuAD0AIgAzAC4AMAAiAD4APABJAFMAUwBVAEUARABUAEkATQBF… + +  + +3. The base64-encoded string was then placed in a **Certificate** element, again in a **CertificateChain** element, and finally prefixed with "\". + +4. The final value of **Data** is thus as follows: + +  + +716. \\\PABYAHIATQBMACAAdgBlAH IAcwBpAG8AbgA9ACIAMQAuADIAIgAgAHgAbQBsAG4AcwA9ACIAIgAgAHAAdQByAHAAbwBzAGUAPQAiAEMAbwBuAHQAZQBuAHQALQBMAGkAYwBlAG4AcwBlACIAPgA8AEIATwBEAFkAIAB0AHkAcABlAD0AIgBMAEkAQwBFAE4AUwBFACIAIAB2AGUAcgBzAGkAbwBuAD0AIgAzAC4AMAAiAD4APABJAFMAUwBVAEUARABUAEkATQBF… + +## EncryptionHeader Structure + +This section provides an example of an **EncryptionHeader** structure (section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f)) used by Office Binary Document RC4 CryptoAPI Encryption (section [2.3.5](#Section_071a449be45349f3b0d14738dca899e3)) to specify the encryption properties for an encrypted [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +717. 00001400: 04 00 00 00 + + 00001410: 00 00 00 00 01 68 00 00 04 80 00 00 28 00 00 00 + + 00001420: 01 00 00 00 B0 0A 86 02 00 00 00 00 4D 00 69 00 + + 00001430: 63 00 72 00 6F 00 73 00 6F 00 66 00 74 00 20 00 + + 00001440: 42 00 61 00 73 00 65 00 20 00 43 00 72 00 79 00 + + 00001450: 70 00 74 00 6F 00 67 00 72 00 61 00 70 00 68 00 + + 00001460: 69 00 63 00 20 00 50 00 72 00 6F 00 76 00 69 00 + + 00001470: 64 00 65 00 72 00 20 00 76 00 31 00 2E 00 30 00 + +[TABLE] + +**Flags (4 bytes):** 0x00000004 specifies that the encryption algorithm uses CryptoAPI encryption. + +**SizeExtra (4 bytes):** 0x00000000 is the value in a reserved field. + +**AlgID (4 bytes):** 0x00006801 specifies that the encryption algorithm used is RC4. + +**AlgIDHash (4 bytes):** 0x00008004 specifies that SHA-1 is the hashing algorithm that is used. + +**KeySize (4 bytes):** 0x00000028 specifies that the key is 40 bits long. + +**ProviderType (4 bytes):** 0x00000001 specifies that RC4 is the provider type. + +**Reserved1 (4 bytes):** 0x02860AB0 is the value in a reserved field. + +**Reserved2 (4 bytes):** 0x00000000 is the value in a reserved field. + +**CSPName (variable):** "Microsoft Base Cryptographic Provider v1.0" specifies the name of the cryptographic provider supplying the RC4 implementation that was used to encrypt the file. + +## EncryptionVerifier Structure + +This section provides an example of an **EncryptionVerifier** structure (section [2.3.3](#Section_e5ad39b89bc14a19bad344e6246d21e6)) using [**AES**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e) encryption. + +725. 000018B0: 10 00 00 00 92 25 50 F6 B6 4F FE 5B D3 96 DF 5E + + 000018C0: E9 17 DA 3A BF 86 E1 8F 64 9D 17 D0 A5 41 D9 45 + + 000018D0: CE FD 96 0C 14 00 00 00 12 FF DC 88 A1 BD 26 23 + + 000018E0: 59 32 27 1F 73 0B 8F 79 4E 45 DA B3 AB 08 04 F4 + + 000018F0: 0B B9 50 46 D3 91 41 84 + +[TABLE] + +**SaltSize (4 bytes):** 0x00000010 specifies the number of bytes used by the **Salt** field and the number of bytes used by **EncryptedVerifier** field. + +**Salt (variable):** "92 25 50 F6 B6 4F FE 5B D3 96 DF 5E E9 17 DA 3A" specifies a randomly generated value used when generating the encryption key. + +**EncryptedVerifier (16 bytes):** An encrypted form of a randomly generated, 16-byte verifier value, which is the randomly generated **Verifier** value encrypted using the algorithm chosen by the implementation—for example, "BF 86 E1 8F 64 9D 17 D0 A5 41 D9 45 CE FD 96 0C". + +**VerifierHashSize (4 bytes):** 0x00000014 specifies the number of bytes used by the hash of the randomly generated **Verifier**. + +**EncryptedVerifierHash (variable):** An array of bytes that contains the encrypted form of the hash of the randomly generated **Verifier** value—for example, "12 FF DC 88 A1 BD 26 23 59 32 27 1F 73 0B 8F 79 4E 45 DA B3 AB 08 04 F4 0B B9 50 46 D3 91 41 84". + +## \EncryptionInfo Stream + +This section provides an example of an **\EncryptionInfo** [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) containing detailed information used to initialize the cryptography that is used to encrypt the **\EncryptedPackage** stream (1). + +730. 00001800: 03 00 02 00 24 00 00 00 A4 00 00 00 24 00 00 00 + + 00001810: 00 00 00 00 0E 66 00 00 04 80 00 00 80 00 00 00 + + 00001820: 18 00 00 00 E0 BC 3B 07 00 00 00 00 4D 00 69 00 + + 00001830: 63 00 72 00 6F 00 73 00 6F 00 66 00 74 00 20 00 + + 00001840: 45 00 6E 00 68 00 61 00 6E 00 63 00 65 00 64 00 + + 00001850: 20 00 52 00 53 00 41 00 20 00 61 00 6E 00 64 00 + + 00001860: 20 00 41 00 45 00 53 00 20 00 43 00 72 00 79 00 + + 00001870: 70 00 74 00 6F 00 67 00 72 00 61 00 70 00 68 00 + + 00001880: 69 00 63 00 20 00 50 00 72 00 6F 00 76 00 69 00 + + 00001890: 64 00 65 00 72 00 20 00 28 00 50 00 72 00 6F 00 + + 000018A0: 74 00 6F 00 74 00 79 00 70 00 65 00 29 00 00 00 + + 000018B0: 10 00 00 00 92 25 50 F6 B6 4F FE 5B D3 96 DF 5E + + 000018C0: E9 17 DA 3A BF 86 E1 8F 64 9D 17 D0 A5 41 D9 45 + + 000018D0: CE FD 96 0C 14 00 00 00 12 FF DC 88 A1 BD 26 23 + + 000018E0: 59 32 27 1F 73 0B 8F 79 4E 45 DA B3 AB 08 04 F4 + + 000018F0: 0B B9 50 46 D3 91 41 84 + +[TABLE] + +**EncryptionVersionInfo.vMajor (2 bytes):** 0x0003 specifies the major version. + +**EncryptionVersionInfo.vMinor (2 bytes):** 0x0002 specifies the minor version. + +**EncryptionHeader.Flags (4 bytes):** 0x00000024 specifies that the CryptoAPI implementation (0x0000004) of the ECMA-376 AES (0x00000020) algorithm [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) was used to encrypt the file. + +**EncryptionHeaderSize (4 bytes):** 0x000000A4 specifies the number of bytes used by the **EncryptionHeader** structure (section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f)). + +**EncryptionHeader (variable):** This field consists of the following: + +- **Flags:** 0x00000024 is a bit flag that specifies that the CryptoAPI implementation (0x0000004) of the ECMA-376 AES (0x00000020) algorithm \[ECMA-376\] was used to encrypt the file. + +- **SizeExtra:** 0x00000000 is unused. + +- **AlgID:** 0x0000660E specifies that the file is encrypted using the AES-128 encryption algorithm. + +- **AlgIDHash:** 0x00008004 specifies that the hashing algorithm used is SHA-1. + +- **KeySize:** 0x00000080 specifies that the key size is 128 bits. + +- **ProviderType:** 0x00000018 specifies that AES is the provider type. + +- **Reserved1:** 0x073BBCE0 is a reserved value. + +- **Reserved2:** 0x00000000 is a reserved value. + +- **CSPName:** "Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype)" specifies the name of the cryptographic provider. + +**Example** + +746. 24 00 00 00 00 00 00 00 0E 66 00 00 04 80 00 00 + + 80 00 00 00 18 00 00 00 E0 BC 3B 07 00 00 00 00 + + 4D 00 69 00 63 00 72 00 6F 00 73 00 6F 00 66 00 + + 74 00 20 00 45 00 6E 00 68 00 61 00 6E 00 63 00 + + 65 00 64 00 20 00 52 00 53 00 41 00 20 00 61 00 + + 6E 00 64 00 20 00 41 00 45 00 53 00 20 00 43 00 + + 72 00 79 00 70 00 74 00 6F 00 67 00 72 00 61 00 + + 70 00 68 00 69 00 63 00 20 00 50 00 72 00 6F 00 + + 76 00 69 00 64 00 65 00 72 00 20 00 28 00 50 00 + + 72 00 6F 00 74 00 6F 00 74 00 79 00 70 00 65 00 + + 29 00 00 00 + +**EncryptionVerifier (variable):** This field consists of the following: + +- **SaltSize:** 0x00000010 specifies the number of bytes that make up the **Salt** field. + +- **Salt:** "92 25 50 F6 B6 4F FE 5B D3 96 DF 5E E9 17 DA 3A" specifies a randomly generated value used when generating the encryption key. + +- **EncryptedVerifier:** "BF 86 E1 8F 64 9D 17 D0 A5 41 D9 45 CE FD 96 0C" specifies the encrypted form of the verifier. + +- **VerifierHashSize**: 0x00000014 specifies the number of bytes needed to contain the hash of the verifier used to generate the **EncryptedVerifier** field. + +- **EncryptedVerifierHash:** "12 FF DC 88 A1 BD 26 23 59 32 27 1F 73 0B 8F 79 4E 45 DA B3 AB 08 04 F4 0B B9 50 46 D3 91 41 84" specifies the encrypted hash of the verifier used to generate the **EncryptedVerifier** field. + +**Example** + +757. 92 25 50 F6 B6 4F FE 5B D3 96 DF 5E E9 17 DA 3A + + BF 86 E1 8F 64 9D 17 D0 A5 41 D9 45 CE FD 96 0C + + 14 00 00 00 12 FF DC 88 A1 BD 26 23 59 32 27 1F + + 73 0B 8F 79 4E 45 DA B3 AB 08 04 F4 0B B9 50 46 + + D3 91 41 84 + +## \EncryptionInfo Stream (Third-Party Extensible Encryption) + +This section provides an example of the XML structure for an **EncryptionInfo** field as specified in section [2.3.4.6](#Section_a922e41e63f2470185217f5d221a7ce0). + +762. \ + + \ + + \AAAAAA==\ + + \ + + \ + +**EncryptionData xmlns:** "urn:schemas-microsoft-com:office:office" specifies the XML namespace for this XML fragment. + +**EncryptionProvider:** Specifies the code module that contains the cryptographic functionality used in this document with the following attributes: + +- **Id:** "{05F17A8A-189E-42CD-9B21-E8F6B730EC8A}" specifies a unique identifier for the encryption provider. + +- **Url:** "http://www.contoso.com/DownloadProvider/" specifies the URL for the location of the **EncryptionProvider** code module. + +**EncryptionProviderData:** Data for consumption by the extensible encryption module specified in the **EncryptionProvider** node. + +## Office Binary Document RC4 Encryption + +### Encryption Header + +This section provides an example of an RC4 encryption header structure (section [2.3.6.1](#Section_76aeedb04d59487f8bd8fb6860a60df7)) used by Office Binary Document RC4 Encryption (section [2.3.6](#Section_5c9691138db44843a9e63f9fee5bb739)) to specify the encryption properties for an encrypted [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +00001200: 01 00 01 00 C4 DC 85 69 91 13 EC 1C F1 E5 29 06 + +00001210: 0E 49 00 B3 F3 53 BB 80 36 63 CD E3 DD F2 D1 CB + +00001220: 10 23 9B 5A 39 8F EA C2 43 EC F4 4B 9A 62 29 1B + +00001230: 1A 4C 9D CD + +[TABLE] + +**EncryptionVersionInfo (4 bytes):** A value specifying that **Version.vMajor** is 0x0001 and **Version.vMinor** is 0x0001. + +**Salt (16 bytes):** "C4 DC 85 69 91 13 EC 1C F1 E5 29 06 0E 49 00 B3" specifies a randomly generated value that is used when generating the encryption key. + +**EncryptedVerifier (16 bytes):** "F3 53 BB 80 36 63 CD E3 DD F2 D1 CB 10 23 9B 5A" specifies that the verifier is encrypted using a 40-bit RC4 cipher initialized as specified in section [2.3.6.2](#Section_09a537cc44ba4ffeaf8ae1c866ed4221), with a block number of 0x00000000. + +**EncryptedVerifierHash (16 bytes):** "39 8F EA C2 43 EC F4 4B 9A 62 29 1B 1A 4C 9D CD" specifies an MD5 hash of the verifier used to create the **EncryptedVerifier** field. + +## PasswordKeyEncryptor (Agile Encryption) + +768. 00000000: 04 00 04 00 40 00 00 00 3C 3F 78 6D 6C 20 76 65 + + 00000010: 72 73 69 6F 6E 3D 22 31 2E 30 22 20 65 6E 63 6F + + 00000020: 64 69 6E 67 3D 22 55 54 46 2D 38 22 20 73 74 61 + + 00000030: 6E 64 61 6C 6F 6E 65 3D 22 79 65 73 22 3F 3E 0D + + 00000040: 0A 3C 65 6E 63 72 79 70 74 69 6F 6E 20 78 6D 6C + + 00000050: 6E 73 3D 22 68 74 74 70 3A 2F 2F 73 63 68 65 6D + + 00000060: 61 73 2E 6D 69 63 72 6F 73 6F 66 74 2E 63 6F 6D + + 00000070: 2F 6F 66 66 69 63 65 2F 32 30 30 36 2F 65 6E 63 + + 00000080: 72 79 70 74 69 6F 6E 22 20 78 6D 6C 6E 73 3A 70 + + 00000090: 3D 22 68 74 74 70 3A 2F 2F 73 63 68 65 6D 61 73 + + 000000A0: 2E 6D 69 63 72 6F 73 6F 66 74 2E 63 6F 6D 2F 6F + + 000000B0: 66 66 69 63 65 2F 32 30 30 36 2F 6B 65 79 45 6E + + 000000C0: 63 72 79 70 74 6F 72 2F 70 61 73 73 77 6F 72 64 + + 000000D0: 22 3E 3C 6B 65 79 44 61 74 61 20 73 61 6C 74 53 + + 000000E0: 69 7A 65 3D 22 31 36 22 20 62 6C 6F 63 6B 53 69 + + 000000F0: 7A 65 3D 22 31 36 22 20 6B 65 79 42 69 74 73 3D + + 00000100: 22 31 32 38 22 20 68 61 73 68 53 69 7A 65 3D 22 + + 00000110: 32 30 22 20 63 69 70 68 65 72 41 6C 67 6F 72 69 + + 00000120: 74 68 6D 3D 22 41 45 53 22 20 63 69 70 68 65 72 + + 00000130: 43 68 61 69 6E 69 6E 67 3D 22 43 68 61 69 6E 69 + + 00000140: 6E 67 4D 6F 64 65 43 42 43 22 20 68 61 73 68 41 + + 00000150: 6C 67 6F 72 69 74 68 6D 3D 22 53 48 41 31 22 20 + + 00000160: 73 61 6C 74 56 61 6C 75 65 3D 22 2F 61 34 69 57 + + 00000170: 71 50 79 49 76 45 32 63 55 6F 6C 4A 4D 4B 72 49 + + 00000180: 77 3D 3D 22 2F 3E 3C 64 61 74 61 49 6E 74 65 67 + + 00000190: 72 69 74 79 20 65 6E 63 72 79 70 74 65 64 48 6D + + 000001A0: 61 63 4B 65 79 3D 22 75 77 70 41 45 46 57 31 68 + + 000001B0: 51 79 44 32 4F 30 31 6B 7A 31 6C 68 6A 65 76 4E + + 000001C0: 77 30 45 43 79 41 41 30 75 32 4F 78 44 79 67 73 + + 000001D0: 66 59 3D 22 20 65 6E 63 72 79 70 74 65 64 48 6D + + 000001E0: 61 63 56 61 6C 75 65 3D 22 75 66 36 48 62 4A 6A + + 000001F0: 74 72 79 4A 4F 6A 53 46 71 72 6B 71 6B 4E 51 59 + + 00000200: 39 4E 6A 4E 51 55 50 49 2B 78 63 6B 38 51 38 79 + + 00000210: 34 6D 6B 6F 3D 22 2F 3E 3C 6B 65 79 45 6E 63 72 + + 00000220: 79 70 74 6F 72 73 3E 3C 6B 65 79 45 6E 63 72 79 + + 00000230: 70 74 6F 72 20 75 72 69 3D 22 68 74 74 70 3A 2F + + 00000240: 2F 73 63 68 65 6D 61 73 2E 6D 69 63 72 6F 73 6F + + 00000250: 66 74 2E 63 6F 6D 2F 6F 66 66 69 63 65 2F 32 30 + + 00000260: 30 36 2F 6B 65 79 45 6E 63 72 79 70 74 6F 72 2F + + 00000270: 70 61 73 73 77 6F 72 64 22 3E 3C 70 3A 65 6E 63 + + 00000280: 72 79 70 74 65 64 4B 65 79 20 73 70 69 6E 43 6F + + 00000290: 75 6E 74 3D 22 31 30 30 30 30 30 22 20 73 61 6C + + 000002A0: 74 53 69 7A 65 3D 22 31 36 22 20 62 6C 6F 63 6B + + 000002B0: 53 69 7A 65 3D 22 31 36 22 20 6B 65 79 42 69 74 + + 000002C0: 73 3D 22 31 32 38 22 20 68 61 73 68 53 69 7A 65 + + 000002D0: 3D 22 32 30 22 20 63 69 70 68 65 72 41 6C 67 6F + + 000002E0: 72 69 74 68 6D 3D 22 41 45 53 22 20 63 69 70 68 + + 000002F0: 65 72 43 68 61 69 6E 69 6E 67 3D 22 43 68 61 69 + + 00000300: 6E 69 6E 67 4D 6F 64 65 43 42 43 22 20 68 61 73 + + 00000310: 68 41 6C 67 6F 72 69 74 68 6D 3D 22 53 48 41 31 + + 00000320: 22 20 73 61 6C 74 56 61 6C 75 65 3D 22 70 70 73 + + 00000330: 36 42 31 62 6D 71 43 46 58 67 6F 70 73 6D 31 72 + + 00000340: 57 6E 51 3D 3D 22 20 65 6E 63 72 79 70 74 65 64 + + 00000350: 56 65 72 69 66 69 65 72 48 61 73 68 49 6E 70 75 + + 00000360: 74 3D 22 4A 59 55 34 51 30 75 32 42 68 71 7A 51 + + 00000370: 41 35 44 34 4A 2F 76 6F 41 3D 3D 22 20 65 6E 63 + + 00000380: 72 79 70 74 65 64 56 65 72 69 66 69 65 72 48 61 + + 00000390: 73 68 56 61 6C 75 65 3D 22 65 42 32 6A 58 35 6D + + 000003A0: 76 68 42 4A 2B 39 4F 37 66 66 43 2B 36 58 32 4D + + 000003B0: 79 64 7A 32 67 6C 48 4F 58 78 30 54 39 50 6E 36 + + 000003C0: 6E 4B 2B 77 3D 22 20 65 6E 63 72 79 70 74 65 64 + + 000003D0: 4B 65 79 56 61 6C 75 65 3D 22 32 46 38 36 48 47 + + 000003E0: 2B 78 56 33 6E 47 61 32 37 44 45 6C 67 71 67 77 + + 000003F0: 3D 3D 22 2F 3E 3C 2F 6B 65 79 45 6E 63 72 79 70 + + 00000400: 74 6F 72 3E 3C 2F 6B 65 79 45 6E 63 72 79 70 74 + + 00000410: 6F 72 73 3E 3C 2F 65 6E 63 72 79 70 74 69 6F 6E + + 00000420: 3E + +[TABLE] + +**EncryptionVersionInfo.vMajor (2 bytes):** 0x0004 specifies the major version. + +**EncryptionVersionInfo.vMinor (2 bytes):** 0x0004 specifies the minor version. + +**Reserved (4 bytes):** 0x00000040 is a reserved value. + +**XmlEncryptionDescriptor (variable):** An XML block that specifies the encryption algorithms used and that contains the following XML: + +835. \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + + \ + +**keyData:** The cryptographic attributes used to encrypt the data. + +**saltSize:** 16 specifies that the salt value is 16 bytes in length. + +**blockSize:** 16 specifies that 16 bytes were used to encrypt each block of data. + +**keyBits:** 128 specifies that the key used to encrypt the data is 128 bits in length. + +**hashSize:** 20 specifies that the hash size is 20 bytes in length. + +**cipherAlgorithm:** "AES" specifies that the cipher algorithm used to encrypt the data is AES. + +**cipherChaining:** "ChainingModeCBC" specifies that the chaining mode to encrypt the data is CBC. + +**hashAlgorithm:** "SHA-1" specifies that the hashing algorithm used to hash the data is SHA-1. + +**SaltValue:** "/a4iWqPyIvE2cUolJMKrIw==" specifies a randomly generated value used when generating the encryption key. + +**dataIntegrity:** Specifies the encrypted copies of the salt and hash values used to help ensure that the integrity of the encrypted data has not been compromised. + +**encryptedHmacKey**: "uwpAEFW1hQyD2O01kz1lhjevNw0ECyAA0u2OxDygsfY=" specifies the encrypted copy of the randomly generated value used when generating the encryption key. + +**encryptedHmacValue**: "uf6HbJjtryJOjSFqrkqkNQY9NjNQUPI+xck8Q8y4mko=" specifies the encrypted copy of the hash value that is generated during the creation of the encryption key. + +**keyEncryptors:** Specifies the key encryptors used to encrypt the data. + +**keyEncryptor:** "http://schemas.microsoft.com/office/2006/keyEncryptor/password" specifies that the schema used by this encryptor is the schema specified in section [2.3.4.10](#Section_87020a34e73f413999bcbbdf6cf6fa55) for password-based encryptors. + +**p:encryptedKey:** The attributes used to generate the encrypting key. + +**spinCount:** 100000 specifies that there are 100000 iterations on the hash of the password. + +**saltSize:** 16 specifies that the salt value is 16 bytes long. + +**blockSize:** 16 specifies that 16 bytes were used to encrypt each block of data. + +**keyBits:** 128 specifies that the key is 128 bits in length. + +**hashSize:** 20 specifies that the hash is 20 bytes in length. + +**cipherAlgorithm:** "AES" specifies that the cipher used to encrypt the data is AES. + +**cipherChaining:** "ChainingModeCBC" specifies that the chaining mode used for encrypting is CBC. + +**hashAlgorithm:** "SHA-1" specifies that the hashing algorithm used is SHA-1. + +**saltValue:** "pps6B1bmqCFXgopsm1rWnQ==" specifies the randomly generated value used for encrypting the data. + +**encryptedVerifierHashInput:** "JYU4Q0u2BhqzQA5D4J/voA==" specifies the **encryptedVerifierHashInput** attribute encoded as specified in section [2.3.4.13](#Section_a57cb947554f4e5eb1503f2978225e92). + +**encryptedVerifierHashValue:** "eB2jX5mvhBJ+9O7ffC+6X2Mydz2glHOXx0T9Pn6nK+w=" specifies the **encryptedVerifierHashValue** encoded as specified in section 2.3.4.13. + +**encryptedKeyValue:** "2F86HG+xV3nGa27DElgqgw==" specifies the **encryptedKeyValue** encoded as specified in section 2.3.4.13. + +## LabelInfo Stream + +This section provides example L**abelInfo [streams (2)](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6)** (section [2.6.4](#Section_b75503d0ada14ecaadc1adeb643ab813)). + +The example below has both applied [**sensitivity labels**](#gt_a1b4b3d0-e8a3-49a6-a5de-51f86ed117c7) (id="{1e5447a7-0548-4856-b1af-4c253c3ad016}", id="{989510b7-9e58-40d7-98bf-60b911cb0ea9}", and id="{f5ad6165-baa2-492b-b3cc-e7925d2faba7}") and removed sensitivity labels (id="{30863317-b7ea-4af9-ba77-23ca2107d146}" and id="{ec916be2-2331-4c51-b61a-32f19fd0a1e3}"). + +871. \\\\\\\\ + +This example provides a **extLst** element (section [2.6.4.5](#Section_792c5bdb59314818a238776039c414f8)) showing two separate hypothetical features. + +872. \\\\\\\\\\\ + +# Security + +## Security Considerations for Implementers + +### Data Spaces + +None. + +### Information Rights Management + +It is recommended that software components that implement the [**Information Rights Management (IRM)**](#gt_ff35237a-a497-42aa-b0d5-7a0116328759) Data Space make a best effort to respect the licensing limitations applied to the protected content in the document. + +Security considerations concerning rights management are as described in [\[MS-RMPR\]](%5bMS-RMPR%5d.pdf#Section_d8ed4b1ee6054668b1736312cba6977e). + +### Encryption + +#### ECMA-376 Document Encryption + +ECMA-376 document encryption [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) using standard encryption does not support [**CBC**](#gt_5d31e40d-bc6a-4813-8087-056aaafa4f01) and does not have a provision for detecting corruption, although a block cipher (specifically, AES) is not known to be subject to bit-flipping attacks. ECMA-376 documents using agile encryption are required to use CBC and corruption detection, and are not subject to the issues noted for standard encryption. + +When setting algorithms for agile encryption, the SHA-2 series of hashing algorithms is preferred. MD2, MD4, and MD5 are not recommended. Older cipher algorithms, such as DES, are also not recommended. + +Passwords are limited to 255 Unicode code points. + +#### Office Binary Document RC4 CryptoAPI Encryption + +The Office binary document RC4 CryptoAPI encryption method is not recommended and ought to be used only when backward compatibility is required. + +Passwords are limited to 255 Unicode characters. + +Office binary document RC4 CryptoAPI encryption has the following known cryptographic weaknesses: + +- The key derivation algorithm described in section [2.3.5.2](#Section_12ec1195af2d44e68c73003e79e635d5) is weak because of the lack of a repeated iteration mechanism, and the password might be subject to rapid brute-force attacks. + +- Encryption begins with the first byte and does not throw away an initial range as is recommended to overcome a known weakness in the RC4 pseudorandom number generator. + +- No provision is made for detecting corruption within the encryption [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6), which exposes encrypted data to bit-flipping attacks. + +- When used with small key lengths (such as 40-bit), brute-force attacks on the key without knowing the password are possible. + +- Some streams (1) are not encrypted. + +- Key stream (1) reuse can occur in document data streams (1), potentially with known plaintext, implying that certain portions of encrypted data can be either directly extracted or trivially retrieved. + +- Key stream (1) reuse occurs multiple times within the RC4 CryptoAPI Encrypted Summary stream (1). + +- Document properties might not be encrypted, which could result in information leakage. + +Because of the cryptographic weaknesses of the Office binary document RC4 CryptoAPI encryption, it is considered insecure, and therefore is not recommended when storing sensitive materials. + +#### Office Binary Document RC4 Encryption + +The Office binary document RC4 encryption method is not recommended, and ought to be used only when backward compatibility is required. + +Passwords are limited to 255 Unicode characters. + +Office binary document RC4 encryption has the following known cryptographic weaknesses: + +- The key derivation algorithm is not an iterated hash, as described in [\[RFC2898\]](https://go.microsoft.com/fwlink/?LinkId=119708), which allows brute-force attacks against the password to be performed rapidly. + +- Encryption begins with the first byte, and does not throw away an initial range as is recommended to overcome a known weakness in the RC4 pseudorandom number generator. + +- No provision is made for detecting corruption within the encryption [**stream (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6), which exposes encrypted data to bit-flipping attacks. + +- While the derived encryption key is actually 128 bits, the input used to derive the key is fixed at 40 bits, and current hardware enables brute-force attacks on the encryption key without knowing the password in a relatively short period of time so that even if the password cannot easily be recovered, the information could still be disclosed. + +- Some streams (1) might not be encrypted. + +- Depending on the application, key stream (1) reuse could occur, potentially with known plaintext, implying that certain portions of encrypted data could be either directly extracted or easily retrieved. + +- Document properties might not be encrypted, which could result in information leakage. + +Because of the cryptographic weaknesses of the Office Binary Document RC4 Encryption, it is considered easily reversible and therefore is not recommended when storing sensitive materials. + +#### XOR Obfuscation + +XOR obfuscation is not recommended. Document data can easily be extracted. The document password could be retrievable. + +Passwords are truncated to 15 characters. It is possible for multiple passwords to map to the same key. + +#### Information Rights Management Cypher Block Chaining + +To generate the Initialization Vector (IV) for [**Cipher block chaining (CBC)**](#gt_5d31e40d-bc6a-4813-8087-056aaafa4f01) encryption mode for [**Information Rights Management (IRM)**](#gt_ff35237a-a497-42aa-b0d5-7a0116328759) [**encrypted documents**](#gt_3bcdc50b-9595-415a-ab9f-dd569ad92220), document writers shall use a 128 bit IV buffer, cast the 0-based block starting offset (not the block number) of the [**document stream**](#gt_554b8f23-fbae-4968-b9a5-d9179f1fe3bb) as an unsigned 32-bit integer, and write it to the buffer [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) to form the first 4 bytes of the buffer, leaving the remaining 12 bytes set to 0. Then the IV shall be encrypted with [**Advanced Encryption Standard (AES)**](#gt_21edac94-99d0-44cb-bc1a-3416d8fc618e) [**electronic codebook (ECB)**](#gt_c44ff0b3-baac-4993-879f-d72ed61239aa) encryption. + +### Document Write Protection + +Document write protection methods 1 (section [2.4.2.1](#Section_90743a0f216744799043603cc97fd57b)) and 3 (section [2.4.2.3](#Section_57fc02f0c1de4fc6908fd146104662f5)) both embed the password in plaintext into the file. Although method 3 subsequently encrypts the file, the encryption is flawed, and the password is described in section 2.4.2.3. In both cases, the password can be extracted with little difficulty. Document write protection is not considered to be a security mechanism, and the write protection can easily be removed by using a binary editor. Document write protection is meant to protect against accidental modification only. + +Some file formats, such as those described in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) and [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06), restrict password length to 15 characters. It is possible for multiple passwords to map to the same key when using document write protection method 2 (section [2.4.2.2](#Section_f13ac487587843c99e241ec0efe3155e)). + +### Binary Document Digital Signatures + +Certain [**streams (1)**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and storages are not subject to signing. Tampering with these streams (1) or storages does not invalidate the signature. + +## Index of Security Fields + +None. + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- Microsoft Office 97 + +- Microsoft Office 2000 + +- Microsoft Office XP + +- Microsoft Office 2003 + +- The 2007 Microsoft Office system + +- Microsoft Office 2010 suites + +- Microsoft Office 2013 + +- Microsoft Office 2016 + +- Microsoft Office 2019 + +- Microsoft Office SharePoint Server 2007 + +- Microsoft SharePoint Server 2010 + +- Microsoft SharePoint Server 2013 + +- Microsoft SharePoint Server 2016 + +- Microsoft SharePoint Server 2019 + +- Microsoft Office 2021 + +- Microsoft SharePoint Server Subscription Edition + +- Microsoft Office LTSC 2024 + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 2.1.1](#Appendix_A_Target_1): Applies to Microsoft OneNote version 2511 and later. + +[\<2\> Section 2.2](#Appendix_A_Target_2): Applications in Office 2003, the 2007 Microsoft Office system, Microsoft Office 2010 suites and Office 2013 versions encrypt the Microsoft Office binary documents by persisting the entire document to a temporary OLE compound file and then transforming the physical representation of the OLE compound file as a single stream of bytes. Similarly, ECMA-376 documents [\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) are encrypted by adding the entire file package to a temporary file and then transforming the physical representation of the file as a single stream of bytes. + +The following streams are also stored outside the protected content to preserve interoperability with applications that do not understand the IRMDS structure: + +- **\_signatures** + +- **0x01CompObj** + +- **Macros** + +- **\_VBA_PROJECT_CUR** + +- **0x05SummaryInformation** + +- **0x05DocumentSummaryInformation** + +- **MsoDataStore** + +Applications in Office 2003, the 2007 Office system, Office 2010 and Office 2013 also create the streams and storages necessary to create a default document within the OLE compound file. This default document contains a short message to the user indicating that the actual document contents are encrypted. This allows versions of Microsoft Office that do not understand the IRMDS structure to open the default document instead of rejecting the file. + +[\<3\> Section 2.2.1](#Appendix_A_Target_3): Office 2003, the 2007 Office system, Office 2010 and Office 2013 offer the user the option of creating a transformed MHTML representation of the document when applying a rights management policy to a document. This option is on by default in Microsoft Office Excel 2003 and off by default in all other applications in Office 2003, and it is off by default in all applications in the 2007 Office system, Office 2010 and Office 2013. If the transformed MHTML representation is created, the **0x09LZXDRMDataSpace** data space definition is applied to it (which includes both LZX compression and encryption). + +[\<4\> Section 2.2.2](#Appendix_A_Target_4): Office 2003, the 2007 Office system, Office 2010 and Office 2013 offer the user the option of creating a transformed MHTML representation of the document when applying a rights management policy to a document. This option is on by default in Office Excel 2003 and off by default in all other Office 2003 applications, and it is off by default in all applications in the 2007 Office system and newer versions. If the transformed MHTML representation is created, the **0x09LZXDRMDataSpace** data space definition is applied to it (which includes both LZX compression and encryption). + +[\<5\> Section 2.2.3](#Appendix_A_Target_5): Office 2003, the 2007 Office system, Office 2010 and Office 2013 offer the user the option of creating a transformed MHTML representation of the document when applying a rights management policy to a document. This option is on by default in Office Excel 2003 and off by default in all other Office 2003 applications, and it is off by default in all applications in the 2007 Office system, Office 2010 and Office 2013. If the transformed MHTML representation is created, the **0x09LZXDRMDataSpace** data space definition is applied to it (which includes both LZX compression and encryption). + +[\<6\> Section 2.2.4](#Appendix_A_Target_6): The information in this section applies to OneNote version 2511 and later if the file is protected by a sensitivity label and the label specifies encryption. + +[\<7\> Section 2.2.6](#Appendix_A_Target_7): Office SharePoint Server 2007 uses the **AUTHENTICATEDDATA** element with the **name** set to "ListGUID" as the application-specific GUID that identifies the storage location for the document. This is stored encrypted within the element as follows. + +873. \ + +Once decrypted, the XrML document contains an element named **AUTHENTICATEDDATA**, containing an attribute named **id** with a value of "APPSPECIFIC" and an attribute named **name** with a value of ListGUID with the contents of the ListGUID. + +[\<8\> Section 2.2.11](#Appendix_A_Target_8): Office 2003, the 2007 Office system, Office 2010 and Office 2013 offer the user the option of creating a transformed MHTML representation of the document when applying a rights management policy to a document. This option is on by default in Office Excel 2003 and off by default in all other Office 2003 applications, and it is off by default in all applications in the 2007 Office system, Office 2010 and Office 2013. If the transformed MHTML representation is created, the **0x09LZXDRMDataSpace** data space definition is applied to it (which includes both LZX compression and encryption). + +[\<9\> Section 2.3.1](#Appendix_A_Target_9): In the 2007 Office system, the 2007 Office system, Office 2010 and Office 2013, the default encryption algorithm for ECMA-376 standard encryption documents \[ECMA-376\] is 128-bit AES, and both 192-bit and 256-bit AES are also supported. It is possible to use alternate encryption algorithms, and for best results, a block cipher supporting [**ECB**](#gt_c44ff0b3-baac-4993-879f-d72ed61239aa) mode is recommended. Additionally, the algorithm ought to convert one block of plaintext to one block of encrypted data, where both blocks are the same size. This information is for guidance only, and it is possible that if alternate algorithms are used, the applications in the 2007 Office system, Office 2010 and Office 2013 might not open the document properly or that information leakage could occur. + +[\<10\> Section 2.3.2](#Appendix_A_Target_10): Several of the cryptographic techniques specified in this document use the [**Cryptographic Application Programming Interface (CAPI) or CryptoAPI**](#gt_7ddf051d-9105-430a-8a89-f551dd4dd0ee) when implemented by Microsoft Office on the Microsoft Windows operating systems. While an implementation is not required to use CryptoAPI, if an implementation is required to interoperate with the 2007 Office system, the 2007 Office system, Office 2010 and Office 2013 on the Windows XP operating system, Windows Vista operating system, Windows 7 operating system, Windows 8 operating system and Windows 8.1 operating systems, the following are required: + +**Cryptographic service provider (CSP):** A library containing implementations of cryptographic algorithms. Several CSPs that support the algorithms required in this specification are present by default on Windows XP, Windows Vista, Windows 7, Windows 8 and Windows 8.1 operating systems. Alternate CSPs can be used, if the CSP is installed on all systems consuming or producing a document. + +**AlgID:** An integer representing an encryption algorithm in the CryptoAPI. Required **AlgID** values are specified in the remainder of this document. Alternate **AlgID** values can be used if the CSP supporting the alternate **AlgID** is installed on all systems consuming or producing a document. + +**AlgIDHash:** An integer representing a hashing algorithm in the CryptoAPI. Required **AlgIDHash** values are specified in the remainder of this document. For encryption operations, the hashing algorithm is fixed and cannot vary from the algorithms specified. + +The following cryptographic providers are recommended to facilitate interoperability across all supported versions of Windows: + +- Microsoft Base Cryptographic Provider v1.0 + +- Microsoft Enhanced Cryptographic Provider v1.0 + +- Microsoft Enhanced RSA and AES Cryptographic Provider + +Note that the following providers are equivalent: + +- Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype) + +- Microsoft Enhanced RSA and AES Cryptographic Provider + +The provider listed as "Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype)" is found on Windows XP. An implementation needs to treat these providers as equivalent when attempting to resolve a CSP on a Windows system. + +When using AES encryption for ECMA-376 documents \[ECMA-376\], the Microsoft Enhanced RSA and AES Cryptographic Provider is written into the header, unless AES encryption facilities are obtained from an alternate cryptographic provider as noted in the next paragraph. When using CryptoAPI RC4 encryption, be aware that the Microsoft Base Cryptographic Provider v1.0 is limited to 56-bit key lengths. The other providers listed support up to 128-bit key lengths. + +Other cryptographic providers can be used, but documents specifying other providers will not open properly if the cryptographic provider is not present. On a non-Windows system, the cryptographic provider will be ignored when opening a file, and the algorithm and key length will be determined by the **EncryptionHeader.AlgID** and **EncryptionHeader.KeySize** fields. When writing a file from a non-Windows system, a correct cryptographic provider needs to be supplied for implementations on Windows systems to properly open the file. + +Additionally, a **ProviderType** parameter is required for an **EncryptionHeader** structure that is compatible with the CSP and encryption algorithm chosen. To facilitate interoperability, the **ProviderTypes** listed in section [2.3.2](#Section_dca653b5b93b48df8e1e0fb9e1c83b0f) are recommended. + +Additionally, see section [4.1.3](#Section_f6c7b94c2832485796d05aa317ada107) for additional information regarding the cryptography used. + +[\<11\> Section 2.3.4.5](#Appendix_A_Target_11): Office 2003 applications set a **Version.vMajor** version value of 0x0002. Applications in the 2007 Office system and Microsoft Office 2007 Service Pack 1 (SP1) set a **Version.vMajor** value of 0x0003. Versions Microsoft Office 2007 Service Pack 2 (SP2), Office 2010 and Office 2013 set a **Version.vMajor** value of 0x0004. + +[\<12\> Section 2.3.4.5](#Appendix_A_Target_12): In the 2007 Office system, Office 2010 and Office 2013, the default encryption algorithm for ECMA-376 standard encryption documents \[ECMA-376\] is 128-bit AES, and both 192-bit and 256-bit AES are also supported. It is possible to use alternate encryption algorithms, and for best results, a block cipher supporting ECB mode is recommended. Additionally, the algorithm ought to convert one block of plaintext to one block of encrypted data, where both blocks are the same size. This information is for guidance only, and it is possible that if alternate algorithms are used, the applications in the 2007 Office system, Office 2010 and Office 2013 might not open the document properly or that information leakage could occur. + +[\<13\> Section 2.3.4.5](#Appendix_A_Target_13): In the 2007 Office system, Office 2010 and Office 2013, the default encryption algorithm for ECMA-376 standard encryption documents \[ECMA-376\] is 128-bit AES, and both 192-bit and 256-bit AES are also supported. It is possible to use alternate encryption algorithms, and for best results, a block cipher supporting ECB mode is recommended. Additionally, the algorithm ought to convert one block of plaintext to one block of encrypted data, where both blocks are the same size. This information is for guidance only, and it is possible that if alternate algorithms are used, the applications in the 2007 Office system, Office 2010 and Office 2013 might not open the document properly or that information leakage could occur. + +[\<14\> Section 2.3.4.6](#Appendix_A_Target_14): On Windows XP, Windows Vista, Windows 7, Windows 8 and Windows 8.1, **CSPName** specifies the GUID of the extensible encryption module used for this file format. This GUID specifies the CLSID of the [**COM**](#gt_ef2ebebc-1760-407a-9ace-af48f9050e02) module containing cryptographic functionality. The **CSPName** is required to be a null-terminated Unicode string. + +[\<15\> Section 2.3.4.10](#Appendix_A_Target_15): The use of RC2 is not recommended. If RC2 is used with a key length of less than 128 bits, documents could interoperate incorrectly across different operating system versions. + +[\<16\> Section 2.3.4.10](#Appendix_A_Target_16): The use of DES is not recommended. If DES is used, the key length specified in the **KeyBits** element is required to be set to 64 for 56-bit encryption, and the key decrypted from **encryptedKeyValue** of **KeyEncryptor** is required to include the DES parity bits. + +[\<17\> Section 2.3.4.10](#Appendix_A_Target_17): The use of DESX is not recommended. If DESX is used, documents could interoperate incorrectly across different operating system versions. + +[\<18\> Section 2.3.4.10](#Appendix_A_Target_18): If 3DES or 3DES_112 is used, the key length specified in the **KeyBits** element is required to be set to 192 for 168-bit encryption and 128 for 112-bit encryption, and the key decrypted from **encryptedKeyValue** of **KeyEncryptor** is required to include the DES parity bits. + +[\<19\> Section 2.3.4.10](#Appendix_A_Target_19): If 3DES or 3DES_112 is used, the key length specified in the **KeyBits** element is required to be set to 192 for 168-bit encryption and 128 for 112-bit encryption, and the key decrypted from **encryptedKeyValue** of **KeyEncryptor** is required to include the DES parity bits. + +[\<20\> Section 2.3.4.10](#Appendix_A_Target_20): Any algorithm that can be resolved by name by the underlying operating system can be used for hashing or encryption. Only block algorithms are supported for encryption. AES-128 is the default encryption algorithm, and SHA-1 is the default hashing algorithm if no other algorithms have been configured. + +[\<21\> Section 2.3.4.10](#Appendix_A_Target_21): Any algorithm that can be resolved by name by the underlying operating system can be used for hashing or encryption. Only block algorithms are supported for encryption. AES-128 is the default encryption algorithm, and SHA-1 is the default hashing algorithm if no other algorithms have been configured. + +[\<22\> Section 2.3.4.10](#Appendix_A_Target_22): All ECMA-376 documents \[ECMA-376\] encrypted by Microsoft Office using agile encryption will have a **DataIntegrity** element present. The schema allows for a **DataIntegrity** element to not be present because the encryption schema can be used by applications that do not create ECMA-376 documents \[ECMA-376\]. + +[\<23\> Section 2.3.5.1](#Appendix_A_Target_23): Office 2003 applications set a **Version.vMajor** version of 0x0002. Applications in the 2007 Office system and Office 2007 SP1 set a **Version.vMajor** value of 0x0003. Versions such as Office 2007 SP2, Office 2010 and Office 2013set a **Version.vMajor** value of 0x004. + +[\<24\> Section 2.3.5.1](#Appendix_A_Target_24): Several of the cryptographic techniques specified in this document use the Cryptographic Application Programming Interface (CAPI) or CryptoAPI when implemented by Microsoft Office on the Windows operating systems. While an implementation is not required to use CryptoAPI, if an implementation is required to interoperate with Microsoft Office on the Windows operating systems, the following are required: + +**Cryptographic service provider (CSP):** A CSP refers to a library containing implementations of cryptographic algorithms. Several CSPs that support the algorithms required in this specification are present by default on the latest versions of Windows. Alternate CSPs can be used, if the CSP is installed on all systems consuming or producing a document. + +**AlgID:** An integer representing an encryption algorithm in the CryptoAPI. Required **AlgID** values are specified in the remainder of this document. Alternate **AlgIDs** can be used if the CSP supporting the alternate **AlgID** is installed on all systems consuming or producing a document. + +**AlgIDHash:** An integer representing a hashing algorithm in the CryptoAPI. Required **AlgIDHash** values are specified in the remainder of this document. For encryption operations, the hashing algorithm is fixed and cannot vary from the algorithms specified. + +The following cryptographic providers are recommended to facilitate interoperability across all supported versions of Windows: + +- Microsoft Base Cryptographic Provider v1.0 + +- Microsoft Enhanced Cryptographic Provider v1.0 + +- Microsoft Enhanced RSA and AES Cryptographic Provider + +Note that the following providers are equivalent: + +- Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype) + +- Microsoft Enhanced RSA and AES Cryptographic Provider + +The provider listed as "Microsoft Enhanced RSA and AES Cryptographic Provider (Prototype)" is found on Windows XP. An implementation needs to treat these providers as equivalent when attempting to resolve a CSP on a Windows system. + +When using AES encryption for ECMA-376 documents \[ECMA-376\], the Microsoft Enhanced RSA and AES Cryptographic Provider is written into the header, unless AES encryption facilities are obtained from an alternate cryptographic provider as noted in the next paragraph. When using CryptoAPI RC4 encryption, be aware that the Microsoft Base Cryptographic Provider v1.0 is limited to 56-bit key lengths. The other providers listed support up to 128-bit key lengths. + +Other cryptographic providers can be used, but documents specifying other providers might not open properly if the cryptographic provider is not present. On a non-Windows system, the cryptographic provider will be ignored when opening a file, and the algorithm and key length will be determined by the **EncryptionHeader.AlgID** and **EncryptionHeader.KeySize** fields. When writing a file from a non-Windows system, a correct cryptographic provider needs to be supplied for implementations on Windows systems to properly open the file. + +Additionally, a **ProviderType** parameter is required for an **EncryptionHeader** structure that is compatible with the CSP and encryption algorithm chosen. To facilitate interoperability, the **ProviderTypes** listed in section 2.3.2 are recommended. + +Additionally, see section 4.1.3 for additional information regarding the cryptography used. + +[\<25\> Section 2.3.5.4](#Appendix_A_Target_25): Office 2003, the 2007 Office system, Office 2010 and Office 2013 allow the user to optionally encrypt the **\0x05SummaryInformation** and **\0x05DocumentSummaryInformation** streams. Additional streams and storages can also be encrypted within the RC4 CryptoAPI summary stream. + +[\<26\> Section 2.4.1](#Appendix_A_Target_26): Documents generated by Microsoft Office Excel 2007, Microsoft Excel2010 and Microsoft Excel 2013 can be encrypted as specified in section [2.3](#Section_e47faaedee584309903388b342df5469) with the following password: "\x56\x65\x6C\x76\x65\x74\x53\x77\x65\x61\x74\x73\x68\x6F\x70". The conditions under which this password is used are described in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) and [\[MS-XLSB\]](%5bMS-XLSB%5d.pdf#Section_acc8aa921f02416799f584f9f676b95a). + +[\<27\> Section 2.4.2.2](#Appendix_A_Target_27): Documents generated by Office Excel 2007, Excel 2010 and Excel 2013 can be encrypted as specified in section 2.3 with the following password: "\x56\x65\x6C\x76\x65\x74\x53\x77\x65\x61\x74\x73\x68\x6F\x70". The conditions under which this password is used are described in \[MS-XLS\] and \[MS-XLSB\]. + +[\<28\> Section 2.4.2.3](#Appendix_A_Target_28): Documents created by Microsoft Office PowerPoint 2003, Microsoft Office PowerPoint 2007 and Microsoft Office PowerPoint 2007 Service Pack 1 use the default password. Microsoft Office PowerPoint 2007 Service Pack 2 does not use the default password. A document created without the default password can be opened in earlier versions. Due to security concerns, it is preferable not to use the default password. + +[\<29\> Section 2.4.2.4](#Appendix_A_Target_29): Any algorithm that can be resolved by name by the underlying operating system can be used for hashing or encryption. Only block algorithms are supported for encryption. AES-128 is the default encryption algorithm, and SHA-1 is the default hashing algorithm if no other algorithms have been configured. + +[\<30\> Section 2.5.2.1](#Appendix_A_Target_30): In the 2007 Office system, the SHA-1 hashing algorithm is required to be used for this purpose. Office 2010 and Office 2013 require only that the underlying operating system support the hashing algorithm. + +[\<31\> Section 2.5.2.1](#Appendix_A_Target_31): In the 2007 Office system, the SHA-1 hashing algorithm is required to be used for this purpose. Office 2010 and Office 2013 require only that the underlying operating system support the hashing algorithm. + +[\<32\> Section 2.5.2.4](#Appendix_A_Target_32): In the 2007 Office system, the SHA-1 hashing algorithm is required to be used for this purpose. Office 2010 and Office 2013 versions require only that the underlying operating system support the hashing algorithm. + +[\<33\> Section 2.5.2.5](#Appendix_A_Target_33): Office 2010, Office 2013 and the 2007 Office system reserve the value of {00000000-0000-0000-0000-000000000000} for their default signature providers and {000CD6A4-0000-0000-C000-000000000046} for their East Asian signature providers. + +[\<34\> Section 2.5.2.6](#Appendix_A_Target_34): Office 2010 and Office 2013 adds XML Advanced Electronic Signatures ([\[XAdES\]](https://go.microsoft.com/fwlink/?LinkId=151586)) extensions to xmldsig signatures when configured to do so by the user. By default, XAdES-EPES signatures are used, as specified in \[XAdES\] section 4.4.2. + +[\<35\> Section 2.5.2.6](#Appendix_A_Target_35): By default, Office 2010 and Office 2013 places the reference to the **SignedProperties** element within the **SignedInfo** element. the 2007 Office system needs an update to correctly validate a reference within the **SignedInfo** element that is not to a top-level **Object** element, and incorrectly rejects these signatures as invalid. To ensure compatibility with earlier versions of Office that have not been updated to validate the signature correctly, an implementation can place the **Reference** element within a manifest. + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [1.4](#Section_ead5df2257e1483fbb8a9a57facbcd6e) Relationship to Protocols and Other Structures | Added reference to \[MS-ONE\]: OneNote File Format. | Major | +| [2.1.1](#Section_11dfbc00031a44bca836e7b9872438fd) File | Added information specific to OneNote. | Major | +| [2.2.4](#Section_dc6708bbe85244b1acbaf74614155191) \0x06DataSpaces\TransformInfo Storage for ECMA-376 Documents | Added information specific to OneNote. | Major | + +# Index + +\\ + +[\\signatures stream](#signatures-stream) 70 + +[\0x06DataSpaces\DataSpaceInfo storage – encryption](#x06dataspacesdataspaceinfo-storage-1) 38 + +[\0x06DataSpaces\DataSpaceInfo storage – IRMDS](#x06dataspacesdataspaceinfo-storage) 29 + +[\0x06DataSpaces\DataSpaceMap stream – encryption](#x06dataspacesdataspacemap-stream-1) 38 + +[\0x06DataSpaces\DataSpaceMap stream – IRMDS](#x06dataspacesdataspacemap-stream) 28 + +[\0x06DataSpaces\TransformInfo storage – encryption](#x06dataspacestransforminfo-storage) 38 + +[\0x06DataSpaces\TransformInfo storage for ECMA-376 documents – IRMDS](#x06dataspacestransforminfo-storage-for-ecma-376-documents) 30 + +[\0x06DataSpaces\TransformInfo storage for Office binary documents – IRMDS](#x06dataspacestransforminfo-storage-for-office-binary-documents) 29 + +[\EncryptedPackage stream – encryption](#encryptedpackage-stream) 39 + +[\EncryptionInfo stream (agile encryption) – encryption](#encryptioninfo-stream-agile-encryption) 44 + +[\EncryptionInfo stream (extensible encryption) – encryption](#encryptioninfo-stream-extensible-encryption) 40 + +[\EncryptionInfo stream (standard encryption) – encryption](#encryptioninfo-stream-standard-encryption) 39 + +[\EncryptionInfo Stream (Third-Party Extensible Encryption) example](#encryptioninfo-stream-third-party-extensible-encryption) 98 + +[\EncryptionInfo Stream example](#encryptioninfo-stream) 96 + +\_ + +[\_xmlsignatures storage](#xmlsignatures-storage) 77 + +0 + +[0x06Primary Stream example](#x06primary-stream) 90 + +4 + +[40-bit RC4 encryption overview](#bit-rc4-encryption) 17 + +A + +Applicability overview + +[data spaces](#data-spaces-1) 19 + +[encryption](#encryption-1) 20 + +[Array overview](#array) 19 + +B + +Binary document digital signatures + +[\\signatures stream](#signatures-stream) 70 + +[\_xmlsignatures storage](#xmlsignatures-storage) 77 + +[CryptoAPI digital signature CertificateInfo structure](#cryptoapi-digital-signature-certificateinfo-structure) 68 + +[CryptoAPI digital signature generation](#cryptoapi-digital-signature-generation) 70 + +[CryptoAPI digital signature structure](#cryptoapi-digital-signature-structure) 70 + +[idOfficeObject object element](#idofficeobject-object-element) 73 + +[idPackageObject object element](#idpackageobject-object-element) 73 + +[KeyInfo element](#keyinfo-element) 73 + +security + +[implementer considerations](#binary-document-digital-signatures-1) 106 + +[SignatureValue element](#signaturevalue-element) 72 + +[SignedInfo element](#signedinfo-element) 72 + +[TimeEncoding structure](#timeencoding-structure) 67 + +[XAdES elements](#xades-elements) 76 + +[Xmldsig digital signature elements](#xmldsig-digital-signature-elements) 72 + +[Binary document digital signatures structure](#binary-document-digital-signatures) 67 + +[Binary document password verifier derivation Method 1 – encryption](#binary-document-password-verifier-derivation-method-1) 60 + +[Binary document password verifier derivation Method 2 – encryption](#binary-document-password-verifier-derivation-method-2) 63 + +[Binary document write protection Method 1](#binary-document-write-protection-method-1) 65 + +[Binary document write protection Method 2](#binary-document-write-protection-method-2) 65 + +[Binary document write protection Method 3](#binary-document-write-protection-method-3) 66 + +[Binary document XOR array initialization Method 1 – encryption](#binary-document-xor-array-initialization-method-1) 60 + +[Binary document XOR array initialization Method 2 – encryption](#binary-document-xor-array-initialization-method-2) 64 + +[Binary document XOR data transformation Method 1 – encryption](#binary-document-xor-data-transformation-method-1) 62 + +[Binary document XOR data transformation Method 2 – encryption](#binary-document-xor-data-transformation-method-2) 65 + +Byte ordering + +[overview](#byte-ordering) 18 + +C + +[Certificate chain example](#certificate-chain) 93 + +[Change tracking](#change-tracking) 114 + +[CryptoAPI digital signature CertificateInfo structure](#cryptoapi-digital-signature-certificateinfo-structure) 68 + +[CryptoAPI digital signature generation](#cryptoapi-digital-signature-generation) 70 + +[CryptoAPI digital signature structure](#cryptoapi-digital-signature-structure) 70 + +[CryptoAPI RC4 encryption overview](#cryptoapi-rc4-encryption) 17 + +D + +[Data encryption (agile encryption) – encryption](#data-encryption-agile-encryption) 52 + +Data spaces + +[applicability](#data-spaces-1) 19 + +[DataSpaceDefinition structure](#dataspacedefinition) 26 + +[DataSpaceMap structure](#dataspacemap) 24 + +[DataSpaceMapEntry structure](#dataspacemapentry-structure) 25 + +[DataSpaceReferenceComponent structure](#dataspacereferencecomponent-structure) 25 + +[DataSpaceVersionInfo structure](#dataspaceversioninfo) 23 + +[EncryptionTransformInfo structure](#encryptiontransforminfo) 27 + +[File](#file) 21 + +[Length-Prefixed Padded Unicode String (UNICODE-LP-P4) structure](#length-prefixed-padded-unicode-string-unicode-lp-p4) 22 + +[Length-Prefixed UTF-8 String (UTF-8-LP-P4) structure](#length-prefixed-utf-8-string-utf-8-lp-p4) 23 + +[overview](#data-spaces) 14 + +security + +[implementer considerations](#data-spaces-3) 104 + +[TransformInfoHeader structure](#transforminfoheader) 27 + +[version structure](#version) 23 + +[Data spaces structure](#data-spaces-2) 21 + +[DataIntegrity generation (agile encryption) – encryption](#dataintegrity-generation-agile-encryption) 52 + +[DataSpaceDefinition structure – data spaces](#dataspacedefinition) 26 + +[DataSpaceMap Stream example](#dataspacemap-stream) 88 + +[DataSpaceMap structure – data spaces](#dataspacemap) 24 + +[DataSpaceMapEntry structure – data spaces](#dataspacemapentry-structure) 25 + +[DataSpaceMapEntry structure example](#dataspacemapentry-structure-1) 89 + +[DataSpaceReferenceComponent structure – data spaces](#dataspacereferencecomponent-structure) 25 + +[DataSpaceVersionInfo structure – data spaces](#dataspaceversioninfo) 23 + +Details + +[\\signatures stream](#signatures-stream) 70 + +\0x06DataSpaces\DataSpaceInfo storage ([section 2.2.2](#x06dataspacesdataspaceinfo-storage) 29, [section 2.3.4.2](#x06dataspacesdataspaceinfo-storage-1) 38) + +\0x06DataSpaces\DataSpaceMap stream ([section 2.2.1](#x06dataspacesdataspacemap-stream) 28, [section 2.3.4.1](#x06dataspacesdataspacemap-stream-1) 38) + +[\0x06DataSpaces\TransformInfo storage](#x06dataspacestransforminfo-storage) 38 + +[\0x06DataSpaces\TransformInfo storage for ECMA-376 documents](#x06dataspacestransforminfo-storage-for-ecma-376-documents) 30 + +[\0x06DataSpaces\TransformInfo storage for Office binary documents](#x06dataspacestransforminfo-storage-for-office-binary-documents) 29 + +[\EncryptedPackage stream](#encryptedpackage-stream) 39 + +[\EncryptionInfo stream (agile encryption)](#encryptioninfo-stream-agile-encryption) 44 + +[\EncryptionInfo stream (extensible encryption)](#encryptioninfo-stream-extensible-encryption) 40 + +[\EncryptionInfo stream (standard encryption)](#encryptioninfo-stream-standard-encryption) 39 + +[\_xmlsignatures storage](#xmlsignatures-storage) 77 + +[binary document digital signatures structure](#binary-document-digital-signatures) 67 + +[binary document password verifier derivation Method 1](#binary-document-password-verifier-derivation-method-1) 60 + +[binary document password verifier derivation Method 2](#binary-document-password-verifier-derivation-method-2) 63 + +[binary document write protection Method 1](#binary-document-write-protection-method-1) 65 + +[binary document write protection Method 2](#binary-document-write-protection-method-2) 65 + +[binary document write protection Method 3](#binary-document-write-protection-method-3) 66 + +[binary document XOR array initialization Method 1](#binary-document-xor-array-initialization-method-1) 60 + +[binary document XOR array initialization Method 2](#binary-document-xor-array-initialization-method-2) 64 + +[binary document XOR data transformation Method 1](#binary-document-xor-data-transformation-method-1) 62 + +[binary document XOR data transformation Method 2](#binary-document-xor-data-transformation-method-2) 65 + +[CertificateInfo structure - CryptoAPI digital signature](#cryptoapi-digital-signature-certificateinfo-structure) 68 + +[CryptoAPI digital signature CertificateInfo structure](#cryptoapi-digital-signature-certificateinfo-structure) 68 + +[CryptoAPI digital signature generation](#cryptoapi-digital-signature-generation) 70 + +[CryptoAPI digital signature structure](#cryptoapi-digital-signature-structure) 70 + +[data encryption (agile encryption)](#data-encryption-agile-encryption) 52 + +[data spaces structure](#data-spaces-2) 21 + +[DataIntegrity generation (agile encryption)](#dataintegrity-generation-agile-encryption) 52 + +[DataSpaceDefinition structure](#dataspacedefinition) 26 + +[DataSpaceMap structure](#dataspacemap) 24 + +[DataSpaceMapEntry structure](#dataspacemapentry-structure) 25 + +[DataSpaceReferenceComponent structure](#dataspacereferencecomponent-structure) 25 + +[DataSpaceVersionInfo structure](#dataspaceversioninfo) 23 + +[document write protection structure](#document-write-protection) 65 + +[ECMA-376 document encryption](#ecma-376-document-encryption-1) 38 + +[ECMA-376 document encryption key generation (standard encryption)](#ecma-376-document-encryption-key-generation-standard-encryption) 42 + +[ECMA-376 document write protection](#ecma-376-document-write-protection) 65 + +[encryption key derivation](#encryption-key-derivation) 59 + +[encryption key generation (agile encryption)](#encryption-key-generation-agile-encryption) 49 + +[encryption structure](#encryption-2) 33 + +[EncryptionHeader structure](#encryptionheader) 34 + +[EncryptionHeaderFlags structure](#encryptionheaderflags) 34 + +[EncryptionTransformInfo structure](#encryptiontransforminfo) 27 + +[EncryptionVerifier structure](#encryptionverifier) 36 + +[end-user license stream](#end-user-license-stream) 31 + +[EndUserLicenseHeader structure](#enduserlicenseheader) 32 + +[ExtensibilityHeader structure](#extensibilityheader) 31 + +[File structure](#file) 21 + +[idOfficeObject object element](#idofficeobject-object-element) 73 + +[idPackageObject object element](#idpackageobject-object-element) 73 + +[Information Rights Management Data Space structure](#information-rights-management-data-space-2) 28 + +[initialization vector generation (agile encryption)](#initialization-vector-generation-agile-encryption) 50 + +[IRMDSTransformInfo structure](#irmdstransforminfo) 31 + +[ISO write protection method](#iso-write-protection-method) 66 + +[KeyInfo element](#keyinfo-element) 73 + +[Length-Prefixed Padded Unicode String (UNICODE-LP-P4) structure](#length-prefixed-padded-unicode-string-unicode-lp-p4) 22 + +[Length-Prefixed UTF-8 String (UTF-8-LP-P4) structure](#length-prefixed-utf-8-string-utf-8-lp-p4) 23 + +[LicenseID](#licenseid) 32 + +[Office binary document RC4 CryptoAPI encryption](#office-binary-document-rc4-cryptoapi-encryption) 53 + +[Office binary document RC4 encryption](#office-binary-document-rc4-encryption) 58 + +[password verification - Office binary document RC4 CryptoAPI encryption](#password-verification) 57 + +[password verification - Office binary document RC4 encryption](#password-verification-1) 59 + +[password verification - XOR obfuscation](#password-verification-2) 65 + +[password verification (standard encryption)](#password-verification-standard-encryption) 43 + +[password verifier generation - Office binary document RC4 CryptoAPI encryption](#password-verifier-generation) 57 + +[password verifier generation - Office binary document RC4 encryption](#password-verifier-generation-1) 59 + +[password verifier generation (standard encryption)](#password-verifier-generation-standard-encryption) 43 + +[PasswordKeyEncryptor generation (agile encryption)](#passwordkeyencryptor-generation-agile-encryption) 50 + +[protected content stream](#protected-content-stream) 32 + +[RC4 CryptoAPI encrypted summary stream](#rc4-cryptoapi-encrypted-summary-stream) 55 + +[RC4 CryptoAPI EncryptedStreamDescriptor structure](#rc4-cryptoapi-encryptedstreamdescriptor-structure) 55 + +[RC4 CryptoAPI encryption header](#rc4-cryptoapi-encryption-header) 53 + +[RC4 CryptoAPI encryption key generation](#rc4-cryptoapi-encryption-key-generation) 54 + +[RC4 encryption header](#rc4-encryption-header) 58 + +[SignatureValue element](#signaturevalue-element) 72 + +[SignedInfo element](#signedinfo-element) 72 + +[TimeEncoding structure](#timeencoding-structure) 67 + +[TransformInfoHeader structure](#transforminfoheader) 27 + +[version structure](#version) 23 + +[viewer content stream](#viewer-content-stream) 33 + +[XAdES elements](#xades-elements) 76 + +[Xmldsig digital signature elements](#xmldsig-digital-signature-elements) 72 + +[XOR obfuscation](#xor-obfuscation-1) 60 + +[Digital signature elements - Xmldsig](#xmldsig-digital-signature-elements) 72 + +Digital signatures + +[overview](#digital-signatures) 18 + +Document write protection + +[binary document write protection Method 1](#binary-document-write-protection-method-1) 65 + +[binary document write protection Method 2](#binary-document-write-protection-method-2) 65 + +[binary document write protection Method 3](#binary-document-write-protection-method-3) 66 + +[ECMA-376](#ecma-376-document-write-protection) 65 + +[ISO write protection method](#iso-write-protection-method) 66 + +security + +[implementer considerations](#document-write-protection-1) 106 + +[Document write protection structure](#document-write-protection) 65 + +[DRMEncryptedDataSpace Stream example](#drmencrypteddataspace-stream) 90 + +E + +ECMA-376 document encryption + +security + +[implementer considerations](#ecma-376-document-encryption-2) 104 + +[ECMA-376 document encryption – encryption](#ecma-376-document-encryption-1) 38 + +[ECMA-376 document encryption key generation (standard encryption) – encryption](#ecma-376-document-encryption-key-generation-standard-encryption) 42 + +[ECMA-376 document encryption overview](#ecma-376-document-encryption) 17 + +[ECMA-376 document write protection](#ecma-376-document-write-protection) 65 + +Elements + +[idOfficeObject object](#idofficeobject-object-element) 73 + +[idPackageObject object](#idpackageobject-object-element) 73 + +[KeyInfo](#keyinfo-element) 73 + +[SignatureValue](#signaturevalue-element) 72 + +[SignedInfo](#signedinfo-element) 72 + +[XAdES](#xades-elements) 76 + +[Xmldsig digital signature](#xmldsig-digital-signature-elements) 72 + +Encryption + +[\0x06DataSpaces\DataSpaceInfo storage](#x06dataspacesdataspaceinfo-storage-1) 38 + +[\0x06DataSpaces\DataSpaceMap stream](#x06dataspacesdataspacemap-stream-1) 38 + +[\0x06DataSpaces\TransformInfo storage](#x06dataspacestransforminfo-storage) 38 + +[\EncryptedPackage stream](#encryptedpackage-stream) 39 + +[\EncryptionInfo stream (agile encryption)](#encryptioninfo-stream-agile-encryption) 44 + +[\EncryptionInfo stream (extensible encryption)](#encryptioninfo-stream-extensible-encryption) 40 + +[\EncryptionInfo stream (standard encryption)](#encryptioninfo-stream-standard-encryption) 39 + +[40-bit RC4 encryption overview](#bit-rc4-encryption) 17 + +[applicability](#encryption-1) 20 + +[binary document password verifier derivation Method 1](#binary-document-password-verifier-derivation-method-1) 60 + +[binary document password verifier derivation Method 2](#binary-document-password-verifier-derivation-method-2) 63 + +[binary document XOR array initialization Method 1](#binary-document-xor-array-initialization-method-1) 60 + +[binary document XOR array initialization Method 2](#binary-document-xor-array-initialization-method-2) 64 + +[binary document XOR data transformation Method 1](#binary-document-xor-data-transformation-method-1) 62 + +[binary document XOR data transformation Method 2](#binary-document-xor-data-transformation-method-2) 65 + +[CryptoAPI RC4 encryption overview](#cryptoapi-rc4-encryption) 17 + +[data encryption (agile encryption)](#data-encryption-agile-encryption) 52 + +[DataIntegrity generation (agile encryption)](#dataintegrity-generation-agile-encryption) 52 + +[ECMA-376 document](#ecma-376-document-encryption-1) 38 + +[ECMA-376 document encryption key generation (standard encryption)](#ecma-376-document-encryption-key-generation-standard-encryption) 42 + +[ECMA-376 document encryption overview](#ecma-376-document-encryption) 17 + +[encryption key derivation](#encryption-key-derivation) 59 + +[encryption key generation (agile encryption)](#encryption-key-generation-agile-encryption) 49 + +[EncryptionHeader structure](#encryptionheader) 34 + +[EncryptionHeaderFlags structure](#encryptionheaderflags) 34 + +[EncryptionVerifier structure](#encryptionverifier) 36 + +[initialization vector generation (agile encryption)](#initialization-vector-generation-agile-encryption) 50 + +[Office binary document RC4](#office-binary-document-rc4-encryption) 58 + +[Office binary document RC4 CryptoAPI](#office-binary-document-rc4-cryptoapi-encryption) 53 + +[overview](#encryption) 17 + +[password verification - Office binary document RC4](#password-verification-1) 59 + +[password verification - Office binary document RC4 CryptoAPI](#password-verification) 57 + +[password verification – XOR obfuscation](#password-verification-2) 65 + +[password verification (standard encryption)](#password-verification-standard-encryption) 43 + +[password verifier generation - Office binary document RC4](#password-verifier-generation-1) 59 + +[password verifier generation - Office binary document RC4 CryptoAPI](#password-verifier-generation) 57 + +[password verifier generation (standard encryption)](#password-verifier-generation-standard-encryption) 43 + +[PasswordKeyEncryptor generation (agile encryption)](#passwordkeyencryptor-generation-agile-encryption) 50 + +[RC4 CryptoAPI encrypted summary stream](#rc4-cryptoapi-encrypted-summary-stream) 55 + +[RC4 CryptoAPI EncryptedStreamDescriptor structure](#rc4-cryptoapi-encryptedstreamdescriptor-structure) 55 + +[RC4 CryptoAPI encryption header](#rc4-cryptoapi-encryption-header) 53 + +[RC4 CryptoAPI encryption key generation](#rc4-cryptoapi-encryption-key-generation) 54 + +[RC4 encryption header](#rc4-encryption-header) 58 + +[XOR obfuscation](#xor-obfuscation-1) 60 + +[XOR obfuscation overview](#xor-obfuscation) 17 + +[Encryption header example](#encryption-header) 99 + +[Encryption key derivation – encryption](#encryption-key-derivation) 59 + +[Encryption key generation (agile encryption) – encryption](#encryption-key-generation-agile-encryption) 49 + +[Encryption structure](#encryption-2) 33 + +[EncryptionHeader structure – encryption](#encryptionheader) 34 + +[EncryptionHeader Structure example](#encryptionheader-structure) 94 + +[EncryptionHeaderFlags structure – encryption](#encryptionheaderflags) 34 + +[EncryptionTransformInfo structure – data spaces](#encryptiontransforminfo) 27 + +[EncryptionVerifier structure – encryption](#encryptionverifier) 36 + +[EncryptionVerifier Structure example](#encryptionverifier-structure) 96 + +[End-user license stream – IRMDS](#end-user-license-stream) 31 + +[EndUserLicenseHeader structure – IRMDS](#enduserlicenseheader) 32 + +[EndUserLicenseHeader structure example](#enduserlicenseheader-structure) 93 + +[EUL-ETRHA1143ZLUDD412YTI3M5CTZ Stream example](#eul-etrha1143zludd412yti3m5ctz-stream) 92 + +[Examples](#structure-examples) 87 + +[\EncryptionInfo Stream](#encryptioninfo-stream) 96 + +[\EncryptionInfo Stream (Third-Party Extensible Encryption)](#encryptioninfo-stream-third-party-extensible-encryption) 98 + +[0x06Primary Stream](#x06primary-stream) 90 + +[certificate chain](#certificate-chain) 93 + +[DataSpaceMap Stream](#dataspacemap-stream) 88 + +[DataSpaceMapEntry structure](#dataspacemapentry-structure-1) 89 + +[DRMEncryptedDataSpace Stream](#drmencrypteddataspace-stream) 90 + +[encryption header](#encryption-header) 99 + +[EncryptionHeader Structure](#encryptionheader-structure) 94 + +[EncryptionVerifier Structure](#encryptionverifier-structure) 96 + +[EndUserLicenseHeader structure](#enduserlicenseheader-structure) 93 + +[EUL-ETRHA1143ZLUDD412YTI3M5CTZ Stream](#eul-etrha1143zludd412yti3m5ctz-stream) 92 + +[LabelInfo Stream](#labelinfo-stream) 103 + +[PasswordKeyEncryptor (Agile Encryption)](#passwordkeyencryptor-agile-encryption) 100 + +[Version Stream](#version-stream) 87 + +[Examples overview](#structure-examples) 87 + +[ExtensibilityHeader structure – IRMDS](#extensibilityheader) 31 + +F + +[Fields - security index](#index-of-security-fields) 106 + +[Fields - vendor-extensible](#vendor-extensible-fields) 20 + +[File – data spaces](#file) 21 + +G + +[Glossary](#glossary) 8 + +I + +[idOfficeObject object element](#idofficeobject-object-element) 73 + +[idPackageObject object element](#idpackageobject-object-element) 73 + +Implementer - security considerations + +[binary document digital signatures](#binary-document-digital-signatures-1) 106 + +[data spaces](#data-spaces-3) 104 + +[document write protection](#document-write-protection-1) 106 + +[ECMA-376 document encryption](#ecma-376-document-encryption-2) 104 + +[Information Rights Management](#information-rights-management) 104 + +[Office binary document RC4 CryptoAPI encryption](#office-binary-document-rc4-cryptoapi-encryption-1) 104 + +[Office binary document RC4 encryption](#office-binary-document-rc4-encryption-2) 105 + +[XOR obfuscation](#xor-obfuscation-2) 105 + +[Index of security fields](#index-of-security-fields) 106 + +Information Rights Management + +security + +[implementer considerations](#information-rights-management) 104 + +Information Rights Management Data Space + +[applicability](#information-rights-management-data-space-1) 20 + +[overview](#information-rights-management-data-space) 15 + +[Information Rights Management Data Space structure](#information-rights-management-data-space-2) 28 + +[Informative references](#informative-references) 14 + +[Initialization vector generation (agile encryption) – encryption](#initialization-vector-generation-agile-encryption) 50 + +[Introduction](#introduction) 8 + +IRMDS + +[\0x06DataSpaces\DataSpaceInfo storage](#x06dataspacesdataspaceinfo-storage) 29 + +[\0x06DataSpaces\DataSpaceMap stream](#x06dataspacesdataspacemap-stream) 28 + +[\0x06DataSpaces\TransformInfo storage for ECMA-376 documents](#x06dataspacestransforminfo-storage-for-ecma-376-documents) 30 + +[\0x06DataSpaces\TransformInfo storage for Office binary documents](#x06dataspacestransforminfo-storage-for-office-binary-documents) 29 + +[end-user license stream](#end-user-license-stream) 31 + +[EndUserLicenseHeader structure](#enduserlicenseheader) 32 + +[ExtensibilityHeader structure](#extensibilityheader) 31 + +[IRMDSTransformInfo structure](#irmdstransforminfo) 31 + +[LicenseID](#licenseid) 32 + +[protected content stream](#protected-content-stream) 32 + +[viewer content stream](#viewer-content-stream) 33 + +[IRMDSTransformInfo structure – IRMDS](#irmdstransforminfo) 31 + +[ISO write protection method](#iso-write-protection-method) 66 + +K + +[KeyInfo element](#keyinfo-element) 73 + +L + +[LabelInfo Stream example](#labelinfo-stream) 103 + +[Length-Prefixed Padded Unicode String (UNICODE-LP-P4) structure – data spaces](#length-prefixed-padded-unicode-string-unicode-lp-p4) 22 + +[Length-Prefixed UTF-8 String (UTF-8-LP-P4) structure – data spaces](#length-prefixed-utf-8-string-utf-8-lp-p4) 23 + +[LicenseID – IRMDS](#licenseid) 32 + +[Localization](#versioning-and-localization) 20 + +N + +[Normative references](#normative-references) 12 + +O + +Office binary document RC4 CryptoAPI encryption + +security + +[implementer considerations](#office-binary-document-rc4-cryptoapi-encryption-1) 104 + +[Office binary document RC4 CryptoAPI encryption – encryption](#office-binary-document-rc4-cryptoapi-encryption) 53 + +Office binary document RC4 encryption + +security + +[implementer considerations](#office-binary-document-rc4-encryption-2) 105 + +[Office binary document RC4 encryption – encryption](#office-binary-document-rc4-encryption) 58 + +OLE compound file path encoding + +[overview](#ole-compound-file-path-encoding) 18 + +Overview + +[40-bit RC4 encryption](#bit-rc4-encryption) 17 + +[array](#array) 19 + +[byte ordering](#byte-ordering) 18 + +[CryptoAPI RC4 encryption](#cryptoapi-rc4-encryption) 17 + +[data spaces - applicability](#data-spaces-1) 19 + +[data spaces – overview (synopsis)](#data-spaces) 14 + +[digital signatures](#digital-signatures) 18 + +[ECMA-376 document encryption](#ecma-376-document-encryption) 17 + +[encryption](#encryption) 17 + +[encryption - applicability](#encryption-1) 20 + +[Information Rights Management Data Space](#information-rights-management-data-space) 15 + +[OLE compound file path encoding](#ole-compound-file-path-encoding) 18 + +[pseudocode standard objects](#pseudocode-standard-objects) 18 + +[storage](#storage) 19 + +[stream](#stream) 19 + +[string](#string) 19 + +[string encoding](#string-encoding) 18 + +[write protection](#write-protection) 18 + +[XOR obfuscation](#xor-obfuscation) 17 + +P + +[Password verification – Office binary document RC4 CryptoAPI encryption](#password-verification) 57 + +[Password verification – Office binary document RC4 encryption](#password-verification-1) 59 + +[Password verification – XOR obfuscation](#password-verification-2) 65 + +[Password verification (standard encryption) – encryption](#password-verification-standard-encryption) 43 + +[Password verifier generation – Office binary document RC4 CryptoAPI encryption](#password-verifier-generation) 57 + +[Password verifier generation – Office binary document RC4 encryption](#password-verifier-generation-1) 59 + +[Password verifier generation (standard encryption) – encryption](#password-verifier-generation-standard-encryption) 43 + +[PasswordKeyEncryptor (Agile Encryption) example](#passwordkeyencryptor-agile-encryption) 100 + +[PasswordKeyEncryptor generation (agile encryption) – encryption](#passwordkeyencryptor-generation-agile-encryption) 50 + +[Product behavior](#appendix-a-product-behavior) 107 + +[Protected content stream – IRMDS](#protected-content-stream) 32 + +Pseudocode standard objects + +[array overview](#array) 19 + +[overview](#pseudocode-standard-objects) 18 + +[storage overview](#storage) 19 + +[stream overview](#stream) 19 + +[string overview](#string) 19 + +R + +[RC4 CryptoAPI encrypted summary stream – encryption](#rc4-cryptoapi-encrypted-summary-stream) 55 + +[RC4 CryptoAPI EncryptedStreamDescriptor structure – encryption](#rc4-cryptoapi-encryptedstreamdescriptor-structure) 55 + +[RC4 CryptoAPI encryption header – encryption](#rc4-cryptoapi-encryption-header) 53 + +[RC4 CryptoAPI encryption key generation – encryption](#rc4-cryptoapi-encryption-key-generation) 54 + +[RC4 encryption header – encryption](#rc4-encryption-header) 58 + +[References](#references) 12 + +[informative](#informative-references) 14 + +[normative](#normative-references) 12 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 19 + +S + +Security + +[field index](#index-of-security-fields) 106 + +implementer considerations + +[binary document digital signatures](#binary-document-digital-signatures-1) 106 + +[data spaces](#data-spaces-3) 104 + +[document write protection](#document-write-protection-1) 106 + +[ECMA-376 document encryption](#ecma-376-document-encryption-2) 104 + +[Information Rights Management](#information-rights-management) 104 + +[Office binary document RC4 CryptoAPI encryption](#office-binary-document-rc4-cryptoapi-encryption-1) 104 + +[Office binary document RC4 encryption](#office-binary-document-rc4-encryption-2) 105 + +[XOR obfuscation](#xor-obfuscation-2) 105 + +[SignatureValue element](#signaturevalue-element) 72 + +[SignedInfo element](#signedinfo-element) 72 + +[Storage - \_xmlsignatures](#xmlsignatures-storage) 77 + +[Storage overview](#storage) 19 + +[Stream overview](#stream) 19 + +String encoding + +[overview](#string-encoding) 18 + +[String overview](#string) 19 + +Structure overview + +[40-bit RC4 encryption](#bit-rc4-encryption) 17 + +[array](#array) 19 + +[byte ordering](#byte-ordering) 18 + +[CryptoAPI RC4 encryption](#cryptoapi-rc4-encryption) 17 + +[data spaces](#data-spaces) 14 + +[digital signatures](#digital-signatures) 18 + +[ECMA-376 document encryption](#ecma-376-document-encryption) 17 + +[encryption](#encryption) 17 + +[Information Rights Management Data Space](#information-rights-management-data-space) 15 + +[OLE compound file path encoding](#ole-compound-file-path-encoding) 18 + +[pseudocode standard objects](#pseudocode-standard-objects) 18 + +[storage](#storage) 19 + +[stream](#stream) 19 + +[string](#string) 19 + +[string encoding](#string-encoding) 18 + +[write protection](#write-protection) 18 + +[XOR obfuscation](#xor-obfuscation) 17 + +Structures + +[binary document digital signatures](#binary-document-digital-signatures) 67 + +[data spaces](#data-spaces-2) 21 + +[document write protection](#document-write-protection) 65 + +[encryption](#encryption-2) 33 + +[Information Rights Management Data Space](#information-rights-management-data-space-2) 28 + +T + +[TimeEncoding structure](#timeencoding-structure) 67 + +[Tracking changes](#change-tracking) 114 + +[TransformInfoHeader structure – data spaces](#transforminfoheader) 27 + +U + +[UNICODE-LP-P4 structure – data spaces](#length-prefixed-padded-unicode-string-unicode-lp-p4) 22 + +[UTF-8-LP-P4 structure – data spaces](#length-prefixed-utf-8-string-utf-8-lp-p4) 23 + +V + +[Vendor-extensible fields](#vendor-extensible-fields) 20 + +[Version Stream example](#version-stream) 87 + +[Version structure – data spaces](#version) 23 + +[Versioning](#versioning-and-localization) 20 + +[Viewer content stream – IRMDS](#viewer-content-stream) 33 + +W + +Write protection + +[overview](#write-protection) 18 + +X + +[XAdES elements](#xades-elements) 76 + +[Xmldsig digital signature elements](#xmldsig-digital-signature-elements) 72 + +XOR obfuscation + +security + +[implementer considerations](#xor-obfuscation-2) 105 + +[XOR obfuscation – encryption](#xor-obfuscation-1) 60 + +[XOR obfuscation overview](#xor-obfuscation) 17 diff --git a/docs/standards/doc/ms-oleps.md b/docs/standards/doc/ms-oleps.md new file mode 100644 index 0000000..b3db4d5 --- /dev/null +++ b/docs/standards/doc/ms-oleps.md @@ -0,0 +1,2149 @@ +**\[MS-OLEPS\]:** + +**Object Linking and Embedding (OLE) Property Set Data Structures** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 4/8/2008 | 0.1 | New | Version 0.1 release | +| 6/20/2008 | 0.1.1 | Editorial | Changed language and formatting in the technical content. | +| 7/25/2008 | 0.1.2 | Editorial | Changed language and formatting in the technical content. | +| 8/29/2008 | 0.1.3 | Editorial | Changed language and formatting in the technical content. | +| 10/24/2008 | 0.1.4 | Editorial | Changed language and formatting in the technical content. | +| 12/5/2008 | 0.2 | Minor | Clarified the meaning of the technical content. | +| 1/16/2009 | 0.2.1 | Editorial | Changed language and formatting in the technical content. | +| 2/27/2009 | 0.2.2 | Editorial | Changed language and formatting in the technical content. | +| 4/10/2009 | 0.2.3 | Editorial | Changed language and formatting in the technical content. | +| 5/22/2009 | 0.2.4 | Editorial | Changed language and formatting in the technical content. | +| 7/2/2009 | 1.0 | Major | Updated and revised the technical content. | +| 8/14/2009 | 1.0.1 | Editorial | Changed language and formatting in the technical content. | +| 9/25/2009 | 1.1 | Minor | Clarified the meaning of the technical content. | +| 11/6/2009 | 1.1.1 | Editorial | Changed language and formatting in the technical content. | +| 12/18/2009 | 2.0 | Major | Updated and revised the technical content. | +| 1/29/2010 | 3.0 | Major | Updated and revised the technical content. | +| 3/12/2010 | 3.0.1 | Editorial | Changed language and formatting in the technical content. | +| 4/23/2010 | 3.0.2 | Editorial | Changed language and formatting in the technical content. | +| 6/4/2010 | 3.0.3 | Editorial | Changed language and formatting in the technical content. | +| 7/16/2010 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 8/27/2010 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/8/2010 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/19/2010 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/7/2011 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/11/2011 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/25/2011 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/6/2011 | 3.0.3 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/17/2011 | 3.1 | Minor | Clarified the meaning of the technical content. | +| 9/23/2011 | 3.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/16/2011 | 3.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/30/2012 | 3.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/12/2012 | 3.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/25/2012 | 3.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/31/2013 | 3.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 8/8/2013 | 4.0 | Major | Updated and revised the technical content. | +| 11/14/2013 | 4.1 | Minor | Clarified the meaning of the technical content. | +| 2/13/2014 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 5/15/2014 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/30/2015 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/16/2015 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/14/2016 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/1/2017 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/15/2017 | 5.0 | Major | Significantly changed the technical content. | +| 9/12/2018 | 6.0 | Major | Significantly changed the technical content. | +| 3/15/2019 | 6.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/7/2021 | 7.0 | Major | Significantly changed the technical content. | +| 6/25/2021 | 8.0 | Major | Significantly changed the technical content. | +| 4/23/2024 | 9.0 | Major | Significantly changed the technical content. | + +Table of Contents + +[1 Introduction [6](#introduction)](#introduction) + +[1.1 Glossary [6](#glossary)](#glossary) + +[1.2 References [7](#references)](#references) + +[1.2.1 Normative References [7](#normative-references)](#normative-references) + +[1.2.2 Informative References [8](#informative-references)](#informative-references) + +[1.3 Overview [8](#overview)](#overview) + +[1.3.1 Background [8](#background)](#background) + +[1.3.2 Properties and Property Sets [9](#properties-and-property-sets)](#properties-and-property-sets) + +[1.4 Relationship to Protocols and Other Structures [9](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [9](#applicability-statement)](#applicability-statement) + +[1.6 Versioning and Localization [9](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [10](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [11](#structures)](#structures) + +[2.1 PropertyIdentifier [11](#propertyidentifier)](#propertyidentifier) + +[2.2 PropertyType [11](#propertytype)](#propertytype) + +[2.3 CURRENCY (Packet Version) [16](#currency-packet-version)](#currency-packet-version) + +[2.4 DATE (Packet Version) [16](#date-packet-version)](#date-packet-version) + +[2.5 CodePageString [16](#codepagestring)](#codepagestring) + +[2.6 DECIMAL (Packet Version) [17](#decimal-packet-version)](#decimal-packet-version) + +[2.7 UnicodeString [17](#unicodestring)](#unicodestring) + +[2.8 FILETIME (Packet Version) [17](#filetime-packet-version)](#filetime-packet-version) + +[2.9 BLOB [18](#blob)](#blob) + +[2.10 IndirectPropertyName [18](#indirectpropertyname)](#indirectpropertyname) + +[2.11 ClipboardData [18](#clipboarddata)](#clipboarddata) + +[2.12 GUID (Packet Version) [19](#guid-packet-version)](#guid-packet-version) + +[2.13 VersionedStream [19](#versionedstream)](#versionedstream) + +[2.14 Vector and Array Property Types [20](#vector-and-array-property-types)](#vector-and-array-property-types) + +[2.14.1 Property Types in Variable-Typed Vectors and Arrays [20](#property-types-in-variable-typed-vectors-and-arrays)](#property-types-in-variable-typed-vectors-and-arrays) + +[2.14.2 VectorHeader [21](#vectorheader)](#vectorheader) + +[2.14.3 ArrayDimension [21](#arraydimension)](#arraydimension) + +[2.14.4 ArrayHeader [22](#arrayheader)](#arrayheader) + +[2.15 TypedPropertyValue [22](#typedpropertyvalue)](#typedpropertyvalue) + +[2.16 DictionaryEntry [26](#dictionaryentry)](#dictionaryentry) + +[2.17 Dictionary [26](#dictionary)](#dictionary) + +[2.18 Special Properties [27](#special-properties)](#special-properties) + +[2.18.1 Dictionary Property [27](#dictionary-property)](#dictionary-property) + +[2.18.2 CodePage Property [27](#codepage-property)](#codepage-property) + +[2.18.3 Locale Property [28](#locale-property)](#locale-property) + +[2.18.4 Behavior Property [28](#behavior-property)](#behavior-property) + +[2.19 PropertyIdentifierAndOffset [28](#propertyidentifierandoffset)](#propertyidentifierandoffset) + +[2.20 PropertySet [28](#propertyset)](#propertyset) + +[2.21 PropertySetStream [29](#propertysetstream)](#propertysetstream) + +[2.22 Non-Simple Property Set Storage Format [31](#non-simple-property-set-storage-format)](#non-simple-property-set-storage-format) + +[2.23 Property Set Stream and Storage Names [32](#property-set-stream-and-storage-names)](#property-set-stream-and-storage-names) + +[2.24 Standard Bindings [33](#standard-bindings)](#standard-bindings) + +[2.24.1 Compound File Binding [33](#compound-file-binding)](#compound-file-binding) + +[2.24.2 Alternate Stream Binding [33](#alternate-stream-binding)](#alternate-stream-binding) + +[2.24.3 Control Stream [33](#control-stream)](#control-stream) + +[2.24.4 Simple Property Set Stream [34](#simple-property-set-stream)](#simple-property-set-stream) + +[2.24.5 Non-Simple Property Set Storage [34](#non-simple-property-set-storage)](#non-simple-property-set-storage) + +[2.25 Well-Known Property Set Formats [34](#well-known-property-set-formats)](#well-known-property-set-formats) + +[2.25.1 SummaryInformation [34](#summaryinformation)](#summaryinformation) + +[2.25.2 PropertyBag [36](#propertybag)](#propertybag) + +[3 Structure Examples [37](#structure-examples)](#structure-examples) + +[3.1 SummaryInformation Property Set [37](#summaryinformation-property-set)](#summaryinformation-property-set) + +[3.1.1 CodePage Property [39](#codepage-property-1)](#codepage-property-1) + +[3.1.2 PIDSI_TITLE [39](#pidsi_title)](#pidsi_title) + +[3.1.3 PIDSI_SUBJECT [40](#pidsi_subject)](#pidsi_subject) + +[3.1.4 PIDSI_AUTHOR [41](#pidsi_author)](#pidsi_author) + +[3.1.5 PIDSI_KEYWORDS [41](#pidsi_keywords)](#pidsi_keywords) + +[3.1.6 PIDSI_COMMENTS [42](#pidsi_comments)](#pidsi_comments) + +[3.1.7 PIDSI_TEMPLATE [42](#pidsi_template)](#pidsi_template) + +[3.1.8 PIDSI_LASTAUTHOR [43](#pidsi_lastauthor)](#pidsi_lastauthor) + +[3.1.9 PIDSI_REVNUMBER [43](#pidsi_revnumber)](#pidsi_revnumber) + +[3.1.10 PIDSI_APPNAME [44](#pidsi_appname)](#pidsi_appname) + +[3.1.11 PIDSI_EDITTIME [44](#pidsi_edittime)](#pidsi_edittime) + +[3.1.12 PIDSI_LASTPRINTED [45](#pidsi_lastprinted)](#pidsi_lastprinted) + +[3.1.13 PIDSI_CREATE_DTM [45](#pidsi_create_dtm)](#pidsi_create_dtm) + +[3.1.14 PIDSI_LASTSAVE_DTM [46](#pidsi_lastsave_dtm)](#pidsi_lastsave_dtm) + +[3.1.15 PIDSI_PAGECOUNT [46](#pidsi_pagecount)](#pidsi_pagecount) + +[3.1.16 PIDSI_WORDCOUNT [46](#pidsi_wordcount)](#pidsi_wordcount) + +[3.1.17 PIDSI_CHARCOUNT [47](#pidsi_charcount)](#pidsi_charcount) + +[3.1.18 PIDSI_DOC_SECURITY [47](#pidsi_doc_security)](#pidsi_doc_security) + +[3.2 PropertyBag Property Set [48](#propertybag-property-set)](#propertybag-property-set) + +[3.2.1 Control Stream ("{4c8cc155-6c1e-11d1-8e41-00c04fb9386d}") [48](#control-stream-4c8cc155-6c1e-11d1-8e41-00c04fb9386d)](#control-stream-4c8cc155-6c1e-11d1-8e41-00c04fb9386d) + +[3.2.2 PropertyBag Stream ("Docf\_\005Bagaaqy23kudbhchAaq5u2chNd") [48](#propertybag-stream-docf_005bagaaqy23kudbhchaaq5u2chnd)](#propertybag-stream-docf_005bagaaqy23kudbhchaaq5u2chnd) + +[3.2.2.1 "CONTENTS" Stream [49](#contents-stream)](#contents-stream) + +[3.2.2.1.1 CodePage [51](#codepage)](#codepage) + +[3.2.2.1.2 Locale [51](#locale)](#locale) + +[3.2.2.1.3 Behavior [52](#behavior)](#behavior) + +[3.2.2.1.4 Dictionary [52](#dictionary-1)](#dictionary-1) + +[3.2.2.1.4.1 Dictionary Entry 0 [53](#dictionary-entry-0)](#dictionary-entry-0) + +[3.2.2.1.4.2 Dictionary Entry 1 [54](#dictionary-entry-1)](#dictionary-entry-1) + +[3.2.2.1.4.3 Dictionary Entry 2 [54](#dictionary-entry-2)](#dictionary-entry-2) + +[3.2.2.1.4.4 Dictionary Entry 3 [55](#dictionary-entry-3)](#dictionary-entry-3) + +[3.2.2.1.4.5 Dictionary Entry 4 [55](#dictionary-entry-4)](#dictionary-entry-4) + +[3.2.2.1.4.6 Dictionary Entry 5 [56](#dictionary-entry-5)](#dictionary-entry-5) + +[3.2.2.1.5 DisplayColour [56](#displaycolour)](#displaycolour) + +[3.2.2.1.6 MyStream [57](#mystream)](#mystream) + +[3.2.2.1.7 Price(GBP) [58](#pricegbp)](#pricegbp) + +[3.2.2.1.8 MyStorage [58](#mystorage)](#mystorage) + +[3.2.2.1.9 CaseSensitive Mixed Case [59](#casesensitive-mixed-case)](#casesensitive-mixed-case) + +[3.2.2.1.10 CASESENSITIVE All Uppercase [60](#casesensitive-all-uppercase)](#casesensitive-all-uppercase) + +[3.2.2.2 "prop6" Stream [61](#prop6-stream)](#prop6-stream) + +[3.2.2.3 "prop12" Storage [61](#prop12-storage)](#prop12-storage) + +[4 Security Considerations [62](#security-considerations)](#security-considerations) + +[5 Appendix A: Product Behavior [63](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [66](#change-tracking)](#change-tracking) + +[7 Index [67](#index)](#index) + +# Introduction + +This document specifies the Object Linking and Embedding (OLE) Property Set Data Structures (OLEPS), a generic persistence format for sets of [**properties**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) typically used to associate simple typed metadata with a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25). In order for an application to make metadata discoverable to other software, it chooses a [**property set format**](#gt_662dbb07-0d00-4322-b305-fa99015511c4), either a well-known published format or an application-defined format, and writes a property set containing the properties specified for this format. In combination with technologies that support multiple virtual [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) in a single physical file, such as the Compound File Binary File Format (for details, see [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b)) or the alternate user data stream feature of certain file systems, one or more [**property sets**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) can be associated with a file. This enables applications to make properties of a file discoverable to software that does not support parsing application-specific portions of the file format. + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **alternate stream**: See named stream. +> +> **class identifier (CLSID)**: A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that identifies a software component; for instance, a DCOM object class or a COM class. +> +> **compound file**: A file that is created as defined in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b) and that is capable of storing data that is structured as storage and streams. +> +> **element**: A stream or storage that is identified by a unique name. +> +> **file**: An entity of data in the file system that a user can access and manage. A [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) must have a unique name in its directory. It consists of one or more streams of bytes that hold a set of related data, plus a set of attributes (also called properties) that describe the [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) or the data within the [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25). The creation time of a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) is an example of a file attribute. +> +> **FMTID**: A GUID value that identifies a property set format. +> +> **globally unique identifier (GUID)**: A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [\[RFC4122\]](https://go.microsoft.com/fwlink/?LinkId=90460) or [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824) must be used for generating the [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1). See also universally unique identifier (UUID). +> +> **GUID_NULL**: A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that has the value "{00000000-0000-0000-0000-000000000000}". +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **non-simple property set**: A property set that is stored as a storage, which enables stream and storage as property types. +> +> **NT file system (NTFS)**: A proprietary Microsoft file system. For more information, see [\[MSFT-NTFS\]](https://go.microsoft.com/fwlink/?LinkId=90200). +> +> **property**: A typed value associated with a property identifier and optionally a property name. +> +> **property identifier**: A unique integer or a 16-bit, numeric identifier that is used to identify a specific attribute or property. +> +> **property name**: A string that, in combination with a [**property set**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264), identifies a named property. +> +> **property set**: A set of properties, along with an FMTID, identifying the property set format and an associated class identifier (CLSID). The CLSID is used to identify the application or component that created the property set. +> +> **property set format**: A specification for the properties in a property set, including the property identifier, type, semantics, and, optionally, a property name for each property. +> +> **simple property set**: A property set that is stored as a stream and does not enable streams and storages as property types. +> +> **storage**: (1) An element of a compound file that is a unit of containment for one or more storages and streams, analogous to directories in a file system, as described in \[MS-CFB\]. +> +> \(2\) A set of elements with an associated CLSID used to identify the application or component that created the storage. +> +> **storage container**: A software-provided location for a stream. +> +> **storage format**: A specification for encoding a particular type of data as a stream. +> +> **stream**: A sequence of bytes that typically encodes application data. +> +> **stream container**: A software-provided location for a stream. +> +> **stream format**: A specification for encoding a particular type of data as a stream. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[C706\] The Open Group, "DCE 1.1: Remote Procedure Call", C706, August 1997, [https://publications.opengroup.org/c706](https://go.microsoft.com/fwlink/?LinkId=89824) + +**Note** Registration is required to download the document. + +\[MS-CFB\] Microsoft Corporation, "[Compound File Binary File Format](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b)". + +\[MS-DTYP\] Microsoft Corporation, "[Windows Data Types](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2)". + +\[MS-LCID\] Microsoft Corporation, "[Windows Language Code Identifier (LCID) Reference](%5bMS-LCID%5d.pdf#Section_70feba9f294e491eb6eb56532684c37f)". + +\[MS-OAUT\] Microsoft Corporation, "[OLE Automation Protocol](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961)". + +\[MS-UCODEREF\] Microsoft Corporation, "[Windows Protocols Unicode Reference](%5bMS-UCODEREF%5d.pdf#Section_4a045e08fc294f22baf416f38c2825fb)". + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[RFC4234\] Crocker, D., Ed., and Overell, P., "Augmented BNF for Syntax Specifications: ABNF", RFC 4234, October 2005, [https://www.rfc-editor.org/info/rfc4234](https://go.microsoft.com/fwlink/?LinkId=90462) + +### Informative References + +\[MSDN-COM\] Microsoft Corporation, "Component Object Model", [http://msdn.microsoft.com/en-us/library/aa286559.aspx](https://go.microsoft.com/fwlink/?LinkId=89977) + +\[MSDN-FileStreams\] Microsoft Corporation, "File Streams", [http://msdn.microsoft.com/en-us/library/aa364404.aspx](https://go.microsoft.com/fwlink/?LinkId=90537) + +## Overview + +The Object Linking and Embedding (OLE) Property Set Data Structures (OLEPS) enable applications to write metadata in a manner that is discoverable to other software. A [**property set**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) consists of a set of [**properties**](#gt_f930baab-25f1-4142-bced-5effc9f62d45), each of which is a typed value associated with a numerical [**property identifier**](#gt_382ac1cd-8ff9-493a-bfec-d9ad08955707), and a [**globally unique identifier (GUID)**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) format identifier, or [**FMTID**](#gt_bb4ffc07-754b-4e76-81e0-06686d942c9a), which can be used to identify the semantics and expected usage of the properties. + +Certain FMTIDs correspond to well-known, published [**property set formats**](#gt_662dbb07-0d00-4322-b305-fa99015511c4), while other property set formats are application-defined. If an application defines its own property set format or formats, the developer of the application will typically publish (through an out-of-band mechanism) the application-defined formats and FMTIDs so that other software can recognize and use the properties in a meaningful way. In either case, the semantics and expected usage of properties in a property set are dependent on the property set format. This document does not specify the semantics of properties or assignment of property identifiers in general, nor does it specify the mechanism to be used for publishing property set formats. + +The OLE Property Set Data Structures Specification consists of the following: + +- The specification for storing a property set as a [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or [**storage (2)**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) suitable for use with a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) format or other storage (2) technology that provides containers for these abstract types. + +- Standard bindings for storing property set streams and storages (1) in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) (for details see [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b)), and for storing property sets in [**alternate streams**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) of a file, in file systems that provide such a feature. An example of a file system that provides alternate streams is [**NTFS**](#gt_86f79a17-c0be-4937-8660-0cf6ce5ddc1a) (for more information, see [\[MSDN-FileStreams\]](https://go.microsoft.com/fwlink/?LinkId=90537) ). + +- The specifications for the well-known property set formats, [PropertyIdentifier](#Section_f7933d282cc44b36bc238861cbcd37c4) and [PropertyBag](#Section_9353494ccc624dccbda5db10c2f25a3e). + +### Background + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) is a sequence of bytes that typically encodes application data. An example of a stream is the data contents of an ordinary [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25). A [**stream container**](#gt_58ee6849-9bfd-4d97-aa22-4dbb6fb36e06) is a software-provided location for a stream. An example of a stream container is a file for which the provider is the file system. In order for an application to store data in a stream container, the application can either define a [**stream format**](#gt_77f4bf29-823b-4aa6-973d-559d31423b75)—a specification for encoding a particular type of data as a stream—or use an existing stream format. + +A [**storage (2)**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) is a collection of [**elements**](#gt_f633cdb5-cb63-4197-ad01-e7b02a745fdb) for which each element consists of either a stream or a storage (2) and a unique name that identifies the element within the storage (2). The definition of a storage (2) is recursive. For example, a storage (2) can contain another storage (2), which can in turn contain a third storage, and so on. In addition to its elements, a storage also has an associated [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99), which is a [GUID](#Section_5ee5aa9d6b964e54a6bc6b1f562d616b) value typically used to identify the application or component that created the storage. For example, an application that implements a Component Object Model (COM) class (for more information, see [\[MSDN-COM\]](https://go.microsoft.com/fwlink/?LinkId=89977)) capable of parsing a storage might set the associated CLSID to the CLSID of this COM class. A [**storage container**](#gt_45e690de-dbe5-49a6-9317-ae4defe379dc) is a software-provided location for a storage. An example of a storage container is a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). In order for an application to store data in a storage container, it either defines a [**storage format**](#gt_47836016-72d2-4f37-9559-29df5393eaa6)—a specification for encoding a particular type of data as a storage—or uses an existing storage format. + +The specification for standard property set stream and storage names in section [2.23](#Section_e5484a833cc143a6afcf6558059fe36e) assumes that storage containers provide element-naming that is case-insensitive for at least the characters A-Z/a-z. Compound files have this property. + +### Properties and Property Sets + +A [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) is a typed value associated with a numerical identifier, known as the [**property identifier**](#gt_382ac1cd-8ff9-493a-bfec-d9ad08955707). OLEPS also enables a property to be optionally associated with a string known as the [**property name**](#gt_dcd670df-c295-466f-b681-d7d91014040a). Typically, this is used to provide a human-readable description of the semantics of the property. A [**property set**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) is a set of properties, along with a [**globally unique identifier (GUID)**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) format identifier, or [**FMTID**](#gt_bb4ffc07-754b-4e76-81e0-06686d942c9a). The FMTID serves to identify the [**property set format**](#gt_662dbb07-0d00-4322-b305-fa99015511c4), which is a specification for the properties in the property set, including the property identifier, type, semantics and, optionally, a property name for each property. Property identifiers and property names (if present) of the properties in a property set are distinct such that both property identifiers and property names (if present) uniquely identify properties. + +To accommodate specialized uses of property sets, OLEPS also enables a property set to have an associated [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99), a GUID value typically used to identify the application or component that created the property set. For example, an application that persists an instance of a Component Object Model (COM) class in a property set might set the associated CLSID to the CLSID of this COM class. + +Two kinds of property sets are defined: [**simple property sets**](#gt_1caaa2c2-c703-4141-b99c-fe446f430f2c) and [**non-simple property sets**](#gt_5756d395-5889-485e-9611-07904421f0f3). Non-simple property sets allow a set of property types that are a superset of the types allowed by simple property sets. In particular, [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) and [**storages (1)**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) are valid types for properties in a non-simple property set, whereas these types are not valid in a simple property set. Additionally, the specification for simple property set is a [**stream format**](#gt_77f4bf29-823b-4aa6-973d-559d31423b75), whereas the specification for non-simple property sets is a [**storage format**](#gt_47836016-72d2-4f37-9559-29df5393eaa6). + +## Relationship to Protocols and Other Structures + +The OLEPS protocol enables [**property sets**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) to be stored in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) (for details, see [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b)). + +## Applicability Statement + +OLEPS is appropriate for writing simple metadata to a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25), especially when this metadata needs to be discoverable by other software. It is most appropriate when the file format itself does not provide a format-specific mechanism for writing typed [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45). + +## Versioning and Localization + +This document covers versioning issues in the following areas: + +- **Structure Versions:** The [PropertySetStream](#Section_2a4589eb9a234a8badbd3e368233c099) packet supports two versions: version 0 and version 1. Version 0 does not support some of the property types in the PropertyType enumeration and does not support the special [Behavior property](#Section_1149ab6d06bc4044940de6681c1ce4e1). These versions are defined in section [2](#Section_94f2ed968bc44c9da87b191c44f42014). + +- **Localization:** The encoding of strings in the [CodePageString](#Section_a4c326115b7949658f5050639c138e16) and [PropertyIdentifier](#Section_333959a3a9994eca862748a224e63e77) packets is dependent on a [**property set's**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) [CodePage property](#Section_b89107367f4a469a9644aed68a71d7d1). Property sets optionally have an informational [Locale property](#Section_bb452c0779f746e0bfb7122c347cc5c8) to identify the language for strings in the property set. Localization-dependent structure content is specified in section 2. + +This document specifies two versions for property sets: version 0 and version 1. Version 1 supports additional [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) types and a special Behavior property. The granularity for versioning is the [PropertyIdentifier](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet, which usually contains a single property set. Therefore, in general, it is possible for a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) to contain both version 0 and version 1 property sets. + +For maximum interoperability, it is recommended that implementations write property sets as version 0 unless they make use of features only supported in version 1. + +## Vendor-Extensible Fields + +Vendors are free to define new [**property set formats**](#gt_662dbb07-0d00-4322-b305-fa99015511c4). The [**FMTIDs**](#gt_bb4ffc07-754b-4e76-81e0-06686d942c9a) of these formats are [**GUIDs**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that are generated using the mechanism specified in [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824) section A.2.5. + +# Structures + +Field types in packet diagrams are defined by the packet diagram and the field descriptions. All fields in packet diagrams use [**little endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) byte ordering unless otherwise stated. + +This protocol uses the following types specified in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) and [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961). + +| Type | Reference | +|--------------|----------------------------| +| HRESULT | \[MS-DTYP\] section 2.2.18 | +| FILETIME | \[MS-DTYP\] section 2.3.3 | +| GUID | \[MS-DTYP\] section 2.3.4 | +| LCID | \[MS-DTYP\] section 2.3.6 | +| CURRENCY | \[MS-OAUT\] section 2.2.24 | +| DATE | \[MS-OAUT\] section 2.2.25 | +| VARIANT_BOOL | \[MS-OAUT\] section 2.2.27 | + +## PropertyIdentifier + +The PropertyIdentifier data type represents the [**property identifier**](#gt_382ac1cd-8ff9-493a-bfec-d9ad08955707) of a [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) in a [**property set**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264). + +This type is declared as follows: + +1. typedef unsigned int PropertyIdentifier; + +[TABLE] + +## PropertyType + +The PropertyType enumeration represents the type of a [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) in a [**property set**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264). The set of types supported depends on the version of the property set, which is indicated by the **Version** field of the [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet. In addition, the property types not supported in [**simple property sets**](#gt_1caaa2c2-c703-4141-b99c-fe446f430f2c) are specified as such. PropertyType is an enumeration, which MUST be one of the following values: + +This type is declared as follows: + +2. typedef unsigned int PropertyType; + +[TABLE] + +## CURRENCY (Packet Version) + +The CURRENCY (Packet Version) packet represents a CURRENCY as specified in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961) section 2.2.24. + +[TABLE] + +**int64 (8 bytes):** The value of the **int64** field specified in \[MS-OAUT\] section 2.2.24. + +## DATE (Packet Version) + +The DATE (Packet Version) packet represents a DATE as specified in[\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961) section 2.2.25. + +[TABLE] + +**Value (8 bytes):** The value of the **DATE** is an 8-byte IEEE floating-point number, as specified in \[MS-OAUT\] section 2.2.25. + +## CodePageString + +The CodePageString packet represents a string whose encoding depends on the value of the [**property set's**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) [CodePage property](#Section_b89107367f4a469a9644aed68a71d7d1). + +[TABLE] + +**Size (4 bytes):** The size in bytes of the **Characters** field, including the null terminator, but not including padding (if any). If the property set's CodePage property has the value CP_WINUNICODE (0x04B0), then the value MUST be a multiple of 2. + +**Characters (variable):** If **Size** is zero, this field MUST be zero bytes in length. If **Size** is nonzero and the CodePage property set's CodePage property has the value CP_WINUNICODE (0x04B0), then the value MUST be a null-terminated array of 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters, followed by zero padding to a multiple of 4 bytes. If **Size** is nonzero and the property set's CodePage property has any other value, it MUST be a null-terminated array of 8-bit characters from the code page identified by the CodePage property, followed by zero padding to a multiple of 4 bytes. The string represented by this field MAY contain embedded or additional trailing null characters and an OLEPS implementation MUST be able to handle such strings. However, the manner in which strings with embedded or additional trailing null characters are presented by the implementation to an application is implementation-specific.[\<1\>](#Appendix_A_1) For maximum interoperability, an OLEPS implementation SHOULD NOT write strings with embedded or trailing null characters unless specifically requested to do so by an application. + +## DECIMAL (Packet Version) + +The DECIMAL (Packet Version) packet represents a DECIMAL as specified in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961) section 2.2.26. + +[TABLE] + +**wReserved (2 bytes):** MUST be set to zero and MUST be ignored. + +**scale (1 byte):** The value of the **scale** field specified in \[MS-OAUT\] section 2.2.26. + +**sign (1 byte):** The value of the **sign** field specified in \[MS-OAUT\] section 2.2.26. + +**Hi32 (4 bytes):** The value of the **Hi32** field specified in \[MS-OAUT\] section 2.2.26. + +**Lo64 (8 bytes):** The value of the **Lo64** field specified in \[MS-OAUT\] section 2.2.26. + +## UnicodeString + +The UnicodeString packet represents a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string. + +[TABLE] + +**Length (4 bytes):** The length in 16-bit Unicode characters of the **Characters** field, including the null terminator, but not including padding (if any). + +**Characters (variable):** If **Length** is zero, this field MUST be zero bytes in length. If **Length** is nonzero, this field MUST be a null-terminated array of 16-bit Unicode characters, followed by zero padding to a multiple of 4 bytes. The string represented by this field SHOULD NOT contain embedded or additional trailing null characters. + +## FILETIME (Packet Version) + +The FILETIME (Packet Version) packet represents a FILETIME structure ([\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.3.3). + +[TABLE] + +**dwLowDateTime (4 bytes):** The value of the **dwLowDateTime** field specified in \[MS-DTYP\] section 2.3.3. + +**dwHighDateTime (4 bytes):** The value of the **dwHighDateTime** field specified in \[MS-DTYP\] section 2.3.3. + +## BLOB + +The BLOB packet represents binary data. + +[TABLE] + +**Size (4 bytes):** The size in bytes of the **Bytes** field, not including padding (if any). + +**Bytes (variable):** MUST be an array of bytes, followed by zero padding to a multiple of 4 bytes. + +## IndirectPropertyName + +The IndirectPropertyName packet represents the name of a [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or storage as used in the representation of the following property types in a [**non-simple property set**](#gt_5756d395-5889-485e-9611-07904421f0f3): VT_STREAM (0x0042), VT_STORAGE (0x0043), VT_STREAMED_OBJECT (0x0044), VT_STORED_OBJECT (0x0044), and VT_VERSIONED_STREAM (0x0049). It MUST be represented as a [CodePageString](#Section_a4c326115b7949658f5050639c138e16), and its value MUST be derived from the [**property identifier**](#gt_382ac1cd-8ff9-493a-bfec-d9ad08955707) of the [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) represented according to the following Augmented Backus–Naur Form (ABNF) [\[RFC4234\]](https://go.microsoft.com/fwlink/?LinkId=90462) syntax. + +3. Indirectproperty = "prop" propertyIdentifier + +Where [PropertyIdentifier](#Section_04727953c1744d0180aeb38b15d7068a) is the decimal string representation of the property identifier. This property identifier MUST be a valid PropertyIdentifier value and MUST NOT be the property identifier for any of the special properties specified in section [2.18](#Section_9389a815d71c4dd2b2722b3a8177f004). + +## ClipboardData + +The ClipboardData packet represents clipboard data. + +[TABLE] + +**Size (4 bytes):** The total size in bytes of the **Format** and **Data** fields, not including padding (if any). + +**Format (4 bytes):** An application-specific identifier for the format of the data in the **Data** field. + +**Data (variable):** MUST be an array of bytes, followed by zero padding to a multiple of 4 bytes. + +## GUID (Packet Version) + +The GUID (Packet Version) packet represents a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1). + +[TABLE] + +**Data1 (4 bytes):** The value of the **Data1** field specified in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.3.4. + +**Data2 (2 bytes):** The value of the **Data2** field specified in \[MS-DTYP\] section 2.3.4. + +**Data3 (2 bytes):** The value of the **Data3** field specified in \[MS-DTYP\] section 2.3.4. + +**Data4 (8 bytes):** The value of the **Data4** field specified in \[MS-DTYP\] section 2.3.4. + +## VersionedStream + +The VersionedStream packet represents a [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) with an application-specific version [GUID](#Section_5ee5aa9d6b964e54a6bc6b1f562d616b). + +[TABLE] + +**VersionGuid (16 bytes):** MUST be a GUID (Packet Version). + +**StreamName (variable):** MUST be an [IndirectPropertyName](#Section_e3bdb60847564a0cb2fd15b7eee52905). + +## Vector and Array Property Types + +Several property types are defined to be a vector or an array of another property type, known as the property's scalar type. **Vector** types, indicated by a [PropertyType](#Section_2a4589eb9a234a8badbd3e368233c099) value with the VT_VECTOR (0x1000) bit set, are simple, one-dimensional arrays of the scalar type. **Array** types, indicated by a PropertyType value with the VT_ARRAY (0x2000) bit set, are multi-dimensional arrays of the scalar type, with [**elements**](#gt_f633cdb5-cb63-4197-ad01-e7b02a745fdb) in row-major order (that is, elements with indices differing only in that the highest-numbered dimensions are consecutive). All such types are represented by a header, which provides information on the size and dimensions of the vector or array, followed by a sequence of scalar values. + +The following sections provide details on the representation of vector and array property types. + +### Property Types in Variable-Typed Vectors and Arrays + +The property types **VT_VECTOR \| VT_VARIANT** (0x100C) and **VT_ARRAY \| VT_VARIANT** (0x200C) are variable-typed sequences in which each scalar value has its own type. The types of the individual scalar values in such a [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) MUST be taken from the following subset of the [PropertyType](#Section_2a4589eb9a234a8badbd3e368233c099) enumeration values. + +| Value | Allowed in VT_VECTOR \| VT_VARIANT property? | Allowed in VT_ARRAY \| VT_VARIANT property? | +|----|----|----| +| VT_I2 (0x0002) | Yes | Yes | +| VT_I4 (0x0003) | Yes | Yes | +| VT_R4 (0x0004) | Yes | Yes | +| VT_R8 (0x0005) | Yes | Yes | +| VT_CY (0x0006) | Yes | Yes | +| VT_DATE (0x0007) | Yes | Yes | +| VT_BSTR (0x0008) | Yes | Yes | +| VT_ERROR (0x000A) | Yes | Yes | +| VT_BOOL (0x000B) | Yes | Yes | +| VT_DECIMAL (0x000E) | No | Yes | +| VT_I1 (0x0010) | Yes | Yes | +| VT_UI1 (0x0011) | Yes | Yes | +| VT_UI2 (0x0012) | Yes | Yes | +| VT_UI4 (0x0013) | Yes | Yes | +| VT_I8 (0x0014) | Yes | No | +| VT_UI8 (0x0015) | Yes | No | +| VT_INT (0x0016) | No | Yes | +| VT_UINT (0x0017) | No | Yes | +| VT_LPSTR (0x001E) | Yes | No | +| VT_LPWSTR (0x001F) | Yes | No | +| VT_FILETIME (0x0040) | Yes | No | +| VT_CF (0x0047) | Yes | No | +| VT_CLSID (0x0048) | Yes | No | + +### VectorHeader + +The VectorHeader packet represents the number of scalar values in a vector property type. + +[TABLE] + +**Length (4 bytes):** An unsigned integer indicating the number of scalar values following the header. + +### ArrayDimension + +The ArrayDimension packet represents the size and index offset of a dimension of an array property type. + +[TABLE] + +**Size (4 bytes):** An unsigned integer representing the size of the dimension. + +**IndexOffset (4 bytes):** A signed integer representing the index offset of the dimension. For example, an array dimension that is to be accessed with a 0-based index would have the value zero, whereas an array dimension that is to be accessed with a 1-based index would have the value 0x00000001. + +| Value | Meaning | +|----|----| +| 0 | An array dimension that is to be accessed with a 0-based index would have the value zero. | +| 0x00000001 | An array dimension that is to be accessed with a 1-based index would have the value 0x00000001. | + +### ArrayHeader + +The ArrayHeader packet represents the type and dimensions of an array property type. + +[TABLE] + +**Type (4 bytes):** MUST be set to the value obtained by clearing the VT_ARRAY (0x2000) bit of this array property's [PropertyType](#Section_2a4589eb9a234a8badbd3e368233c099) value. + +**NumDimensions (4 bytes):** An unsigned integer representing the number of dimensions in the array property. MUST be at least 1 and at most 31. + +| Value | Meaning | +|----|----| +| 1 — 31 | An unsigned integer representing the number of dimensions in the array property. | + +**Dimension 0 (variable):** MUST be a sequence of [ArrayDimension](#Section_7db5c301aacb4f45b95646ee7010bf90) packets. + +The number of scalar values in an array property can be calculated from the ArrayHeader packet as the product of the **Size** fields of each of the ArrayDimension packets. + +## TypedPropertyValue + +The TypedPropertyValue structure represents the typed value of a [**property**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) in a property set. + +[TABLE] + +**Type (2 bytes):** MUST be a value from the [PropertyType](#Section_2a4589eb9a234a8badbd3e368233c099) enumeration, indicating the type of property represented. + +**Padding (2 bytes):** MUST be set to zero, and any nonzero value SHOULD be rejected. + +| Value | Meaning | +|-------|--------------| +| 0 | As required. | + +**Value (variable):** MUST be the value of the property represented and serialized according to the value of **Type** as follows. + +| Type | Format | +|----|----| +| VT_EMPTY (0x0000) | MUST be zero bytes in length. | +| VT_NULL (0x0001) | MUST be zero bytes in length. | +| VT_I2 (0x0002) | MUST be a **16-bit signed integer**, followed by zero padding to 4 bytes. | +| VT_I4 (0x0003) | MUST be a **32-bit signed integer**. | +| VT_R4 (0x0004) | MUST be a **4-byte (single-precision) IEEE floating-point number**. | +| VT_R8 (0x0005) | MUST be an **8-byte (double-precision) IEEE floating-point number**. | +| VT_CY (0x0006) | MUST be a [CURRENCY](#Section_fb1fc39313a945399bbb9c696434c6e0) (Packet Version). | +| VT_DATE (0x0007) | MUST be a DATE (Packet Version). | +| VT_BSTR (0x0008) | MUST be a [CodePageString](#Section_a4c326115b7949658f5050639c138e16). | +| VT_ERROR (0x000A) | MUST be a **32-bit unsigned integer** representing an HRESULT, as specified in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.18. | +| VT_BOOL (0x000B) | MUST be a **VARIANT_BOOL** as specified in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961) section 2.2.27, followed by zero padding to 4 bytes. | +| VT_DECIMAL (0x000E) | MUST be a [DECIMAL](#Section_8c12ac7edc0b42819753b58b58dcd2b3) (Packet Version). | +| VT_I1 (0x0010) | MUST be a **1-byte signed integer**, followed by zero padding to 4 bytes. | +| VT_UI1 (0x0011) | MUST be a **1-byte unsigned integer**, followed by zero padding to 4 bytes. | +| VT_UI2 (0x0012) | MUST be a **2-byte unsigned integer**, followed by zero padding to 4 bytes. | +| VT_UI4 (0x0013) | MUST be a **4-byte unsigned integer**. | +| VT_I8 (0x0014) | MUST be an **8-byte signed integer**. | +| VT_UI8 (0x0015) | MUST be an **8-byte unsigned integer**. | +| VT_INT (0x0016) | MUST be a **4-byte signed integer**. | +| VT_UINT (0x0017) | MUST be a **4-byte unsigned integer**. | +| VT_LPSTR (0x001E) | MUST be a CodePageString. | +| VT_LPWSTR (0x001F) | MUST be a [UnicodeString](#Section_9660cb24953a4e60adf237cc0e779d19). | +| VT_FILETIME (0x0040) | MUST be a [FILETIME (Packet Version)](#Section_d8070a967f0c4235b4a1112876f2a419). | +| VT_BLOB (0x0041) | MUST be a [BLOB](#Section_8d5b277838214e2db1fcf52d6ad1e446). | +| VT_STREAM (0x0042) | MUST be an [IndirectPropertyName](#Section_e3bdb60847564a0cb2fd15b7eee52905). The storage representing the (non-simple) property set MUST have a stream element with this name. | +| VT_STORAGE (0x0043) | MUST be an IndirectPropertyName. The storage representing the (non-simple) property set MUST have a storage element with this name. | +| VT_STREAMED_OBJECT (0x0044) | MUST be an IndirectPropertyName. The storage representing the (non-simple) property set MUST have a stream element with this name. | +| VT_STORED_OBJECT (0x0045) | MUST be an IndirectPropertyName. The storage representing the (non-simple) property set MUST have a storage element with this name. | +| VT_BLOB_OBJECT (0x0046) | MUST be a BLOB. | +| VT_CF (0x0047) | MUST be a [ClipboardData](#Section_e51754139dad4a8dbd1f058eb301fdc9). | +| VT_CLSID (0x0048) | MUST be a [GUID](#Section_5ee5aa9d6b964e54a6bc6b1f562d616b) (Packet Version). | +| VT_VERSIONED_STREAM (0x0049) | MUST be a [VersionedStream](#Section_7c6776d18f2c4693aa7e281bcbc61a1f). The storage representing the (non-simple) property set MUST have a stream element with the name in the **StreamName** field. | +| VT_VECTOR \| VT_I2 (0x1002) | MUST be a [VectorHeader](#Section_f288f09af6a0493290920a80f86febf6) followed by a sequence of **16-bit signed integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_VECTOR \| VT_I4 (0x1003) | MUST be a VectorHeader followed by a sequence of **32-bit signed integers**. | +| VT_VECTOR \| VT_R4 (0x1004) | MUST be a VectorHeader followed by a sequence of **4-byte (single-precision) IEEE floating-point numbers**. | +| VT_VECTOR \| VT_R8 (0x1005) | MUST be a VectorHeader followed by a sequence of **8-byte (double-precision) IEEE floating-point numbers**. | +| VT_VECTOR \| VT_CY (0x1006) | MUST be a VectorHeader followed by a sequence of CURRENCY (Packet Version) packets. | +| VT_VECTOR \| VT_DATE (0x1007) | MUST be a VectorHeader followed by a sequence of DATE (Packet Version) packets. | +| VT_VECTOR \| VT_BSTR (0x1008) | MUST be a VectorHeader followed by a sequence of CodePageString packets. | +| VT_VECTOR \| VT_ERROR (0x100A) | MUST be a VectorHeader followed by a sequence of **32-bit unsigned integers** representing HRESULTs, as specified in \[MS-DTYP\] section 2.2.18. | +| VT_VECTOR \| VT_BOOL (0x100B) | MUST be a VectorHeader followed by a sequence of **VARIANT_BOOL** as specified in \[MS-OAUT\] section 2.2.27, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_VECTOR \| VT_VARIANT (0x100C) | MUST be a VectorHeader followed by a sequence of TypedPropertyValue packets. | +| VT_VECTOR \| VT_I1 (0x1010) | MUST be a VectorHeader followed by a sequence of **1-byte signed integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_VECTOR \| VT_UI1 (0x1011) | MUST be a VectorHeader followed by a sequence of **1-byte unsigned integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_VECTOR \| VT_UI2 (0x1012) | MUST be a VectorHeader followed by a sequence of **2-byte unsigned integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_VECTOR \| VT_UI4 (0x1013) | MUST be a VectorHeader followed by a sequence of **4-byte unsigned integers**. | +| VT_VECTOR \| VT_I8 (0x1014) | MUST be a VectorHeader followed by a sequence of **8-byte signed integers**. | +| VT_VECTOR \| VT_UI8 (0x1015) | MUST be a VectorHeader followed by a sequence of **8-byte unsigned integers**. | +| VT_VECTOR \| VT_LPSTR (0x101E) | MUST be a VectorHeader followed by a sequence of CodePageString packets. | +| VT_VECTOR \| VT_LPWSTR (0x101F) | MUST be a VectorHeader followed by a sequence of UnicodeString packets. | +| VT_VECTOR \| VT_FILETIME (0x1040) | MUST be a VectorHeader followed by a sequence of FILETIME (Packet Version) packets. | +| VT_VECTOR \| VT_CF (0x1047) | MUST be a VectorHeader followed by a sequence of ClipboardData packets. | +| VT_VECTOR \| VT_CLSID (0x1048) | MUST be a VectorHeader followed by a sequence of GUID (Packet Version) packets. | +| VT_ARRAY \| VT_I2 (0x2002) | MUST be an [ArrayHeader](#Section_e74a8869440b43a4985c70b850b8aeed) followed by a sequence of **16-bit signed integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_ARRAY \| VT_I4 (0x2003) | MUST be an ArrayHeader followed by a sequence of **32-bit signed integers**. | +| VT_ARRAY \| VT_R4 (0x2004) | MUST be an ArrayHeader followed by a sequence of **4-byte (single-precision) IEEE floating-point numbers**. | +| VT_ARRAY \| VT_R8 (0x2005) | MUST be an ArrayHeader followed by a sequence of **8-byte (double-precision) IEEE floating-point numbers**. | +| VT_ARRAY \| VT_CY (0x2006) | MUST be an ArrayHeader followed by a sequence of CURRENCY (Packet Version) packets. | +| VT_ARRAY \| VT_DATE (0x2007) | MUST be an ArrayHeader followed by a sequence of DATE (Packet Version) packets. | +| VT_ARRAY \| VT_BSTR (0x2008) | MUST be an ArrayHeader followed by a sequence of CodePageString packets. | +| VT_ARRAY \| VT_ERROR (0x200A) | MUST be an ArrayHeader followed by a sequence of **32-bit unsigned integers** representing HRESULTs, as specified in \[MS-DTYP\] section 2.2.18. | +| VT_ARRAY \| VT_BOOL (0x200B) | MUST be an ArrayHeader followed by a sequence of VARIANT_BOOL as specified in \[MS-OAUT\] section 2.2.27, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_ARRAY \| VT_VARIANT (0x200C) | MUST be an ArrayHeader followed by a sequence of TypedPropertyValue packets. | +| VT_ARRAY \| VT_DECIMAL (0x200E) | MUST be an ArrayHeader followed by a sequence of DECIMAL (Packet Version) packets. | +| VT_ARRAY \| VT_I1 (0x2010) | MUST be an ArrayHeader followed by a sequence of **1-byte signed integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_ARRAY \| VT_UI1 (0x2011) | MUST be an ArrayHeader followed by a sequence of **1-byte unsigned integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_ARRAY \| VT_UI2 (0x2012) | MUST be an ArrayHeader followed by a sequence of **2-byte unsigned integers**, followed by zero padding to a total length that is a multiple of 4 bytes. | +| VT_ARRAY \| VT_UI4 (0x2013) | MUST be an ArrayHeader followed by a sequence of **4-byte unsigned integers**. | +| VT_ARRAY \| VT_INT (0x2016) | MUST be an ArrayHeader followed by a sequence of **4-byte signed integers**. | +| VT_ARRAY \| VT_UINT (0x2017) | MUST be an ArrayHeader followed by a sequence of **4-byte unsigned integers**. | + +## DictionaryEntry + +The DictionaryEntry packet represents a mapping between a property identifier and a [**property name**](#gt_dcd670df-c295-466f-b681-d7d91014040a). + +[TABLE] + +**PropertyIdentifier (4 bytes):** An unsigned integer representing a property identifier. MUST be a valid [PropertyIdentifier](#Section_04727953c1744d0180aeb38b15d7068a) value in the range 0x00000002 to 0x7FFFFFFF, inclusive (this specifically excludes the [**property identifiers**](#gt_382ac1cd-8ff9-493a-bfec-d9ad08955707) for any of the special properties specified in section [2.18](#Section_9389a815d71c4dd2b2722b3a8177f004)). + +**Length (4 bytes):** If the property set's [CodePage property](#Section_b89107367f4a469a9644aed68a71d7d1) has the value CP_WINUNICODE (0x04B0), MUST be the length of the **Name** field in 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters, including the null terminator but not including padding (if any). Otherwise, MUST be the length of the **Name** field in 8-bit characters, including the null terminator. + +**Name (variable):** If the property set's CodePage property has the value CP_WINUNICODE (0x04B0), MUST be a null-terminated array of 16-bit Unicode characters, followed by zero padding to a multiple of 4 bytes. Otherwise, MUST be a null-terminated array of 8-bit characters from the code page identified by the CodePage property and MUST NOT be padded. + +## Dictionary + +The Dictionary packet represents all mappings between [**property identifiers**](#gt_382ac1cd-8ff9-493a-bfec-d9ad08955707) and [**property names**](#gt_dcd670df-c295-466f-b681-d7d91014040a) in a property set. + +[TABLE] + +**NumEntries (4 bytes):** (4 bytes) An unsigned integer representing the number of entries in the Dictionary. + +**Entry 1 (variable):** All Entry fields MUST be a sequence of [DictionaryEntry](#Section_333959a3a9994eca862748a224e63e77) packets. Entries are not required to appear in any particular order. + +**Padding (variable):** Padding, if necessary, to a total length that is a multiple of 4 bytes. + +## Special Properties + +The following sections provide additional information on [**properties**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) that have special representation, usage, or restrictions. + +### Dictionary Property + +The Dictionary property, if present, MUST have a property identifier of 0x00000000 and MUST NOT have a [**property name**](#gt_dcd670df-c295-466f-b681-d7d91014040a). Unlike other properties, which are represented as [TypedPropertyValue](#Section_f122b9d7e5cf4484846683f6fd94b3cc) packets, the Dictionary property MUST be represented as a [Dictionary](#Section_99127b7fc440469791a4c853086d6b33) packet. A property set in which any [**properties**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) have property names MUST have a Dictionary property. + +The Dictionary property MUST NOT have multiple entries with the same property identifier or multiple entries with the same property name. Property names MUST be compared in a case-insensitive manner unless the property set has a [Behavior property](#Section_1149ab6d06bc4044940de6681c1ce4e1) with the value 0x00000001, in which case property names MUST be compared in a case-sensitive manner. + +### CodePage Property + +The CodePage property MUST have the property identifier 0x00000001, MUST NOT have a [**property name**](#gt_dcd670df-c295-466f-b681-d7d91014040a), and MUST have type VT_I2 (0x0002). Every property set MUST have a CodePage property and its value MUST be a valid code page identifier as specified in [\[MS-UCODEREF\]](%5bMS-UCODEREF%5d.pdf#Section_4a045e08fc294f22baf416f38c2825fb) section 2.2.1. Its value is selected in an implementation-specific manner.[\<2\>](#Appendix_A_2) + +The CodePage property of a property set affects the representation of the [CodePageString](#Section_a4c326115b7949658f5050639c138e16) and [DictionaryEntry](#Section_333959a3a9994eca862748a224e63e77) packets. The value CP_WINUNICODE (0x04B0) indicates that the strings in these packets are encoded as arrays of 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. Any other value indicates that the strings in these packets are encoded as arrays of 8-bit characters from the code page identified. + +### Locale Property + +The Locale property, if present, MUST have the property identifier 0x80000000, MUST NOT have a [**property name**](#gt_dcd670df-c295-466f-b681-d7d91014040a), and MUST have type VT_UI4 (0x0013). If present, its value MUST be a valid language code identifier as specified in [\[MS-LCID\]](%5bMS-LCID%5d.pdf#Section_70feba9f294e491eb6eb56532684c37f). Its value is selected in an implementation-specific manner.[\<3\>](#Appendix_A_3) + +### Behavior Property + +The Behavior property, if present, MUST have the property identifier 0x80000003, MUST NOT have a [**property name**](#gt_dcd670df-c295-466f-b681-d7d91014040a), and MUST have type VT_UI4 (0x0013). A version 0 property set, indicated by the value 0x0000 for the **Version** field of the [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet, MUST NOT have a Behavior property. + +If the Behavior property is present, it MUST have one of the following values. + +| Value | Meaning | +|------------|------------------------------------------------| +| 0x00000000 | Property names are case-insensitive (default). | +| 0x00000001 | Property names are case-sensitive. | + +## PropertyIdentifierAndOffset + +The PropertyIdentifierAndOffset packet is used in the [PropertySet](#Section_aefcbddff2994f5ea9da65ce4ca55075) packet to represent a property identifier and the byte offset of the property in the PropertySet packet. + +[TABLE] + +**PropertyIdentifier (4 bytes):** An unsigned integer representing the property identifier of a property in the property set. MUST be a valid [PropertyIdentifier](#Section_04727953c1744d0180aeb38b15d7068a) value. + +**Offset (4 bytes):** An unsigned integer representing the offset in bytes from the beginning of the PropertySet packet to the beginning of the **Property** field for the property represented. MUST be a multiple of 4 bytes. + +## PropertySet + +The PropertySet packet represents a property set. + +[TABLE] + +**Size (4 bytes):** MUST be the total size in bytes of the PropertySet packet. + +**NumProperties (4 bytes):** An unsigned integer representing the number of [**properties**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) in the property set. + +**PropertyIdentifierAndOffset 0 (variable):** All PropertyIdentifierAndOffset fields MUST be a sequence of [PropertyIdentifierAndOffset](#Section_f59e6c94a0ae4d1b85d3f01c35779a22) packets. The sequence MUST be in order of increasing value of the **Offset** field. Packets are not required to be in any particular order with regard to the value of the **PropertyIdentifier** field. + +**Property 0 (variable):** Each Property field is a sequence of property values, each of which MUST be represented by a [TypedPropertyValue](#Section_f122b9d7e5cf4484846683f6fd94b3cc) packet or a [Dictionary](#Section_99127b7fc440469791a4c853086d6b33) packet in the special case of the [Dictionary property](#Section_4177a4bc554749fea4d94767350fd9cf). + +## PropertySetStream + +The PropertySetStream packet specifies the [**stream format**](#gt_77f4bf29-823b-4aa6-973d-559d31423b75) for [**simple property sets**](#gt_1caaa2c2-c703-4141-b99c-fe446f430f2c) and the stream format for the CONTENTS stream in the [Non-Simple Property Set Storage Format](#Section_83b0f8316adf48c58befb62e7ac1cc1e). A simple property set MUST be represented by a [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) containing a PropertySetStream packet. + +The PropertySetStream packet usually represents exactly one property set, but for historical reasons, the DocumentSummaryInfo and UserDefinedProperties [**property sets**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) are represented in the same stream. In this special case, a PropertySetStream might represent two property sets. + +An implementation SHOULD enforce a limit on the total size of a PropertySetStream packet. This limit MUST be at least 262,144 bytes, and for maximum interoperability SHOULD[\<4\>](#Appendix_A_4) be 2,097,152 bytes. + +[TABLE] + +**ByteOrder (2 bytes):** MUST be set to 0xFFFE. + +**Version (2 bytes):** An unsigned integer indicating the version number of the property set (or property sets). MUST be 0x0000 or 0x0001. An OLEPS implementation MUST accept version 0 property sets and SHOULD[\<5\>](#Appendix_A_5) also accept version 1 property sets. This field MUST be set to 0x0001 if the property set or property sets use any of the following features not supported by version 0 property sets: + +- Property types not supported for version 0 property sets, as specified in the [PropertyType](#Section_2a4589eb9a234a8badbd3e368233c099) enumeration. + +- The [Behavior property](#Section_1149ab6d06bc4044940de6681c1ce4e1). + +> If the property set does not use any of these features, this field SHOULD be set to 0x0000 for maximum interoperability. + +| Value | Meaning | +|--------|---------------------------------------| +| 0x0000 | Version 0 property sets will be used. | +| 0x0001 | Version 1 property sets will be used. | + +**SystemIdentifier (4 bytes):** An implementation-specific[\<6\>](#Appendix_A_6) value that SHOULD be ignored, except possibly to report this value to applications. It SHOULD NOT be interpreted by the OLEPS implementation. + +**CLSID (16 bytes):** MUST be a [GUID](#Section_5ee5aa9d6b964e54a6bc6b1f562d616b) (Packet Version) packet representing the associated [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the property set (or property sets). If no CLSID is provided by the application, it SHOULD be set to [**GUID_NULL**](#gt_b9d97d88-9398-4450-9e92-247073ce0362) by default. + +**NumPropertySets (4 bytes):** An unsigned integer indicating the number of property sets represented by this PropertySetStream structure. MUST be either 0x00000001 or 0x00000002. + +| Value | Meaning | +|----|----| +| 0x00000001 | This structure contains one property set. | +| 0x00000002 | This structure contains two property sets. The optional fields for **PropertySet 1** are present. | + +**FMTID0 (16 bytes):** A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that MUST be set to the [**FMTID**](#gt_bb4ffc07-754b-4e76-81e0-06686d942c9a) of the property set represented by the field **PropertySet 0**. If **NumPropertySets** has the value 0x00000002, then this GUID MUST be set to FMTID_DocSummaryInformation ({D5CDD502-2E9C-101B-9397-08002B2CF9AE}). + +**Offset0 (4 bytes):** An unsigned integer that MUST be set to the offset in bytes from the beginning of this PropertySetStream structure to the beginning of the field **PropertySet 0**. + +**FMTID1 (16 bytes):** If **NumPropertySets** has the value 0x00000002, it MUST be set to FMTID_UserDefinedProperties ({D5CDD505-2E9C-101B-9397-08002B2CF9AE}). Otherwise, it MUST be absent. + +**Offset1 (4 bytes):** If **NumPropertySets** has the value 0x00000002, it MUST be set to the offset in bytes from the beginning of this PropertySetStream structure to the beginning of the field **PropertySet 1**. Otherwise, it MUST be absent. + +**PropertySet0 (variable):** MUST be a [PropertySet](#Section_aefcbddff2994f5ea9da65ce4ca55075) packet. + +**PropertySet1 (variable):** If **NumPropertySets** has the value 0x00000002, it MUST be a PropertySet packet. Otherwise, it MUST be absent. + +**Padding (variable):** Contains additional padding added by the implementation. If present, padding MUST be zeroes and MUST be ignored. + +## Non-Simple Property Set Storage Format + +A [**non-simple property set**](#gt_5756d395-5889-485e-9611-07904421f0f3) MUST be represented by a storage. This storage MUST have a stream element with the name "CONTENTS", which MUST contain a [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet. The [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the storage MUST be set to the associated CLSID of the property set from the **CLSID** field of the PropertySetStream packet. + +In addition, the property set MUST have an [**element**](#gt_f633cdb5-cb63-4197-ad01-e7b02a745fdb) for each property of the following types: + +| Property Type | Element Type | +|----|----| +| VT_STREAM (0x0042) | [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) | +| VT_STORAGE(0x0043) | [**storage (2)**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) | +| VT_STREAMED_OBJECT (0x0044) | stream | +| VT_STORED_OBJECT (0x0044) | storage (2) | +| VT_VERSIONED_STREAM (0x0049) | stream | + +Each of these elements MUST have the name specified in the property's [IndirectPropertyName](#Section_e3bdb60847564a0cb2fd15b7eee52905) packet. + +## Property Set Stream and Storage Names + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or storage representing a property set might be an [**element**](#gt_f633cdb5-cb63-4197-ad01-e7b02a745fdb) of a storage. For example, the standard binding for property set streams or storages in a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) requires each to be an element of the root storage of the [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25). This section specifies a standard mapping between a property set's [**FMTID**](#gt_bb4ffc07-754b-4e76-81e0-06686d942c9a) and the name for the stream or storage element representing the property set, so that property sets stored in this way are discoverable. + +An OLEPS implementation SHOULD provide a mechanism by which elements with names derived according to this standard mapping are used for property sets, although the implementation MAY[\<7\>](#Appendix_A_7) additionally provide one or more other mechanisms that do not follow this convention. For example, the implementation might provide a mechanism by which a property set can be stored in an arbitrary application-provided [**stream container**](#gt_58ee6849-9bfd-4d97-aa22-4dbb6fb36e06) or [**storage container**](#gt_45e690de-dbe5-49a6-9317-ae4defe379dc). + +The following ABNF [\[RFC4234\]](https://go.microsoft.com/fwlink/?LinkId=90462) syntax specifies the standard names for property set streams and storages. + +4. PropertySetStreamOrStorageName = %x05 ("SummaryInformation" / + + "DocumentSummaryInformation" / "GlobalInfo" / "ImageContents" / + + "ImageInfo" / 26(ALPHA / "0" / "1" / "2" / "3" / "4" / "5") ) + +The special-case FMTID values listed in the following table MUST be mapped to the names as specified in the table. + +| FMTID | Stream or storage name | +|----|----| +| FMTID_SummaryInformation {F29F85E0-4FF9-1068-AB91-08002B27B3D9} | "\005SummaryInformation" | +| FMTID_DocSummaryInformation {D5CDD502-2E9C-101B-9397-08002B2CF9AE} | "\005DocumentSummaryInformation" | +| FMTID_UserDefinedProperties {D5CDD505-2E9C-101B-9397-08002B2CF9AE} | "\005DocumentSummaryInformation" | +| FMTID_GlobalInfo {56616F00-C154-11CE-8553-00AA00A1F95B} | "\005GlobalInfo" | +| FMTID_ImageContents {56616400-C154-11CE-8553-00AA00A1F95B} | "\005ImageContents" | +| FMTID_ImageInfo {56616500-C154-11CE-8553-00AA00A1F95B} | "\005ImageInfo" | + +All other FMTID values MUST be mapped to names as follows: + +1. Start with the 128-bit [GUID](#Section_5ee5aa9d6b964e54a6bc6b1f562d616b) (Packet Version) representation of the FMTID and append 2 zero bits for a total of 130 bits. + +2. Split the 130 bits into 26 groups of 5 consecutive bits each. + +3. Map each group to a character as specified in the following table. Character mappings are case-insensitive, and an implementation MAY[\<8\>](#Appendix_A_8) convert characters to uppercase. + +| Bits | Character | Bits | Character | Bits | Character | Bits | Character | +|-------|-----------|-------|-----------|-------|-----------|-------|-----------| +| 00000 | a | 01000 | i | 10000 | q | 11000 | y | +| 00001 | b | 01001 | j | 10001 | r | 11001 | z | +| 00010 | c | 01010 | k | 10010 | s | 11010 | 0 | +| 00011 | d | 01011 | l | 10011 | t | 11011 | 1 | +| 00100 | e | 01100 | m | 10100 | u | 11100 | 2 | +| 00101 | f | 01101 | n | 10101 | v | 11101 | 3 | +| 00110 | g | 01110 | o | 10110 | w | 11110 | 4 | +| 00111 | h | 01111 | p | 10111 | x | 11111 | 5 | + +4. The stream or storage name is the character "\005" followed by the 26 characters obtained from this mapping. + +## Standard Bindings + +The following sections specify standard bindings that can be used to associate property sets with a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25), so that property sets stored in this manner are discoverable to other implementations. An OLEPS implementation SHOULD support the [Compound File binding](#Section_89f4884730b24c3a835653ddfdda9fb7) for [**compound files**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). An implementation MAY[\<9\>](#Appendix_A_9) additionally support the [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) binding if the file system supports alternate streams, but this binding MUST NOT be used for compound files. + +### Compound File Binding + +To associate a property set with a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7), the [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or storage representing the property set MUST be an [**element**](#gt_f633cdb5-cb63-4197-ad01-e7b02a745fdb) of the compound file's root storage and MUST have the standard name specified in section [2.23](#Section_e5484a833cc143a6afcf6558059fe36e). + +### Alternate Stream Binding + +Some file systems provide a feature where a file can have alternate, named streams in addition to the main data stream of the file. For example, [**NTFS**](#gt_86f79a17-c0be-4937-8660-0cf6ce5ddc1a) has such a feature (see [\[MSDN-FileStreams\]](https://go.microsoft.com/fwlink/?LinkId=90537) for more information). The [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) binding enables property sets to be stored in these alternate streams, such that property sets can be associated with a file that is not a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7). + +### Control Stream + +A [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) that has one or more property sets associated with it through the [alternate stream binding](#Section_a7c45ae8f8f84db5ac0320c66f9634e9) MUST have a control stream, which is an [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) with the name "{4c8cc155-6c1e-11d1-8e41-00c04fb9386d}". This [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST contain the following packet. + +[TABLE] + +**Reserved1 (2 bytes):** MUST be set to zero, and nonzero values MUST be rejected. + +**Reserved2 (2 bytes):** MUST be set to zero, and MUST be ignored. + +**ApplicationState (4 bytes):** An application-provided value that MUST NOT be interpreted by the OLEPS implementation. If the application did not provide a value, it SHOULD be set to zero. + +**CLSID (16 bytes):** An application-provided value that MUST NOT be interpreted by the OLEPS implementation. If the application did not provide a value, it SHOULD be absent. + +### Simple Property Set Stream + +A [**simple property set**](#gt_1caaa2c2-c703-4141-b99c-fe446f430f2c) MUST be represented by an [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) with the standard name specified in section [2.23](#Section_e5484a833cc143a6afcf6558059fe36e). This stream MUST contain a [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet. + +### Non-Simple Property Set Storage + +A [**non-simple property set**](#gt_5756d395-5889-485e-9611-07904421f0f3) MUST be represented by an [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) with a name derived from the standard name specified in section [2.23](#Section_e5484a833cc143a6afcf6558059fe36e) according to the following ABNF [\[RFC4234\]](https://go.microsoft.com/fwlink/?LinkId=90462) syntax. + +8. NonSimplePropertySetAlternateStreamName = "Docf\_" + + PropertySetStreamOrStorageName + +This stream's contents MUST be in the format of a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) (see [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b) for details). The root storage of this compound file MUST conform to the non-simple property set [**storage format**](#gt_47836016-72d2-4f37-9559-29df5393eaa6) as specified in section [2.22](#Section_83b0f8316adf48c58befb62e7ac1cc1e). + +## Well-Known Property Set Formats + +The following sections specify the well-known [**property set formats**](#gt_662dbb07-0d00-4322-b305-fa99015511c4) [PropertyIdentifier](#Section_f7933d282cc44b36bc238861cbcd37c4) and [PropertyBag](#Section_9353494ccc624dccbda5db10c2f25a3e). + +### SummaryInformation + +The SummaryInformation property set format, identified by FMTID_SummaryInformation ({F29F85E0-4FF9-1068-AB91-08002B27B3D9}), represents generic [**properties**](#gt_f930baab-25f1-4142-bced-5effc9f62d45) of a document. The properties specific to the SummaryInformation property set are specified in the following table. Except where otherwise stated, a SummaryInformation property set SHOULD have all of these properties, and SHOULD NOT have any other properties, except for the special properties specified in section [2.18](#Section_9389a815d71c4dd2b2722b3a8177f004). + +[TABLE] + +### PropertyBag + +The PropertyBag [**property set format**](#gt_662dbb07-0d00-4322-b305-fa99015511c4), identified by FMTID_PropertyBag ({20001801-5DE6-11D1-8E38-00C04FB9386D}), is used in applications that persist an object as a property set, typically by saving state variables as properties. A PropertyBag [**property set's**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) associated [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) SHOULD identify the application or component whose object is persisted in the property set. The properties contained in a PropertyBag property set are application-specific. + +# Structure Examples + +## SummaryInformation Property Set + +The following table shows the binary contents of a stream representing a SummaryInformation Property Set. This is a [**simple property set**](#gt_1caaa2c2-c703-4141-b99c-fe446f430f2c), as the [SummaryInformation](#Section_f7933d282cc44b36bc238861cbcd37c4) format does not require support for stream and storage type properties. The name of this stream is "\005SummaryInformation", as specified in section [2.23](#Section_e5484a833cc143a6afcf6558059fe36e). + +[TABLE] + +The stream contains a [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet, with the following field values. Field offsets in this example are calculated from the beginning of the PropertySetStream packet. + +> **ByteOrder (2 bytes at offset 0):** 0xFFFE, as required. +> +> **Version (2 bytes at offset 2):** 0x0000, indicating that this is a version 0 property set. +> +> **SystemIdentifier (4 bytes at offset 4):** 0x00020006, which is the implementation-specific identifier written by Windows Vista operating system. +> +> **CLSID (16 bytes at offset 8):** GUID_NULL ({00000000-0000-0000-0000-000000000000}), the default value which indicates that the application that wrote the property set did not set the [**property set's**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99). +> +> **NumPropertySets (4 bytes at offset 24):** 0x00000001, which indicates that there is only one property set in this stream (as required, since this is not the special case of FMTID_DocSummaryInformation/FMTID_UserDefinedProperties). +> +> **FMTID 0 (16 bytes at offset 28):** FMTID_SummaryInformation ({F29F85E0-4FF9-1068-AB91-08002B27B3D9}). +> +> **Offset 0 (4 bytes at offset 44):** 0x00000030, the offset from the beginning of this structure to the beginning of the field **PropertySet 0**. +> +> **FMTID 1 (0 bytes):** Absent, as required for a PropertySetStream with only one property set. +> +> **Offset 1 (0 bytes):** Absent, as required for a PropertySetStream with only one property set. +> +> **PropertySet 0 (396 bytes at offset 48):** A [PropertySet](#Section_aefcbddff2994f5ea9da65ce4ca55075) packet (consists of the remainder of the stream contents). +> +> The field **PropertySet 0** has the following subfield values: +> +> **Size (4 bytes at offset 48):** 0x0000018C. +> +> **NumProperties (4 bytes at offset 52):** 0x00000012 (decimal 18). +> +> **PropertyIdentifierAndOffset 0-17 (144 bytes total at offset 56):** This field includes the following sequence of 18 [PropertyIdentifierAndOffset](#Section_f59e6c94a0ae4d1b85d3f01c35779a22) packets. + +| PropertyIdentifier | Offset | +|----|----| +| 0x00000001 (property identifier for the [CodePage property](#Section_18a44a264a6748948db252a701f2473f)) | 0x00000098 | +| PIDSI_TITLE (0x00000002) | 0x000000A0 | +| PIDSI_SUBJECT (0x00000003) | 0x000000B8 | +| PIDSI_AUTHOR (0x00000004) | 0x000000C4 | +| PIDSI_KEYWORDS (0x00000005) | 0x000000D0 | +| PIDSI_COMMENTS (0x00000006) | 0x000000DC | +| PIDSI_TEMPLATE (0x00000007) | 0x000000E8 | +| PIDSI_LASTAUTHOR (0x00000008) | 0x000000FC | +| PIDSI_REVNUMBER (0x00000009) | 0x00000110 | +| PIDSI_APPNAME (0x00000012) | 0x0000011C | +| PIDSI_EDITTIME (0x0000000A) | 0x0000013C | +| PIDSI_LASTPRINTED (0x0000000B) | 0x00000148 | +| PIDSI_CREATE_DTM (0x0000000C) | 0x00000154 | +| PIDSI_LASTSAVE_DTM (0x0000000D) | 0x00000160 | +| PIDSI_PAGECOUNT (0x0000000E) | 0x0000016C | +| PIDSI_WORDCOUNT (0x0000000F) | 0x00000174 | +| PIDSI_CHARCOUNT (0x00000010) | 0x0000017C | +| PIDSI_DOC_SECURITY (0x00000013) | 0x00000184 | + +> **Property 0-17 (252 bytes total at offset 200):** A sequence of 18 [TypedPropertyValue](#Section_f122b9d7e5cf4484846683f6fd94b3cc) packets, as described in the following sections (3.1.1 through [3.1.18](#Section_e45b4495a9b54c179f4d5b194c72a3e5)). +> +> **PropertySet 1:** Absent, as required for a PropertySetStream with only one property set. + +### CodePage Property + +The CodePage property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000001 +> +> **Property offset:** 0x00000030 + 0x00000098 = 0x000000C8 (decimal 200) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 200):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I2 (0x0002). +> +> **Padding (2 bytes at offset 202):** Set to zero, as required. +> +> **Value (4 bytes at offset 204):** The 2-byte signed integer 0x04E4 (decimal 1252) followed by 2 bytes of zero padding as required. Indicates that [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packets in this property set are encoded with code page 1252 (Latin 1). + +### PIDSI_TITLE + +The PIDSI_TITLE property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000002 +> +> **Property offset:** 0x00000030 + 0x000000A0 = 0x000000D0 (decimal 208) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 208):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 210):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 212):** 0x00000F (decimal 15). +> +> **Characters (16 bytes at offset 216):** The null-terminated sequence of 8-bit characters, "Joe's document", padded to a total length of 16 bytes. + +### PIDSI_SUBJECT + +The PIDSI_SUBJECT property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000003 +> +> **Property offset:** 0x00000030 + 0x000000B8 = 0x000000E8 (decimal 232) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 232):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 234):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 236):** 0x000004. +> +> **Characters (4 bytes at offset 240):** The null-terminated sequence of 8-bit characters, "Job". + +### PIDSI_AUTHOR + +The PIDSI_AUTHOR property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000004 +> +> **Property offset:** 0x00000030 + 0x000000C4 = 0x000000F4 (decimal 244) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 244):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 246):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 248):** 0x000004. +> +> **Characters (4 bytes at offset 252):** The null-terminated sequence of 8-bit characters, "Joe". + +### PIDSI_KEYWORDS + +The PIDSI_KEYWORDS property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000005 +> +> **Property offset:** 0x00000030 + 0x000000D0 = 0x00000100 (decimal 256) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 256):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 258):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 260):** 0x000004. +> +> **Characters (4 bytes at offset 264):** A null-terminated sequence of 8-bit characters. The string itself consists entirely of null characters. + +### PIDSI_COMMENTS + +The PIDSI_COMMENTS property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000006 +> +> **Property offset:** 0x00000030 + 0x000000DC = 0x0000010C (decimal 268) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 268):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 270):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 272):** 0x000004. +> +> **Characters (4 bytes at offset 276):** A null-terminated sequence of 8-bit characters. The string itself consists entirely of null characters. + +### PIDSI_TEMPLATE + +The PIDSI_TEMPLATE property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000007 +> +> **Property offset:** 0x00000014 + 0x000000FC = 0x00000110 (decimal 272) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 280):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 282):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 284):** 0x0000000C (decimal 12). +> +> **Characters (12 bytes at offset 288):** The null-terminated sequence of 8-bit characters, "Normal.dotm". + +### PIDSI_LASTAUTHOR + +The PIDSI_LASTAUTHOR property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000008 +> +> **Property offset:** 0x00000030 + 0x000000FC = 0x0000012C (decimal 300) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 300):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 302):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 304):** 0x00000A (decimal 10). +> +> **Characters (12 bytes at offset 308):** The null-terminated sequence of 8-bit characters, "Cornelius", padded to a total length of 12 bytes. + +### PIDSI_REVNUMBER + +The PIDSI_REVNUMBER property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000009 +> +> **Property offset:** 0x00000030 + 0x00000110 = 0x00000140 (decimal 320) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 320):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 322):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 324):** 0x000004. +> +> **Characters (4 bytes at offset 328):** The null-terminated sequence of 8-bit characters, "66", followed by an additional null character. + +### PIDSI_APPNAME + +The PIDSI_APPNAME property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000012 +> +> **Property offset:** 0x00000030 + 0x0000011C = 0x0000014C (decimal 332) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 332):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_LPSTR (0x001E). +> +> **Padding (2 bytes at offset 334):** Set to zero, as required. +> +> **Value:** A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 336):** 0x000018. +> +> **Characters (24 bytes at offset 340):** The null-terminated sequence of 8-bit characters, "Microsoft Office Word", followed by two additional null characters. + +### PIDSI_EDITTIME + +The PIDSI_EDITTIME property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000A +> +> **Property offset:** 0x00000030 + 0x0000013C = 0x0000016C (decimal 364) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 364):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_FILETIME (0x0040). +> +> **Padding (2 bytes at offset 366):** Set to zero, as required. +> +> **Value (8 bytes at offset 368):** A [FILETIME](#Section_d8070a967f0c4235b4a1112876f2a419) packet that, when interpreted as a **64-bit unsigned integer**, as is appropriate for the **PIDSI_EDITTIME** property, has the value 0x00000042A2D96E00 (decimal 286,200,000,000). This value is in 100-nanosecond increments and is equal to 7 hours, 57 minutes. + +### PIDSI_LASTPRINTED + +The PIDSI_LASTPRINTED property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000B +> +> **Property offset:** 0x00000030 + 0x00000148 = 0x00000178 (decimal 376) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 376):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_FILETIME (0x0040). +> +> **Padding (2 bytes at offset 378):** Set to zero, as required. +> +> **Value (8 bytes at offset 380):** A [FILETIME](#Section_d8070a967f0c4235b4a1112876f2a419) packet with the value June 12, 2006 6:33 P.M. coordinated universal time (UTC). + +### PIDSI_CREATE_DTM + +The PIDSI_CREATE_DTM property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000C +> +> **Property offset:** 0x00000030 + 0x00000154 = 0x00000184 (decimal 388) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 388):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_FILETIME (0x0040). +> +> **Padding (2 bytes at offset 390):** Set to zero, as required. +> +> **Value (8 bytes at offset 392):** A [FILETIME](#Section_d8070a967f0c4235b4a1112876f2a419) packet with the value September 2, 2006 12:58 A.M. UTC. + +### PIDSI_LASTSAVE_DTM + +The PIDSI_LASTSAVE_DTM property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000D +> +> **Property offset:** 0x00000030 + 0x00000160 = 0x00000190 (decimal 400) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 400):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_FILETIME (0x0040). +> +> **Padding (2 bytes at offset 402):** Set to zero, as required. +> +> **Value (8 bytes at offset 404):** A [FILETIME](#Section_d8070a967f0c4235b4a1112876f2a419) packet with the value March 8, 2008 5:30 A.M. UTC. + +### PIDSI_PAGECOUNT + +The PIDSI_PAGECOUNT property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000E +> +> **Property offset:** 0x00000030 + 0x0000016C = 0x0000019C (decimal 412) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 412):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I4 (0x0003). +> +> **Padding (2 bytes at offset 414):** Set to zero, as required. +> +> **Value (4 bytes at offset 416):** The 32-bit signed integer 0x0000000E (decimal 14). + +### PIDSI_WORDCOUNT + +The PIDSI_WORDCOUNT property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000F +> +> **Property offset:** 0x00000030 + 0x00000174 = 0x000001A4 (decimal 420) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 420):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I4 (0x0003). +> +> **Padding (2 bytes at offset 422):** Set to zero, as required. +> +> **Value (4 bytes at offset 424):** The 32-bit signed integer 0x00000DE5 (decimal 3,557). + +### PIDSI_CHARCOUNT + +The PIDSI_CHARCOUNT property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000010 +> +> **Property offset:** 0x00000030 + 0x0000017C = 0x000001AC (decimal 428) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 428):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I4 (0x0003). +> +> **Padding (2 bytes at offset 430):** Set to zero, as required. +> +> **Value (4 bytes at offset 432):** The 32-bit signed integer 0x00004F38 (decimal 20,280). + +### PIDSI_DOC_SECURITY + +The PIDSI_DOC_SECURITY property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000013 +> +> **Property offset:** 0x00000030 + 0x00000184 = 0x000001B4 (decimal 436) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 436):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I4 (0x0003). +> +> **Padding (2 bytes at offset 438):** Set to zero, as required. +> +> **Value (4 bytes at offset 440):** The 32-bit signed integer 0x00000000, indicating that no access control is suggested by the application used to create the document. + +## PropertyBag Property Set + +This section demonstrates the usage of some of the capabilities of OLEPS that are not used in [SummaryInformation](#Section_f7933d282cc44b36bc238861cbcd37c4) property sets (as described in section [3.1](#Section_3f9119dcfaa24bb9af955cf128fa5fbd)). The example is a [PropertyBag](#Section_9353494ccc624dccbda5db10c2f25a3e) property set, which an application has used to persist object state in an application-specific manner. The example property set uses the [**non-simple property set**](#gt_5756d395-5889-485e-9611-07904421f0f3) format and is stored using the [Alternate Stream Binding](#Section_a7c45ae8f8f84db5ac0320c66f9634e9). + +The [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) with which the property set is associated has two [**alternate streams**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41): "{4c8cc155-6c1e-11d1-8e41-00c04fb9386d}" and "Docf\_\005Bagaaqy23kudbhchAaq5u2chNd". + +### Control Stream ("{4c8cc155-6c1e-11d1-8e41-00c04fb9386d}") + +The following table shows the binary contents of the control stream, which is required for a [**file**](#gt_a04c146a-de3b-4e4b-829f-a9e772f3fe25) containing one or more property sets stored using the [alternate stream binding](#Section_a7c45ae8f8f84db5ac0320c66f9634e9). This stream is identified by its name, "{4c8cc155-6c1e-11d1-8e41-00c04fb9386d}", as specified in section [2.24.3](#Section_f45612562877445c83d8aa91598462b6). + +[TABLE] + +> **Reserved1 (2 bytes at offset 0):** Set to zero, as required. +> +> **Reserved2 (2 bytes at offset 2):** Set to zero, as required. +> +> **ApplicationState (4 bytes at offset 4):** Set to zero, indicating that the application did not provide a value. +> +> **CLSID (0 bytes):** Absent, indicating that the application did not provide a value. + +### PropertyBag Stream ("Docf\_\005Bagaaqy23kudbhchAaq5u2chNd") + +This stream contains the [non-simple property set storage format](#Section_83b0f8316adf48c58befb62e7ac1cc1e) representing the PropertyBag property set (as described in section [3.2](#Section_b8307f6f8e7040d0b09a3de2f4fd494b)). The [**FMTID**](#gt_bb4ffc07-754b-4e76-81e0-06686d942c9a) of the property set, FMTID_PropertyBag ({20001801-5DE6-11D1-8E38-00C04FB9386D}), as well as the fact that it is a [**non-simple property set**](#gt_5756d395-5889-485e-9611-07904421f0f3), are indicated by its name, "Docf\_\005Bagaaqy23kudbhchAaq5u2chNd", as specified in section [2.24.5](#Section_d56ee70751914fa5b66928259cac03a2). + +The [**stream's**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contents are in the format of a [**compound file**](#gt_4819d51b-789c-4d2a-ba56-88a48a87fae7) (see [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b) for details). For brevity, the binary contents of this stream are omitted here. The compound file stored in this [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) represents a storage with the following elements: + +- A stream named "CONTENTS" + +- A stream named "prop6" + +- A storage named "prop12" + +The associated [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the root storage is {994BFF53-DDF9-42AD-A56A-FFEA3617AC16}, which, as specified in section 2.22, is the associated CLSID of the property set. This value was set by the application and is not recognized by OLEPS implementations. + +#### "CONTENTS" Stream + +The following table shows the binary contents of the "CONTENTS" stream. + +[TABLE] + +The stream contains a [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet, with the following field values: + +**Note**  Field offsets in this example are calculated from the beginning of the PropertySetStream packet. + +> **ByteOrder (2 bytes at offset 0):** 0xFFFE, as required. +> +> **Version (2 bytes at offset 2):** 0x0001, indicating that this is a version 1 property set. This value was set by the OLEPS implementation, because the application used the following features not supported by version 0 property sets: + +- A property of type VT_ARRAY \| VT_I1 (0x2010). + +- The [Behavior property](#Section_1149ab6d06bc4044940de6681c1ce4e1). + +> **SystemIdentifier (4 bytes at offset 4):** 0x00020006, which is the operating system identifier.[\<10\>](#Appendix_A_10) +> +> **CLSID (16 bytes at offset 8):** {994BFF53-DDF9-42AD-A56A-FFEA3617AC16}. This is the same value as the associated [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the storage in which this property set is stored. +> +> **NumPropertySets (4 bytes at offset 24):** 0x00000001, which indicates that there is only one property set in this stream (as required, because this is not the special case of FMTID_DocSummaryInformation/FMTID_UserDefinedProperties). +> +> **FMTID 0 (16 bytes at offset 28):** FMTID_PropertyBag ({20001801-5DE6-11D1-8E38-00C04FB9386D}). +> +> **Offset 0 (4 bytes at offset 44):** 0x00000030, the offset from the beginning of this structure to the beginning of the field **PropertySet 0**. +> +> **FMTID 1 (0 bytes):** Absent, as required for a PropertySetStream with only one property set. +> +> **Offset 1 (0 bytes):** Absent, as required for a PropertySetStream with only one property set. +> +> **PropertySet 0 (396 bytes at offset 48):** A [PropertySet](#Section_aefcbddff2994f5ea9da65ce4ca55075) packet (consists of the remainder of the stream contents). +> +> The field **PropertySet 0** has the following subfield values: +> +> **Size (4 bytes at offset 48):** 0x000001DC (decimal 496). +> +> **NumProperties (4 bytes at offset 52):** 0x0000000A (decimal 10). +> +> **PropertyIdentifierAndOffset 0–9 (80 bytes total at offset 56):** This consists of the following sequence of [PropertyIdentifierAndOffset](#Section_f59e6c94a0ae4d1b85d3f01c35779a22) packets. + +| PropertyIdentifier | Offset | +|----|----| +| 0x00000001 (property identifier for the [CodePage property](#Section_b89107367f4a469a9644aed68a71d7d1)) | 0x00000058 | +| 0x80000000 (property identifier for the [Locale property](#Section_bb452c0779f746e0bfb7122c347cc5c8)) | 0x00000060 | +| 0x80000001 (property identifier for the Behavior property) | 0x00000068 | +| 0x00000000 (property identifier for the [Dictionary property](#Section_4177a4bc554749fea4d94767350fd9cf)) | 0x00000070 | +| 0x00000004 | 0x00000138 | +| 0x00000006 | 0x0000014C | +| 0x00000007 | 0x00000170 | +| 0x0000000c | 0x0000017C | +| 0x00000027 | 0x00000194 | +| 0x00000092 | 0x000001C0 | + +> **Property 0–9 (496 bytes total at offset 136):** A sequence of 10 [TypedPropertyValue](#Section_f122b9d7e5cf4484846683f6fd94b3cc) packets, except the Dictionary property, which is a [Dictionary](#Section_c1947489dff74274bed7a8c5eefc6853) packet, as described in section 3.2.2.1.4. + +##### CodePage + +The CodePage property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000001 +> +> **Property offset:** 0x00000030 + 0x00000058 = 0x00000088 (decimal 136) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 136):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I2 (0x0002). +> +> **Padding (2 bytes at offset 138):** Set to zero, as required. +> +> **Value (4 bytes at offset 140):** The 2-byte signed integer 0x04B0 (decimal 1200) followed by 2 bytes of zero padding as required. This value is CP_WINUNICODE, which indicates that [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packets in this property set are encoded as arrays of 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. + +##### Locale + +The Locale property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x80000000 +> +> **Property offset:** 0x00000030 + 0x00000060 = 0x00000090 (decimal 144) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 144):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_UI4 (0x0013). +> +> **Padding (2 bytes at offset 146):** Set to zero, as required. +> +> **Value (4 bytes at offset 148):** The 4-byte unsigned integer 0x08090000. This value encodes the Language ID 0x0809 (en-GB) and Sort ID 0x0 (SORT_DEFAULT), as specified in [\[MS-LCID\]](%5bMS-LCID%5d.pdf#Section_70feba9f294e491eb6eb56532684c37f) section 2.2. + +##### Behavior + +The Behavior property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x80000001 +> +> **Property offset:** 0x00000030 + 0x00000068 = 0x00000098 (decimal 152) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 152):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_UI4 (0x0013). +> +> **Padding (2 bytes at offset 154):** Set to zero, as required. +> +> **Value (4 bytes at offset 156):** The 4-byte unsigned integer 0x00000001, indicating that property names are case-sensitive. + +##### Dictionary + +The Dictionary property is an instance of the **Dictionary** structure defined in section [2.17](#Section_99127b7fc440469791a4c853086d6b33). + +> **Property identifier:** 0x00000000 +> +> **Property offset:** 0x00000030 + 0x00000070 = 0x000000A0 (decimal 160) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **NumEntries (4 bytes at offset 160):** 0x00000006. +> +> **Entry 0–5 (196 bytes total at offset 164):** A sequence of six [DictionaryEntry](#Section_333959a3a9994eca862748a224e63e77) packets as described in sections [3.2.2.1.4.1](#Section_be6c51af08c64f6db769d0c41e578880) through [3.2.2.1.4.6](#Section_187e913d8ed04d9d8d05caf250b34cff). + +The Dictionary property set assigns [**property names**](#gt_dcd670df-c295-466f-b681-d7d91014040a) to each of its properties (except the [Special properties](#Section_9389a815d71c4dd2b2722b3a8177f004), which cannot have property names). + +| PropertyIdentifier | Name | Section | +|----|----|----| +| 0x00000004 | DisplayColour | Dictionary Entry 0 (section 3.2.2.1.4.1) | +| 0x00000006 | MyStream | Dictionary Entry 1 (section [3.2.2.1.4.2](#Section_ccf935f24a1541cfa965e24392905959)) | +| 0x00000007 | Price(GBP) | Dictionary Entry 2 (section [3.2.2.1.4.3](#Section_ae8df321a51747eba964eb1ac8b5ad56)) | +| 0x0000000c | MyStorage | Dictionary Entry 3 (section [3.2.2.1.4.4](#Section_2284360a4dc14919b8c4d92f1ce86eed)) | +| 0x00000027 | CaseSensitive | Dictionary Entry 4 (section [3.2.2.1.4.5](#Section_284652dddfb54802974e6e20b148e009)) | +| 0x00000092 | CASESENSITIVE | Dictionary Entry 5 (section 3.2.2.1.4.6) | + +Note that two of these properties have names that are equal when compared in a manner that ignores case sensitivity ("CaseSensitive" and "CASESENSITIVE"). This equality is valid because the Dictionary [**property set's**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) [Behavior property](#Section_1149ab6d06bc4044940de6681c1ce4e1) has the value 0x00000001; otherwise, this would be invalid. + +###### Dictionary Entry 0 + +Entry 0 of the [Dictionary (section 3.2.2.1.4)](#Section_c1947489dff74274bed7a8c5eefc6853) property is an instance of the **DictionaryEntry** structure defined in section [2.16](#Section_333959a3a9994eca862748a224e63e77). + +> **Entry offset:** 0x000000A4 (decimal 164) + +The following table shows the binary contents of the structure representing the entry. + +[TABLE] + +> **PropertyIdentifier (4 bytes at offset 164):** 0x00000004 +> +> **Length (4 bytes at offset 168):** 0x0000000E (decimal 14). +> +> **Name (28 bytes at offset 172):** The null-terminated sequence of 16-bit Unicode characters, "DisplayColour". + +###### Dictionary Entry 1 + +Entry 1 of the [Dictionary (section 3.2.2.1.4)](#Section_c1947489dff74274bed7a8c5eefc6853) property is an instance of the **DictionaryEntry** structure defined in section [2.16](#Section_333959a3a9994eca862748a224e63e77). + +> **Entry offset:** 0x000000C8 (decimal 200) + +The following table shows the binary contents of the structure representing the entry. + +[TABLE] + +> **PropertyIdentifier (4 bytes at offset 200):** 0x00000006 +> +> **Length (4 bytes at offset 204):** 0x00000009. +> +> **Name (20 bytes at offset 208):** The null-terminated sequence of 16-bit Unicode characters, "MyStream", padded with zeroes to a multiple of 4 bytes. + +###### Dictionary Entry 2 + +Entry 2 of the [Dictionary (section 3.2.2.1.4)](#Section_c1947489dff74274bed7a8c5eefc6853) property is an instance of the **DictionaryEntry** structure defined in section [2.16](#Section_333959a3a9994eca862748a224e63e77). + +> **Entry offset:** 0x000000E4 (decimal 228) + +The following table shows the binary contents of the structure representing the entry. + +[TABLE] + +> **PropertyIdentifier (4 bytes at offset 228):** 0x00000007 +> +> **Length (4 bytes at offset 232):** 0x0000000B (decimal 11). +> +> **Name (24 bytes at offset 236):** The null-terminated sequence of 16-bit Unicode characters, "Price(GBP)", padded with zeroes to a multiple of 4 bytes. + +###### Dictionary Entry 3 + +Entry 3 of the [Dictionary (section 3.2.2.1.4)](#Section_c1947489dff74274bed7a8c5eefc6853) property is an instance of the **DictionaryEntry** structure defined in section [2.16](#Section_333959a3a9994eca862748a224e63e77). + +> **Entry offset:** 0x00000104 (decimal 260) + +The following table shows the binary contents of the structure representing the entry. + +[TABLE] + +> **PropertyIdentifier (4 bytes at offset 260):** 0x0000000C (decimal 12). +> +> **Length (4 bytes at offset 264):** 0x0000000A (decimal 10). +> +> **Name (20 bytes at offset 268):** The null-terminated sequence of 16-bit Unicode characters, "MyStorage". + +###### Dictionary Entry 4 + +Entry 4 of the [Dictionary (section 3.2.2.1.4)](#Section_c1947489dff74274bed7a8c5eefc6853) property is an instance of the **DictionaryEntry** structure defined in section [2.16](#Section_333959a3a9994eca862748a224e63e77). + +> **Entry offset:** 0x000000A4 (decimal 288) + +The following table shows the binary contents of the structure representing the entry. + +[TABLE] + +> **PropertyIdentifier (4 bytes at offset 288):** 0x00000027 +> +> **Length (4 bytes at offset 292):** 0x0000000E (decimal 14). +> +> **Name (28 bytes at offset 296):** The null-terminated sequence of 16-bit Unicode characters, "CaseSensitive". + +###### Dictionary Entry 5 + +Entry 5 of the [Dictionary (section 3.2.2.1.4)](#Section_c1947489dff74274bed7a8c5eefc6853) property is an instance of the **DictionaryEntry** structure defined in section [2.16](#Section_333959a3a9994eca862748a224e63e77). + +> **Entry offset:** 0x00000144 (decimal 324) + +The following table shows the binary contents of the structure representing the entry. + +[TABLE] + +> **PropertyIdentifier (4 bytes at offset 324):** 0x00000092 (decimal 146). +> +> **Length (4 bytes at offset 328):** 0x0000000E (decimal 14). +> +> **Name (28 bytes at offset 332):** The null-terminated sequence of 16-bit Unicode characters, "CASESENSITIVE". + +##### DisplayColour + +The DisplayColour property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000004 +> +> **Property offset:** 0x00000030 + 0x00000138 = 0x00000168 (decimal 360) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 360):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_BSTR (0x0008). +> +> **Padding (2 bytes at offset 362):** Set to zero, as required. +> +> **Value:** Value A [CodePageString](#Section_a4c326115b7949658f5050639c138e16) packet with the following subfields: +> +> **Size (4 bytes at offset 364):** 0x00000A (decimal 10). +> +> **Characters (12 bytes at offset 368):** The null-terminated sequence of 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters, "Grey", padded with zeroes to a multiple of 4 bytes. + +##### MyStream + +The MyStream property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000006 +> +> **Property offset:** 0x00000030 + 0x0000014C = 0x0000017C (decimal 380) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 380):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_VERSIONED_STREAM (0x0049). +> +> **Padding (2 bytes at offset 382):** Set to zero, as required. +> +> **Value:** A [VersionedStream](#Section_7c6776d18f2c4693aa7e281bcbc61a1f) packet with the following subfields: +> +> **VersionGuid (16 bytes at offset 384):** {F99584CA-CA23-470B-8394-220177907AAD}. This is an application-specific value that has no meaning to OLEPS implementations. +> +> **Size (4 bytes at offset 400):** 0x0000000C (decimal 12). +> +> **Characters (12 bytes at offset 404):** The null-terminated sequence of 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters, "prop6". + +Note that the TypedPropertyValue packet representing this property does not contain the complete property value. The remainder of the property value is contained in the stream, "[prop6](#Section_7b86c5e9a6e14e2e93b14e51b2c90eea)". + +##### Price(GBP) + +The Price(GBP) property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000007 +> +> **Property offset:** 0x00000030 + 0x00000170 = 0x000001A0 (decimal 416) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 416):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_CY (0x0006). +> +> **Padding (2 bytes at offset 418):** Set to zero, as required. +> +> **Value (8 bytes at offset 420):** A [CURRENCY](#Section_fb1fc39313a945399bbb9c696434c6e0) packet with the value 133.1200 (presumably £133.12 based on the name of the property). + +##### MyStorage + +The MyStorage property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x0000000C +> +> **Property offset:** 0x00000030 + 0x0000017C = 0x000001AC (decimal 428) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 428):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_STORED_OBJECT (0x0045). +> +> **Padding (2 bytes at offset 430):** Set to zero, as required. +> +> **Value:** An [IndirectPropertyName](#Section_e3bdb60847564a0cb2fd15b7eee52905) packet with the following subfields: +> +> **Size (4 bytes at offset 432):** 0x0000000E (decimal 14). +> +> **Characters (16 bytes at offset 436):** The null-terminated sequence of 16-bit [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters, "prop12", padded with zeroes to a multiple of 4 bytes. + +Note that the TypedPropertyValue packet representing this property does not contain the property value. The property value is contained in the storage, "prop12". + +##### CaseSensitive Mixed Case + +The CaseSensitive property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000027 +> +> **Property offset:** 0x00000030 + 0x00000194 = 0x000001C4 (decimal 452) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 452):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_ARRAY \| VT_I1 (0x2010). +> +> **Padding (2 bytes at offset 454):** Set to zero, as required. +> +> **Value:** An [ArrayHeader](#Section_e74a8869440b43a4985c70b850b8aeed) followed by a sequence of 1-byte signed integers, followed by zero padding to a total length that is a multiple of 4 bytes. The ArrayHeader has the following subfields: +> +> **Type (4 bytes at offset 456):** 0x00000010, the value obtained by clearing the VT_ARRAY (0x2000) bit of the **Type** field. +> +> **NumDimensions (4 bytes at offset 460):** 0x00000002. +> +> **Dimension 0-1 (16 bytes total at offset 464):** A sequence of [ArrayDimension](#Section_7db5c301aacb4f45b95646ee7010bf90) packets described as follows. + +[TABLE] + +> **Size (4 bytes at offset 464):** 0x00000003. +> +> **IndexOffset (4 bytes at offset 468):** 0xFFFFFFFF (decimal -1). + +[TABLE] + +> **Size (4 bytes at offset 472):** 0x00000005. +> +> **IndexOffset (4 bytes at offset 476):** 0x00000000. +> +> **Scalar values 0-14 (16 bytes total at offset 480):** The total number of scalar values in the array property is 3×5 = 15. +> +> A sequence of 15 1-byte signed integers, padded with zeroes to a multiple of 4 bytes. The arrangement of the integer sequence in the array is shown in the following table. + +[TABLE] + +##### CASESENSITIVE All Uppercase + +The CASESENSITIVE All Uppercase property is an instance of the **TypedPropertyValue** structure defined in section [2.15](#Section_f122b9d7e5cf4484846683f6fd94b3cc). + +> **Property identifier:** 0x00000092 +> +> **Property offset:** 0x00000030 + 0x000001C0 = 0x000001F0 (decimal 496) + +The following table shows the binary contents of the structure representing the property. + +[TABLE] + +> **Type (2 bytes at offset 496):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_VECTOR \| VT_VARIANT (0x100C). +> +> **Padding (2 bytes at offset 498):** Set to zero, as required. +> +> **Value:** A [VectorHeader](#Section_7db5c301aacb4f45b95646ee7010bf90) followed by a sequence of TypedPropertyValue packets. The VectorHeader has the following subfield: +> +> **Length (4 bytes at offset 500):** 0x00000002. +> +> **Scalar values 0-1 (20 bytes total at offset 504):** This includes the following sequence of TypedPropertyValue packets. + +[TABLE] + +> **Type (2 bytes at offset 504):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_UI1 (0x0011). +> +> **Padding (2 bytes at offset 506):** Set to zero, as required. +> +> **Value (4 bytes at offset 508):** The 1-byte unsigned integer 0xA9 (decimal 169), padded with zeroes to a multiple of 4 bytes. + +[TABLE] + +> **Type (2 bytes at offset 512):** The type of property represented in the packet; the type is identified as the **PropertyType** enumeration value VT_I8 (0x0014). +> +> **Padding (2 bytes at offset 514):** Set to zero, as required. +> +> **Value (8 bytes at offset 516):** The 8-byte signed integer 0x9C10223B997600A9 (decimal -7201218164792360791). + +#### "prop6" Stream + +This stream contains the stream portion of the VT_VERSIONED_STREAM property, "MyStream" ([PropertyIdentifier](#Section_04727953c1744d0180aeb38b15d7068a) 0x00000006). For brevity, the contents of the stream are omitted here. + +#### "prop12" Storage + +This storage contains the value of the VT_STORED_OBJECT property, "MyStorage" ([PropertyIdentifier](#Section_04727953c1744d0180aeb38b15d7068a) 0x0000000C). This storage contains an application-specific representation of an object. For brevity, the contents of the storage are omitted here. + +# Security Considerations + +None. + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- Windows NT 4.0 operating system + +  + +- Windows 2000 operating system + +- Windows XP operating system + +- Windows Server 2003 operating system + +- Windows Vista operating system + +- Windows Server 2008 operating system + +- Windows 7 operating system + +- Windows Server 2008 R2 operating system + +- Windows 8 operating system + +- Windows Server 2012 operating system + +- Windows 8.1 operating system + +- Windows Server 2012 R2 operating system + +- Windows 10 operating system + +- Windows Server 2016 operating system + +- Windows Server operating system + +- Windows Server 2019 operating system + +  + +- Windows Server 2022 operating system + +- Windows 11 operating system + +- Windows Server 2025 operating system + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 2.5](#Appendix_A_Target_1): Windows presents properties with [PropertySet](#Section_aefcbddff2994f5ea9da65ce4ca55075) VT_LPSTR (0x001E) to applications as null-terminated string values such that the application cannot reliably detect the presence of trailing null characters or any characters following the first embedded null character. Properties with [PropertyType](#Section_2a4589eb9a234a8badbd3e368233c099) VT_BSTR (0x0008) are presented to the application as a value of type **BSTR** (for more information, see [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.5), which is an explicitly-sized string type, and in which an application can detect these characters. Identical behavior also applies to scalar values of type VT_LPSTR or VT_BSTR, respectively, when these values are part of a vector or array property type. + +[\<2\> Section 2.18.2](#Appendix_A_Target_2): Windows enables applications creating a [**property set**](#gt_dc3c2e4a-3b46-4284-973e-cc0e362a3264) to select whether a property set is [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8), in which case the [CodePage property](#Section_b89107367f4a469a9644aed68a71d7d1) is CP_WINUNICODE (0x04B0). Alternatively, it can select ANSI, in which case the CodePage property is the current ANSI code page identifier for the system. + +[\<3\> Section 2.18.3](#Appendix_A_Target_3): Windows always selects the current user's default locale for the [Locale property](#Section_bb452c0779f746e0bfb7122c347cc5c8). + +[\<4\> Section 2.21](#Appendix_A_Target_4): Different versions of Windows limit the size of a [PropertySetStream](#Section_6e65d6fa60444e23ae71d65d1e3b1249) packet as follows. + +| Windows version | Limit (bytes) | +|----|----| +| Windows NT operating system | 262,144 | +| Windows 2000 | 1,048,576 | +| Windows XP | 1,048,576 | +| Windows XP operating system Service Pack 2 (SP2) | 1,048,576 | +| Windows XP operating system Service Pack 3 (SP3) | 2,097,152 | +| Windows Server 2003 operating system with Service Pack 1 (SP1) | 1,048,576 | +| Windows Server 2003 operating system with Service Pack 2 (SP2) | 2,097,152 | +| Windows Vista and later | 2,097,152 | +| Windows Server 2008 and later | 2,097,152 | + +[\<5\> Section 2.21](#Appendix_A_Target_5): Windows NT does not support version 1 property sets. + +[\<6\> Section 2.21](#Appendix_A_Target_6): Different versions of Windows write the **SystemIdentifier** field as follows. + +| Windows version | SystemIdentifier | +|-------------------------------|------------------| +| Windows | 0x00020004 | +| Windows 2000 | 0x00020005 | +| Windows XP | 0x00020105 | +| Windows Server 2003 | 0x00020205 | +| Windows Vista and later | 0x00020006 | +| Windows Server 2008 and later | 0x00020006 | + +[\<7\> Section 2.23](#Appendix_A_Target_7): Windows provides a mechanism for applications to store property sets in an arbitrary application-provided [**stream container**](#gt_58ee6849-9bfd-4d97-aa22-4dbb6fb36e06) or [**storage container**](#gt_45e690de-dbe5-49a6-9317-ae4defe379dc). + +[\<8\> Section 2.23](#Appendix_A_Target_8): Windows converts the mapped characters in positions 0, 8, 16, and 24 to uppercase. + +[\<9\> Section 2.24](#Appendix_A_Target_9): Windows NT does not support the [**alternate stream**](#gt_71cb9ca5-c721-4593-8498-c745d6a29b41) binding for files on [**NTFS**](#gt_86f79a17-c0be-4937-8660-0cf6ce5ddc1a) volumes. + +[\<10\> Section 3.2.2.1](#Appendix_A_Target_10): Different versions of Windows write the **SystemIdentifier** field as follows. + +| Windows version | SystemIdentifier | +|-----------------|------------------| +| Windows Vista | 0x00020006 | +| Windows 7 | 0x00020106 | +| Windows 8 | 0x00020206 | +| Windows 8.1 | 0x00020306 | +| Windows 10 | 0x0002000a | + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [5](#Section_0ad7dbc8a93d4b71972cd5f4ff01d0cf) Appendix A: Product Behavior | Added Windows Server 2025 to the list of applicable products. | Major | + +# Index + +A + +[Applicability](#applicability-statement) 9 + +[Array property types](#vector-and-array-property-types) 20 + +[ArrayDimension packet](#arraydimension) 21 + +[ArrayHeader packet](#arrayheader) 22 + +B + +[Bindings - standard](#standard-bindings) 33 + +[BLOB packet](#blob) 18 + +C + +[Change tracking](#change-tracking) 66 + +[ClipboardData packet](#clipboarddata) 18 + +[CodePageString packet](#codepagestring) 16 + +[Common data types and fields](#structures) 11 + +[ControlStream packet](#control-stream) 33 + +[CURRENCY packet](#currency-packet-version) 16 + +D + +[Data types and fields - common](#structures) 11 + +[DATE packet](#date-packet-version) 16 + +[DECIMAL packet](#decimal-packet-version) 17 + +Details + +[common data types and fields](#structures) 11 + +[Dictionary packet](#dictionary) 26 + +[DictionaryEntry packet](#dictionaryentry) 26 + +E + +Examples + +[PropertyBag Property Set](#propertybag-property-set) 48 + +[SummaryInformation Property Set](#summaryinformation-property-set) 37 + +F + +[Fields - vendor-extensible](#vendor-extensible-fields) 10 + +[FILETIME packet](#filetime-packet-version) 17 + +[Formats - property set](#well-known-property-set-formats) 34 + +G + +[Glossary](#glossary) 6 + +[GUID packet](#guid-packet-version) 19 + +I + +[Implementer - security considerations](#security-considerations) 62 + +[Informative references](#informative-references) 8 + +[Introduction](#introduction) 6 + +L + +[Localization](#versioning-and-localization) 9 + +N + +[Normative references](#normative-references) 7 + +O + +[Overview (synopsis)](#overview) 8 + +P + +[Product behavior](#appendix-a-product-behavior) 63 + +[Property set formats - well-known](#well-known-property-set-formats) 34 + +Property types + +[array](#vector-and-array-property-types) 20 + +[vector](#vector-and-array-property-types) 20 + +[PropertyBag property set](#propertybag-property-set) 48 + +[PropertyBag Property Set example](#propertybag-property-set) 48 + +[PropertyIdentifierAndOffset packet](#propertyidentifierandoffset) 28 + +[PropertySet packet](#propertyset) 28 + +[PropertySetStream packet](#propertysetstream) 29 + +R + +[References](#references) 7 + +[informative](#informative-references) 8 + +[normative](#normative-references) 7 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 9 + +S + +[Security](#security-considerations) 62 + +[Security - implementer considerations](#security-considerations) 62 + +[Special properties](#special-properties) 27 + +[Standard bindings](#standard-bindings) 33 + +[Structures](#structures) 11 + +[overview](#structures) 11 + +[SummaryInformation property set](#summaryinformation-property-set) 37 + +[SummaryInformation Property Set example](#summaryinformation-property-set) 37 + +T + +[Tracking changes](#change-tracking) 66 + +[TypedPropertyValue packet](#typedpropertyvalue) 22 + +U + +[UnicodeString packet](#unicodestring) 17 + +V + +[Vector property types](#vector-and-array-property-types) 20 + +[VectorHeader packet](#vectorheader) 21 + +[Vendor-extensible fields](#vendor-extensible-fields) 10 + +[VersionedStream packet](#versionedstream) 19 + +[Versioning](#versioning-and-localization) 9 + +W + +[Well-known property set formats](#well-known-property-set-formats) 34 diff --git a/docs/standards/doc/ms-oshared.md b/docs/standards/doc/ms-oshared.md new file mode 100644 index 0000000..8f2a0d0 --- /dev/null +++ b/docs/standards/doc/ms-oshared.md @@ -0,0 +1,7627 @@ +**\[MS-OSHARED\]:** + +**Office Common Data Types and Objects Structures** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 6/27/2008 | 1.0 | New | Initial Availability | +| 1/16/2009 | 1.01 | Editorial | Revised and edited the technical content | +| 7/13/2009 | 1.02 | Major | Changes made for template compliance | +| 8/28/2009 | 1.03 | Editorial | Revised and edited the technical content | +| 11/6/2009 | 1.04 | Editorial | Revised and edited the technical content | +| 2/19/2010 | 2.0 | Editorial | Revised and edited the technical content | +| 3/31/2010 | 2.01 | Editorial | Revised and edited the technical content | +| 4/30/2010 | 2.02 | Editorial | Revised and edited the technical content | +| 6/7/2010 | 2.03 | Editorial | Revised and edited the technical content | +| 6/29/2010 | 2.04 | Editorial | Changed language and formatting in the technical content. | +| 7/23/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/27/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/15/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/17/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/18/2011 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/10/2011 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/20/2012 | 2.5 | Minor | Clarified the meaning of the technical content. | +| 4/11/2012 | 2.5 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/16/2012 | 2.6 | Minor | Clarified the meaning of the technical content. | +| 10/8/2012 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/11/2013 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/30/2013 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/18/2013 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/10/2014 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/30/2014 | 2.7 | Minor | Clarified the meaning of the technical content. | +| 7/31/2014 | 2.8 | Minor | Clarified the meaning of the technical content. | +| 10/30/2014 | 2.9 | Minor | Clarified the meaning of the technical content. | +| 3/16/2015 | 3.0 | Major | Significantly changed the technical content. | +| 9/4/2015 | 4.0 | Major | Significantly changed the technical content. | +| 7/15/2016 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/14/2016 | 4.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 12/15/2016 | 4.1 | Minor | Clarified the meaning of the technical content. | +| 6/20/2017 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/19/2017 | 4.2 | Minor | Clarified the meaning of the technical content. | +| 12/12/2017 | 4.3 | Minor | Clarified the meaning of the technical content. | +| 4/27/2018 | 5.0 | Major | Significantly changed the technical content. | +| 8/28/2018 | 6.0 | Major | Significantly changed the technical content. | +| 12/11/2018 | 7.0 | Major | Significantly changed the technical content. | +| 3/19/2019 | 7.0 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/19/2020 | 7.1 | Minor | Clarified the meaning of the technical content. | +| 4/22/2021 | 8.0 | Major | Significantly changed the technical content. | +| 8/17/2021 | 9.0 | Major | Significantly changed the technical content. | +| 4/16/2024 | 10.0 | Major | Significantly changed the technical content. | +| 8/20/2024 | 11.0 | Major | Significantly changed the technical content. | +| 11/13/2025 | 11.1 | Minor | Clarified the meaning of the technical content. | + +Table of Contents + +[1 Introduction [9](#introduction)](#introduction) + +[1.1 Glossary [9](#glossary)](#glossary) + +[1.2 References [15](#references)](#references) + +[1.2.1 Normative References [15](#normative-references)](#normative-references) + +[1.2.2 Informative References [17](#informative-references)](#informative-references) + +[1.3 Structure Overview (Synopsis) [17](#structure-overview-synopsis)](#structure-overview-synopsis) + +[1.3.1 Toolbar Customization [17](#toolbar-customization)](#toolbar-customization) + +[1.3.2 Property Set Storage [19](#_Toc213739256)](#_Toc213739256) + +[1.3.3 RefEdit Control [20](#_Toc213739257)](#_Toc213739257) + +[1.3.4 Visual Basic for Applications Digital Signature [20](#_Toc213739258)](#_Toc213739258) + +[1.3.5 Byte Ordering [22](#_Toc213739259)](#_Toc213739259) + +[1.4 Relationship to Protocols and Other Structures [22](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.4.1 Toolbar Customization [22](#_Toc213739261)](#_Toc213739261) + +[1.4.2 Property Set Storage [23](#ms-ctdoc-for-the-persistence-format-for-word-processing-documents.ms-ctxls-for-the-persistence-format-for-spreadsheet-toolbar-customization-structures-defined-in-this-document.-property-set-storage)](#ms-ctdoc-for-the-persistence-format-for-word-processing-documents.ms-ctxls-for-the-persistence-format-for-spreadsheet-toolbar-customization-structures-defined-in-this-document.-property-set-storage) + +[1.4.3 Visual Basic for Applications Digital Signature [23](#_Toc213739263)](#_Toc213739263) + +[1.5 Applicability Statement [23](#_Toc213739264)](#_Toc213739264) + +[1.5.1 Toolbar Customization [23](#_Toc213739265)](#_Toc213739265) + +[1.5.2 Property Set Storage [23](#_Toc213739266)](#_Toc213739266) + +[1.5.3 Visual Basic for Applications Digital Signature [23](#_Toc213739267)](#_Toc213739267) + +[1.6 Versioning and Localization [23](#versioning-and-localization)](#versioning-and-localization) + +[1.6.1 Toolbar Customization [23](#_Toc213739269)](#_Toc213739269) + +[1.6.2 Property Set Storage [24](#structure-versions-there-is-only-one-version-of-the-toolbar-customization-structures-section-2.3.1.localization-the-toolbar-customization-structures-define-no-locale-specific-processes-or-data.property-set-storage)](#structure-versions-there-is-only-one-version-of-the-toolbar-customization-structures-section-2.3.1.localization-the-toolbar-customization-structures-define-no-locale-specific-processes-or-data.property-set-storage) + +[1.6.3 Visual Basic for Applications Digital Signature [24](#structure-versions-there-is-only-one-version-of-the-property-sets-defined-in-property-set-storage-section-2.3.3.localization-the-encoding-of-strings-contained-in-the-lpstr-section-2.3.3.1.4-data-type-and-the-unalignedlpstr-section-2.3.3.1.5-data-type-depend-on-the-property-sets-codepage-property-described-in-ms-oleps-section-2.18.2.visual-basic-for-applications-digital-signature)](#structure-versions-there-is-only-one-version-of-the-property-sets-defined-in-property-set-storage-section-2.3.3.localization-the-encoding-of-strings-contained-in-the-lpstr-section-2.3.3.1.4-data-type-and-the-unalignedlpstr-section-2.3.3.1.5-data-type-depend-on-the-property-sets-codepage-property-described-in-ms-oleps-section-2.18.2.visual-basic-for-applications-digital-signature) + +[1.7 Vendor-Extensible Fields [24](#structure-versions-there-is-only-one-version-of-the-vba-digital-signature-defined-in-visual-basic-for-applications-digital-signature-storage-section-2.3.2.localization-the-vba-digital-signature-structures-define-no-locale-specific-processes-or-data.vendor-extensible-fields)](#structure-versions-there-is-only-one-version-of-the-vba-digital-signature-defined-in-visual-basic-for-applications-digital-signature-storage-section-2.3.2.localization-the-vba-digital-signature-structures-define-no-locale-specific-processes-or-data.vendor-extensible-fields) + +[1.7.1 Toolbar Customization [24](#_Toc213739273)](#_Toc213739273) + +[1.7.2 Property Set Storage [24](#_Toc213739274)](#_Toc213739274) + +[1.7.3 Visual Basic for Applications Digital Signature [24](#_Toc213739275)](#_Toc213739275) + +[2 Structures [25](#structures)](#structures) + +[2.1 Common ABNF Definitions [25](#_Toc213739277)](#_Toc213739277) + +[2.2 Data Types [27](#data-types)](#data-types) + +[2.2.1 Common Data Types [27](#common-data-types)](#common-data-types) + +[2.2.1.1 ObjectUpdateEnum [27](#_Toc213739280)](#_Toc213739280) + +[2.2.1.2 DataViewAspectEnum [27](#_Toc213739281)](#_Toc213739281) + +[2.2.1.3 MSONFC [27](#_Toc213739282)](#_Toc213739282) + +[2.2.1.4 WebScreenSizeEnum [29](#_Toc213739283)](#_Toc213739283) + +[2.2.1.5 FilePointer [30](#_Toc213739284)](#_Toc213739284) + +[2.2.1.6 FixedPoint [30](#_Toc213739285)](#_Toc213739285) + +[2.3 Common Objects [30](#common-objects)](#common-objects) + +[2.3.1 Toolbar Customization [30](#_Toc213739287)](#_Toc213739287) + +[2.3.1.1 TBCBitmap [30](#_Toc213739288)](#_Toc213739288) + +[2.3.1.2 BITMAPINFOHEADER [31](#_Toc213739289)](#_Toc213739289) + +[2.3.1.3 RGBQuad [32](#_Toc213739290)](#_Toc213739290) + +[2.3.1.4 WString [33](#_Toc213739291)](#_Toc213739291) + +[2.3.1.5 SRECT [33](#_Toc213739292)](#_Toc213739292) + +[2.3.1.6 TB [34](#_Toc213739293)](#_Toc213739293) + +[2.3.1.7 TBTRFlags [34](#_Toc213739294)](#_Toc213739294) + +[2.3.1.8 TBFlags [36](#_Toc213739295)](#_Toc213739295) + +[2.3.1.9 TBVisualData [36](#_Toc213739296)](#_Toc213739296) + +[2.3.1.10 TBCHeader [39](#_Toc213739297)](#_Toc213739297) + +[2.3.1.11 TBCFlags [40](#_Toc213739298)](#_Toc213739298) + +[2.3.1.12 TBCSFlags [40](#_Toc213739299)](#_Toc213739299) + +[2.3.1.13 TBCData [43](#_Toc213739300)](#_Toc213739300) + +[2.3.1.14 TBCGeneralInfo [44](#_Toc213739301)](#_Toc213739301) + +[2.3.1.15 TBCGIFlags [44](#_Toc213739302)](#_Toc213739302) + +[2.3.1.16 TBCExtraInfo [45](#_Toc213739303)](#_Toc213739303) + +[2.3.1.17 TBCBSpecific [46](#_Toc213739304)](#_Toc213739304) + +[2.3.1.18 TBCBSFlags [47](#_Toc213739305)](#_Toc213739305) + +[2.3.1.19 TBCComboDropdownSpecific [48](#_Toc213739306)](#_Toc213739306) + +[2.3.1.20 TBCCDData [49](#_Toc213739307)](#_Toc213739307) + +[2.3.1.21 TBCMenuSpecific [49](#_Toc213739308)](#_Toc213739308) + +[2.3.2 Visual Basic for Applications Digital Signature Storage [50](#_Toc213739309)](#_Toc213739309) + +[2.3.2.1 DigSigInfoSerialized [50](#_Toc213739310)](#_Toc213739310) + +[2.3.2.2 DigSigBlob [52](#_Toc213739311)](#_Toc213739311) + +[2.3.2.3 WordSigBlob [52](#_Toc213739312)](#_Toc213739312) + +[2.3.2.4 VBA Digital Signature [53](#_Toc213739313)](#_Toc213739313) + +[2.3.2.4.1 SignedData Constraints [53](#_Toc213739314)](#_Toc213739314) + +[2.3.2.4.2 SignerInfo Constraints [53](#the-digestalgorithms-field-must-contain-only-one-digestalgorithmidentifier-pkcs7-section-6.3-and-that-digestalgorithmidentifier-must-specify-the-identifier-of-the-algorithm-used-to-create-the-digest-of-the-signature.10the-contentinfo-fields-contenttype-must-be-an-object-identifier-itux680-with-the-value-1.3.6.1.4.1.311.2.1.4.-the-content-field-of-the-contentinfo-of-this-signeddata-structure-must-be-a-spcindirectdatacontent-structure-section-2.3.2.4.3.1.the-certificates-field-must-contain-certificates-as-specified-by-pkcs7-section-9.1.-this-must-include-the-signature-verification-certificate-and-can-contain-any-intermediate-certificates-between-that-end-entity-and-the-root-including-the-root.-if-the-signeddata-contains-a-countersignature-pkcs9-section-6.6-the-certificates-associated-with-the-countersignature-also-must-be-contained-in-the-certificates-field.the-crls-field-should-be-absent.-if-present-the-crls-field-must-be-ignored.the-signerinfos-field-must-contain-a-single-signerinfo-structure-section-2.3.2.4.2-pkcs7-section-9.2.signerinfo-constraints)](#the-digestalgorithms-field-must-contain-only-one-digestalgorithmidentifier-pkcs7-section-6.3-and-that-digestalgorithmidentifier-must-specify-the-identifier-of-the-algorithm-used-to-create-the-digest-of-the-signature.10the-contentinfo-fields-contenttype-must-be-an-object-identifier-itux680-with-the-value-1.3.6.1.4.1.311.2.1.4.-the-content-field-of-the-contentinfo-of-this-signeddata-structure-must-be-a-spcindirectdatacontent-structure-section-2.3.2.4.3.1.the-certificates-field-must-contain-certificates-as-specified-by-pkcs7-section-9.1.-this-must-include-the-signature-verification-certificate-and-can-contain-any-intermediate-certificates-between-that-end-entity-and-the-root-including-the-root.-if-the-signeddata-contains-a-countersignature-pkcs9-section-6.6-the-certificates-associated-with-the-countersignature-also-must-be-contained-in-the-certificates-field.the-crls-field-should-be-absent.-if-present-the-crls-field-must-be-ignored.the-signerinfos-field-must-contain-a-single-signerinfo-structure-section-2.3.2.4.2-pkcs7-section-9.2.signerinfo-constraints) + +[2.3.2.4.3 SignedData contentInfo Structures [54](#the-authenticatedattributes-section-2.3.2.4.4-field-must-be-present.this-field-must-contain-the-following-attributesa-content-type-attribute-with-its-value-set-as-specified-in-pkcs7-section-9.2.a-message-digest-attribute-with-its-value-set-as-specified-in-pkcs7-section-9.2.this-field-can-also-containone-spcstatementtype-attribute-section-2.3.2.4.4.1-but-this-attribute-must-be-ignored.one-spcspopusinfo-attribute-section-2.3.2.4.4.2.if-the-signature-has-been-timestamped-then-the-unauthenticatedattributes-field-section-2.3.2.4.5-must-be-present-and-must-contain-a-single-countersignature-attribute-pkcs9-section-6.6.-if-the-signature-has-not-been-timestamped-the-unauthenticatedattributes-field-must-be-absent.signeddata-contentinfo-structures)](#the-authenticatedattributes-section-2.3.2.4.4-field-must-be-present.this-field-must-contain-the-following-attributesa-content-type-attribute-with-its-value-set-as-specified-in-pkcs7-section-9.2.a-message-digest-attribute-with-its-value-set-as-specified-in-pkcs7-section-9.2.this-field-can-also-containone-spcstatementtype-attribute-section-2.3.2.4.4.1-but-this-attribute-must-be-ignored.one-spcspopusinfo-attribute-section-2.3.2.4.4.2.if-the-signature-has-been-timestamped-then-the-unauthenticatedattributes-field-section-2.3.2.4.5-must-be-present-and-must-contain-a-single-countersignature-attribute-pkcs9-section-6.6.-if-the-signature-has-not-been-timestamped-the-unauthenticatedattributes-field-must-be-absent.signeddata-contentinfo-structures) + +[2.3.2.4.3.1 SpcIndirectDataContent [54](#_Toc213739317)](#_Toc213739317) + +[2.3.2.4.3.2 SpcIndirectDataContentV2 [55](#the-digestalgorithm-field-must-be-an-algorithmidentifier-structure.-the-algorithm-field-of-digestalgorithm-specifies-the-object-identifier-itux680-of-the-digest-algorithm-that-was-used-to-hash-the-vba-project-contents-producing-the-value-for-the-digest-field.-this-object-identifier-itux680-value-must-be-set-to-the-same-algorithm-identifier-as-specified-in-the-digestalgorithm-field-of-the-signeddata-structure-section-2.3.2.4.1.-the-parameters-field-of-digestalgorithm-must-be-set-to-the-null-type-itux680-with-a-length-of-zero.the-digest-field-must-be-an-octetstring-itux680.-the-value-of-the-octetstring-must-be-produced-by-means-of-the-hash-algorithm-specified-in-ms-ovba-section-2.4.2.spcindirectdatacontentv2)](#the-digestalgorithm-field-must-be-an-algorithmidentifier-structure.-the-algorithm-field-of-digestalgorithm-specifies-the-object-identifier-itux680-of-the-digest-algorithm-that-was-used-to-hash-the-vba-project-contents-producing-the-value-for-the-digest-field.-this-object-identifier-itux680-value-must-be-set-to-the-same-algorithm-identifier-as-specified-in-the-digestalgorithm-field-of-the-signeddata-structure-section-2.3.2.4.1.-the-parameters-field-of-digestalgorithm-must-be-set-to-the-null-type-itux680-with-a-length-of-zero.the-digest-field-must-be-an-octetstring-itux680.-the-value-of-the-octetstring-must-be-produced-by-means-of-the-hash-algorithm-specified-in-ms-ovba-section-2.4.2.spcindirectdatacontentv2) + +[2.3.2.4.4 SignerInfo authenticatedAttributes Structures [56](#the-algorithmidsize-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-size-of-the-algorithmid-field.the-compiledhashsize-field-should-be-zero.the-sourcehashsize-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-size-of-the-sourcehash-field.the-algorithmidoffset-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-position-in-bytes-of-the-algorithmid-field-from-the-beginning-of-the-structure.the-compiledhashoffset-field-should-be-zero.the-sourcehashoffset-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-position-in-bytes-of-the-sourcehash-field-from-the-beginning-of-the-structure.the-algorithmid-field-specifies-the-object-identifier-itux680-of-the-digest-algorithm-that-was-used-to-hash-the-vba-project-contents-producing-the-value-for-the-digest-field.-this-object-identifier-itux680-value-must-be-set-to-the-same-algorithm-identifier-as-specified-in-the-digestalgorithm-field-of-the-signeddata-structure.the-compiledhash-field-should-be-empty.the-sourcehash-field-must-be-an-octetstring-itux680.-the-value-of-the-octetstring-must-be-produced-by-means-of-the-hash-algorithm-specified-in-ms-ovba-section-2.4.2.signerinfo-authenticatedattributes-structures)](#the-algorithmidsize-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-size-of-the-algorithmid-field.the-compiledhashsize-field-should-be-zero.the-sourcehashsize-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-size-of-the-sourcehash-field.the-algorithmidoffset-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-position-in-bytes-of-the-algorithmid-field-from-the-beginning-of-the-structure.the-compiledhashoffset-field-should-be-zero.the-sourcehashoffset-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-position-in-bytes-of-the-sourcehash-field-from-the-beginning-of-the-structure.the-algorithmid-field-specifies-the-object-identifier-itux680-of-the-digest-algorithm-that-was-used-to-hash-the-vba-project-contents-producing-the-value-for-the-digest-field.-this-object-identifier-itux680-value-must-be-set-to-the-same-algorithm-identifier-as-specified-in-the-digestalgorithm-field-of-the-signeddata-structure.the-compiledhash-field-should-be-empty.the-sourcehash-field-must-be-an-octetstring-itux680.-the-value-of-the-octetstring-must-be-produced-by-means-of-the-hash-algorithm-specified-in-ms-ovba-section-2.4.2.signerinfo-authenticatedattributes-structures) + +[2.3.2.4.4.1 SpcStatementType [57](#_Toc213739320)](#_Toc213739320) + +[2.3.2.4.4.2 SpcSpOpusInfo [57](#_Toc213739321)](#_Toc213739321) + +[2.3.2.4.4.3 SpcString [57](#_Toc213739322)](#_Toc213739322) + +[2.3.2.4.4.4 SpcLink [57](#_Toc213739323)](#_Toc213739323) + +[2.3.2.4.5 SignerInfo unauthenticatedAttributes [57](#_Toc213739324)](#_Toc213739324) + +[2.3.2.4.6 VBA Digital Signature Verification [58](#_Toc213739325)](#_Toc213739325) + +[2.3.2.4.6.1 Certificate Processing [58](#_Toc213739326)](#_Toc213739326) + +[2.3.2.4.6.2 Timestamp Processing [58](#_Toc213739327)](#_Toc213739327) + +[2.3.2.5 Serialized Certificate Store Structure [58](#the-certificate-chain-for-the-countersignature-must-be-built-according-to-a-trusted-root-certificate-by-using-x.509-path-validation-rules-as-specified-by-rfc3280-section-6.the-time-stamp-authority-tsa-certificate-that-was-used-to-sign-the-timestamp-must-contain-the-eku-value-for-timestamping-1.3.6.1.5.5.7.3.8.serialized-certificate-store-structure)](#the-certificate-chain-for-the-countersignature-must-be-built-according-to-a-trusted-root-certificate-by-using-x.509-path-validation-rules-as-specified-by-rfc3280-section-6.the-time-stamp-authority-tsa-certificate-that-was-used-to-sign-the-timestamp-must-contain-the-eku-value-for-timestamping-1.3.6.1.5.5.7.3.8.serialized-certificate-store-structure) + +[2.3.2.5.1 SerializedCertificateEntry [58](#_Toc213739329)](#_Toc213739329) + +[2.3.2.5.2 EndElementMarkerEntry [59](#_Toc213739330)](#_Toc213739330) + +[2.3.2.5.3 SerializedPropertyEntry [59](#_Toc213739331)](#_Toc213739331) + +[2.3.2.5.4 CertStoreCertificateGroup [60](#_Toc213739332)](#_Toc213739332) + +[2.3.2.5.5 VBASigSerializedCertStore [60](#_Toc213739333)](#_Toc213739333) + +[2.3.3 Property Set Storage [61](#_Toc213739334)](#_Toc213739334) + +[2.3.3.1 Property Types [61](#_Toc213739335)](#_Toc213739335) + +[2.3.3.1.1 PropertySetSystemIdentifier [61](#_Toc213739336)](#_Toc213739336) + +[2.3.3.1.2 VtThumbnailValue [62](#_Toc213739337)](#_Toc213739337) + +[2.3.3.1.3 VtThumbnail [63](#_Toc213739338)](#_Toc213739338) + +[2.3.3.1.4 Lpstr [63](#_Toc213739339)](#_Toc213739339) + +[2.3.3.1.5 UnalignedLpstr [64](#_Toc213739340)](#_Toc213739340) + +[2.3.3.1.6 Lpwstr [64](#_Toc213739341)](#_Toc213739341) + +[2.3.3.1.7 VtVecLpwstrValue [65](#_Toc213739342)](#_Toc213739342) + +[2.3.3.1.8 VtVecLpwstr [65](#_Toc213739343)](#_Toc213739343) + +[2.3.3.1.9 VtVecUnalignedLpstrValue [65](#_Toc213739344)](#_Toc213739344) + +[2.3.3.1.10 VtVecUnalignedLpstr [66](#_Toc213739345)](#_Toc213739345) + +[2.3.3.1.11 VtString [66](#_Toc213739346)](#_Toc213739346) + +[2.3.3.1.12 VtUnalignedString [67](#_Toc213739347)](#_Toc213739347) + +[2.3.3.1.13 VtHeadingPair [67](#_Toc213739348)](#_Toc213739348) + +[2.3.3.1.14 VtVecHeadingPairValue [68](#_Toc213739349)](#_Toc213739349) + +[2.3.3.1.15 VtVecHeadingPair [68](#_Toc213739350)](#_Toc213739350) + +[2.3.3.1.16 VtDigSigValue [69](#_Toc213739351)](#_Toc213739351) + +[2.3.3.1.17 VtDigSig [69](#_Toc213739352)](#_Toc213739352) + +[2.3.3.1.18 VtHyperlink [69](#_Toc213739353)](#_Toc213739353) + +[2.3.3.1.19 VecVtHyperlink [71](#_Toc213739354)](#_Toc213739354) + +[2.3.3.1.20 VtHyperlinkValue [71](#_Toc213739355)](#_Toc213739355) + +[2.3.3.1.21 VtHyperlinks [71](#_Toc213739356)](#_Toc213739356) + +[2.3.3.2 OLE Property Sets [72](#_Toc213739357)](#_Toc213739357) + +[2.3.3.2.1 Summary Information Property Set [72](#_Toc213739358)](#_Toc213739358) + +[2.3.3.2.1.1 PIDSI [72](#_Toc213739359)](#_Toc213739359) + +[2.3.3.2.2 Document Summary Information Property Set [74](#_Toc213739360)](#_Toc213739360) + +[2.3.3.2.2.1 PIDDSI [75](#_Toc213739361)](#_Toc213739361) + +[2.3.3.2.3 User Defined Property Set [78](#_Toc213739362)](#_Toc213739362) + +[2.3.3.2.3.1 User Defined Property Set Constraints [79](#_Toc213739363)](#_Toc213739363) + +[2.3.3.2.3.1.1 Required Properties [79](#_Toc213739364)](#_Toc213739364) + +[2.3.3.2.3.1.2 Supported Types [79](#_Toc213739365)](#_Toc213739365) + +[2.3.3.2.3.2 Reserved Properties [79](#vtstring-section-2.3.3.1.11typedpropertyvalue-ms-oleps-section-2.15-the-type-of-which-must-be-one-of-the-following-typesvt_i4-0x0003vt_r8-0x0005vt_bool-0x000bvt_filetime-0x0040vt_blob-0x0041reserved-properties)](#vtstring-section-2.3.3.1.11typedpropertyvalue-ms-oleps-section-2.15-the-type-of-which-must-be-one-of-the-following-typesvt_i4-0x0003vt_r8-0x0005vt_bool-0x000bvt_filetime-0x0040vt_blob-0x0041reserved-properties) + +[2.3.3.2.3.3 Linked Properties [85](#_Toc213739367)](#_Toc213739367) + +[2.3.4 SmartTag Objects [85](#_Toc213739368)](#_Toc213739368) + +[2.3.4.1 PropertyBagStore [85](#_Toc213739369)](#_Toc213739369) + +[2.3.4.2 FactoidType [86](#_Toc213739370)](#_Toc213739370) + +[2.3.4.3 PropertyBag [87](#_Toc213739371)](#_Toc213739371) + +[2.3.4.4 Property [87](#_Toc213739372)](#_Toc213739372) + +[2.3.4.5 PBString [88](#_Toc213739373)](#_Toc213739373) + +[2.3.5 RefEdit Control [88](#_Toc213739374)](#_Toc213739374) + +[2.3.6 Custom XML Data Storage [88](#_Toc213739375)](#_Toc213739375) + +[2.3.6.1 Custom XML Data Storage Item [88](#_Toc213739376)](#_Toc213739376) + +[2.3.6.1.1 Custom Property Editor [89](#_Toc213739377)](#_Toc213739377) + +[2.3.6.1.1.1 XMLNamespace [89](#_Toc213739378)](#_Toc213739378) + +[2.3.6.1.1.2 XSNLocation [89](#_Toc213739379)](#_Toc213739379) + +[2.3.6.1.1.3 showOnOpen [89](#_Toc213739380)](#_Toc213739380) + +[2.3.6.1.1.4 defaultPropertyEditorNamespace [90](#_Toc213739381)](#_Toc213739381) + +[2.3.6.1.1.5 customPropertyEditor [90](#_Toc213739382)](#_Toc213739382) + +[2.3.6.1.1.6 customPropertyEditors [90](#_Toc213739383)](#_Toc213739383) + +[2.3.6.1.2 Custom Xsn [91](#_Toc213739384)](#_Toc213739384) + +[2.3.6.1.2.1 ST_TrueFalse [91](#_Toc213739385)](#_Toc213739385) + +[2.3.6.1.2.2 xsnLocation [91](#_Toc213739386)](#_Toc213739386) + +[2.3.6.1.2.3 cached [91](#_Toc213739387)](#_Toc213739387) + +[2.3.6.1.2.4 openByDefault [91](#_Toc213739388)](#_Toc213739388) + +[2.3.6.1.2.5 xsnScope [92](#_Toc213739389)](#_Toc213739389) + +[2.3.6.1.2.6 customXsn [92](#_Toc213739390)](#_Toc213739390) + +[2.3.6.1.3 Schema for Content Type [92](#_Toc213739391)](#_Toc213739391) + +[2.3.6.1.3.1 ContentTypeId [92](#_Toc213739392)](#_Toc213739392) + +[2.3.6.1.3.2 IntNonNegative [93](#_Toc213739393)](#_Toc213739393) + +[2.3.6.1.3.3 UniqueIdentifierWithoutBraces [93](#_Toc213739394)](#_Toc213739394) + +[2.3.6.1.3.4 UniqueIdentifierWithoutBracesOrEmpty [93](#_Toc213739395)](#_Toc213739395) + +[2.3.6.1.3.5 DummyContentTypeElement [93](#_Toc213739396)](#_Toc213739396) + +[2.3.6.1.3.6 schema [98](#_Toc213739397)](#_Toc213739397) + +[2.3.6.1.3.7 contentTypeSchema [98](#_Toc213739398)](#_Toc213739398) + +[2.3.6.1.4 Cover Page Properties [101](#_Toc213739399)](#_Toc213739399) + +[2.3.6.1.4.1 ST_PublishDate [101](#_Toc213739400)](#_Toc213739400) + +[2.3.6.1.4.2 PublishDate [101](#_Toc213739401)](#_Toc213739401) + +[2.3.6.1.4.3 Abstract [101](#_Toc213739402)](#_Toc213739402) + +[2.3.6.1.4.4 CompanyAddress [101](#_Toc213739403)](#_Toc213739403) + +[2.3.6.1.4.5 CompanyPhone [101](#_Toc213739404)](#_Toc213739404) + +[2.3.6.1.4.6 CompanyFax [101](#_Toc213739405)](#_Toc213739405) + +[2.3.6.1.4.7 CompanyEmail [101](#_Toc213739406)](#_Toc213739406) + +[2.3.6.1.4.8 CoverPageProperties [102](#_Toc213739407)](#_Toc213739407) + +[2.3.6.1.5 Long Properties [102](#_Toc213739408)](#_Toc213739408) + +[2.3.6.1.5.1 LongProp [102](#_Toc213739409)](#_Toc213739409) + +[2.3.6.1.5.2 LongProperties [102](#_Toc213739410)](#_Toc213739410) + +[2.3.6.2 Custom XML Data Storage Properties [103](#_Toc213739411)](#_Toc213739411) + +[2.3.6.2.1 ST_Guid [103](#_Toc213739412)](#_Toc213739412) + +[2.3.6.2.2 schemaRef [103](#_Toc213739413)](#_Toc213739413) + +[2.3.6.2.3 schemaRefs [103](#_Toc213739414)](#_Toc213739414) + +[2.3.6.2.4 dataStoreItem [104](#_Toc213739415)](#_Toc213739415) + +[2.3.7 Hyperlinks [104](#_Toc213739416)](#_Toc213739416) + +[2.3.7.1 Hyperlink Object [104](#_Toc213739417)](#_Toc213739417) + +[2.3.7.2 HyperlinkMoniker [106](#_Toc213739418)](#_Toc213739418) + +[2.3.7.3 CompositeMoniker [107](#_Toc213739419)](#_Toc213739419) + +[2.3.7.4 AntiMoniker [107](#_Toc213739420)](#_Toc213739420) + +[2.3.7.5 ItemMoniker [107](#_Toc213739421)](#_Toc213739421) + +[2.3.7.6 URLMoniker [109](#_Toc213739422)](#_Toc213739422) + +[2.3.7.7 URICreateFlags [109](#_Toc213739423)](#_Toc213739423) + +[2.3.7.8 FileMoniker [111](#_Toc213739424)](#_Toc213739424) + +[2.3.7.9 HyperlinkString [112](#_Toc213739425)](#_Toc213739425) + +[2.3.8 MsoEnvelope [113](#_Toc213739426)](#_Toc213739426) + +[2.3.8.1 MsoEnvelopeCLSID [113](#_Toc213739427)](#_Toc213739427) + +[2.3.8.2 MsoEnvelope [113](#_Toc213739428)](#_Toc213739428) + +[2.3.8.3 EnvRecipientCollection [117](#_Toc213739429)](#_Toc213739429) + +[2.3.8.4 EnvRecipientProperties [117](#_Toc213739430)](#_Toc213739430) + +[2.3.8.5 EnvRecipientProperty [118](#_Toc213739431)](#_Toc213739431) + +[2.3.8.6 EnvRecipientPropertyBlob [118](#_Toc213739432)](#_Toc213739432) + +[2.3.8.7 PT_LONG [119](#_Toc213739433)](#_Toc213739433) + +[2.3.8.8 PT_NULL [119](#_Toc213739434)](#_Toc213739434) + +[2.3.8.9 PT_BOOLEAN [119](#_Toc213739435)](#_Toc213739435) + +[2.3.8.10 PT_SYSTIME [120](#_Toc213739436)](#_Toc213739436) + +[2.3.8.11 PT_ERROR [120](#_Toc213739437)](#_Toc213739437) + +[2.3.8.12 PT_STRING8 [120](#_Toc213739438)](#_Toc213739438) + +[2.3.8.13 PT_UNICODE [120](#_Toc213739439)](#_Toc213739439) + +[2.3.8.14 PT_BINARY [121](#_Toc213739440)](#_Toc213739440) + +[2.3.8.15 PT_MV_STRING8 [121](#_Toc213739441)](#_Toc213739441) + +[2.3.8.16 PT_MV_BINARY [122](#_Toc213739442)](#_Toc213739442) + +[2.3.8.17 EnvAttachmentCollection [122](#_Toc213739443)](#_Toc213739443) + +[2.3.8.18 EnvAttachment [122](#_Toc213739444)](#_Toc213739444) + +[2.3.8.19 IntroText [123](#_Toc213739445)](#_Toc213739445) + +[2.3.9 Document Signature Serialized Certificate Store Structure [124](#_Toc213739446)](#_Toc213739446) + +[2.3.9.1 DocSigSerializedCertStore [124](#_Toc213739447)](#_Toc213739447) + +[2.4 Common Algorithms [124](#common-algorithms)](#common-algorithms) + +[2.4.1 Unicode String to Unsigned Integer Hash [124](#_Toc213739449)](#_Toc213739449) + +[2.4.2 Hyperlink Hash [125](#the-result-of-the-algorithm-is-the-value-dwhash.hyperlink-hash)](#the-result-of-the-algorithm-is-the-value-dwhash.hyperlink-hash) + +[2.4.3 MsoCrc32Compute [125](#_Toc213739451)](#_Toc213739451) + +[2.4.3.1 Caching Algorithm [125](#_Toc213739452)](#_Toc213739452) + +[2.4.3.2 CRC Computation [126](#_Toc213739453)](#_Toc213739453) + +[2.4.4 Date/Time Format from Format Index [126](#_Toc213739454)](#_Toc213739454) + +[2.4.4.1 Format Indices [126](#_Toc213739455)](#_Toc213739455) + +[2.4.4.2 Base Format Strings [127](#_Toc213739456)](#_Toc213739456) + +[2.4.4.3 Retrieve Format [127](#_Toc213739457)](#_Toc213739457) + +[2.4.4.3.1 Chinese Formats [127](#_Toc213739458)](#_Toc213739458) + +[2.4.4.3.2 Hindi Formats [128](#_Toc213739459)](#_Toc213739459) + +[2.4.4.3.3 Japanese Formats [128](#_Toc213739460)](#_Toc213739460) + +[2.4.4.3.4 Korean Formats [129](#_Toc213739461)](#_Toc213739461) + +[2.4.4.3.5 Taiwanese Formats [129](#_Toc213739462)](#_Toc213739462) + +[2.4.4.3.6 Thai Formats [130](#_Toc213739463)](#_Toc213739463) + +[2.4.4.3.7 Yi Formats [130](#_Toc213739464)](#_Toc213739464) + +[2.4.4.3.8 Formats for all other Locales [131](#_Toc213739465)](#_Toc213739465) + +[2.4.4.4 Apply Format Exceptions [132](#_Toc213739466)](#_Toc213739466) + +[2.4.4.4.1 Bokmål (Norwegian) [132](#_Toc213739467)](#_Toc213739467) + +[2.4.4.4.2 Czech [132](#_Toc213739468)](#_Toc213739468) + +[2.4.4.4.3 Danish [132](#_Toc213739469)](#_Toc213739469) + +[2.4.4.4.4 Dutch [133](#_Toc213739470)](#_Toc213739470) + +[2.4.4.4.5 Finnish [133](#_Toc213739471)](#_Toc213739471) + +[2.4.4.4.6 French Canadian [133](#_Toc213739472)](#_Toc213739472) + +[2.4.4.4.7 German [133](#_Toc213739473)](#_Toc213739473) + +[2.4.4.4.8 Hungarian [133](#_Toc213739474)](#_Toc213739474) + +[2.4.4.4.9 Italian [133](#_Toc213739475)](#_Toc213739475) + +[2.4.4.4.10 Japanese [133](#_Toc213739476)](#_Toc213739476) + +[2.4.4.4.11 Kazakh [133](#_Toc213739477)](#_Toc213739477) + +[2.4.4.4.12 Khmer [134](#_Toc213739478)](#_Toc213739478) + +[2.4.4.4.13 Korean [134](#_Toc213739479)](#_Toc213739479) + +[2.4.4.4.14 Lao [134](#_Toc213739480)](#_Toc213739480) + +[2.4.4.4.15 Lithuanian [134](#_Toc213739481)](#_Toc213739481) + +[2.4.4.4.16 Polish [134](#_Toc213739482)](#_Toc213739482) + +[2.4.4.4.17 Portuguese [134](#_Toc213739483)](#_Toc213739483) + +[2.4.4.4.18 Russian [134](#_Toc213739484)](#_Toc213739484) + +[2.4.4.4.19 Spanish [134](#_Toc213739485)](#_Toc213739485) + +[2.4.4.4.20 Swedish [134](#_Toc213739486)](#_Toc213739486) + +[2.4.4.4.21 Tibetan [135](#_Toc213739487)](#_Toc213739487) + +[2.4.4.4.22 Uzbek Cyrillic [135](#_Toc213739488)](#_Toc213739488) + +[2.4.4.4.23 Vietnamese [135](#_Toc213739489)](#_Toc213739489) + +[2.4.4.4.24 Bhutanese [135](#_Toc213739490)](#_Toc213739490) + +[3 Structure Examples [136](#structure-examples)](#structure-examples) + +[3.1 Toolbar Customization Examples [136](#_Toc213739492)](#_Toc213739492) + +[3.1.1 Toolbar Control Example [136](#_Toc213739493)](#_Toc213739493) + +[3.1.2 Toolbar Delta Example [141](#_Toc213739494)](#_Toc213739494) + +[3.2 Document Summary Information Examples [143](#_Toc213739495)](#_Toc213739495) + +[3.2.1 Document Summary Information Stream Overview [145](#_Toc213739496)](#_Toc213739496) + +[3.2.2 Document Summary Information Property Set Overview [147](#_Toc213739497)](#_Toc213739497) + +[3.2.2.1 CodePage Property Example [150](#_Toc213739498)](#_Toc213739498) + +[3.2.2.2 Category Property Example [151](#_Toc213739499)](#_Toc213739499) + +[3.2.2.3 LineCount Property Example [151](#_Toc213739500)](#_Toc213739500) + +[3.2.2.4 LinksDirty Property Example [152](#_Toc213739501)](#_Toc213739501) + +[3.2.2.5 DocumentParts Property Example [152](#_Toc213739502)](#_Toc213739502) + +[3.2.2.6 HeadingPairs Property Example [155](#_Toc213739503)](#_Toc213739503) + +[3.2.3 User Defined Property Set Overview [157](#_Toc213739504)](#_Toc213739504) + +[3.2.3.1 Dictionary Property Example [160](#dictionary-property-example)](#dictionary-property-example) + +[3.2.3.2 LinkBase Property Example [163](#linkbase-property-example)](#linkbase-property-example) + +[3.2.3.3 Hyperlinks Property Example [163](#_Toc213739507)](#_Toc213739507) + +[3.2.3.3.1 LinkElement-1 Example [164](#_Toc213739508)](#_Toc213739508) + +[3.2.3.3.2 LinkElement-2 Example [166](#_Toc213739509)](#_Toc213739509) + +[3.2.3.3.3 LinkElement-3 Example [168](#_Toc213739510)](#_Toc213739510) + +[3.2.3.3.4 LinkElement-4 Example [169](#_Toc213739511)](#_Toc213739511) + +[3.2.3.3.5 LinkElement-5 Example [171](#_Toc213739512)](#_Toc213739512) + +[3.2.3.3.6 LinkElement-6 Example [173](#_Toc213739513)](#_Toc213739513) + +[3.2.3.4 Linked Property Example [174](#linked-property-example)](#linked-property-example) + +[3.3 SmartTag Examples [175](#_Toc213739515)](#_Toc213739515) + +[3.4 Visual Basic for Applications Digital Signature Example Structures [181](#_Toc213739516)](#_Toc213739516) + +[4 Security Considerations [185](#security-considerations)](#security-considerations) + +[4.1 Toolbar Customization [185](#_Toc213739518)](#_Toc213739518) + +[4.2 Property Set Storage [185](#_Toc213739519)](#_Toc213739519) + +[4.3 Visual Basic for Applications Digital Signature [185](#_Toc213739520)](#_Toc213739520) + +[5 Appendix A: Product Behavior [186](#_Toc213739521)](#_Toc213739521) + +[6 Change Tracking [195](#_Toc213739522)](#_Toc213739522) + +[7 Index [196](#index)](#index) + +# Introduction + +The Office Common Data Types and Objects Structures provide a collection of common data types, objects, and algorithms used by various Office application binary file formats. While the structure of the persistence of the data types and objects is specified in this document, their location in the binary formats is determined by the host application. + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **absolute path**: A string that identifies the location of a file and that begins with a drive identifier and root directory or network share and ends with the complete file name. Examples are C:\Documents\Work\example.txt and \\netshare\Documents\Work\example.txt. +> +> **accelerator key**: Any combination of keys that are pressed simultaneously to run a command. +> +> **ActiveX control**: A reusable software control, such as a check box or button, that uses ActiveX technology and provides options to users or runs macros or scripts that automate a task. See also ActiveX object. +> +> **adaptive menu**: A type of menu that displays the most recently used commands at the top of that menu. +> +> **add-in**: Supplemental functionality that is provided by an external application or macro to extend the capabilities of an application. +> +> **American National Standards Institute (ANSI) character set**: A character set defined by a [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) approved by the American National Standards Institute (ANSI). The term "ANSI" as used to signify Windows code pages is a historical reference and a misnomer that persists in the Windows community. The source of this misnomer stems from the fact that the Windows code page 1252 was originally based on an ANSI draft, which became International Organization for Standardization (ISO) Standard 8859-1 [\[ISO/IEC-8859-1\]](https://go.microsoft.com/fwlink/?LinkId=90689). In Windows, the ANSI character set can be any of the following code pages: 1252, 1250, 1251, 1253, 1254, 1255, 1256, 1257, 1258, 874, 932, 936, 949, or 950. For example, "ANSI application" is usually a reference to a non-[**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) or code-page-based application. Therefore, "ANSI character set" is often misused to refer to one of the character sets defined by a Windows code page that can be used as an active system code page; for example, character sets defined by code page 1252 or character sets defined by code page 950. Windows is now based on Unicode, so the use of ANSI character sets is strongly discouraged unless they are used to interoperate with legacy applications or legacy data. +> +> **anti-moniker**: A Component Object Model (COM) object that is the inverse of a simple [**moniker**](#gt_b88df1f8-e55a-4d08-9861-e7d6a4ed9abc) and has no internal structure; it is the inverse of a COM implementation of a file, an item, or a pointer moniker. An anti-moniker that is composed to the right of a file moniker, item moniker, or pointer moniker composes to nothing. +> +> **assembly**: A collection of one or more files that is versioned and deployed as a unit. An assembly is the primary building block of a .NET Framework application. All managed types and resources are contained within an assembly and are marked either as accessible only within the assembly or as accessible from code in other assemblies. Assemblies also play a key role in security. The code access security system uses information about an assembly to determine the set of permissions that is granted to code in the assembly. +> +> **base URL**: A URL that is specified for a web resource to convert all relative URLs in that resource to absolute URLs. A base URL ends with either a file name, such as http://www.example.com/sample.htm, or a slash, such as http://www.example.com/subdir/. See also absolute URL. +> +> **basic toolbar**: A toolbar that consists of a row, column, or block of buttons, each of which perform an action when activated. Unlike a [**menu toolbar**](#gt_2eb45441-112f-420b-ab4a-768b569582dc), which displays only text labels, a basic toolbar can display both text and icons. +> +> **big-endian**: Multiple-byte values that are byte-ordered with the most significant byte stored in the memory location with the lowest address. +> +> **ButtonPopup control**: A type of Button control that displays a menu of related commands when activated. +> +> **cell**: A box that is formed by the intersection of a row and a column in a worksheet or a table. A cell can contain numbers, strings, and formulas, and various formats can be applied to that data. +> +> **class identifier (CLSID)**: A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that identifies a software component; for instance, a DCOM object class or a COM class. +> +> **clipboard format**: An unsigned integer that uniquely identifies the format of a data packet that is stored in a binary large object (BLOB) and can be shared between processes through the operating system clipboard or other means. +> +> **code page**: An ordered set of characters of a specific script in which a numerical index (code-point value) is associated with each character. Code pages are a means of providing support for character sets and keyboard layouts used in different countries/regions. Devices such as the display and keyboard can be configured to use a specific code page and to switch from one code page (such as the United States) to another (such as Portugal) at the user's request. +> +> **Component Object Model (COM)**: An object-oriented programming model that defines how objects interact within a single process or between processes. In [**COM**](#gt_ef2ebebc-1760-407a-9ace-af48f9050e02), clients have access to an object through interfaces implemented on the object. For more information, see [\[MS-DCOM\]](%5bMS-DCOM%5d.pdf#Section_4a893f3dbd2948cd9f43d9777a4415b0). +> +> **composite moniker**: A Component Object Model (COM) object that joins two or more moniker objects and that can determine the relation between the parts. There are two types of composite monikers: generic, which can connect any two monikers regardless of class; and, nongeneric, which can connect monikers only of the same class. +> +> **context menu**: A menu that is related to the active window, selection, or object. Also referred to as shortcut menu. +> +> **Coordinated Universal Time (UTC)**: A high-precision atomic time standard that approximately tracks Universal Time (UT). It is the basis for legal, civil time all over the Earth. Time zones around the world are expressed as positive and negative offsets from UTC. In this role, it is also referred to as Zulu time (Z) and Greenwich Mean Time (GMT). In these specifications, all references to UTC refer to the time at UTC-0 (or GMT). +> +> **custom toolbar**: A type of toolbar that contains a user-defined set of controls and is not included in an application by default. A custom toolbar has a toolbar identifier value of "1". +> +> **custom toolbar control**: A user-defined control that can be added to a toolbar. A custom toolbar control has a [**toolbar control identifier (TCID)**](#gt_28d9adbd-b340-469a-97cd-3befd6a782b3) value of "1" and can be one of the following types of controls: ActiveX, Button, ComboBox, DropDown, Edit, or Popup. +> +> **cyclic redundancy check (CRC)**: An algorithm used to produce a checksum (a small, fixed number of bits) against a block of data, such as a packet of network traffic or a block of a computer file. The CRC is a broad class of functions used to detect errors after transmission or storage. A CRC is designed to catch random errors, as opposed to intentional errors. If errors might be introduced by a motivated and intelligent adversary, a cryptographic hash function has to be used instead. +> +> **datasheet**: A worksheet window that contains the source data for a Microsoft Graph chart object. +> +> **digital certificate**: See the "digital certificate definition standard," as described in [\[X509\]](https://go.microsoft.com/fwlink/?LinkId=90590). +> +> **digital certificate store**: A database that stores a variety of [**digital certificates**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) and information about those certificates, including attributes and constraints. +> +> **digital signature**: A value that is generated by using a digital signature algorithm, taking as input a private key and an arbitrary-length string, such that a specific verification algorithm is satisfied by the value, the input string, and the public key corresponding to the input private key. +> +> **docked**: A condition where a toolbar is attached to the [**docking area**](#gt_25929137-cc77-41d9-af22-d3f449b23dcf) of an application window. +> +> **docked location**: A specific position of a toolbar within the [**docking area**](#gt_25929137-cc77-41d9-af22-d3f449b23dcf) of an application window. +> +> **docking area**: An area that is adjacent to the edge of an application window. A toolbar can be moved and attached to a docking area. +> +> **document workspace**: A document repository that enables users to collaborate on one or more documents. +> +> **ExpandingGrid control**: A type of [**ButtonPopup control**](#gt_d638405a-d78b-4c5f-aed2-8616d98d3519) that displays and sets a value from a continuous range of possible values when the user drags across the menu area. +> +> **file moniker**: A Component Object Model (COM) object that stores the path name that is assigned to a file by the native file system. +> +> **Gauge control**: A type of control that displays and sets a value from a continuous range of possible values that the user selects by dragging a slider. An example is the Zoom control in an application window. +> +> **globally unique identifier (GUID)**: A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [\[RFC4122\]](https://go.microsoft.com/fwlink/?LinkId=90460) or [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824) have to be used for generating the GUID. See also universally unique identifier (UUID). +> +> **GraphicCombo control**: A type of ComboBox control that can display both text and graphics as a list of options. +> +> **GraphicDropDown control**: A type of DropDown control that can display custom graphics in a list of options. +> +> **Grid control**: A type of menu control that can be activated by clicking a cell in a grid. An example is the Font Color control. +> +> **GUID_NULL**: A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that has the value "{00000000-0000-0000-0000-000000000000}". +> +> **hash**: A fixed-size result that is obtained by applying a one-way mathematical function, which is sometimes referred to as a hash algorithm, to an arbitrary amount of data. If the input data changes, the hash also changes. The hash can be used in many operations, including authentication and digital signing. +> +> **hyperlink**: A relationship between two anchors, as described in [\[RFC1866\]](https://go.microsoft.com/fwlink/?LinkId=90296). +> +> **hyperlink location**: A portion of a hyperlink that specifies the location of a specific item, such as a bookmark, within a document, object, or other type of resource; for example "#bookmark" in the hyperlink location C:\Documents\Document.docx#bookmark. +> +> **hyperlink target**: A portion of a hyperlink that specifies the document, object, or other resource; for example "C:\Documents\Document.docx" in the hyperlink location C:\Documents\Document.docx#bookmark. +> +> **item moniker**: A Component Object Model (COM) object that identifies an object that is contained in another object, such as an OLE object that is embedded in a document. +> +> **Joint Photographic Experts Group (JPEG)**: A raster graphics file format for displaying high-resolution color graphics. JPEG graphics apply a user-specified compression scheme that can significantly reduce the file sizes of photo-realistic color graphics. A higher level of compression results in lower quality, whereas a lower level of compression results in higher quality. JPEG-format files have a .jpg or .jpeg file name extension. +> +> **language code identifier (LCID)**: A 32-bit number that identifies the user interface human language dialect or variation that is supported by an application or a client computer. +> +> **linked object**: An object that is inserted into a document and continues to exist in a separate source file. If the object in the source file changes, the object in the document is updated automatically to reflect those changes. +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **locale**: A collection of rules and data that are specific to a language and a geographical area. A locale can include information about sorting rules, date and time formatting, numeric and monetary conventions, and character classification. +> +> **locale settings**: A collection of rules and data that are specific to a language and a geographic area. Locale settings include information about sorting rules, date and time formatting, numeric and monetary conventions, and character classification. +> +> **major version**: An iteration of a software component, document, or list item that is ready for a larger group to see, or has changed significantly from the previous major version. For an item on a SharePoint site, the [**minor version**](#gt_e0d99b53-9426-4a45-8429-b012184a4045) is always "0" (zero) for a major version. +> +> **managed code**: Code that is executed by the common language runtime (CLR) environment rather than directly by the operating system. Managed code applications gain CLR services, such as automatic garbage collection, runtime type checking, and security support. These services provide uniform behavior that is independent of platform and language. +> +> **manifest**: A file that stores metadata about an expansion pack, such as the name of the expansion pack, the files and resources that are included in the expansion pack, and the dependencies that it has on other files and components. +> +> **menu toolbar**: A type of toolbar that is displayed in an application window, typically at the top, and provides a set of menu controls from which the user can select. Activating a control on the toolbar displays a list of commands in that menu, and the menu remains open until the user closes it or chooses a menu command. +> +> **minor version**: An iteration of a software component, document, or list item that is in progress or has changed only slightly from the previous version. For an item on a SharePoint site, the minor version number is never "0" (zero) and is incremented for each new version of an item, unless a [**major version**](#gt_66583c77-eb07-43c4-8f1b-dd157580db46) is explicitly published. When minor versioning is disabled on a SharePoint site, only major version numbers are incremented, and the minor version is always "0" (zero). +> +> **moniker**: An object that stores information that uniquely identifies a Component Object Model (COM) object and allows that object to be located and activated. +> +> **MS-DOS path compatibility mode**: A mode that converts an MS-DOS path into a corresponding path by mapping MS-DOS device names to MS-DOS devices and drive letters. +> +> **object**: In [**COM**](#gt_ef2ebebc-1760-407a-9ace-af48f9050e02), a software entity that implements the IUnknown interface and zero or more additional interfaces that can be obtained from each other using the IUnknown interface. A [**COM**](#gt_ef2ebebc-1760-407a-9ace-af48f9050e02) [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) can be exposed to remote clients via the DCOM protocol, in which case it is also a DCOM object. +> +> **Object Linking and Embedding (OLE)**: A technology for transferring and sharing information between applications by inserting a file or part of a file into a compound document. The inserted file can be either embedded or linked. See also embedded object and [**linked object**](#gt_cfc45e76-9219-4c47-9ef2-5832a172f795). +> +> **OCXDropDown control**: A type of DropDown control that displays a list of the ActiveX controls that are available within that application. +> +> **Pane control**: A type of toolbar control that hosts a window within itself. The hosted window is not constrained by the layout and control type options of a [**basic toolbar**](#gt_39d82905-44bc-438d-9b2d-a2cd633a9dd9) or a [**menu toolbar**](#gt_2eb45441-112f-420b-ab4a-768b569582dc). +> +> **parent directory indicator**: In a hierarchical filing system, two periods followed by a backslash (..\\ that specify a working directory, relative to the current working directory. +> +> **Popup control**: A built-in or custom control on a menu bar or toolbar that displays a menu of related commands when clicked. +> +> **range**: An addressable region that is in a workbook. A range typically consists of zero or more cells and represents a single, contiguous rectangle of cells on a single sheet. +> +> **relative path**: A path that is implied by the active working directory or is calculated based on a specified directory. If users enter a command that refers to a file and the full path is not entered, the active working directory is the relative path of the referenced file. +> +> **smart document**: A file that is programmed to assist the user as the user creates or updates the document. Several types of files, such as forms and templates, can also function as smart documents. +> +> **smart tag**: A feature that adds the ability to recognize and label specific data types, such as people's names, within a document and displays an action button that enables users to perform common tasks for that data type. +> +> **smart tag recognizer**: An [**add-in**](#gt_a3be101e-9d37-484a-a5e6-b70d559146c6) that can interpret a specific type of smart tag, such as an address or a financial symbol, in a document and display an action button that enables users to perform common tasks for that data type. +> +> **SplitButtonMRUPopup control**: A type of [**SplitButtonPopup control**](#gt_1c046ab6-2530-4a41-8d19-03f92914beaf) whose icon changes to reflect the command that the user most recently selected from the menu that is displayed by that button. +> +> **SplitButtonPopup control**: A type of Button control that performs an action when clicked, and can also display a menu of related commands when the user clicks a drop-down arrow that appears on the button. +> +> **SplitDropDown control**: A type of Button control that performs a default action when clicked, and can also expand to display a list of other possible actions when the user clicks a drop-down arrow that appears on the button. +> +> **storage**: An element of a compound file that is a unit of containment for one or more storages and streams, analogous to directories in a file system, as described in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). +> +> **stream**: An element of a compound file, as described in \[MS-CFB\]. A stream contains a sequence of bytes that can be read from or written to by an application, and they can exist only in storages. +> +> **target frame**: The name of a frame that is in an HTML-based frames page and displays the destination of a hyperlink. +> +> **thumbnail**: A miniature version of an image that is typically used to browse multiple images quickly. +> +> **time stamp authority**: A service acknowledging that a datum existed before a specific time. The service is typically a trusted third party. +> +> **timestamp**: A condition of a [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) that indicates whether the signature was created with a valid certificate that has expired or was created with a certificate that had expired already. If the certificate expired after the signature was created, the signature can be trusted. If it expired before the signature was created, it cannot be trusted. +> +> **toolbar**: A row, column, or block of controls that represent tasks or commands within an application. A toolbar can be either a menu toolbar, which provides access to menu commands, or a [**basic toolbar**](#gt_39d82905-44bc-438d-9b2d-a2cd633a9dd9), which contains buttons that provide shortcuts to tasks that are frequently accessed from menus. +> +> **toolbar control**: An object that appears on a toolbar and enables user interaction or input, typically to initiate an action, display information, or set values. +> +> **toolbar control identifier (TCID)**: An integer that identifies a specific control on a toolbar. +> +> **toolbar control separator**: A line that separates groups of controls on a user interface surface, such as controls on a toolbar or commands on a menu. +> +> **toolbar control type**: A set of pre-defined behaviors and user interface elements for an object that can be implemented on a toolbar. Types include: ActiveX; Button; ButtonPopup; ComboBox; DropDown; Edit; ExpandingGrid; Gauge; GraphicCombo; GraphicDropDown; Grid; Label; OCXDropDown; Popup; SplitButtonPopup; SplitButtonMRUPopup; and SplitDropDown. +> +> **toolbar delta**: A file component that stores a modification that a user made to a built-in toolbar. Stored modifications include adding, changing, or removing a control from a built-in toolbar. +> +> **tooltip**: A window displaying text that is created when the mouse is moved over a window or notification icon. +> +> **top-level toolbar**: A [**basic toolbar**](#gt_39d82905-44bc-438d-9b2d-a2cd633a9dd9) that is not contained by another [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13). +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **Uniform Resource Identifier (URI)**: A string that identifies a resource. The URI is an addressing mechanism defined in Internet Engineering Task Force (IETF) Uniform Resource Identifier (URI): Generic Syntax [\[RFC3986\]](https://go.microsoft.com/fwlink/?LinkId=90453). +> +> **Uniform Resource Locator (URL)**: A string of characters in a standardized format that identifies a document or resource on the World Wide Web. The format is as specified in [\[RFC1738\]](https://go.microsoft.com/fwlink/?LinkId=90287). +> +> **Universal Naming Convention (UNC)**: A string format that specifies the location of a resource. For more information, see [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.57. +> +> **URI fragment**: The portion of a [**Uniform Resource Identifier (URI)**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95) that allows indirect identification of a secondary resource by reference to a primary resource and additional identifying information, as described in \[RFC3986\]. A fragment component is indicated by a number sign (#) and is terminated by the end of the URI. +> +> **URI query**: The portion of a [**Uniform Resource Identifier (URI)**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95) that, in conjunction with the data in the path component, identifies a resource within the scope of a URI's scheme and naming authority, if any, as described in \[RFC3986\]. A query component is indicated by the first question mark (?) character and is terminated by a number sign (#) or the end of the URI. +> +> **URI scheme**: The portion of a [**Uniform Resource Identifier (URI)**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95) that refers to a specification for assigning identifiers within the URI, as described in \[RFC3986\]. +> +> **URL moniker**: A Component Object Model (COM) object that stores a [**Uniform Resource Locator (URL)**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) as a string, based on either a full URL or the combination of a [**base URL**](#gt_4c44eaed-bf47-4788-a856-dcf7e55c8f0e) and a partial URL string. +> +> **Visual Basic for Applications (VBA)**: A macro-based programming language that derives from Microsoft Visual Basic and can be used to customize and extend an application. Unlike Visual Basic, Microsoft Visual Basic for Applications (VBA) code and macros can be run only from within a host application that supports VBA. +> +> **whitespace**: A character that can be found between words, including a space (" "), a carriage return in combination with a line feed (newline), and a tab character. +> +> **XML expansion pack**: A collection of files, managed by a manifest.xml file, that adds functionality to a document by specifying custom displays or actions. +> +> **XML namespace**: A collection of names that is used to identify elements, types, and attributes in XML documents identified in a URI reference \[RFC3986\]. A combination of XML namespace and local name allows XML documents to use elements, types, and attributes that have the same names but come from different sources. For more information, see [\[XMLNS-2ED\]](https://go.microsoft.com/fwlink/?LinkId=90602). +> +> **XML schema**: A description of a type of XML document that is typically expressed in terms of constraints on the structure and content of documents of that type, in addition to the basic syntax constraints that are imposed by XML itself. An XML schema provides a view of a document type at a relatively high level of abstraction. +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[ECMA-376\] ECMA International, "Office Open XML File Formats", [https://www.ecma-international.org/publications-and-standards/standards/ecma-376/](https://go.microsoft.com/fwlink/?LinkId=200054) + +\[ITUX680\] ITU-T, "Abstract Syntax Notation One (ASN.1): Specification of Basic Notation", Recommendation X.680, Approved 2021-02-13, [https://www.itu.int/rec/T-REC-X.680-202102-I/en](https://go.microsoft.com/fwlink/?LinkId=89923) + +\[MS-CTDOC\] Microsoft Corporation, "[Word Custom Toolbar Binary File Format](%5bMS-CTDOC%5d.pdf#Section_aff21c961b434bcf8c8a677e012c7e6a)". + +\[MS-CTXLS\] Microsoft Corporation, "[Excel Custom Toolbar Binary File Format](%5bMS-CTXLS%5d.pdf#Section_b461dcd9933e471081bcdc1c74801b6b)". + +\[MS-DOC\] Microsoft Corporation, "[Word (.doc) Binary File Format](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22)". + +\[MS-DTYP\] Microsoft Corporation, "[Windows Data Types](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2)". + +\[MS-EMF\] Microsoft Corporation, "[Enhanced Metafile Format](%5bMS-EMF%5d.pdf#Section_91c257d7c39d4a369b1f63e3f73d30ca)". + +\[MS-IPFF\] Microsoft Corporation, "[InfoPath Form Template Format](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)". + +\[MS-LCID\] Microsoft Corporation, "[Windows Language Code Identifier (LCID) Reference](%5bMS-LCID%5d.pdf#Section_70feba9f294e491eb6eb56532684c37f)". + +\[MS-LISTSWS\] Microsoft Corporation, "[Lists Web Service Protocol](%5bMS-LISTSWS%5d.pdf#Section_30b364cc38374e839ce81963292e2ee5)". + +\[MS-ODRAW\] Microsoft Corporation, "[Office Drawing Binary File Format](%5bMS-ODRAW%5d.pdf#Section_8560795e77594745838ff7f2ef2f1872)". + +\[MS-OFFCRYPTO\] Microsoft Corporation, "[Office Document Cryptography Structure](%5bMS-OFFCRYPTO%5d.pdf#Section_3c34d72a1a614b52a893196f9157f083)". + +\[MS-OFORMS\] Microsoft Corporation, "[Office Forms Binary File Formats](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a)". + +\[MS-OI29500\] Microsoft Corporation, "[Office Implementation Information for ISO/IEC 29500 Standards Support](%5bMS-OI29500%5d.pdf#Section_1fd4a662862349c082f018fa91b413b8)". + +\[MS-OLEPS\] Microsoft Corporation, "[Object Linking and Embedding (OLE) Property Set Data Structures](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc)". + +\[MS-OVBA\] Microsoft Corporation, "[Office VBA File Format Structure](%5bMS-OVBA%5d.pdf#Section_575462babf6741909facc275523c75fc)". + +\[MS-OXCDATA\] Microsoft Corporation, "[Data Structures](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8)". + +\[MS-OXPROPS\] Microsoft Corporation, "[Exchange Server Protocols Master Property List](%5bMS-OXPROPS%5d.pdf#Section_f6ab1613aefe447da49c18217230b148)". + +\[MS-WMF\] Microsoft Corporation, "[Windows Metafile Format](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2)". + +\[MS-WSSCAML\] Microsoft Corporation, "[Collaborative Application Markup Language (CAML) Structure](%5bMS-WSSCAML%5d.pdf#Section_8d6156fd646842949594644a946ed6a6)". + +\[MS-XLS\] Microsoft Corporation, "[Excel Binary File Format (.xls) Structure](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06)". + +\[PKCS7\] RSA Laboratories, "PKCS \#7: Cryptographic Message Syntax Standard", PKCS \#7, version 1.5, November 1993 (\[RFC2315\], March 1998), [https://www.rfc-editor.org/info/rfc2315](https://go.microsoft.com/fwlink/?LinkId=510681) + +**Note** Original Archived. + +\[PKCS9\] RSA Laboratories, "PKCS \#9: Selected Attribute Types", PKCS \#9, version 1.1, November 1993, [http://www.emc.com/emc-plus/rsa-labs/standards-initiatives/pkcs-9-selected-attribute-types.htm](https://go.microsoft.com/fwlink/?LinkId=510682) + +\[RFC1321\] Rivest, R., "The MD5 Message-Digest Algorithm", RFC 1321, April 1992, [https://www.rfc-editor.org/info/rfc1321](https://go.microsoft.com/fwlink/?LinkId=90275) + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[RFC3280\] Housley, R., Polk, W., Ford, W., and Solo, D., "Internet X.509 Public Key Infrastructure Certificate and Certificate Revocation List (CRL) Profile", RFC 3280, April 2002, [http://www.rfc-editor.org/info/rfc3280](https://go.microsoft.com/fwlink/?LinkId=90414) + +\[RFC3986\] Berners-Lee, T., Fielding, R., and Masinter, L., "Uniform Resource Identifier (URI): Generic Syntax", STD 66, RFC 3986, January 2005, [https://www.rfc-editor.org/info/rfc3986](https://go.microsoft.com/fwlink/?LinkId=90453) + +\[RFC5234\] Crocker, D., Ed., and Overell, P., "Augmented BNF for Syntax Specifications: ABNF", STD 68, RFC 5234, January 2008, [https://www.rfc-editor.org/info/rfc5234](https://go.microsoft.com/fwlink/?LinkId=123096) + +\[W3C-XSD\] World Wide Web Consortium, "XML Schema Part 2: Datatypes Second Edition", 28 October 2004, [http://www.w3.org/TR/2004/REC-xmlschema-2-20041028](https://go.microsoft.com/fwlink/?LinkId=90563) + +### Informative References + +\[MS-PPT\] Microsoft Corporation, "[PowerPoint (.ppt) Binary File Format](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662)". + +\[MSDN-AVSTOS\] Microsoft Corporation, "Architecture of Visual Studio Tools for Office Solutions", [http://msdn.microsoft.com/en-us/library/zkhw8h59(VS.80).aspx](https://go.microsoft.com/fwlink/?LinkId=121211) + +\[MSDN-CreateUri\] Microsoft Corporation, "CreateUri Function", [http://msdn.microsoft.com/en-us/library/ms775098(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=120601) + +\[MSDN-FM\] Microsoft Corporation, "File Monikers", [http://msdn.microsoft.com/en-us/library/ms688670(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=121362) + +\[MSDN-IMAMI\] Microsoft Corporation, "IMoniker -- Anti-Moniker Implementation", [http://msdn.microsoft.com/en-us/library/ms682346(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=121364) + +\[MSDN-IMCOM\] Microsoft Corporation, "Item Monikers (COM)", [http://msdn.microsoft.com/en-us/library/ms693722(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=121361) + +\[MSDN-IMGCMI\] Microsoft Corporation, "IMoniker -- Generic Composite Moniker Implementation", [http://msdn.microsoft.com/en-us/library/ms688541(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=121363) + +\[MSDN-SDO\] Microsoft Corporation, "Smart Documents Overview", Office 2003 Smart Document Software Development Kit, [http://msdn.microsoft.com/en-us/library/aa193956(office.11).aspx](https://go.microsoft.com/fwlink/?LinkId=120839) + +\[MSDN-URLM\] Microsoft Corporation, "URL Monikers", [http://msdn.microsoft.com/en-us/library/ms688580(VS.85).aspx](https://go.microsoft.com/fwlink/?LinkId=121360) + +## Structure Overview (Synopsis) + +The following sections provide an overview of the structure of this protocol. + +### Toolbar Customization + +[**Toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) customization structures provide a run-time solution for the creation and deployment of toolbar customizations that are specific to the content of a file. + +The following diagram illustrates how toolbar customization structures are presented within the XCB binary [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6), as described in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.1.7.10 with its toolbar customization structures. + +![Toolbar customization structures in an XCB binary stream](media/image1.bin "Toolbar customization structures in an XCB binary stream") + +Figure 1: Toolbar customization structures in an XCB binary stream + +The following diagram illustrates how toolbar customization structures are presented within the Table Stream, as described in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.1.2. + +![Toolbar customization structures in a Table Stream](media/image2.bin "Toolbar customization structures in a Table Stream") + +Figure 2: Toolbar customization structures in a Table Stream + +### Property Set Storage + +[**OLE Property Sets**](#Section_0105a8ee6e664b1281a5d3d39c8270f2) (section 2.3.3.2) define a common way to store metadata about a file. The [**Summary Information Property Set**](#Section_11b5612735f44bfaa23f23935a6edf54) (section 2.3.3.2.1) and [**Document Summary Information Property Set**](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2) contain a predefined set of properties, storing information such as title, subject, keywords, author, and line count. The [User Defined Property Set](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) contains a set of properties that an application or user can extend. + +The following two diagrams illustrate the structure of these property sets as persisted to a binary file. These property sets are implementations of [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) Property Sets. For a structural overview of OLE Property Sets, see [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [1.3](http://msdn.microsoft.com/en-us/library/df2e0abe-365f-4bf8-a630-6c1f560238c8/). + +![Property set storage structure](media/image3.bin "Property set storage structure") + +Figure 3: Property set storage structure + +![Property set packet structure](media/image4.bin "Property set packet structure") + +Figure 4: Property set packet structure + +### RefEdit Control + +A [**RefEdit**](#Section_45556c0e0f424c79864e503cd04e38ba) control (section 2.3.5) displays a [**range**](#gt_c2c93fec-8d3e-45de-8010-c738cc1cea99) value that references [**cells**](#gt_43d1e51e-4f26-493b-b7c9-e84e920d7461) in a [**datasheet**](#gt_044a2880-814e-4b2f-b3eb-e5d78d499896). A user can enter the value into the control directly or click a drop-down box to select it. The format of the range value depends on the datasheet implementation. + +### Visual Basic for Applications Digital Signature + +The **[Visual Basic for Applications (VBA)](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [digital signature structure](#Section_f80ee18cd72f4c3c9ea5a56f396322e0)** (section 2.3.2) is contained in a wrapping structure that is specific to the mechanism the file format uses to store the signature. + +In the formats described in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) and [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662), the signature structure is stored in the [**Document Summary Information OLE property set**](#Section_3ef02e83afef4b6c9585c109edd24e07) (section 2.3.3.2.2.1) as a VT_BLOB **TypedPropertyValue** property. The following diagram illustrates the relative structures for this storage mechanism. + +![VBA digital signature storage as OLE property set property](media/image5.bin "VBA digital signature storage as OLE property set property") + +Figure 5: VBA digital signature storage as OLE property set property + +In the format described in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22), the signature structure is stored in the StwUser string table (\[MS-DOC\] section 2.9.298) as the value of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string variables named "Sign" or "SigAgile". The following diagram illustrates the relative structures for this storage mechanism. + +![VBA digital signature storage as \[MS-DOC\] string table variable](media/image6.bin "VBA digital signature storage as [MS-DOC] string table variable") + +Figure 6: VBA digital signature storage as \[MS-DOC\] string table variable + +The signature structure consists of information about the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189), as well as the signature (section [2.3.2.4](#Section_7c4ce2e22a714b028f51b9f0eeed756a)) itself, and a [serialized certificate store](#Section_e88d644c80f84016a2c093fc5b110877) (section 2.3.2.5.5). The following diagram illustrates this structure. + +![DigSigInfoSerialized structure](media/image7.bin "DigSigInfoSerialized structure") + +Figure 7: DigSigInfoSerialized structure + +### Byte Ordering + +Data in the Office Common Data Types and Objects Structure is stored in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) format. + +Some computer architectures number bytes in a binary word from left to right, which is referred to as [**big-endian**](#gt_6f6f9e8e-5966-4727-8527-7e02fb864e7e). The packet diagrams for this documentation are big-endian. Other architectures number the bytes in a binary word from right to left, which is referred to as little-endian. The underlying file format enumerations, objects, and records are little-endian. + +Using big-endian and little-endian methods, the number 0x12345678 would be stored as shown in the following table. + +| Byte order | Byte 0 | Byte 1 | Byte 2 | Byte 3 | +|---------------|--------|--------|--------|--------| +| Big-endian | 0x12 | 0x34 | 0x56 | 0x78 | +| Little-endian | 0x78 | 0x56 | 0x34 | 0x12 | + +## Relationship to Protocols and Other Structures + +### Toolbar Customization + +The **CTB** and **TBC** structures described in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.6, and the **CTB** and **TBC** structures described in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.9 depend on the toolbar customization structures specified in this document. + +The [**TBCHeader**](#Section_6fec0363d40148aaacdf46b7a8bf31db) (section 2.3.1.10), [**TBCSFlags**](#Section_df3f6f9b34c6451fad13765c2cb63c09) (section 2.3.1.12), and [**TBCMenuSpecific**](#Section_912bf645a367471b9d4efc29583a01bc) (section 2.3.1.21) structures specified in this document are dependent on the toolbar customization data described in the following references: + +- +- + +### [\[MS-CTDOC\]](%5bMS-CTDOC%5d.pdf#Section_aff21c961b434bcf8c8a677e012c7e6a) for the persistence format for word processing documents.[\[MS-CTXLS\]](%5bMS-CTXLS%5d.pdf#Section_b461dcd9933e471081bcdc1c74801b6b) for the persistence format for spreadsheet [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) customization structures defined in this document. Property Set Storage + +The [**OLE Property Sets**](#Section_0105a8ee6e664b1281a5d3d39c8270f2) (section 2.3.3.2) specified in this document are implementations of [**Object Linking and Embedding (OLE)**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) Property Set Data Structures (OLEPS) as described in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc). This document describes where [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22), [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662), and [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) file formats extend \[MS-OLEPS\] and where they deviate from \[MS-OLEPS\]. + +These property sets are contained in persistence formats described in \[MS-XLS\], \[MS-DOC\], and \[MS-PPT\]. Some data in the property sets is generated according to algorithms specified in [\[MS-ODRAW\]](%5bMS-ODRAW%5d.pdf#Section_8560795e77594745838ff7f2ef2f1872), \[MS-DOC\], and \[MS-XLS\]. + +### Visual Basic for Applications Digital Signature + +The [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) for a [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project is a specific implementation of the PKCS \#7 Cryptographic Message Syntax Standard as described in [\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681). Additional implementation information for attributes of the signature is described in [\[PKCS9\]](https://go.microsoft.com/fwlink/?LinkId=510682). The file formats [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) and [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) store their VBA digital signature in their [**OLE Property Sets**](#Section_0105a8ee6e664b1281a5d3d39c8270f2) (section 2.3.3.2). The file format [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) stores the VBA digital signature in a string table within the document. The data that the VBA digital signature encrypts is described in the [\[MS-OVBA\]](%5bMS-OVBA%5d.pdf#Section_575462babf6741909facc275523c75fc) specification. + +## Applicability Statement + +The structures in this document are intended to function as persistence formats for portions of a document, and are not intended for stand-alone use. These persistence formats provide interoperability with applications that create or read documents conforming to this structure[\<1\>](#Appendix_A_1). + +### Toolbar Customization + +[**Toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) customization structures represent a common model for storing [**custom toolbars**](#gt_6ee69c13-ffa9-43b1-989e-a942dceb1fa5) or toolbar alterations within the [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) and [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) file formats. Toolbar customization structures can be used whenever it is desirable to have [**custom toolbar controls**](#gt_75556eac-bd5a-4dc2-b7b5-48c27bfa1c93) (for example, custom toolbar controls that run custom macros) travel with a file from one system to another. + +### Property Set Storage + +**OLE Property Sets** (section [2.3.3.2](#Section_0105a8ee6e664b1281a5d3d39c8270f2)) represent a common way to store metadata about a file within the [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22), [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662), and [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) file formats in a way that is discoverable to other software. + +### Visual Basic for Applications Digital Signature + +The [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) for a [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project represents a way to securely identify the author of the executable VBA code that is associated with the document by means of a public [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0). By securely identifying the author, a future user of the document can make a decision to trust or reject the executable document content based on the signer’s identity. A digital signature also allows a future user to determine whether the content of the document’s executable code is no longer the same as the code that was originally signed, which means that the code can no longer be trusted to have come from the signer identified by the accompanying digital certificate. + +## Versioning and Localization + +### Toolbar Customization + +This document covers versioning issues in the following areas: + +- +- + +### **Structure Versions:** There is only one version of the [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) customization structures (section [2.3.1](#Section_a38b2b42f81045358ffb175863574222)).**Localization:** The toolbar customization structures define no [**locale**](#gt_7b78ebef-e35d-45ab-abfd-4121b60995de)-specific processes or data.Property Set Storage + +This document covers versioning issues in the following areas: + +- +- + +### **Structure Versions:** There is only one version of the property sets defined in [**Property Set Storage**](#Section_9673a168c71544eb882502cfa2b4627d) (section 2.3.3).**Localization:** The encoding of strings contained in the [**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) (section 2.3.3.1.4) data type and the [**UnalignedLpstr**](#Section_a8f75582c3d34a5bbbca62ed6a05711d) (section 2.3.3.1.5) data type depend on the property set’s **CodePage** property (described in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.18.2](http://msdn.microsoft.com/en-us/library/b8910736-7f4a-469a-9644-aed68a71d7d1/)).Visual Basic for Applications Digital Signature + +This document covers versioning issues in the following areas: + +- +- + +## **Structure Versions:** There is only one version of the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) defined in [Visual Basic for Applications Digital Signature Storage](#Section_f80ee18cd72f4c3c9ea5a56f396322e0) (section 2.3.2).**Localization:** The VBA digital signature structures define no [**locale**](#gt_7b78ebef-e35d-45ab-abfd-4121b60995de)-specific processes or data.Vendor-Extensible Fields + +The following sections describe the vendor-extensible fields used by this protocol. + +### Toolbar Customization + +None. + +### Property Set Storage + +None. + +### Visual Basic for Applications Digital Signature + +Extensibility is as described in the [\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681) specification, except the constraints in, VBA Digital Signature (section [2.3.2.4](#Section_7c4ce2e22a714b028f51b9f0eeed756a)). + +# Structures + +## Common ABNF Definitions + +The following are common ABNF ([\[RFC5234\]](https://go.microsoft.com/fwlink/?LinkId=123096)) definitions for the standard ASCII and [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. + +1. ASCII-SPACE = %x20 + + ASCII-EXCLAMATION-MARK = %x21 + + ASCII-QUOTATION-MARK = %x22 + + ASCII-NUMBER-SIGN = %x23 + + ASCII-DOLLAR-SIGN = %x24 + + ASCII-PERCENT-SIGN = %x25 + + ASCII-AMPERSAND = %x26 + + ASCII-APOSTROPHE = %x27 + + ASCII-LEFT-PARENTHESIS = %x28 + + ASCII-RIGHT-PARENTHESIS = %x29 + + ASCII-ASTERISK = %x2A + + ASCII-PLUS-SIGN = %x2B + + ASCII-COMMA = %x2C + + ASCII-HYPHEN-MINUS = %x2D + + ASCII-FULL-STOP = %x2E + + ASCII-SOLIDUS = %x2F + + ASCII-DIGIT-ZERO = %x30 + + ASCII-DIGIT-ONE = %x31 + + ASCII-DIGIT-TWO = %x32 + + ASCII-DIGIT-THREE = %x33 + + ASCII-DIGIT-FOUR = %x34 + + ASCII-DIGIT-FIVE = %x35 + + ASCII-DIGIT-SIX = %x36 + + ASCII-DIGIT-SEVEN = %x37 + + ASCII-DIGIT-EIGHT = %x38 + + ASCII-DIGIT-NINE = %x39 + + ASCII-COLON = %x3A + + ASCII-SEMICOLON = %x3B + + ASCII-LESS-THAN-SIGN = %x3C + + ASCII-EQUALS-SIGN = %x3D + + ASCII-GREATER-THAN-SIGN = %x3E + + ASCII-QUESTION-MARK = %x3F + + ASCII-COMMERCIAL-AT = %x40 + + ASCII-CAPITAL-LETTER-A = %x41 + + ASCII-CAPITAL-LETTER-B = %x42 + + ASCII-CAPITAL-LETTER-C = %x43 + + ASCII-CAPITAL-LETTER-D = %x44 + + ASCII-CAPITAL-LETTER-E = %x45 + + ASCII-CAPITAL-LETTER-F = %x46 + + ASCII-CAPITAL-LETTER-G = %x47 + + ASCII-CAPITAL-LETTER-H = %x48 + + ASCII-CAPITAL-LETTER-I = %x49 + + ASCII-CAPITAL-LETTER-J = %x4A + + ASCII-CAPITAL-LETTER-K = %x4B + + ASCII-CAPITAL-LETTER-L = %x4C + + ASCII-CAPITAL-LETTER-M = %x4D + + ASCII-CAPITAL-LETTER-N = %x4E + + ASCII-CAPITAL-LETTER-O = %x4F + + ASCII-CAPITAL-LETTER-P = %x50 + + ASCII-CAPITAL-LETTER-Q = %x51 + + ASCII-CAPITAL-LETTER-R = %x52 + + ASCII-CAPITAL-LETTER-S = %x53 + + ASCII-CAPITAL-LETTER-T = %x54 + + ASCII-CAPITAL-LETTER-U = %x55 + + ASCII-CAPITAL-LETTER-V = %x56 + + ASCII-CAPITAL-LETTER-W = %x57 + + ASCII-CAPITAL-LETTER-X = %x58 + + ASCII-CAPITAL-LETTER-Y = %x59 + + ASCII-CAPITAL-LETTER-Z = %x5A + + ASCII-LEFT-SQUARE-BRACKET = %x5B + + ASCII-REVERSE-SOLIDUS = %x5C + + ASCII-RIGHT-SQUARE-BRACKET = %x5D + + ASCII-CIRCUMFLEX-ACCENT = %x5E + + ASCII-LOW-LINE = %x5F + + ASCII-GRAVE-ACCENT = %x60 + + ASCII-SMALL-LETTER-A = %x61 + + ASCII-SMALL-LETTER-B = %x62 + + ASCII-SMALL-LETTER-C = %x63 + + ASCII-SMALL-LETTER-D = %x64 + + ASCII-SMALL-LETTER-E = %x65 + + ASCII-SMALL-LETTER-F = %x66 + + ASCII-SMALL-LETTER-G = %x67 + + ASCII-SMALL-LETTER-H = %x68 + + ASCII-SMALL-LETTER-I = %x69 + + ASCII-SMALL-LETTER-J = %x6A + + ASCII-SMALL-LETTER-K = %x6B + + ASCII-SMALL-LETTER-L = %x6C + + ASCII-SMALL-LETTER-M = %x6D + + ASCII-SMALL-LETTER-N = %x6E + + ASCII-SMALL-LETTER-O = %x6F + + ASCII-SMALL-LETTER-P = %x70 + + ASCII-SMALL-LETTER-Q = %x71 + + ASCII-SMALL-LETTER-R = %x72 + + ASCII-SMALL-LETTER-S = %x73 + + ASCII-SMALL-LETTER-T = %x74 + + ASCII-SMALL-LETTER-U = %x75 + + ASCII-SMALL-LETTER-V = %x76 + + ASCII-SMALL-LETTER-W = %x77 + + ASCII-SMALL-LETTER-X = %x78 + + ASCII-SMALL-LETTER-Y = %x79 + + ASCII-SMALL-LETTER-Z = %x7A + + ASCII-LEFT-CURLY-BRACKET = %x7B + + ASCII-VERTICAL-LINE = %x7C + + ASCII-RIGHT-CURLY-BRACKET = %x7D + + ASCII-TILDE = %x7E + + ASCII-DELETE = %x7F + + ASCII-CRLF = %x0d.0a + + ASCII-DIGIT = ASCII-DIGIT-ZERO / + + ASCII-DIGIT-ONE / + + ASCII-DIGIT-TWO / + + ASCII-DIGIT-THREE / + + ASCII-DIGIT-FOUR / + + ASCII-DIGIT-FIVE / + + ASCII-DIGIT-SIX / + + ASCII-DIGIT-SEVEN / + + ASCII-DIGIT-EIGHT / + + ASCII-DIGIT-NINE + + ASCII-DIGIT-HEXADECIMAL = ASCII-DIGIT / + + ASCII-SMALL-LETTER-A / + + ASCII-SMALL-LETTER-B / + + ASCII-SMALL-LETTER-C / + + ASCII-SMALL-LETTER-D / + + ASCII-SMALL-LETTER-E / + + ASCII-SMALL-LETTER-F / + + ASCII-CAPITAL-LETTER-A / + + ASCII-CAPITAL-LETTER-B / + + ASCII-CAPITAL-LETTER-C / + + ASCII-CAPITAL-LETTER-D / + + ASCII-CAPITAL-LETTER-E / + + ASCII-CAPITAL-LETTER-F + + ASCII-ALL = %x20-7F + + UTF16-CHAR-NON-ASCII = %x0080-FFFF + + UTF16-ANY = ASCII-ALL / UTF16-CHAR-NON-ASCII + +## Data Types + +### Common Data Types + +#### ObjectUpdateEnum + +Specifies how the container updates the [**linked object**](#gt_cfc45e76-9219-4c47-9ef2-5832a172f795) embedded in an application. + +| Name | Value | Meaning | +|----|----|----| +| **OU_Always** | 0x00000001 | The container updates the linked object whenever there is an update associated with it. | +| **OU_OnCall** | 0x00000003 | The container updates the linked object only when the container calls its update method. | + +#### DataViewAspectEnum + +Specifies the desired data or view aspect of the [**object**](#gt_8bb43a65-7a8c-4585-a7ed-23044772f8ca) when drawing or obtaining data. + +| Name | Value | Meaning | +|----|----|----| +| **OR_Content** | 0x00000001 | Specifies that the object is displayed as an embedded object inside of a container. | +| **OR_Thumbnail** | 0x00000002 | Specifies that the object is displayed as a [**thumbnail**](#gt_811d0e6b-538c-487d-a54f-44f31e41e172) image. | +| **OR_Icon** | 0x00000004 | Specifies that the object is displayed as an icon. | +| **OR_DocPrint** | 0x00000008 | Specifies that the object is displayed on the screen as though it were printed to a printer. | + +#### MSONFC + +This specifies the list of numbering formats that can be used for a group of automatically numbered objects. The numbering format values are mapped to the ST_NumberFormat ([\[ECMA-376\]](https://go.microsoft.com/fwlink/?LinkId=200054) partition IV section 2.18.66) enumeration equivalents as described in the following table. + +| Name | Value | Meaning | +|----|----|----| +| **msonfcArabic** | 0x00 | decimal | +| **msonfcUCRoman** | 0x01 | upperRoman | +| **msonfcLCRoman** | 0x02 | lowerRoman | +| **msonfcUCLetter** | 0x03 | upperLetter | +| **msonfcLCLetter** | 0x04 | lowerLetter | +| **msonfcOrdinal** | 0x05 | ordinal | +| **msonfcCardtext** | 0x06 | cardinalText | +| **msonfcOrdtext** | 0x07 | ordinalText | +| **msonfcHex** | 0x08 | hex | +| **msonfcChiManSty** | 0x09 | chicago | +| **msonfcDbNum1** | 0x0A | ideographDigital | +| **msonfcDbNum2** | 0x0B | japaneseCounting | +| **msonfcAiueo** | 0x0C | Aiueo | +| **msonfcIroha** | 0x0D | Iroha | +| **msonfcDbChar** | 0x0E | decimalFullWidth | +| **msonfcSbChar** | 0x0F | decimalHalfWidth | +| **msonfcDbNum3** | 0x10 | japaneseLegal | +| **msonfcDbNum4** | 0x11 | japaneseDigitalTenThousand | +| **msonfcCirclenum** | 0x12 | decimalEnclosedCircle | +| **msonfcDArabic** | 0x13 | decimalFullWidth2 | +| **msonfcDAiueo** | 0x14 | aiueoFullWidth | +| **msonfcDIroha** | 0x15 | irohaFullWidth | +| **msonfcArabicLZ** | 0x16 | decimalZero | +| **msonfcBullet** | 0x17 | bullet | +| **msonfcGanada** | 0x18 | ganada | +| **msonfcChosung** | 0x19 | chosung | +| **msonfcGB1** | 0x1A | decimalEnclosedFullstop | +| **msonfcGB2** | 0x1B | decimalEnclosedParen | +| **msonfcGB3** | 0x1C | decimalEnclosedCircleChinese | +| **msonfcGB4** | 0x1D | ideographEnclosedCircle | +| **msonfcZodiac1** | 0x1E | ideographTraditional | +| **msonfcZodiac2** | 0x1F | ideographZodiac | +| **msonfcZodiac3** | 0x20 | ideographZodiacTraditional | +| **msonfcTpeDbNum1** | 0x21 | taiwaneseCounting | +| **msonfcTpeDbNum2** | 0x22 | ideographLegalTraditional | +| **msonfcTpeDbNum3** | 0x23 | taiwaneseCountingThousand | +| **msonfcTpeDbNum4** | 0x24 | taiwaneseDigital | +| **msonfcChnDbNum1** | 0x25 | chineseCounting | +| **msonfcChnDbNum2** | 0x26 | chineseLegalSimplified | +| **msonfcChnDbNum3** | 0x27 | chineseCountingThousand | +| **msonfcChnDbNum4** | 0x28 | decimal | +| **msonfcKorDbNum1** | 0x29 | koreanDigital | +| **msonfcKorDbNum2** | 0x2A | koreanCounting | +| **msonfcKorDbNum3** | 0x2B | koreanLegal | +| **msonfcKorDbNum4** | 0x2C | koreanDigital2 | +| **msonfcHebrew1** | 0x2D | hebrew1 | +| **msonfcArabic1** | 0x2E | arabicAlpha | +| **msonfcHebrew2** | 0x2F | hebrew2 | +| **msonfcArabic2** | 0x30 | arabicAbjad | +| **msonfcHindi1** | 0x31 | hindiVowels | +| **msonfcHindi2** | 0x32 | hindiConsonants | +| **msonfcHindi3** | 0x33 | hindiNumbers | +| **msonfcHindi4** | 0x34 | hindiCounting | +| **msonfcThai1** | 0x35 | thaiLetters | +| **msonfcThai2** | 0x36 | thaiNumbers | +| **msonfcThai3** | 0x37 | thaiCounting | +| **msonfcViet1** | 0x38 | vietnameseCounting | +| **msonfcNumInDash** | 0x39 | numberInDash | +| **msonfcLCRus** | 0x3A | russianLower | +| **msonfcUCRus** | 0x3B | russianUpper | +| **msonfcNone** | 0xFF | Specifies that the sequence will not display any numbering | + +#### WebScreenSizeEnum + +An enumeration that specifies the screen resolution for the target monitor on which the Web page is to be displayed. Values are described in the following table. + +| Name | Value | Meaning | +|--------------------------------|-------|---------------------| +| **MSOWOPTScreenSize544x376** | 0x00 | 544 by 376 pixels | +| **MSOWOPTScreenSizeWebTV** | 0x00 | 544 by 376 pixels | +| **MSOWOPTScreenSize640x480** | 0x01 | 640 by 480 pixels | +| **MSOWOPTScreenSize720x512** | 0x02 | 720 by 512 pixels | +| **MSOWOPTScreenSize800x600** | 0x03 | 800 by 600 pixels | +| **MSOWOPTScreenSize1024x768** | 0x04 | 1024 by 768 pixels | +| **MSOWOPTScreenSize1152x882** | 0x05 | 1152 by 882 pixels | +| **MSOWOPTScreenSize1152x900** | 0x06 | 1152 by 900 pixels | +| **MSOWOPTScreenSize1280x1024** | 0x07 | 1280 by 1024 pixels | +| **MSOWOPTScreenSize1600x1200** | 0x08 | 1600 by 1200 pixels | +| **MSOWOPTScreenSize1800x1440** | 0x09 | 1800 by 1440 pixels | +| **MSOWOPTScreenSize1920x1200** | 0x0A | 1920 by 1200 pixels | + +#### FilePointer + +Specifies the offset into the [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or file that is to be read from or written to. + +**offset (4 bytes):** Unsigned integer that specifies the offset into a stream or file. + +#### FixedPoint + +Specifies an approximation of a real number, where the approximation has a fixed number of digits after the radix point. + +129. Value of the real number = **Integral** + (**Fractional** / 65536.0) + +**Integral (2 bytes):** A signed integer that specifies the integral part of the real number. + +**Fractional (2 bytes):** An unsigned integer that specifies the fractional part of the real number. + +## Common Objects + +### Toolbar Customization + +This section specifies structures used by the **CTB**, and **TBC** structures specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.6, and by the **CTB**, and **TBC** structures specified in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.9. + +#### TBCBitmap + +*Referenced by: [TBCBSpecific](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0)* + +Specifies a bitmap used to store a custom icon used by a [**toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). + +[TABLE] + +**cbDIB (4 bytes):** Signed integer that specifies the count of total bytes, excluding this field, in the **TBCBitmap** structure plus 10. The value is given by the following formula: + +130. **cbDIB** = sizeOf(**biHeader**) + sizeOf(**colors**) + sizeOf(**bitmapData**) + 10 + +The value MUST be greater than or equal to 40, and MUST be less than or equal to 65576 (which is a bitmap that is 128 pixels high, 128 pixels wide at 32 bits of color per pixel plus 40 ((128 \* 128 \* 32 / 8) + 40)). + +**biHeader (30 bytes):** A [**BITMAPINFOHEADER**](#Section_5eb5fc23797e4e428ef1ef844994d7d4) structure (section 2.3.1.2) that contains information about this bitmap. + +**colors (variable):** Zero-based array of [**RGBQuad**](#Section_635c7c9d5a7f45dc98c1577be7d0f7ac) structures (section 2.3.1.3). MUST exist only if **biHeader.biBitCount** is less than or equal to 0x08. The number of elements in this array MUST be equal to 2^biHeader.biBitCount. + +**bitmapData (variable):** An array of bytes as specified by the **aData** field of a **DeviceIndependentBitmap** object specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section [2.2.2.9](http://msdn.microsoft.com/en-us/library/7376542a-cce9-4625-8ead-585e9538f9f1/). The number of bytes in this array MUST be equal to cbDIB – sizeOf(colors) – sizeOf(biHeader) -10. The number of bytes in this array is also calculated with the following formula: + +131. Number of bytes in **bitmapData** = ((**biHeader.biWidth** \* **biHeader.biBitCount** + 31) & ~31) / 8 \* **biHeader.biHeight** + +#### BITMAPINFOHEADER + +*Referenced by: [TBCBitmap](#Section_24c6da6cfc9f4815ad189a7a3a6d9205)* + +Bitmap header. Contains information about a bitmap. + +[TABLE] + +**bData (4 bytes):** Unsigned integer. MUST be 0x00000028. + +**biWidth (2 bytes):** Signed integer that specifies the width of the bitmap in pixels. MUST be positive and less than or equal to 0x0080. + +**biHeight (2 bytes):** Signed integer that specifies the height of the bitmap in pixels. MUST be positive and less than or equal to 0x0080. + +**biPlanes (1 byte):** Unsigned integer that MUST be 0x01. + +**biBitCount (1 byte):** Unsigned integer that specifies the number of bits per pixel. MUST be equal to one of the values in the following table. + +| Value of biBitCount | +|:-------------------:| +| 0x01 | +| 0x04 | +| 0x08 | +| 0x10 | +| 0x18 | +| 0x20 | + +**biCompression (2 bytes):** Unsigned integer that specifies the bitmap compression format. A value of 0x0000 means that the bitmap is uncompressed. The value MUST be 0x0000. + +**biSizeImage (2 bytes):** Unsigned integer that specifies the size, in bytes, of the image. The value SHOULD specify the size of the **bitmapData** array of the **TBCBitmap** structure (section 2.3.1.1) that contains this structure and is given by the following formula. For ​uncompressed bitmaps, this value is equal to 0x0000 and does not specify the size of the image. + +132. biSizeImage = ((biHeader.biWidth \* biHeader.biBitCount + 31) & ~31) / 8 \* biHeader.biHeight + +**biXPelsPerMeter (4 bytes):** MUST be 0x00000000 and MUST be ignored. + +**biYPelsPerMeter (4 bytes):** MUST be 0x00000000 and MUST be ignored. + +**biClrUsed (4 bytes):** Unsigned integer as specified by the **ColorUsed** field of the **BitmapInfoHeader** object specified in [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2) section [2.2.2.3](http://msdn.microsoft.com/en-us/library/567172fa-b8a2-4d79-86a2-5e21d6659ef3/). MUST be 0x00000000. + +**biClrImportant (4 bytes):** Unsigned integer as specified by the **ColorImportant** field of the **BitmapInfoHeader** object specified in \[MS-WMF\] section 2.2.2.3. MUST be 0x00000000. + +#### RGBQuad + +*Referenced by: [TBCBitmap](#Section_24c6da6cfc9f4815ad189a7a3a6d9205)* + +Specifies the pixel color values in a **TBCBitmap** (section 2.3.1.1). + +[TABLE] + +**blue (1 byte):** An unsigned integer that specifies the relative intensity of blue. + +**green (1 byte):** An unsigned integer that specifies the relative intensity of green. + +**red (1 byte):** An unsigned integer that specifies the relative intensity of red. + +**reserved (1 byte):** Undefined and MUST be ignored. + +#### WString + +*Referenced by: [TB](#Section_4b59413771ec456fbaf9ba1dd0a28c5c), [TBCBSpecific](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0), [TBCCDData](#Section_aa9aecdd1d154724adecc1f6bd7e8c59), [TBCExtraInfo](#Section_feebb647ba9c40378718babc740201c5), [TBCGeneralInfo](#Section_99109267262941139ceca9481d6d606d), [TBCMenuSpecific](#Section_912bf645a367471b9d4efc29583a01bc)* + +String structure that [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) customization structures use. This structure specifies a non-null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string. + +[TABLE] + +**cLen (1 byte):** Unsigned integer that specifies the count of characters in this string. + +**data (variable):** Array of Unicode characters. The number of characters in the array MUST be equal to the value of the **cLen** field. Because this is a non-null-terminated Unicode string all of the elements of this string MUST NOT have a value of 0x0000. + +#### SRECT + +*Referenced by: [TBVisualData](#Section_1b41ab5402664559bc7b92a02483362b)* + +Specifies a rectangle structure. + +[TABLE] + +**left (2 bytes):** Signed integer that specifies the position in pixels of the left side of the rectangle. + +**top (2 bytes):** Signed integer that specifies the position in pixels of the top side of the rectangle. + +**right (2 bytes):** Signed integer that specifies the position in pixels of the right side of the rectangle. + +**bottom (2 bytes):** Signed integer that specifies the position in pixels of the bottom side of the rectangle. + +#### TB + +Structure that contains [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) information. + +[TABLE] + +**bSignature (1 byte):** Signed integer that specifies the toolbar signature number. MUST be 0x02. + +**bVersion (1 byte):** Signed integer that specifies the toolbar version number. MUST be 0x01. + +**cCL (2 bytes):** Signed integer that SHOULD[\<2\>](#Appendix_A_2) specify the number of [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) contained in this toolbar. + +**ltbid (4 bytes):** Signed integer that specifies the toolbar ID. MUST be 0x00000001 ([**custom toolbar**](#gt_6ee69c13-ffa9-43b1-989e-a942dceb1fa5) ID). + +**ltbtr (4 bytes):** Unsigned integer of type [**TBTRFlags**](#Section_e51860d90eb74d6b8608a6eaf078dd53) (section 2.3.1.7) that specifies the toolbar type and toolbar restrictions. + +**cRowsDefault (2 bytes):** Unsigned integer that specifies the number of preferred rows for the toolbar when the toolbar is not [**docked**](#gt_96e46041-1a76-4cbf-a612-d918840976be). MUST be less than or equal to 255. + +**bFlags (2 bytes):** Unsigned integer of type [**TBFlags**](#Section_2809bc150e0d4c959444e624aa9b76ec) (section 2.3.1.8). + +**name (variable):** Structure of type [**WString**](#Section_9aa198843ab34da3a4aff2db446befda) (section 2.3.1.4) that specifies the toolbar name. + +#### TBTRFlags + +*Referenced by: [TB](#Section_4b59413771ec456fbaf9ba1dd0a28c5c)* + +[**Toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) type and restrictions flags. The bit description begins from the least significant bit. + +This structure MUST specify the toolbar type which means that the 8 most significant bits MUST have one of the values in the following table. + +| 8 most significant bits of the TBTRFlags structure (section 2.3.1.7) | Meaning | +|----|----| +| 00000000 | Specifies that the toolbar is a [**basic toolbar**](#gt_39d82905-44bc-438d-9b2d-a2cd633a9dd9). | +| 00000010 | Specifies that the toolbar is a [**menu toolbar**](#gt_2eb45441-112f-420b-ab4a-768b569582dc). | + +The rest of the bits in this structure specify toolbar restrictions. A toolbar restriction limits the end user’s ability to change and manipulate the toolbar. + +[TABLE] + +**A - NoAddDelCtl (1 bit):** A bit that specifies whether [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) can be added to or removed from this toolbar. A value of 1 specifies that no toolbar controls can be added or removed from this toolbar. + +**B - NoResize (1 bit):** A bit that specifies whether this toolbar can be resized when not [**docked**](#gt_96e46041-1a76-4cbf-a612-d918840976be). A value of 1 specifies that this toolbar cannot be resized when not docked. + +**C - NoMove (1 bit):** A bit that specifies whether this toolbar can or cannot be moved. A value of 1 specifies that this toolbar cannot be moved. + +**D - NoChangeVisible (1 bit):** A bit that specifies whether the visibility of this toolbar can be changed. A value of 1 specifies that the visibility of this toolbar cannot be changed. + +**E - NoChangeDock (1 bit):** A bit that specifies whether the [**docked location**](#gt_fd188728-2b59-4fd1-aec1-ac2a60c3d567) of this toolbar can or cannot be changed. A value of 1 specifies that the end user cannot change the docked location of this toolbar. + +**F - NoVerticalDock (1 bit):** A bit that specifies whether this toolbar can be vertically docked. A value of 1 specifies that the toolbar cannot be vertically docked. + +**G - NoHorizontalDock (1 bit):** A bit that specifies whether this toolbar can be horizontally docked. A value of 1 specifies that the toolbar cannot be horizontally docked. + +**H - NoBorder (1 bit):** A bit that specifies whether the toolbar has a title bar and a border when not docked. A value of 1 specifies that the toolbar does not have a title bar and a border when not docked. MUST be 1 when the **TBTPopupMenu** field equals 1; MUST be 0 when the **TBTPopupMenu** equals 0. + +**I - NoTbContextMenu (1 bit):** A bit that specifies whether the toolbar shows a [**context menu**](#gt_df0390ab-3a38-4d1c-a74f-1dcfaf7464fc) when right-clicked. A value of 1 specifies that the toolbar will not show a context menu when right-clicked. MUST be 1 when **TBTPopupMenu** equals 1; MUST be 0 when **TBTPopupMenu** equals 0. + +**J - reserved1 (1 bit):** Reserved bit. MUST be 0. + +**K - reserved2 (1 bit):** Reserved bit. MUST be 0. + +**L - NotTopLevel (1 bit):** A bit that specifies whether the toolbar can be a [**top-level toolbar**](#gt_9cf4e9c6-38c4-422c-8190-7ddf53ed9151). A value of 1 specifies that this toolbar is a child of another toolbar, and can never be a top-level toolbar. A value of 0 specifies that this toolbar can be a top-level toolbar. MUST be 1 when the **TBTPopupMenu** field equals 1; MUST be 0 when the **TBTPopupMenu** field equals 0. + +**M - reserved3 (1 bit):** Reserved bit. MUST be 0. + +**N - reserved4 (1 bit):** Reserved bit. MUST be 0. + +**O - reserved5 (1 bit):** Reserved bit. MUST be 0. + +**P - reserved6 (1 bit):** Reserved bit. MUST be 0. + +**Q - reserved7 (1 bit):** Reserved bit. MUST be 0. + +**R - reserved8 (1 bit):** Reserved bit. MUST be 0. + +**S - reserved9 (1 bit):** Reserved bit. MUST be 0. + +**T - reserved10 (1 bit):** Reserved bit. MUST be 0. + +**U - reserved11 (1 bit):** Reserved bit. MUST be 0. + +**V - reserved12 (1 bit):** Reserved bit. MUST be 0. + +**W - reserved13 (1 bit):** Reserved bit. MUST be 0. + +**X - reserved14 (1 bit):** Reserved bit. MUST be 0. + +**Y - reserved15 (1 bit):** Reserved bit. MUST be 0. + +**Z - TBTPopupMenu (1 bit):** A bit that specifies whether this toolbar is of type menu toolbar. A value of 1 specifies that this is a menu toolbar. If the value equals 1, the fields **NoResize**, **NoMove**, **NoChangeDock**, **NoBorder**, **NoTbContextMenu**, and **NotTopLevel** MUST equal 1. + +**a - reserved16 (1 bit):** Reserved bit. MUST be 0. + +**reserved17 (5 bits):** Reserved bits. MUST be 0. + +#### TBFlags + +*Referenced by: [TB](#Section_4b59413771ec456fbaf9ba1dd0a28c5c)* + +[**Toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) flags. The bit description begins from the least significant bit. + +[TABLE] + +**A - fDisabled (1 bit):** A bit that specifies whether this toolbar is disabled. A value of 1 specifies that this toolbar is disabled. + +**B - reserved1 (1 bit):** Undefined and MUST be ignored. + +**C - fCtlModified (1 bit):** A bit that specifies whether the [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) of this toolbar have to be saved to the file. A value of 1 specifies that the toolbar controls of this toolbar have to be saved to the file. MAY be 0 and the toolbar MAY still save its toolbar controls to the file.[\<3\>](#Appendix_A_3) + +**D - fNoAdaptiveMenus (1 bit):** A bit that specifies whether [**adaptive menus**](#gt_6e6d597e-b4ee-4c54-991e-88ced9e12a9c) are disabled for this toolbar. A value of 1 specifies that adaptive menus are disabled for this toolbar. + +**E - fNeedsPositioning (1 bit):** A bit that specifies whether the toolbar’s non-[**docked**](#gt_96e46041-1a76-4cbf-a612-d918840976be) position needs to be updated for display on multiple monitors. A value of 1 specifies that the toolbar's non-docked position needs to be updated for display on multiple monitors. + +**reserved2 (11 bits):** Reserved bits. MUST be 0. + +#### TBVisualData + +Contains visual information about a [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13). The values of some of the fields in this structure are restricted by the toolbar type and restrictions of this toolbar (the value of the **ltbtr** field of the [**TB**](#Section_4b59413771ec456fbaf9ba1dd0a28c5c) structure (section 2.3.1.6) that contains the structure that contains this structure). The restrictions are shown in the following table. + +[TABLE] + +[TABLE] + +**tbds (1 byte):** Signed integer that specifies the current toolbar [**docked**](#gt_96e46041-1a76-4cbf-a612-d918840976be) state. The value MUST be in the following table. + +| Value | Meaning | +|:-----:|-------------------------------------------------------| +| 0x00 | Toolbar is docked on application frame at the left. | +| 0x01 | Toolbar is docked on application frame at the top. | +| 0x02 | Toolbar is docked on application frame at the right. | +| 0x03 | Toolbar is docked on application frame at the bottom. | +| 0x04 | Toolbar is not docked. | + +**tbv (1 byte):** Signed integer that specifies the toolbar visibility. The value MUST be in the following table. + +| Value | Meaning | +|:-----:|-------------------------| +| 0x00 | Toolbar is not visible. | +| 0x01 | Toolbar is visible. | +| 0x02 | Toolbar is visible. | + +**tbdsDock (1 byte):** Signed integer that SHOULD specify the toolbar docked state. The value MUST be in the following table. + +| Value | Meaning | +|:-----:|-------------------------------------------------------| +| 0x00 | Toolbar is docked on application frame at the left. | +| 0x01 | Toolbar is docked on application frame at the top. | +| 0x02 | Toolbar is docked on application frame at the right. | +| 0x03 | Toolbar is docked on application frame at the bottom. | + +If the value of the **tbds** field is less than or equal to 0x03, this value MUST be equal to the value of the **tbds** field. When tbds is greater than 0x03, this field specifies the most recent toolbar dock state. + +**iRow (1 byte):** Signed integer that specifies, when the toolbar is docked, the index of the [**docked location**](#gt_fd188728-2b59-4fd1-aec1-ac2a60c3d567) of the toolbar in the [**docking area**](#gt_25929137-cc77-41d9-af22-d3f449b23dcf) in relation to other toolbars in the docking area. MUST be in the range 0-127 or in the following table. + +| Value | Meaning | +|----|----| +| 0xFE (-2) | Row append. Toolbar is placed on the last row of the docking area. | +| 0xFD (-3) | Row prepend. Toolbar is placed on the first row of the docking area. | + +**rcDock (8 bytes):** Structure of type [**SRECT**](#Section_21c05acf851f4874bdcbd69e94bffed1) (section 2.3.1.5) that specifies the preferred docked location of the toolbar. Refer to the following table for the meaning of the values of each field of this structure. + +| Field of rcDock structure | Meaning | +|----|----| +| **rcDock.left** | Signed integer that specifies the distance in pixels from the left border of the docking area to the left border of the toolbar. | +| **rcDock.top** | Signed integer that specifies the distance in pixels from the top border of the docking area to the top border of the toolbar. | +| **rcDock.right** | Signed integer that specifies the distance in pixels from the left border of the docking area to the right border of the toolbar. | +| **rcDock.bottom** | Signed integer that specifies the distance in pixels from the top border of the docking area to the bottom border of the toolbar. | + +**rcFloat (8 bytes):** Structure of type **SRECT** (section 2.3.1.5) that specifies the preferred toolbar location when the toolbar is not docked. Refer to the following table for the meaning of the values of each field of this structure. + +| Field of rcFloat structure | Meaning | +|----|----| +| **rcFloat.left** | Signed integer that specifies the distance in pixels from the left border of the screen to the left border of the toolbar. | +| **rcFloat.top** | Signed integer that specifies the distance in pixels from the top border of the screen to the top border of the toolbar. | +| **rcFloat.right** | Signed integer that specifies the distance in pixels from the left border of the screen to the right border of the toolbar. | +| **rdFloat.bottom** | Signed integer that specifies the distance in pixels from the top border of the screen to the bottom border of the toolbar. | + +#### TBCHeader + +[**Toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) header information. + +[TABLE] + +**bSignature (1 byte):** Signed integer that specifies the toolbar control signature number. MUST be 0x03. + +**bVersion (1 byte):** Signed integer that specifies the toolbar control version number. MUST be 0x01. + +**bFlagsTCR (1 byte):** Structure of type [**TBCFlags**](#Section_8b35e28b45f14e92ab1a39fa84e0fb2b) (section 2.3.1.11) that specifies toolbar control flags. + +**tct (1 byte):** Unsigned integer that specifies the [**toolbar control type**](#gt_6a54dff3-f66e-4140-9b4d-30643e7e428f). The value MUST be in the following table: + +| Value | Toolbar control type | +|----|----| +| 0x01 | Button control | +| 0x02 | Edit control | +| 0x03 | DropDown control | +| 0x04 | ComboBox control | +| 0x06 | [**SplitDropDown control**](#gt_809470f7-7486-4a44-a50d-2489b32389af) | +| 0x07 | [**OCXDropDown control**](#gt_e139011b-a966-4495-9264-d923ecdfeb66) | +| 0x09 | [**GraphicDropDown control**](#gt_007e8308-eee4-4435-a1f8-e2b27e58f1ac) | +| 0x0A | [**Popup control**](#gt_a259e677-3d9d-47e4-87ba-590fd09734c8) | +| 0x0C | [**ButtonPopup control**](#gt_d638405a-d78b-4c5f-aed2-8616d98d3519) | +| 0x0D | [**SplitButtonPopup control**](#gt_1c046ab6-2530-4a41-8d19-03f92914beaf) | +| 0x0E | [**SplitButtonMRUPopup control**](#gt_01b548cd-095a-4517-a468-1771a038c392) | +| 0x0F | Label control | +| 0x10 | [**ExpandingGrid control**](#gt_b419469c-ed58-4e45-af81-21dd840c8770) | +| 0x12 | [**Grid control**](#gt_3ffa7c43-7cdc-480a-ac6c-f3a624a1bb38) | +| 0x13 | [**Gauge control**](#gt_52882546-dd96-4cff-8bbb-ae3e7d7a0b4c) | +| 0x14 | [**GraphicCombo control**](#gt_b724d1c9-9cf9-4b1f-82fb-a6a1a20748a5) | +| 0x15 | [**Pane control**](#gt_0b77cb34-c2be-4fbe-8f82-df82f7b02b07) | +| 0x16 | [**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) | + +**tcid (2 bytes):** Unsigned integer that specifies the [**toolbar control identifier (TCID)**](#gt_28d9adbd-b340-469a-97cd-3befd6a782b3) for this toolbar control. MUST be 0x0001 when the toolbar control is a [**custom toolbar control**](#gt_75556eac-bd5a-4dc2-b7b5-48c27bfa1c93) or MUST be equal to one of the values listed in [\[MS-CTDOC\]](%5bMS-CTDOC%5d.pdf#Section_aff21c961b434bcf8c8a677e012c7e6a) section 2.2 or in [\[MS-CTXLS\]](%5bMS-CTXLS%5d.pdf#Section_b461dcd9933e471081bcdc1c74801b6b) section 2.2 when the toolbar control is not a custom toolbar control. + +**tbct (4 bytes):** Structure of type [**TBCSFlags**](#Section_df3f6f9b34c6451fad13765c2cb63c09) (section 2.3.1.12) that specifies toolbar control flags. + +**bPriority (1 byte):** Unsigned integer that specifies the toolbar control priority for dropping and wrapping purposes. The value MUST be in the range 0x00 to 0x07. If the value equals 0x00, it is considered the default state. If it equals 0x01 the toolbar control will never be dropped from the [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) and will be wrapped when needed. Otherwise, the higher the number the sooner the toolbar control will be dropped. + +**width (2 bytes):** Unsigned integer that specifies the width, in pixels, of the toolbar control. MUST only exist if **bFlagsTCR.fSaveDxy** equals 1. + +**height (2 bytes):** Unsigned integer that specifies the height, in pixels, of the toolbar control. MUST only exist if **bFlagsTCR.fSaveDxy** equals 1. + +#### TBCFlags + +*Referenced by: [TBCHeader](#Section_6fec0363d40148aaacdf46b7a8bf31db)* + +[**Toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) flags. The bit description begins from the least significant bit. + +| 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | +|-----|-----|-----|-----|-----|-----|-----|-----| +| A | B | C | D | E | F | G | H | + +**A - fHidden (1 bit):** A bit that specifies whether this toolbar control is visible. A value of 1 specifies that the toolbar control is not visible. + +**B - fBeginGroup (1 bit):** A bit that specifies whether a [**toolbar control separator**](#gt_babca65d-f3a3-4f29-b844-fcec439a0964) appears before this toolbar control. A value of 1 specifies that a toolbar control separator appears before the toolbar control. + +**C - fOwnLine (1 bit):** A bit that specifies whether the toolbar control requires its own row. A value of 1 specifies that the toolbar control requires its own row in the [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13). + +**D - fNoCustomize (1 bit):** A bit that specifies whether this toolbar control can be altered by customization. A value of 1 specifies that the toolbar control cannot be altered by customization. + +**E - fSaveDxy (1 bit):** A bit that specifies whether the width and height of the toolbar control have been saved to the file. A value of 1 specifies that the **width** and **height** fields of the **TBCHeader** structure (section 2.3.1.10) that contains this structure MUST exist. + +**F - reserved1 (1 bit):** Reserved bit. Undefined and MUST be ignored. + +**G - fBeginLine (1 bit):** A bit that specifies whether the toolbar control begins a new row in the toolbar. A value of 1 specifies that the toolbar control begins a new row in the toolbar. + +**H - reserved2 (1 bit):** Reserved bit. MUST be 0. + +#### TBCSFlags + +*Referenced by: [TBCHeader](#Section_6fec0363d40148aaacdf46b7a8bf31db)* + +[**Toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) flags that manage specific properties of a toolbar control. The bit description begins from the least significant bit. + +[TABLE] + +**A - textIcon (2 bits):** Unsigned integer that specifies the visibility of the label and icon of this toolbar control. The value MUST be in the following table: + +[TABLE] + +**B - fOwnerDraw (1 bit):** A bit that specifies whether this toolbar control uses an internal rendering option. A value of 1 specifies that this toolbar control uses an internal rendering option. MUST be 0 if the **tcid** value of the **TBCHeader** structure (section 2.3.1.10) that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in [\[MS-CTDOC\]](%5bMS-CTDOC%5d.pdf#Section_aff21c961b434bcf8c8a677e012c7e6a) section 2.2 or in [\[MS-CTXLS\]](%5bMS-CTXLS%5d.pdf#Section_b461dcd9933e471081bcdc1c74801b6b) section 2.2. + +**C - fAllowResize (1 bit):** A bit that specifies whether sizing is allowed for this toolbar control. A value of 1 specifies that toolbar control sizing is allowed. This flag is used when a toolbar control is being initialized and allows for the toolbar control to be smaller or bigger than normal. MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in \[MS-CTDOC\] section 2.2 or in \[MS-CTXLS\] section 2.2. + +**D - fOneState (1 bit):** A bit that specifies whether this is a one-state toolbar control. This bit is only used by toolbar controls of type Button or ExpandingGrid. A value of 1 specifies that the toolbar control can have only one state (ButtonUp, the value of the **state** field of the [**TBCBSFlags**](#Section_d6b3333d6f7042848b41752d3ede4116) structure (section 2.3.1.18) contained in the [**TBCBSpecific**](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0) structure (section 2.3.1.17) contained in the [**TBCData**](#Section_2abc9423fd1b49c490986846ddc07283) structure (section 2.3.1.13) that contains toolbar control information for this toolbar control equals 0). MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in \[MS-CTDOC\] section 2.2 or in \[MS-CTXLS\] section 2.2. + +**E - fNoSetCursor (1 bit):** A bit that specifies whether the toolbar control can change the mouse cursor when it is over the toolbar control area. A value of 1 specifies that the toolbar control can change the mouse cursor when this is over the toolbar control area. MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. SHOULD[\<4\>](#Appendix_A_4) be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +**F - fNoAccel (1 bit):** A bit that specifies whether this toolbar control has [**accelerator keys**](#gt_d61b4a07-b6c1-4c08-9ebd-1d00b360f953). A value of 1 specifies that the toolbar control does not have accelerator keys. MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. SHOULD[\<5\>](#Appendix_A_5) be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +**G - fChgAccel (1 bit):** A bit that specifies whether the accelerator keys for the toolbar control can change. A value of 1 specifies that the accelerator keys can be changed by the application. MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in \[MS-CTDOC\] section 2.2 or in \[MS-CTXLS\] section 2.2. + +**unused1 (8 bits):** Undefined and MUST be ignored. + +**H - fAlwaysEnabled (1 bit):** A bit that specifies whether this toolbar control is enabled by default. A value of 1 specifies that the toolbar control is enabled by default. MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. SHOULD[\<6\>](#Appendix_A_6) be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +**I - fAlwaysVisible (1 bit):** A bit that specifies whether this toolbar control is visible by default. A value of 1 specifies that the toolbar control is visible by default. MUST be 0 if the **tcid** value of the **TBCHeader** structure that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in \[MS-CTDOC\] section 2.2 or in \[MS-CTXLS\] section 2.2. + +**J - fNoChangeLabel (1 bit):** A bit that specifies whether the label of the toolbar control can change. A value of 1 specifies that the toolbar control label does not be changed by the application. MUST be 0 if the **tcid** value of the **TBCHeader** structure (section 2.3.1.10) that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in \[MS-CTDOC\] section 2.2 or in \[MS-CTXLS\] section 2.2. + +**K - fKeepLabel (1 bit):** A bit that specifies whether the label of the toolbar control can change. A value of 1 specifies that the toolbar control label will not be changed by the application unless the toolbar control is reset. + +**L - fNoQueryTooltip (1 bit):** A bit that specifies whether the toolbar control can use an internal string as a [**ToolTip**](#gt_84d44447-feaf-41a4-bf12-004c0f080fc2). A value of 1 specifies that the toolbar control will not use an internal string as a ToolTip. If the toolbar control has a custom ToolTip, it will use it. MUST be 0 if the **tcid** value of the **TBCHeader** structure (section 2.3.1.10) that contains this structure equals 0x0001. If the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001, this value MUST be equal to the value associated with the **tcid** listed in \[MS-CTDOC\] section 2.2 or in \[MS-CTXLS\] section 2.2. + +**M - fSaveUIStrings (1 bit):** A bit that specifies whether none, one, or more of a variety of strings are saved to the file. A value of 1 specifies that one or more of the following fields will be saved to the file: **customText**, **descriptionText**, and **tooltip** fields of the [**TBCGeneralInfo**](#Section_99109267262941139ceca9481d6d606d) structure (section 2.3.1.14) contained by the **TBCData** structure (section 2.3.1.13) contained by the structure that contains the **TBCHeader** structure (section 2.3.1.10) that contains this structure and if this toolbar control is of type Button or ExpandingGrid, the **wstrAcc** field of the **TBCBSpecific** structure (section 2.3.1.17) contained by the **TBCData** structure contained by the structure that contains the **TBCHeader** structure that contains this structure. When the value of the **tcid** field of the **TBCHeader** structure that contains the **TBCSFlags** structure (section 2.3.1.12) that contains this field equals 1, **fSaveUIStrings** is equal to 1, even if no extra strings are saved to the file. + +**N - fExclusivePopup (1 bit):** A bit that specifies whether the toolbar control is going to drop a unique [**custom toolbar**](#gt_6ee69c13-ffa9-43b1-989e-a942dceb1fa5). This bit is only used by toolbar controls that drop a [**menu toolbar**](#gt_2eb45441-112f-420b-ab4a-768b569582dc). A value of 1 specifies that the toolbar control is going to drop a unique custom toolbar. SHOULD[\<7\>](#Appendix_A_7) be 0. + +**O - fDefaultBehavior (1 bit):** A bit that specifies whether the toolbar control will have default behavior during [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) merging. A value of 1 specifies that the toolbar control will have default behavior during OLE merging. A value of 0 specifies that the application can change the behavior of the toolbar control during OLE merging. SHOULD[\<8\>](#Appendix_A_8) be 0. + +**P - unused2 (1 bit):** Undefined and MUST be ignored. + +**Q - fWrapText (1 bit):** A bit that specifies whether the toolbar control can wrap its label across multiple lines. A value of 1 specifies that the label of the toolbar control can wrap across multiple lines. + +**R - fTextBelow (1 bit):** A bit that specifies that the label of the toolbar control will be displayed under the toolbar control icon. A value of 1 specifies that the label of the toolbar control will be displayed under the toolbar control icon, rather than beside it. + +**unused3 (4 bits):** Undefined and MUST be ignored. + +**S - reserved1 (1 bit):** Reserved bit. MUST be 0. + +#### TBCData + +[**Toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) information. + +[TABLE] + +**controlGeneralInfo (variable):** Structure of type [**TBCGeneralInfo**](#Section_99109267262941139ceca9481d6d606d) (section 2.3.1.14) that specifies toolbar control general information. + +**controlSpecificInfo (variable):** Toolbar control specific information is saved depending on the type of the toolbar control which is specified by the value of the **tct** field of the [TBCHeader](#Section_6fec0363d40148aaacdf46b7a8bf31db) structure (section 2.3.1.10) contained by the structure that contains this structure. The following table shows the type of structure that is saved according to the type of the toolbar control: + +| Value of the tct field | Type of the controlSpecificInfo field | +|----|----| +| 0x01 (Button control) | [**TBCBSpecific**](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0) (section 2.3.1.17) | +| 0x10 ([**ExpandingGrid control**](#gt_b419469c-ed58-4e45-af81-21dd840c8770)) | **TBCBSpecific** | +| 0x0A ([**Popup control**](#gt_a259e677-3d9d-47e4-87ba-590fd09734c8)) | [**TBCMenuSpecific**](#Section_912bf645a367471b9d4efc29583a01bc) (section 2.3.1.21) | +| 0x0C ([**ButtonPopup control**](#gt_d638405a-d78b-4c5f-aed2-8616d98d3519)) | **TBCMenuSpecific** | +| 0x0D ([**SplitButtonPopup control**](#gt_1c046ab6-2530-4a41-8d19-03f92914beaf)) | **TBCMenuSpecific** | +| 0x0E ([**SplitButtonMRUPopup control**](#gt_01b548cd-095a-4517-a468-1771a038c392)) | **TBCMenuSpecific** | +| 0x02 (Edit control) | [**TBCComboDropdownSpecific**](#Section_d264bd1960084eb5ba7ce1e12a80c7a3) (section 2.3.1.19) | +| 0x04 (ComboBox control) | **TBCComboDropdownSpecific** | +| 0x14 ([**GraphicCombo control**](#gt_b724d1c9-9cf9-4b1f-82fb-a6a1a20748a5)) | **TBCComboDropdownSpecific** | +| 0x03 (DropDown control) | **TBCComboDropdownSpecific** | +| 0x06 ([**SplitDropDown control**](#gt_809470f7-7486-4a44-a50d-2489b32389af)) | **TBCComboDropdownSpecific** | +| 0x09 ([**GraphicDropDown control**](#gt_007e8308-eee4-4435-a1f8-e2b27e58f1ac)) | **TBCComboDropdownSpecific** | +| 0x07 ([**OCXDropDown control**](#gt_e139011b-a966-4495-9264-d923ecdfeb66)) | **controlSpecificInfo** MUST NOT exist | +| 0x0F (Label control) | **controlSpecificInfo** MUST NOT exist | +| 0x12 ([**Grid control**](#gt_3ffa7c43-7cdc-480a-ac6c-f3a624a1bb38)) | **controlSpecificInfo** MUST NOT exist | +| 0x13 ([**Gauge control**](#gt_52882546-dd96-4cff-8bbb-ae3e7d7a0b4c)) | **controlSpecificInfo** MUST NOT exist | +| 0x15 ([**Pane control**](#gt_0b77cb34-c2be-4fbe-8f82-df82f7b02b07)) | **controlSpecificInfo** MUST NOT exist | +| 0x16 ([**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2)) | **controlSpecificInfo** MUST NOT exist | + +#### TBCGeneralInfo + +*Referenced by: [TBCData](#Section_2abc9423fd1b49c490986846ddc07283)* + +[**Toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) general information. + +[TABLE] + +**bFlags (1 byte):** Structure of type [**TBCGIFlags**](#Section_5a7caae568844e45b93687022aa2f2d6) (section 2.3.1.15) that specifies which of the fields of this structure have been saved to the file. + +**customText (variable):** Optional. Structure of type [**WString**](#Section_9aa198843ab34da3a4aff2db446befda) (section 2.3.1.4) that specifies the custom label of the toolbar control. MUST exist if **bFlags.fSaveText** equals 1. MUST NOT exist if **bFlags.fSaveText** equals 0. + +**descriptionText (variable):** Optional. Structure of type **WString** that specifies a description of this toolbar control. MUST exist if **bFlags.fSaveMiscUIStrings** equals 1. MUST NOT exist if **bflags.fSaveMiscUIString** equals 0. + +**tooltip (variable):** Optional. Structure of type **WString** that SHOULD specify the [**ToolTip**](#gt_84d44447-feaf-41a4-bf12-004c0f080fc2) of this toolbar control. MUST exist if **bFlags.fSaveMiscUIStrings** equals 1. MUST NOT exist if **bFlags.fSaveMiscUIStrings** equals 0. If the toolbar control is of type Button or ExpandingGrid, and the fHyperlinkType field of the TBCBSFlags structure (section [2.3.1.18](#Section_d6b3333d6f7042848b41752d3ede4116)) contained by the TBCBSpecific structure (section [2.3.1.17](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0)), contained by the TBCData structure (section 2.3.1.13) that contains the TBCGeneralInfo structure (section 2.3.1.14) that contains this structure does not equal 0, the value of tooltip specifies the hyperlink path for the toolbar control. + +**extraInfo (variable):** Optional. Structure of type [**TBCExtraInfo**](#Section_feebb647ba9c40378718babc740201c5) (section 2.3.1.16) that specifies extra information saved for a toolbar control. MUST exist if **bFlags.fSaveMiscCustom** equals 1. MUST NOT exist if **bFlags.fSaveMiscCustom** equals 0. + +#### TBCGIFlags + +*Referenced by: [TBCGeneralInfo](#Section_99109267262941139ceca9481d6d606d)* + +[**Toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) general information flags that specify which fields in the **TBCGeneralInfo** structure (section 2.3.1.14) that contains this structure will be saved to the file. The bit description begins from the least significant bit. + +[TABLE] + +**A - fSaveText (1 bit):** A bit that specifies whether the toolbar control will save its custom text. A value of 1 specifies that the **customText** field of the **TBCGeneralInfo** structure (section 2.3.1.14) that contains this structure MUST exist. If the value equals 1, the value of the **fSaveUIStrings** field of the [**TBCSFlags**](#Section_df3f6f9b34c6451fad13765c2cb63c09) structure (section 2.3.1.12) contained by the [**TBCHeader**](#Section_6fec0363d40148aaacdf46b7a8bf31db) structure (section 2.3.1.10) contained by the structure that contains the [TBCData](#Section_2abc9423fd1b49c490986846ddc07283) structure (section 2.3.1.13) that contains the **TBCGeneralInfo** structure (section 2.3.1.14) that contains this structure MUST be 1. + +**B - fSaveMiscUIStrings (1 bit):** A bit that specifies whether the toolbar control will save its description and [**ToolTip**](#gt_84d44447-feaf-41a4-bf12-004c0f080fc2) strings. A value of 1 specifies that the **descriptionText** and **tooltip** fields of the **TBCGeneralInfo** structure that contains this structure MUST exist. If the value equals 1, the value of the **fSaveUIStrings** field of the **TBCSFlags** structure contained by the **TBCHeader** structure contained by the structure that contains the **TBCData** structure that contains the **TBCGeneralInfo** structure that contains this structure MUST be 1. + +**C - fSaveMiscCustom (1 bit):** A bit that specifies whether the toolbar control will save toolbar control extra information. A value of 1 specifies that the **extraInfo** field of the **TBCGeneralInfo** structure that contains this structure MUST exist. + +**D - fDisabled (1 bit):** A bit that specifies whether the toolbar control is disabled. A value of 1 specifies that the toolbar control is disabled. + +**Unused (4 bits):** Undefined and MUST be ignored. + +#### TBCExtraInfo + +*Referenced by: [TBCGeneralInfo](#Section_99109267262941139ceca9481d6d606d)* + +Structure that specifies extra information saved for a [**toolbar control**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). + +[TABLE] + +**wstrHelpFile (variable):** A structure of type [**WString**](#Section_9aa198843ab34da3a4aff2db446befda) (section 2.3.1.4) that specifies the full path to the help file used to provide the help topic of the toolbar control. For this field to be used **idHelpContext** MUST be greater than zero. + +**idHelpContext (4 bytes):** Signed integer that specifies the help context id number for the help topic of the toolbar control. A help context id is a numeric identifier associated with a specific help topic. For this field to be used **wstrHelpFile** MUST specify a non-empty string. + +**wstrTag (variable):** Structure of type **WString** that specifies a custom string used to store arbitrary information about the toolbar control. + +**wstrOnAction (variable):** Structure of type **WString** that specifies the name of the macro associated with this toolbar control. + +**wstrParam (variable):** Structure of type **WString** that specifies a custom string used to store arbitrary information about the toolbar control. + +**tbcu (1 byte):** Signed integer that specifies how the toolbar control will be used during [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) merging. The value MUST be in the following table. + +| Value | Meaning | +|----|----| +| 0xFF | A correct value was not found for this toolbar control. A value of 0x01 will be used when the value of this field is requested. | +| 0x00 | Neither. Toolbar control is not applicable when the application is in either OLE host mode or OLE server mode. | +| 0x01 | Server. Toolbar control is applicable when the application is in OLE server mode. (This is the default value used by [**custom toolbar controls**](#gt_75556eac-bd5a-4dc2-b7b5-48c27bfa1c93).) | +| 0x02 | Host. Toolbar control is applicable when the application is in OLE host mode. | +| 0x03 | Both. Toolbar control is applicable when the application is in OLE server mode and OLE host mode. | + +**tbmg (1 byte):** Signed integer that specifies how the toolbar control will be used during OLE menu merging. This field is only used by toolbar controls of type Popup. The value MUST be in the following table. + +| Value | Meaning | +|----|----| +| 0xFF | None. Toolbar control will not be placed in any OLE menu group. | +| 0x00 | File. Toolbar control will be placed in the File OLE menu group. | +| 0x01 | Edit. Toolbar control will be placed in the Edit OLE menu group. | +| 0x02 | Container. Toolbar control will be placed in the Container OLE menu group. | +| 0x03 | Object. Toolbar control will be placed in the Object OLE menu group. | +| 0x04 | Window. Toolbar control will be placed in the Window OLE menu group. | +| 0x05 | Help. Toolbar control will be placed in the Help OLE menu group. | + +#### TBCBSpecific + +Contains information specific to button and **ExpandingGrid** type [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). + +[TABLE] + +**bFlags (1 byte):** Structure of type [**TBCBSFlags**](#Section_d6b3333d6f7042848b41752d3ede4116) section 2.3.1.18) that specifies which fields of this structure are saved to the file. + +**icon (variable):** Optional. Structure of type [**TBCBitmap**](#Section_24c6da6cfc9f4815ad189a7a3a6d9205) (section 2.3.1.1) that specifies the icon data for this toolbar control. MUST exist if **bFlags.fCustomBitmap** equals 1. MUST NOT exist if **bFlags.fCustomBitmap** equals 0. + +**iconMask (variable):** Optional. Structure of type **TBCBitmap** (section 2.3.1.1) that specifies the icon data mask for this toolbar control. MUST exist if **bFlags.fCustomBitmap** equals 1. MUST NOT exist if **bFlags.fCustomBitmap** equals 0. The value of the **biBitCount** field of the [**BITMAPINFOHEADER**](#Section_5eb5fc23797e4e428ef1ef844994d7d4) (section 2.3.1.2) contained by this **TBCBitmap** MUST be 0x01. The **iconMask** is used to specify the transparency of the icon. The **iconMask** is white in all the areas in which the icon is displayed as transparent and is black in all other areas. + +**iBtnFace (2 bytes):** Optional. Unsigned integer that specifies the icon of the toolbar control. When this value is set, the toolbar control will use the icon of the toolbar control whose [**toolbar control identifier (TCID)**](#gt_28d9adbd-b340-469a-97cd-3befd6a782b3) equals this value. MUST exist if **bFlags.fCustomBtnFace** equals 1. MUST NOT exist if **bFlags.fCustomBtnFace** equals 0. + +**wstrAcc (variable):** Optional. Structure of type [**WString**](#Section_9aa198843ab34da3a4aff2db446befda) (section 2.3.1.4) that specifies the [**accelerator keys**](#gt_d61b4a07-b6c1-4c08-9ebd-1d00b360f953) for this toolbar control. MUST exist if **bFlags.fAccelerator** equals 1. MUST NOT exist if **bFlags.fAccelerator** equals 0. + +#### TBCBSFlags + +*Referenced by: [TBCBSpecific](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0)* + +Contains flags for Button and ExpandingGrid type [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). The bit description begins from the least significant bit. + +[TABLE] + +**A - state (2 bits):** Unsigned integer that specifies the toolbar control state. The value MUST be in the following table. + +| Value (value of bits in parenthesis) | Meaning | +|--------------------------------------|---------------------------| +| 0x00 (00) | Button is up. | +| 0x01 (01) | Button is down (pushed). | +| 0x03 (11) | Button is in mixed state. | + +**B - fAccelerator (1 bit):** A bit that specifies whether the **wstrAcc** field of the **TBCBSpecific** structure (section 2.3.1.17) that contains this structure has been saved to the file. A value of 1 specifies that the **wstrAcc** field of the **TBCBSpecific** structure (section 2.3.1.17) that contains this structure MUST exist. If the value equals 1, the value of the **fSaveUIStrings** field of the [**TBCSFlags**](#Section_df3f6f9b34c6451fad13765c2cb63c09) structure (section 2.3.1.12) contained by the [**TBCHeader**](#Section_6fec0363d40148aaacdf46b7a8bf31db) structure (section 2.3.1.10) contained by the structure that contains the [**TBCData**](#Section_2abc9423fd1b49c490986846ddc07283) structure (section 2.3.1.13) that contains the **TBCBSpecific** structure (section 2.3.1.17) that contains this structure MUST be 1. + +**C - fCustomBitmap (1 bit):** A bit that specifies whether the toolbar control has a custom icon. A value of 1 specifies that the **icon** and **iconMask** fields of the **TBCBSpecific** structure that contains this structure MUST exist. + +**D - fCustomBtnFace (1 bit):** A bit that specifies whether the toolbar control is using an alternate icon as its own. A value of 1 specifies that the **iBtnFace** field of the **TBCBSpecific** structure that contains this structure MUST exist. + +**E - fHyperlinkType (2 bits):** Unsigned integer that specifies the type of [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) associated with this toolbar control. The value MUST be in the following table. + +| Value (value of bits in parenthesis) | Hyperlink type | +|----|----| +| 0x00 (00) | No hyperlink. This toolbar control does not have a hyperlink. | +| 0x01 (01) | Open in browser. The hyperlink will be opened in the default browser. | +| 0x02 (10) | Image link. The hyperlink links to an image file. | + +**F - reserved1 (1 bit):** Reserved bit. SHOULD[\<9\>](#Appendix_A_9) be 1. + +#### TBCComboDropdownSpecific + +Contains information specific to Edit, ComboBox, GraphicCombo, DropDown, SplitDropDown, and GraphicDropDown type [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). + +[TABLE] + +**data (variable):** Optional. Structure of type [**TBCCDData**](#Section_aa9aecdd1d154724adecc1f6bd7e8c59) (section 2.3.1.20). MUST exist if the [**toolbar control identifier (TCID)**](#gt_28d9adbd-b340-469a-97cd-3befd6a782b3) (the **tcid** field of the [**TBCHeader**](#Section_6fec0363d40148aaacdf46b7a8bf31db) structure (section 2.3.1.10) contained by the structure that contains the [**TBCData**](#Section_2abc9423fd1b49c490986846ddc07283) structure (section 2.3.1.13) that contains this structure) equals 0x0001. MUST NOT exist if the TCID does not equal 0x0001. + +#### TBCCDData + +*Referenced by: [TBCComboDropdownSpecific](#Section_d264bd1960084eb5ba7ce1e12a80c7a3)* + +Contains information specific to Edit, ComboBox, GraphicCombo, DropDown, SplitDropDown, and GraphicDropDown type [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). + +[TABLE] + +**cwstrItems (2 bytes):** Signed integer that specifies the number of items in **wstrList**. MUST be positive. + +**wstrList (variable):** Zero-based index array of [**WString**](#Section_9aa198843ab34da3a4aff2db446befda) structures (section 2.3.1.4). The number of elements MUST be equal to **cwstrItems**. Contains the list of strings that are dropped by this toolbar control. + +**cwstrMRU (2 bytes):** Signed integer that specifies the number of most recently used strings. MUST be equal to 0xFFFF (-1) or greater than or equal to 0x0000. A value of 0xFFFF (-1) means that there are no most recently used strings. + +**iSel (2 bytes):** Signed integer that specifies the zero-based index of the selected item in the **wstrList** field. MUST be equal to 0xFFFF (-1) or greater than or equal to 0x0000. A value of 0xFFFF (-1) means that there is no selected item. MUST be less than the **cwstrItems** value. + +**cLines (2 bytes):** Signed integer that specifies the suggested number of lines that the toolbar control will display at any time when displaying the elements of **wstrList**. A value of 0x0000 means that the toolbar control will size itself according to the number of items. MUST equal to or greater than 0x0000. + +**dxWidth (2 bytes):** Signed integer that specifies the width in pixels that the interior of the drop-down has. This excludes the width of the toolbar control border and scroll bar. MUST be equal to 0xFFFF (-1) or greater than or equal to 0x0000. A value of 0xFFFF (-1) will set the width to accommodate all the strings in **wstrList**. + +**wstrEdit (variable):** Structure of type **WString** (section 2.3.1.4). Editable text for editable area of the ComboBox toolbar control. + +#### TBCMenuSpecific + +Contains information specific to **Popup**, **ButtonPopup**, **SplitButtonPopup**, and **SplitButtonMRUPopup** type [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d). + +[TABLE] + +**tbid (4 bytes):** Signed integer that specifies the [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) ID of the toolbar that the toolbar control drops. MUST be greater than or equal to 0x00000000. A value of 0x00000000 means that the toolbar control does not drop a toolbar. A value of 0x00000001 means that the toolbar control drops a [**custom toolbar**](#gt_6ee69c13-ffa9-43b1-989e-a942dceb1fa5). A value greater than 0x00000001 means that the toolbar control drops a built-in toolbar. See [\[MS-CTDOC\]](%5bMS-CTDOC%5d.pdf#Section_aff21c961b434bcf8c8a677e012c7e6a) section 2.1 and [\[MS-CTXLS\]](%5bMS-CTXLS%5d.pdf#Section_b461dcd9933e471081bcdc1c74801b6b) section 2.1 for a list of toolbar identifiers associated with built-in toolbars. + +**name (variable):** Optional. Structure of type [**WString**](#Section_9aa198843ab34da3a4aff2db446befda) (section 2.3.1.4). Name of the custom toolbar that the toolbar control drops. MUST exist if **tbid** equals 0x00000001. MUST NOT exist if **tbid** is not equal to 0x00000001. + +### Visual Basic for Applications Digital Signature Storage + +Specifies the format of the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) for [**Visual Basic for Applications (VBA)**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) projects. + +#### DigSigInfoSerialized + +*Referenced by: [DigSigBlob](#Section_bc21c922b7ae473690aa86afb6403462), [WordSigBlob](#Section_0a2166b32e294b12886dd89f23c6824c)* + +Specifies the detailed data of a [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189). + +[TABLE] + +**cbSignature (4 bytes):** An unsigned integer that specifies the size of the **pbSignatureBuffer** field in bytes. + +**signatureOffset (4 bytes):** An unsigned integer that specifies the offset of the **pbSignatureBuffer** field relative to the beginning of this structure’s parent **DigSigBlob** (section 2.3.2.2); or if the parent is a **WordSigBlob** (section 2.3.2.3), the offset is relative to the beginning of the parent’s **cbSigInfo** field. + +**cbSigningCertStore (4 bytes):** An unsigned integer that specifies the size of the **pbSigningCertStoreBuffer** field in bytes. + +**certStoreOffset (4 bytes):** An unsigned integer that specifies the offset of the **pbSigningCertStoreBuffer** field relative to the start of this structure’s parent **DigSigBlob** (section 2.3.2.2); or if the parent is a **WordSigBlob** (section 2.3.2.3), the offset is relative to the start of the parent’s **cbSigInfo** field. + +**cbProjectName (4 bytes):** An unsigned integer that specifies the count in bytes of the **rgchProjectNameBuffer** field, not including the null-terminating character. MUST be 0x00000000. + +**projectNameOffset (4 bytes):** An unsigned integer that specifies the offset of the **rgchProjectNameBuffer** field relative to the beginning of this structure’s parent **DigSigBlob** (section 2.3.2.2); or if the parent is a **WordSigBlob** (section 2.3.2.3), the offset is relative to the beginning of the parent’s **cbSigInfo** field. + +**fTimestamp (4 bytes):** This field is reserved and MUST be 0x00000000. MUST ignore on reading. + +**cbTimestampUrl (4 bytes):** An unsigned integer that specifies the count in bytes of the **rgchTimestampBuffer** field, not including the null-terminating character. MUST be 0x00000000. + +**timestampUrlOffset (4 bytes):** An unsigned integer that specifies the offset of the **rgchTimestampBuffer** field relative to the beginning of this structure’s parent **DigSigBlob** (section 2.3.2.2); or if the parent is a **WordSigBlob** (section 2.3.2.3), the offset is relative to the beginning of the parent’s **cbSigInfo** field. + +**pbSignatureBuffer (variable):** An array of bytes that specifies the [**VBA Digital Signature**](#Section_7c4ce2e22a714b028f51b9f0eeed756a) (section 2.3.2.4) of the VBA project. + +**pbSigningCertStoreBuffer (variable):** A [VBASigSerializedCertStore](#Section_e88d644c80f84016a2c093fc5b110877) structure (section 2.3.2.5.5) containing the public [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) information of the certificate used to create the digital signature. + +**rgchProjectNameBuffer (variable):** A null-terminated array of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. The field is reserved and MUST be a single null Unicode character (0x0000). + +**rgchTimestampBuffer (variable):** A null-terminated array of Unicode characters. The field is reserved and MUST be a single null Unicode character (0x0000). + +#### DigSigBlob + +*Referenced by: [VtDigSigValue](#Section_a7c3987feaa64f8cbc5cf0dd124eb32f)* + +Specifies the layout of the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) data. + +[TABLE] + +**cb (4 bytes):** An unsigned integer that specifies the size of the **signatureInfo** and **padding** fields combined, in bytes. + +**serializedPointer (4 bytes):** An unsigned integer that specifies the offset of the **signatureInfo** field within this structure. MUST be 0x00000008. + +**signatureInfo (variable):** A [**DigSigInfoSerialized**](#Section_30a00273dbee422fb488f4b8430ae046) structure (section 2.3.2.1) containing the data for the signature. + +**padding (variable):** An array of bytes. The size of this array is the number of bytes necessary to pad the size of the **signatureInfo** field to a multiple of 4 bytes. The contents of this field are undefined and MUST be ignored. + +#### WordSigBlob + +Specifies the layout of the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) data when it is wrapped as a length-prefixed [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character string. + +[TABLE] + +**cch (2 bytes):** An unsigned integer that specifies half the count of bytes of the remainder of the structure. MUST be the value given by the following formula. + +cch = (**cbSigInfo** + (**cbSigInfo** mod 2) + 8) / 2 + +**cbSigInfo (4 bytes):** An unsigned integer that specifies the size of the **signatureInfo** field in bytes. + +**serializedPointer (4 bytes):** An unsigned integer that specifies the offset of the **signatureInfo** field within this structure relative to the **cbSigInfo** field. MUST be 0x00000008. + +**signatureInfo (variable):** A [**DigSigInfoSerialized**](#Section_30a00273dbee422fb488f4b8430ae046) structure (section 2.3.2.1) containing the data for the signature. + +**padding (variable):** An array of bytes. The size of this array is the number of bytes necessary to pad the entire structure’s size to a multiple of 2 bytes. The contents of this field are undefined and MUST be ignored. + +#### VBA Digital Signature + +The [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) MUST be a PKCS \#7 **SignedData** ([\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681) section 9.1) structure, constrained as specified in the following sections. The following section uses ASN.1 notation [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) to specify the data format where applicable. + +##### SignedData Constraints + +The **SignedData** structure ([\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681) section 9.1) specifying the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) MUST conform to the following constraints: + +- +- +- +- +- + +##### The **digestAlgorithms** field MUST contain only one **digestAlgorithmIdentifier** (\[PKCS7\] section 6.3), and that **digestAlgorithmIdentifier** MUST specify the identifier of the algorithm used to create the digest of the signature.[\<10\>](#Appendix_A_10)The **contentInfo** field’s **contentType** MUST be an **Object Identifier** [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) with the value "1.3.6.1.4.1.311.2.1.4". The **content** field of the **contentInfo** of this **SignedData** structure MUST be a [**SpcIndirectDataContent**](#Section_1537695a28f048288b7bd6dab62b8030) structure (section 2.3.2.4.3.1).The **certificates** field MUST contain certificates as specified by \[PKCS7\] section 9.1. This MUST include the signature verification certificate and can contain any intermediate certificates between that end entity and the root, including the root. If the **SignedData** contains a **Countersignature** ([\[PKCS9\]](https://go.microsoft.com/fwlink/?LinkId=510682) section 6.6), the certificates associated with the **Countersignature** also MUST be contained in the **certificates** field.The **crls** field SHOULD be absent. If present, the **crls** field MUST be ignored.The **signerInfos** field MUST contain a single [**SignerInfo**](#Section_05ee163f764f40cf921c400bd104a665) structure (section 2.3.2.4.2) (\[PKCS7\] section 9.2).SignerInfo Constraints + +The **SignerInfo** in the [**SignedData**](#Section_708462617bc14c3094fe29ebf7f697ff) structure (section 2.3.2.4.1) MUST conform to the following constraints: + +- +- - + - +- - + - +- + +##### The [**authenticatedAttributes**](#Section_e0c3e0df4ced45339a3014caaf94cd83) (section 2.3.2.4.4) field MUST be present.This field MUST contain the following attributes:A **content-type** attribute with its value set as specified in [\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681) section 9.2.A **message-digest** attribute with its value set as specified in \[PKCS7\] section 9.2.This field can also contain:One [**SpcStatementType**](#Section_c541e3e43d044cbd82db1b73163427fd) attribute (section 2.3.2.4.4.1), but this attribute MUST be ignored.One [**SpcSpOpusInfo**](#Section_917556324b0d44ca89a99699afbbd268) attribute (section 2.3.2.4.4.2).If the signature has been timestamped, then the [**unauthenticatedAttributes**](#Section_2dca257e8a014526adc2bbc62861f05b) field (section 2.3.2.4.5) MUST be present and MUST contain a single **Countersignature** attribute ([\[PKCS9\]](https://go.microsoft.com/fwlink/?LinkId=510682) section 6.6). If the signature has not been timestamped, the **unauthenticatedAttributes** field MUST be absent.SignedData contentInfo Structures + +The **contentInfo** field of the [**SignedData**](#Section_708462617bc14c3094fe29ebf7f697ff) structure (section 2.3.2.4.1) MUST be a [**SpcIndirectDataContent**](#Section_1537695a28f048288b7bd6dab62b8030) structure (section 2.3.2.4.3.1) or a **SpcIndirectDataContentV2** structure (section [2.3.2.4.3.2](#Section_b44805870ab848428323961c477da0e6)) formatted as specified in the corresponding section. The type of the **contentInfo** field MUST be specified by the consumer of the [**DigSigBlob**](#Section_bc21c922b7ae473690aa86afb6403462) (section 2.3.2.2) or [**WordSigBlob**](#Section_0a2166b32e294b12886dd89f23c6824c) (section 2.3.2.3) structures. + +###### SpcIndirectDataContent + +This structure specifies data about the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) and contains the [**hash**](#gt_b7e2b611-0af5-4fec-8af2-3f9ce7bad205) of the data that is to be signed. This structure is specified by the following ASN.1 [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) notation. + +133. SpcIndirectDataContent ::= SEQUENCE { + + data SpcAttributeTypeAndOptionalValue, + + messageDigest DigestInfo + + } + + SpcAttributeTypeAndOptionalValue ::= SEQUENCE { + + type OBJECT IDENTIFIER, + + value \[0\] EXPLICIT ANY OPTIONAL + + } + + DigestInfo ::= SEQUENCE { + + digestAlgorithm AlgorithmIdentifier, + + digest OCTETSTRING + + } + + AlgorithmIdentifier ::= SEQUENCE { + + algorithm OBJECT IDENTIFIER, + + parameters \[0\] EXPLICIT ANY OPTIONAL + + } + +The **SpcIndirectDataContent** structure’s fields MUST be constrained as follows: + +- +- + +The **data** field MUST be a **SpcAttributeTypeAndOptionalValue** structure.The **messageDigest** field MUST be a **DigestInfo** structure.The **SpcAttributeTypeAndOptionalValue** structure fields MUST be constrained as follows: + +- +- + +The **type** field MUST be an **Object Identifier** \[ITUX680\] with the value 1.3.6.1.4.1.311.2.1.29.The **value** field SHOULD be set to a zero byte **OCTETSTRING** (\[ITUX680\]. If the field has any data associated with it, the data MUST be ignored.The **DigestInfo** structure’s fields MUST be constrained as follows: + +- +- + +###### The **digestAlgorithm** field MUST be an **AlgorithmIdentifier** structure. The **algorithm** field of **digestAlgorithm** specifies the **Object Identifier** \[ITUX680\] of the digest algorithm that was used to hash the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project contents, producing the value for the **digest** field. This **Object Identifier** \[ITUX680\] value MUST be set to the same algorithm identifier as specified in the **digestAlgorithm** field of the [**SignedData**](#Section_708462617bc14c3094fe29ebf7f697ff) structure (section 2.3.2.4.1). The **parameters** field of **digestAlgorithm** MUST be set to the **Null** type \[ITUX680\] with a length of zero.The **digest** field MUST be an **OCTETSTRING** \[ITUX680\]. The value of the **OCTETSTRING** MUST be produced by means of the hash algorithm specified in [\[MS-OVBA\]](%5bMS-OVBA%5d.pdf#Section_575462babf6741909facc275523c75fc) section 2.4.2.SpcIndirectDataContentV2 + +This structure specifies data about the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) and contains the [**hash**](#gt_b7e2b611-0af5-4fec-8af2-3f9ce7bad205) of the data that is to be signed. This structure is specified by the following ASN.1 [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) notation. + +152. SpcIndirectDataContentV2 ::= SEQUENCE { + + data SpcAttributeTypeAndOptionalValue, + + messageDigest DigestInfo + + } + + SpcAttributeTypeAndOptionalValue ::= SEQUENCE { + + type OBJECT IDENTIFIER, + + value \[0\] EXPLICIT ANY OPTIONAL + + } + + DigestInfo ::= SEQUENCE { + + digestAlgorithm AlgorithmIdentifier, + + digest OCTETSTRING + + } + + AlgorithmIdentifier ::= SEQUENCE { + + algorithm OBJECT IDENTIFIER, + + parameters \[0\] EXPLICIT ANY OPTIONAL + + } + + SigFormatDescriptorV1 ::= SEQUENCE { + + size INTEGER, + + version INTEGER, + + format INTEGER + + } + + SigDataV1Serialized ::= SEQUENCE { + + algorithmIdSize INTEGER, + + compiledHashSize INTEGER, + + sourceHashSize INTEGER, + + algorithmIdOffset INTEGER, + + compiledHashOffset INTEGER, + + sourceHashOffset INTEGER, + + algorithmId OBJECT IDENTIFIER, + + compiledHash + + sourceHash **OCTETSTRING** + + } + +The fields of the **SpcIndirectDataContentV2** structure MUST be constrained as follows: + +- +- + +The **data** field MUST be a **SpcAttributeTypeAndOptionalValue** structure.The **messageDigest** field MUST be a **DigestInfo** structure.The **SpcAttributeTypeAndOptionalValue** structure fields MUST be constrained as follows: + +- +- + +The **type** field MUST be an **Object Identifier** \[ITUX680\] with the value 1.3.6.1.4.1.311.2.1.31.The **value** field MUST be an **OCTETSTRING** \[ITUX680\]. The value MUST contain the DER encoding ASN.1 data of a **SigFormatDescriptorV1** structure.The **SigFormatDescriptorV1** structure fields MUST be constrained as follows: + +- +- +- + +The **size** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to the size of the structure.The **version** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to 1.The **format** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to 1.The **DigestInfo** structure’s fields MUST be constrained as follows: + +- +- + +The **digestAlgorithm** field MUST be an **AlgorithmIdentifier** structure. The **algorithm** field of **digestAlgorithm** specifies the **Object Identifier** \[ITUX680\] of the digest algorithm that was used to hash the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project contents, producing the value for the **digest** field. This **Object Identifier** \[ITUX680\] value MUST be set to the same algorithm identifier as specified in the **digestAlgorithm** field of the [**SignedData**](#Section_708462617bc14c3094fe29ebf7f697ff) structure (section 2.3.2.4.1). The **parameters** field of **digestAlgorithm** MUST be set to the **Null** type \[ITUX680\] with a length of zero.The **digest** field MUST be an **OCTETSTRING** \[ITUX680\]. The value MUST contain the DER encoding ASN.1 data of a **SigDataV1Serialized** structure.The **SigDataV1Serialized** structure fields MUST be constrained as follows: + +- +- +- +- +- +- +- +- +- + +##### The **algorithmIdSize** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to the size of the **algorithmId** field.The **compiledHashSize** field SHOULD be zero.The **sourceHashSize** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to the size of the **sourceHash** field.The **algorithmIdOffset** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to the position in bytes of the **algorithmId** field from the beginning of the structure.The **compiledHashOffset** field SHOULD be zero.The **sourceHashOffset** field MUST be an **INTEGER** \[ITUX680\] and the value MUST be equal to the position in bytes of the **sourceHash** field from the beginning of the structure.The **algorithmId** field specifies the **Object Identifier** \[ITUX680\] of the digest algorithm that was used to hash the VBA project contents, producing the value for the **digest** field. This **Object Identifier** \[ITUX680\] value MUST be set to the same algorithm identifier as specified in the **digestAlgorithm** field of the **SignedData** structure.The **compiledHash** field SHOULD be empty.The **sourceHash** field MUST be an **OCTETSTRING** \[ITUX680\]. The value of the **OCTETSTRING** MUST be produced by means of the hash algorithm specified in [\[MS-OVBA\]](%5bMS-OVBA%5d.pdf#Section_575462babf6741909facc275523c75fc) section 2.4.2.SignerInfo authenticatedAttributes Structures + +This section specifies the attribute data that is stored in the **authenticatedAttributes** field of the [**SignerInfo**](#Section_05ee163f764f40cf921c400bd104a665) structure (section 2.3.2.4.2). + +###### SpcStatementType + +This structure is specified by the following ASN.1 [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) notation. + +190. SpcStatementType ::= SEQUENCE of OBJECT IDENTIFIER + +The **SpcStatementType** MUST contain one **Object Identifier** \[ITUX680\] with either the value 1.3.6.1.4.1.311.2.1.21 or 1.3.6.1.4.1.311.2.1.22. The **SpcStatementType** MUST be ignored. + +###### SpcSpOpusInfo + +This structure is specified by the following ASN.1 [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) notation. + +191. SpcSpOpusInfo ::= SEQUENCE { + + programName \[0\] EXPLICIT SpcString OPTIONAL, + + moreInfo \[1\] EXPLICIT SpcLink OPTIONAL + + } + +The **programName** field MUST be set to a [**SpcString**](#Section_d5bcc38d051f47758c4474d52e301702) structure (section 2.3.2.4.4.3). The value of the string contained in this structure specifies the description of the project for which the signature was created. The **unicode** field within the **SpcString** **programName** SHOULD have a value that is a 0 length **BMPSTRING** \[ITUX680\]. A value other than an empty string MAY[\<11\>](#Appendix_A_11) be provided. + +The **moreInfo** field MUST be set to a [**SpcLink**](#Section_7cb90c30902f48d7a5ee686ce1ff0d36) structure (section 2.3.2.4.4.4) if present. If present the value of the **url** field within the **SpcLink** structure specifies a [**Uniform Resource Locator (URL)**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) to associate with the signature.[\<12\>](#Appendix_A_12) + +###### SpcString + +This structure is specified by the following ASN.1 [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) notation. + +195. SpcString ::= CHOICE { + + unicode \[0\] IMPLICIT BMPSTRING + + } + +The **unicode** field MUST be of the **BMPSTRING** \[ITUX680\] type. + +###### SpcLink + +This structure is specified by the following ASN.1 \[ITUX680\] notation. + +198. SpcLink ::= CHOICE { + + url \[0\] IMPLICIT IA5STRING + + } + +The **url** field MUST be of the **IA5STRING** \[ITUX680\] type. The structure specifies a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) resource by using the [**Uniform Resource Locator (URL)**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1). + +##### SignerInfo unauthenticatedAttributes + +A **Countersignature** located in the [**SignerInfo**](#Section_05ee163f764f40cf921c400bd104a665) (section 2.3.2.4.2) **unauthenticatedAttributes** field SHOULD be generated by a trusted third-party [**time stamp authority**](#gt_3247e47d-5652-471c-8c7a-58e90420a0d8) (TSA). Its purpose is to assert that the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project signature existed prior to the time specified in the **SigningTime** attribute, specified in the following attributes. + +The **Countersignature** used MUST consist of the following attributes in the **unauthenticatedAttributes** field: + +- +- +- + +**ContentType** ([\[PKCS9\]](https://go.microsoft.com/fwlink/?LinkId=510682) section 6.3): The attribute’s value MUST be set to PKCS \#7 **Data** ([\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681) section 8).**SigningTime** (\[PKCS9\] section 6.5): The value MUST be set as specified by \[PKCS9\] section 6.5.**messageDigest** (\[PKCS9\] section 6.4): The value MUST be set as specified by \[PKCS9\] section 6.6.In addition, the certificate ([\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414)) whose private key signed the **Countersignature** MUST be added to the [**SignedData**](#Section_708462617bc14c3094fe29ebf7f697ff) (section 2.3.2.4.1) **certificates** field. Intermediate and root certificates of the certificate chain, including the signing certificate, MAY also be added to the **SignedData** (section 2.3.2.4.1) **certificates** field. + +##### VBA Digital Signature Verification + +The [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) signature verification employs the steps specified in the following sections. The [**SignedData**](#Section_708462617bc14c3094fe29ebf7f697ff) (section [2.3.2.4](#Section_7c4ce2e22a714b028f51b9f0eeed756a)) integrity is verified as specified in PKCS \#7 ([\[PKCS7\]](https://go.microsoft.com/fwlink/?LinkId=510681) section 9.3 and \[PKCS7\] section 9.4). + +###### Certificate Processing + +The software publisher’s signing certificate and certificate chain MUST be verified against the following criteria: + +- +- +- + +The certificate chain MUST be validated to a trusted root certificate by using X.509 path validation rules as specified by [\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414) section 6.Either the signing certificate MUST contain the extended key usage (EKU) (\[RFC3280\] section 4.2.1.13) value for code signing (1.3.6.1.5.5.7.3.3) or there MUST be no EKU fields present in the signing certificate.The certificate chain MUST be within its validity period. If the certificate chain is not within its validity period, the signature MUST have a [**timestamp**](#gt_5799f340-0d0f-4f06-a629-32afbcf95081), and that timestamp MUST be validated according to the [**Timestamp Processing**](#Section_ad34050a39bb4482b973db85586bccd8) rules (section 2.3.2.4.6.2). If the signature has a timestamp, the certificate chain MUST be within its validity period at the timestamp time.If any of these conditions are not met, the signature MUST be treated as invalid. + +###### Timestamp Processing + +A signature with a [**timestamp**](#gt_5799f340-0d0f-4f06-a629-32afbcf95081) **Countersignature** MUST be considered valid if, and only if, it meets the following criteria: + +- +- + +#### The certificate chain for the **Countersignature** MUST be built according to a trusted root certificate by using X.509 path validation rules as specified by [\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414) section 6.The [**time stamp authority**](#gt_3247e47d-5652-471c-8c7a-58e90420a0d8) (TSA) certificate that was used to sign the timestamp MUST contain the EKU value for timestamping ("1.3.6.1.5.5.7.3.8").Serialized Certificate Store Structure + +This section specifies the structures used for storing a [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0), and optionally a list of properties, in a serialized representation as part of the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) for a [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project. + +##### SerializedCertificateEntry + +*Referenced by: [CertStoreCertificateGroup](#Section_462654f19be347f59c1ea6d328ac52e0)* + +Specifies a serialized [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) entry in a serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b). + +[TABLE] + +**id (4 bytes):** An unsigned integer. MUST be 0x00000020. + +**encodingType (4 bytes):** An unsigned integer that MUST be the value 0x00000001, which specifies ASN.1 encoding \[ITUX680\]. + +**length (4 bytes):** An unsigned integer that specifies the count of bytes for the **certificate** field. + +**certificate (variable):** Specifies the certificate data. MUST contain the ASN.1 [\[ITUX680\]](https://go.microsoft.com/fwlink/?LinkId=89923) DER encoding of an X.509 certificate as specified by [\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414). + +##### EndElementMarkerEntry + +*Referenced by: [DocSigSerializedCertStore](#Section_37d4b77da7d340fe9c3bcd327444f6ff), [VBASigSerializedCertStore](#Section_e88d644c80f84016a2c093fc5b110877)* + +Specifies a special entry in a serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) that marks the end of the store. + +[TABLE] + +**id (4 bytes):** An unsigned integer. MUST be 0x00000000. + +**marker (8 bytes):** A sentinel value 8 bytes in length, the value of which MUST be 0x0000000000000000. + +##### SerializedPropertyEntry + +*Referenced by: [CertStoreCertificateGroup](#Section_462654f19be347f59c1ea6d328ac52e0)* + +Specifies an entry in a serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) that contains data for a property associated with a certificate in the store. + +[TABLE] + +**id (4 bytes):** An unsigned integer specifying the identifier of the property. MUST be less than or equal to 0x0000FFFF and MUST NOT be the value 0x00000000 or 0x00000020 because these values specify the special entries [**SerializedCertificateEntry**](#Section_38a1970aa95e49a4bcaf6d8c10ddd5ac) (section 2.3.2.5.1) and [**EndElementMarkerEntry**](#Section_020eb66c88e3466b80f60e3ce84d0544) (section 2.3.2.5.2). + +**encodingType (4 bytes):** An unsigned integer that MUST be the value 0x00000001, which specifies ASN.1 encoding \[ITUX680\]. + +**length (4 bytes):** An unsigned integer that specifies the count of bytes for the **value** field. + +**value (variable):** Specifies the value of the property. This field SHOULD be ignored on read[\<13\>](#Appendix_A_13). + +##### CertStoreCertificateGroup + +*Referenced by: [DocSigSerializedCertStore](#Section_37d4b77da7d340fe9c3bcd327444f6ff), [VBASigSerializedCertStore](#Section_e88d644c80f84016a2c093fc5b110877)* + +Specifies a grouping of elements in a serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) that consists of zero or more properties of a certificate, and the serialized certificate itself. + +[TABLE] + +**elementList (variable):** An array of [**SerializedPropertyEntry**](#Section_b8e9c71efe594c568419a2ed2a5858f0) (section 2.3.2.5.3). This array can contain zero or more elements. Elements of this array are read and processed until a **SerializedPropertyEntry.id** is read with the unsigned integer value 0x00000020, which specifies the end of this array and the beginning of the **certificateElement** field. The terminating **SerializedPropertyEntry.id** that is read is actually the **certificateElement.id** field and not a part of this field. + +**certificateElement (variable):** A [**SerializedCertificateEntry**](#Section_38a1970aa95e49a4bcaf6d8c10ddd5ac) (section 2.3.2.5.1) specifying a [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) stored in this digital certificate store. + +##### VBASigSerializedCertStore + +*Referenced by: [DigSigInfoSerialized](#Section_30a00273dbee422fb488f4b8430ae046)* + +The serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) specifies structures for storing a digital certificate store containing a single [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) and, optionally, a list of properties associated with the certificate. + +[TABLE] + +**version (4 bytes):** An unsigned integer identifying the version of the structure. MUST be 0x00000000. + +**fileType (4 bytes):** An unsigned integer that MUST be the value 0x54524543. This value specifies that the structure is a digital certificate store. + +**certGroup (variable):** A [**CertStoreCertificateGroup**](#Section_462654f19be347f59c1ea6d328ac52e0) (section 2.3.2.5.4) structure that specifies the digital certificate stored in this serialized digital certificate store along with a set of optional properties. + +**endMarkerElement (12 bytes):** An [**EndElementMarkerEntry**](#Section_020eb66c88e3466b80f60e3ce84d0544) (section 2.3.2.5.2) structure specifying the end of the structure. + +### Property Set Storage + +An [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) property set storage is a format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) that specifies how to store a collection of sets of properties. This section specifies the property sets and data formats used within them that are applicable to this specification. The [**Summary Information**](#Section_11b5612735f44bfaa23f23935a6edf54) (section 2.3.3.2.1) property set SHOULD be written[\<14\>](#Appendix_A_14). The [**Document Summary Information**](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2) and [**User Defined**](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) property sets are optional. + +#### Property Types + +This section specifies the data format for property data types that require more detailed specification than what is provided in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc). + +##### PropertySetSystemIdentifier + +Specifies an operating system type and version for a property set. + +[TABLE] + +**OSMajorVersion (1 byte):** An unsigned integer specifying the [**major version**](#gt_66583c77-eb07-43c4-8f1b-dd157580db46) number of the operating system that wrote the property set. + +**OSMinorVersion (1 byte):** An unsigned integer specifying the [**minor version**](#gt_e0d99b53-9426-4a45-8429-b012184a4045) number of the operating system that wrote the property set. + +**OSType (2 bytes):** An unsigned integer that MUST be 0x0002. + +##### VtThumbnailValue + +*Referenced by: [VtThumbnail](#Section_4af3a094890c4ecc832cf212bfebbfa9)* + +Specifies data for the [**thumbnail**](#gt_811d0e6b-538c-487d-a54f-44f31e41e172) property. This type conforms to the **ClipboardData** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.11](http://msdn.microsoft.com/en-us/library/e5175413-9dad-4a8d-bd1f-058eb301fdc9/), but this section specifies additional detail applicable to this type. + +[TABLE] + +**cb (4 bytes):** An unsigned integer that specifies the count of bytes of the remainder of the structure, not including any **padding** field bytes. + +**cftag (4 bytes):** An unsigned integer specifying the [**clipboard format**](#gt_8f3c1316-2599-4b4f-918a-fa1898835c15) of the data. MUST be 0x00000000, CF_WINDOWS (0xFFFFFFFF), or CF_MACINTOSH (0xFFFFFFFE). A value of 0x00000000 specifies that there is no image data associated with the property. + +**formatId (4 bytes):** An unsigned integer specifying the format of the data stored in the **cfDataBytes** field. MUST NOT exist if the **cftag** field is 0x00000000. MUST exist if **cftag** is not 0x00000000. If it exists, it MUST be one of the following: CF_METAFILEPICT (0x00000003), CF_ENHMETAFILE (0x0000000E), or CF_JPEG (0x00000333). + +**cfDataBytes (variable):** An array of bytes containing the data for the thumbnail image. MUST NOT exist if the **cftag** field is 0x00000000. MUST exist if **cftag** is not 0x00000000. If it exists, MUST be (**cb** - 8) bytes in length. The format of the data is specified by **formatId** according to the following table. + +| formatId Value | Data format | +|----|----| +| CF_METAFILEPICT (0x00000003) | A **METAFILEPICT** structure as specified by [\[MS-WMF\]](%5bMS-WMF%5d.pdf#Section_4813e7fd52d04f42965f228c8b7488d2). | +| CF_ENHMETAFILE (0x0000000E) | Enhanced metafile image data as specified in [\[MS-EMF\]](%5bMS-EMF%5d.pdf#Section_91c257d7c39d4a369b1f63e3f73d30ca). | +| CF_JPEG (0x00000333) | [**Joint Photographic Experts Group (JPEG)**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image data. | + +**padding (variable):** An array of bytes. The length of the array MUST be the smallest number of bytes required to pad the size of this structure to a multiple of 4 bytes. The padding SHOULD be 0x00 values, but MAY be undefined values, and MUST be ignored. + +##### VtThumbnail + +Specifies the format for the [**thumbnail**](#gt_811d0e6b-538c-487d-a54f-44f31e41e172) property. This type conforms to the VT_CF **TypedPropertyValue** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but is presented in additional detail here to specify specific constraints on the type of data that can be contained in this type. + +[TABLE] + +**wType (2 bytes):** An unsigned integer that MUST be VT_CF (0x0047). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**vtValue (variable):** MUST be a [**VtThumbnailValue**](#Section_427efceff31c4d9e9e4ed28ff9bb6e0b) (section 2.3.3.1.2) structure. + +##### Lpstr + +*Referenced by: [VtString](#Section_60485cf2d8d94a7f99b1d1cf275ae83c)* + +Specifies data for a null-terminated single-byte character string, the encoding of which corresponds to the value of the enclosing property set’s **CodePage** property ([\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.18.2](http://msdn.microsoft.com/en-us/library/b8910736-7f4a-469a-9644-aed68a71d7d1/)). This type deviates from the **CodePageString** type specified in \[MS-OLEPS\] section [2.5](http://msdn.microsoft.com/en-us/library/a4c32611-5b79-4965-8f50-50639c138e16/) in the way that the **cch** field can be calculated and in the limit to the length of the string. + +[TABLE] + +**cch (4 bytes):** An unsigned integer specifying the number of single-byte characters in the **value** field. SHOULD be less than or equal to 0x0000FFFF.[\<15\>](#Appendix_A_15) SHOULD specify the number of characters in the **value** field including the terminating NULL character but not including **padding**. MAY specify the number of characters in both the **value** and **padding** fields.[\<16\>](#Appendix_A_16) + +**value (variable):** A null-terminated array of single-byte characters defining the string. + +**padding (variable):** An array of bytes. The length of the array MUST be the smallest number of bytes required to pad the size of the **value** field to a multiple of 4 bytes. The padding SHOULD be 0x00 values, but MAY be undefined values, and MUST be ignored.[\<17\>](#Appendix_A_17) + +##### UnalignedLpstr + +*Referenced by: [VtUnalignedString](#Section_eb04ce67f96b4ea4adf77f75847c7abb), [VtVecUnalignedLpstrValue](#Section_cd95ca9770c748288b5bb86263348026)* + +Specifies data for a null-terminated single-byte character string, the encoding of which corresponds to the value of the enclosing property set’s **CodePage** property ([\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.18.2](http://msdn.microsoft.com/en-us/library/b8910736-7f4a-469a-9644-aed68a71d7d1/)). This type deviates from the **CodePageString** type specified in \[MS-OLEPS\] section [2.5](http://msdn.microsoft.com/en-us/library/a4c32611-5b79-4965-8f50-50639c138e16/) in the absence of padding bytes and in the limit to the length of the string. + +[TABLE] + +**cch (4 bytes):** An unsigned integer specifying the number of single-byte characters in the **value** field. SHOULD be less than or equal to 0x0000FFFF.[\<18\>](#Appendix_A_18) + +**value (variable):** A null-terminated array of single-byte characters defining the string. + +##### Lpwstr + +*Referenced by: [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592), [VtString](#Section_60485cf2d8d94a7f99b1d1cf275ae83c), [VtUnalignedString](#Section_eb04ce67f96b4ea4adf77f75847c7abb), [VtVecLpwstrValue](#Section_112762c273624710afad1f4c8bc6a814)* + +Specifies data for a null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character string. This type deviates from the **UnicodeString** type specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.7](http://msdn.microsoft.com/en-us/library/9660cb24-953a-4e60-adf2-37cc0e779d19/) in the limit to the length of the string and in the way the length is specified in characters and not bytes. + +[TABLE] + +**cch (4 bytes):** An unsigned integer specifying the number of Unicode characters written as the **value** field including the terminating NULL character. SHOULD be less than or equal to 0x0000FFFF.[\<19\>](#Appendix_A_19) + +**value (variable):** A null-terminated array of Unicode characters defining the string. + +**padding (variable):** An array of bytes. The length of the array MUST be the smallest number of bytes required to pad the size of the **value** field to a multiple of 4 bytes. The padding SHOULD be 0x00 values, but MAY be undefined values, and MUST be ignored.[\<20\>](#Appendix_A_20) + +##### VtVecLpwstrValue + +*Referenced by: [VtVecLpwstr](#Section_2dc59d31a90349bba1f145fc01c8b8b0)* + +Specifies data for a property containing an array of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) strings. This type conforms to the (VT_VECTOR \| VT_LPWSTR) **TypedPropertyValue** value format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), except that the sequence of string structures following the **cElements** field are of type [**Lpwstr**](#Section_e5f5c0973b4440f293ccab4ce521f82d) (section 2.3.3.1.6). + +[TABLE] + +**cElements (4 bytes):** An unsigned integer specifying the number of elements in **rgString**. + +**rgString (variable):** An array of **Lpwstr** (section 2.3.3.1.6). Specifies the list of values for the property. + +##### VtVecLpwstr + +Specifies the format of a property for which the value is a list of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) strings. This type conforms to the (VT_VECTOR \| VT_LPWSTR) **TypedPropertyValue** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), except that the format of the strings it contains is as specified in this specification. + +[TABLE] + +**wType (2 bytes):** An unsigned integer that MUST be equal to VT_VECTOR \| VT_LPWSTR (0x101F). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**vtValue (variable):** MUST be a [**VtVecLpwstrValue**](#Section_112762c273624710afad1f4c8bc6a814) (section 2.3.3.1.7) structure. + +##### VtVecUnalignedLpstrValue + +*Referenced by: [VtVecUnalignedLpstr](#Section_523af67dd69a4eb1848ba299674ac9b8)* + +Specifies data for a property containing an array of single-byte character strings. This type conforms to the (VT_VECTOR \| VT_LPSTR) **TypedPropertyValue** value format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), except that the sequence of string structures following the **cElements** field are of type [**UnalignedLpstr**](#Section_a8f75582c3d34a5bbbca62ed6a05711d) (section 2.3.3.1.5). + +[TABLE] + +**cElements (4 bytes):** An unsigned integer specifying the number of elements in **rgString**. + +**rgString (variable):** An array of **UnalignedLpstr** (section 2.3.3.1.5). Specifies the list of values for the property. + +##### VtVecUnalignedLpstr + +Specifies the format of a property for which the value is a list of single-byte character strings. This type conforms to the (VT_VECTOR \| VT_LPSTR) **TypedPropertyValue** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), except that the format of the strings it contains is as specified in this specification. + +[TABLE] + +**wType (2 bytes):** An unsigned integer that MUST be VT_VECTOR \| VT_LPSTR (0x101E). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**vtValue (variable):** MUST be a [**VtVecUnalignedLpstrValue**](#Section_cd95ca9770c748288b5bb86263348026) (section 2.3.3.1.9) structure. + +##### VtString + +Specifies the format of a property for which the value is a string. + +[TABLE] + +**stringType (2 bytes):** An unsigned integer that MUST be VT_LPSTR (0x001E) or VT_LPWSTR (0x001F). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**stringValue (variable):** A structure that determines its type depending on the value of the **stringType** field according to the following table. + +| stringType | stringValue type | +|----|----| +| VT_LPSTR (0x001E) | [**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) (section 2.3.3.1.4) | +| VT_LPWSTR (0x001F) | [**Lpwstr**](#Section_e5f5c0973b4440f293ccab4ce521f82d) (section 2.3.3.1.6) | + +##### VtUnalignedString + +*Referenced by: [VtHeadingPair](#Section_8d8db7dc9a0c4bcc9ad5a2937bb559b0)* + +Specifies the format of a property for which the value is a string but where the **stringValue** field is not padded to any particular length if it is a single-byte character string type. + +[TABLE] + +**stringType (2 bytes):** An unsigned integer that MUST be VT_LPSTR (0x001E) or VT_LPWSTR (0x001F). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**stringValue (variable):** A structure that determines its type depending on the value of the **stringType** field according to the following table. + +| stringType | stringValue type | +|----|----| +| VT_LPSTR (0x001E) | [**UnalignedLpstr**](#Section_a8f75582c3d34a5bbbca62ed6a05711d) (section 2.3.3.1.5) | +| VT_LPWSTR (0x001F) | [**Lpwstr**](#Section_e5f5c0973b4440f293ccab4ce521f82d) (section 2.3.3.1.6) | + +##### VtHeadingPair + +*Referenced by: [VtVecHeadingPairValue](#Section_7eaa201d3fe149178e393690a3a36c11)* + +Specifies data for a heading pair for a property. + +[TABLE] + +**headingString (variable):** A structure of type [**VtUnalignedString**](#Section_eb04ce67f96b4ea4adf77f75847c7abb) (section 2.3.3.1.12) specifying the header string. + +**headerParts (8 bytes):** A VT_I4 **TypedPropertyValue** structure as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/). The **Value** field of the **TypedPropertyValue** structure specifies the number of document parts associated with this header. + +##### VtVecHeadingPairValue + +*Referenced by: [VtVecHeadingPair](#Section_3aaaf9e84f1a42fa9359fe0ab0c1cccc)* + +Specifies data for the heading pair property. This type conforms to the (VT_VECTOR \| VT_VARIANT) **TypedPropertyValue** value format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but this section specifies additional detail specifically applicable to this type. + +[TABLE] + +**cElements (4 bytes):** An unsigned integer specifying the count of elements in the **rgHeadingPairs** field. The number of elements in **rgHeadingPairs** MUST be half of this value. This value MUST be even. + +**rgHeadingPairs (variable):** An array of [**VtHeadingPair**](#Section_8d8db7dc9a0c4bcc9ad5a2937bb559b0) (section 2.3.3.1.13). Specifies the list of heading pairs for the property. + +##### VtVecHeadingPair + +Specifies the format for a property representing the headers corresponding to the [**GKPIDDSI_DOCPARTS**](#Section_3ef02e83afef4b6c9585c109edd24e07) property data (section 2.3.3.2.2.1). This type conforms to the (VT_VECTOR \| VT_VARIANT) **TypedPropertyValue** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but is presented in additional detail here to specify specific constraints on the type and format of data that can be contained in this type. + +Refer to the **GKPIDDSI_HEADINGPAIR** (section 2.3.3.2.2.1) and **GKPIDDSI_DOCPARTS** (section 2.3.3.2.2.1) properties for additional details. + +[TABLE] + +**wType (2 bytes):** An unsigned integer that MUST be VT_VECTOR \| VT_VARIANT (0x100C). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**vtValue (variable):** MUST be a [**VtVecHeadingPairValue**](#Section_7eaa201d3fe149178e393690a3a36c11) (section 2.3.3.1.14) structure. + +##### VtDigSigValue + +*Referenced by: [VtDigSig](#Section_e1f6b35d7e064dbc880ba074fabcd06d)* + +Specifies the data for a [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) property. This type conforms to the VT_BLOB **TypedPropertyValue** value format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but this section specifies additional detail applicable to this type. + +[TABLE] + +**cb (4 bytes):** An unsigned integer that specifies the size in bytes of **vbaDigSig**. MUST be equal to **vbaDigSig.cb** + 8. + +**vbaDigSig (variable):** A [**DigSigBlob**](#Section_bc21c922b7ae473690aa86afb6403462) (section 2.3.2.2) structure that specifies a VBA digital signature. + +##### VtDigSig + +Specifies the format for a property representing a [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189). This type conforms to the VT_BLOB **TypedPropertyValue** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but is presented in additional detail here to further specify the content of the property. + +[TABLE] + +**wType (2 bytes):** An unsigned integer that MUST be equal to VT_BLOB (0x0041). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**vtValue (variable):** MUST be a [**VtDigSigValue**](#Section_a7c3987feaa64f8cbc5cf0dd124eb32f) (section 2.3.3.1.16) structure. + +##### VtHyperlink + +*Referenced by: [VecVtHyperlink](#Section_754880cc03d448e794fcd9f6573f11af)* + +Specifies the data format for a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) for a property. + +[TABLE] + +**dwHash (8 bytes):** MUST be a VT_I4 **TypedPropertyValue** as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/). The **Value** field of this structure SHOULD be calculated as specified in the [Hyperlink Hash](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2) section with the **hlink1** field and **hlink2** field string values given as input.[\<21\>](#Appendix_A_21) + +**dwApp (8 bytes):** MUST be a VT_I4 **TypedPropertyValue** as specified in \[MS-OLEPS\] section 2.15. The **Value** field of this structure is implementation specific.[\<22\>](#Appendix_A_22) + +**dwOfficeArt (8 bytes):** MUST be a VT_I4 **TypedPropertyValue** as specified in \[MS-OLEPS\] section 2.15. The **Value** field of this structure MUST be a **MSOSPID** type value ([\[MS-ODRAW\]](%5bMS-ODRAW%5d.pdf#Section_8560795e77594745838ff7f2ef2f1872) section 2.1.2) specifying the identifier of the shape (\[MS-ODRAW\] section 2.2.31) to which this hyperlink applies in the document. If this hyperlink does not apply to a shape, the **Value** field of this structure MUST be 0x00000000. + +**dwInfo (8 bytes):** MUST be a VT_I4 **TypedPropertyValue** as specified in \[MS-OLEPS\] section 2.15. The **Value** field of this structure is implementation specific.[\<23\>](#Appendix_A_23) The high-order 2-byte integer of the **Value** field of this structure SHOULD be 0x0000. The unsigned 2-byte integer specified by the high two bytes of this value can be written as 0x0000 by an application that saves the entire file, as it specifies that the hyperlink is in sync with the document contents. If a process changes the hyperlink property element without a corresponding change to the related document content such that the hyperlink needs to be fixed in the document the next time the document is loaded, this value needs to be changed to 0x0001 by the process. If such a process wishes to specify that the hyperlink is to be removed from the document the next time the document is loaded, this value needs to be changed to 0x0002 by the process. + +**hlink1 (variable):** MUST be a [**VtString**](#Section_60485cf2d8d94a7f99b1d1cf275ae83c) structure (section 2.3.3.1.11) with **hlink1.wType** equal to VT_LPWSTR. **hlink1.stringValue** specifies the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). + +**hlink2 (variable):** MUST be a **VtString** structure (section 2.3.3.1.11) with **hlink2.wType** equal to VT_LPWSTR. **hlink2.stringValue** specifies the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). + +##### VecVtHyperlink + +*Referenced by: [VtHyperlinkValue](#Section_f65d95215c8d4888a23ecc1b9f9d7da5)* + +Specifies the data format for an array of [**hyperlinks**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e). This type conforms to the (VT_VECTOR \| VT_VARIANT) **TypedPropertyValue** value format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but this section specifies additional details specific to this type. + +[TABLE] + +**cElements (4 bytes):** An unsigned integer specifying the count of elements in the **rgHyperlink** field. The number of elements in **rgHyperlink** MUST be 1/6 of this value. This value MUST be evenly divisible by 6. + +**rgHyperlink (variable):** An array of [**VtHyperlink**](#Section_2225d544e06344ff9f70739f1c14d592) (section 2.3.3.1.18). Specifies the list of hyperlinks for the property. + +##### VtHyperlinkValue + +*Referenced by: [VtHyperlinks](#Section_4df4d1a8bb4746bdacd7944e817338e7)* + +Specifies the data for a [**hyperlinks**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) property. This type conforms to the VT_BLOB **TypedPropertyValue** value format as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but this section specifies additional detail applicable to this type. + +[TABLE] + +**cbData (4 bytes):** An unsigned integer that specifies the size in bytes of **vecHyperlink**. + +**vecHyperlink (variable):** MUST be a [**VecVtHyperlink**](#Section_754880cc03d448e794fcd9f6573f11af) structure (section 2.3.3.1.19). + +##### VtHyperlinks + +Specifies the format for a property representing a set of [**hyperlinks**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e). This type conforms to the VT_BLOB **TypedPropertyValue** type as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), but is presented in more detail here to further specify the contents of the data in this type. + +[TABLE] + +**wType (2 bytes):** An unsigned integer that MUST be equal to VT_BLOB (0x0041). + +**padding (2 bytes):** An unsigned integer that MUST be 0x0000. MUST be ignored. + +**vtValue (variable):** MUST be a [**VtHyperlinkValue**](#Section_f65d95215c8d4888a23ecc1b9f9d7da5) structure (section 2.3.3.1.20). + +#### OLE Property Sets + +This section defines the format of a property set storage [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc). This format applies to the [**Summary Information**](#Section_11b5612735f44bfaa23f23935a6edf54) (section 2.3.3.2.1) and [**Document Summary Information**](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2) streams. + +##### Summary Information Property Set + +This section defines a simple [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) property set as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) that conforms to the well-known property set format SummaryInformation as specified in \[MS-OLEPS\] section [2.23](http://msdn.microsoft.com/en-us/library/e5484a83-3cc1-43a6-afcf-6558059fe36e/) and \[MS-OLEPS\] section [2.25.1](http://msdn.microsoft.com/en-us/library/f7933d28-2cc4-4b36-bc23-8861cbcd37c4/). This specifies that the property set has the identifier [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) FMTID_SummaryInformation and is contained in the document [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) named "\005SummaryInformation". It contains a fixed set of recognized properties, which are generally specified in the \[MS-OLEPS\] specification, but are specified in the following section with more details regarding their use or deviations from the simple OLE property set format pursuant to this specification. The format of this property set is as specified in \[MS-OLEPS\], except where stated otherwise in the following section. In addition, this property set MUST have the following: + +- +- +- + +This property set MUST have its **PropertySetStream** structure **Version** field set to 0x00000000.This property set MUST have its **PropertySetStream** structure **CLSID** field set to [**GUID_NULL**](#gt_b9d97d88-9398-4450-9e92-247073ce0362).This property set MUST have a **PropertySetSystemIdentifier** structure (section [2.3.3.1.1](#Section_6ac486b48d634cdebd729c2306a482fe)) for its **PropertySetStream** structure **SystemIdentifier** field.For additional information about the OLE property set storage format, see \[MS-OLEPS\]. + +###### PIDSI + +Specifies the list of properties that can be defined in the [**Summary Information property set**](#Section_11b5612735f44bfaa23f23935a6edf54) (section 2.3.3.2.1). This set MUST NOT contain a **Dictionary** property ([\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.18.1](http://msdn.microsoft.com/en-us/library/4177a4bc-5547-49fe-a4d9-4767350fd9cf/)). All properties are optional, except the **GKPIDSI_CODEPAGE** property which MUST be written if the **Summary Information property set** (section 2.3.3.2.1) is present. All persisted string type properties ([**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) (section 2.3.3.1.4), [**UnalignedLpstr**](#Section_a8f75582c3d34a5bbbca62ed6a05711d) (section 2.3.3.1.5), and [**Lpwstr**](#Section_e5f5c0973b4440f293ccab4ce521f82d) (section 2.3.3.1.6)) MUST share the same [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) encoding as specified by the **GKPIDSI_CODEPAGE** property. If the string properties are persisted as **Lpwstr** (section 2.3.3.1.6) type properties, the **GKPIDSI_CODEPAGE** property MUST be set to CP_WINUNICODE (0x04B0). No order in persistence of the properties is enforced. All properties are persisted as **TypedPropertyValue** types as specified in \[MS-OLEPS\] section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), except where indicated otherwise for the purpose of additional clarification or deviation from the specification. + +The **Value** column of the following table specifies the value of the **PropertyIdentifier** field for the **PropertyIdentifierAndOffset** structure (\[MS-OLEPS\] section [2.19](http://msdn.microsoft.com/en-us/library/f59e6c94-a0ae-4d1b-85d3-f01c35779a22/)) for the specified property. + +The **Meaning** column of the following table specifies the property data type and the property’s meaning. The property data type specifies the format of the **Property** field of the **PropertySet** structure (\[MS-OLEPS\] section [2.20](http://msdn.microsoft.com/en-us/library/aefcbddf-f299-4f5e-a9da-65ce4ca55075/)) for the given property. + +[TABLE] + +##### Document Summary Information Property Set + +This section defines a simple [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) property set as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) containing application-defined properties. This property set conforms to \[MS-OLEPS\] section [2.21](http://msdn.microsoft.com/en-us/library/6e65d6fa-6044-4e23-ae71-d65d1e3b1249/) and \[MS-OLEPS\] section [2.23](http://msdn.microsoft.com/en-us/library/e5484a83-3cc1-43a6-afcf-6558059fe36e/) with regards to the [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) name requirements and format identifier [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) for the FMTID_DocSummaryInformation property set. The Document Summary Information property set is contained in the document stream named **"\005DocumentSummaryInformation"** and contains a fixed set of recognized properties, which are specified in the following section. In addition, this property set MUST have the following: + +- +- +- + +This property set MUST have its **PropertySetStream** structure **Version** field set to 0x00000000.This property set MUST have its **PropertySetStream** structure **CLSID** field set to [**GUID_NULL**](#gt_b9d97d88-9398-4450-9e92-247073ce0362).This property set MUST have a [**PropertySetSystemIdentifier**](#Section_6ac486b48d634cdebd729c2306a482fe) structure (section 2.3.3.1.1) for its **PropertySetStream** structure **SystemIdentifier** field.The total size of this property set’s **PropertySet** structure (\[MS-OLEPS\] section [2.20](http://msdn.microsoft.com/en-us/library/aefcbddf-f299-4f5e-a9da-65ce4ca55075/)) MUST be padded to a multiple of 4 bytes. The padding, if needed, MUST be located after the final property value of the property set and MUST be the minimum size required to produce a **PropertySet** structure with a size that is a multiple of 4 bytes. The contents of the padding are undefined and MUST be ignored. The **PropertySet** structure’s **Size** field MUST include the count of padding bytes in its calculation. + +For additional information about the OLE property set storage format, see \[MS-OLEPS\]. + +###### PIDDSI + +Specifies the list of properties that can be defined in the [**Document Summary Information property set**](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2). This set MUST NOT contain a **Dictionary** property ([\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.18.1](http://msdn.microsoft.com/en-us/library/4177a4bc-5547-49fe-a4d9-4767350fd9cf/)). All properties are optional, except the **GKPIDDSI_CODEPAGE** property (section 2.3.3.2.2.1) which MUST be written if the **Document Summary Information property set** (section 2.3.3.2.2) is present. All persisted string type properties ([**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) (section 2.3.3.1.4), [**UnalignedLpstr**](#Section_a8f75582c3d34a5bbbca62ed6a05711d) (section 2.3.3.1.5), and [**Lpwstr**](#Section_e5f5c0973b4440f293ccab4ce521f82d) (section 2.3.3.1.6)) MUST share the same [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) encoding as specified by the **GKPIDDSI_CODEPAGE** property. If the string properties are persisted as **Lpwstr** (section 2.3.3.1.6) type properties, the **GKPIDDSI_CODEPAGE** property MUST be set to CP_WINUNICODE (0x04B0). No order in persistence of properties is enforced. All properties are persisted as **TypedPropertyValue** types as specified in \[MS-OLEPS\] section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/), except where indicated otherwise for the purpose of additional clarification or deviation from the specification. + +The **Value** column of the following table specifies the value of the **PropertyIdentifier** field for the **PropertyIdentifierAndOffset** structure (\[MS-OLEPS\] section [2.19](http://msdn.microsoft.com/en-us/library/f59e6c94-a0ae-4d1b-85d3-f01c35779a22/)) for the specified property. + +The **Meaning** column of the following table specifies the property type and description. The type specifies the format of the **Property** field of the **PropertySet** structure (\[MS-OLEPS\] section [2.20](http://msdn.microsoft.com/en-us/library/aefcbddf-f299-4f5e-a9da-65ce4ca55075/)) for the given property. + +[TABLE] + +##### User Defined Property Set + +This section defines a simple [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) property set, as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc), containing arbitrary user-defined properties. This property set conforms to \[MS-OLEPS\] section [2.21](http://msdn.microsoft.com/en-us/library/6e65d6fa-6044-4e23-ae71-d65d1e3b1249/) and \[MS-OLEPS\] section [2.23](http://msdn.microsoft.com/en-us/library/e5484a83-3cc1-43a6-afcf-6558059fe36e/) with regards to [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) name requirements and format identifier [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) for the FMTID_UserDefinedProperties property set. The User Defined property set is contained in the document stream named **"\005DocumentSummaryInformation"**. It contains properties of arbitrary type and value (within the constraints specified in section [2.3.3.2.3.1](#Section_1edd5ada132a4108af3323225e159aa8)), and assigned any property name that meets the \[MS-OLEPS\] specification except for those names that are reserved as specified in section [2.3.3.2.3.2](#Section_3394ba979ea34b52ba45555bb5b8e94c). This property set also supports the concept of linked properties that use two property entries, one of which does not have an associated property name. The specification for these properties is specified in section [2.3.3.2.3.3](#Section_97ac7ca64fab4fb582527bb52a36fde2). Properties stored in this property set have an effective **PropertyIdentifier** maximum of 0x00FFFFFF because of reserved high-order bits for property entry link specification. In addition, this property set MUST have the following: + +- +- +- + +This property set MUST have its **PropertySetStream** structure **Version** field set to 0x00000000.This property set MUST have its **PropertySetStream** structure **CLSID** field set to [**GUID_NULL**](#gt_b9d97d88-9398-4450-9e92-247073ce0362).This property set MUST have a [**PropertySetSystemIdentifier**](#Section_6ac486b48d634cdebd729c2306a482fe) structure (section 2.3.3.1.1)for its **PropertySetStream** structure **SystemIdentifier** field.The total size of this property set’s **PropertySet** structure (\[MS-OLEPS\] section [2.20](http://msdn.microsoft.com/en-us/library/aefcbddf-f299-4f5e-a9da-65ce4ca55075/)) MUST be padded to a multiple of 4 bytes. The padding, if needed, MUST be located after the final property value of the property set and MUST be the minimum size required to produce a **PropertySet** structure with a size that is a multiple of 4 bytes. The contents of the padding are undefined and MUST be ignored. The **PropertySet** structure’s **Size** field MUST include the count of padding bytes in its calculation. + +For additional information about the OLE property set storage format, see \[MS-OLEPS\]. + +###### User Defined Property Set Constraints + +The [User Defined property set](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) is a location where user-defined properties can be persisted by associating arbitrary property names to data of arbitrary types. There are limits on the format the data can take, which are specified in this section. + +####### Required Properties + +Because the format of the [User Defined property set](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) MUST associate a name with each property (except for the **Dictionary** and **CodePage** properties and [links](#Section_97ac7ca64fab4fb582527bb52a36fde2) associated with properties), the property set MUST have a **Dictionary** property as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.18.1](http://msdn.microsoft.com/en-us/library/4177a4bc-5547-49fe-a4d9-4767350fd9cf/) to make this association, and MUST follow the rules as specified in \[MS-OLEPS\] regarding property name and property identifier uniqueness. + +The User Defined property set (section 2.3.3.2.3) MUST also contain the **CodePage** property as specified in \[MS-OLEPS\] section [2.18.2](http://msdn.microsoft.com/en-us/library/b8910736-7f4a-469a-9644-aed68a71d7d1/). + +####### Supported Types + +The [User Defined property set](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) does not support every property type defined in the [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) specification. Each property in this property set (with the exception of the **Dictionary** and **CodePage** properties) MUST be in one of the following formats: + +- +- - + - + - + - + - + +###### [**VtString**](#Section_60485cf2d8d94a7f99b1d1cf275ae83c) (section 2.3.3.1.11)**TypedPropertyValue** (\[MS-OLEPS\] section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/)), the type of which MUST be one of the following types:VT_I4 (0x0003)VT_R8 (0x0005)VT_BOOL (0x000B)VT_FILETIME (0x0040)VT_BLOB (0x0041)Reserved Properties + +The [User Defined property set](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) has a number of names that are reserved for specific data. These names MUST only be used to specify the data for which the names are reserved. All of these properties are optional and can be absent. The reserved names and the data they specify are as specified in the following tables. + +[TABLE] + +The following properties are associated with [**document workspace**](#gt_4669f004-eb55-4d2a-b7d3-f9de045e4614) management. All of these properties MAY be ignored.[\<57\>](#Appendix_A_57) + +[TABLE] + +The following properties are associated with [**smart document**](#gt_cc9fe152-6a63-4555-91f1-1543ff84035d) solutions. + +| Reserved name | Format and description | +|----|----| +| Solution ID | MUST be a **VtString** property. It specifies the identifier[\<59\>](#Appendix_A_59) for the associated smart document solution. This property can be used to check whether the specified smart document solution is already installed and, if so, use the existing solution information to determine if the solution needs to be updated. If it is not previously installed, the solution is installed based on the value of the "Solution URL" property. MAY be ignored[\<60\>](#Appendix_A_60). For more information about smart documents, see [\[MSDN-SDO\]](https://go.microsoft.com/fwlink/?LinkId=120839). The length of the property’s **VtString.stringValue.value** field MUST be less than or equal to 51 characters, including the terminating NULL character. | +| Solution URL | MUST be a **VtString** property. It specifies the path to an [**XML expansion pack**](#gt_fdf0febb-e3dd-45f5-a3fa-912b1baf9bac) [**manifest**](#gt_d1a20cdc-cced-44de-a041-857fb9054856) file, which defines the contents of the smart document solution associated with the document. MAY be ignored[\<61\>](#Appendix_A_61). For more information about XML expansion pack manifest files, see \[MSDN-SDO\]. The length of the property’s **VtString.stringValue.value** field MUST be less than or equal to 256 characters, including the terminating NULL character. | +| Solution Template ID | MUST be a **VtString** property. It specifies the identifier of a document template installed as part of the XML expansion pack. This property is used to ensure that the local copy of the document template installed as part of the XML expansion pack is updated when the document template referenced by the manifest file is updated. MAY be ignored[\<62\>](#Appendix_A_62). For more information about XML expansion pack manifest files, see \[MSDN-SDO\]. The length of the property’s **VtString.stringValue.value** field MUST be less than or equal to 256 characters, including the terminating NULL character. | +| Other Solution ID | MUST be a **VtString** property. It specifies the identifier[\<63\>](#Appendix_A_63) of a solution of type 'other' installed as a part of a XML expansion pack. For more information about XML expansion pack and types of solutions, see \[MSDN-SDO\]. This property is used when the solution itself does not affect the document behavior but it can be used to check if the referenced solution needs to be updated whenever the document is loaded. MAY be ignored[\<64\>](#Appendix_A_64). The length of the property’s **VtString.stringValue.value** field MUST be less than or equal to 51 characters, including the terminating NULL character. | + +The following properties are associated with [**managed code**](#gt_5293dd75-4296-4f8b-bb9a-cfef88c3c44d) document [**add-in**](#gt_a3be101e-9d37-484a-a5e6-b70d559146c6) solutions[\<65\>](#Appendix_A_65). For more information about managed code document add-in solutions, see [\[MSDN-AVSTOS\]](https://go.microsoft.com/fwlink/?LinkId=121211). These properties MUST both exist if present. + +[TABLE] + +The following properties specify information about a document that has been sent by using email, either for review or as an attachment, from an author to a reviewer or from a reviewer back to the author. These properties MAY be ignored.[\<68\>](#Appendix_A_68) + +[TABLE] + +Associated properties with sensitivity labels are specified in [\[MS-OI29500\]](%5bMS-OI29500%5d.pdf#Section_1fd4a662862349c082f018fa91b413b8) section 2.1.31. + +###### Linked Properties + +The specification for a simple [**OLE**](#gt_171744b8-3f44-4198-b7b9-1c0147282d2c) property set storage as specified in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) specifies that properties contained in a property set storage can be named, when that property set storage contains the special **Dictionary** property. As specified previously, the [**User Defined property set**](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) MUST contain a **Dictionary** property, and all properties of the property set except those that are special properties as specified in \[MS-OLEPS\] section [2.18](http://msdn.microsoft.com/en-us/library/9389a815-d71c-4dd2-b272-2b3a8177f004/) have names. However, the properties in this property set, excluding the special properties and [**Reserved Properties**](#Section_3394ba979ea34b52ba45555bb5b8e94c) (section 2.3.3.2.3.2), can also be linked, meaning they receive their value from document content instead of from explicit value assignment. + +A link for any property that allows it, if applicable, MUST be specified by creating an additional entry in the property set that is unnamed (that is, does not have an associated entry in the **Dictionary** property table). The **PropertyIdentifier** (\[MS-OLEPS\] section [2.19](http://msdn.microsoft.com/en-us/library/f59e6c94-a0ae-4d1b-85d3-f01c35779a22/)) for an entry created for this purpose is equal to its associated property’s **PropertyIdentifier** combined with the value **0x01000000** by using the bitwise **OR** operation. + +A property’s link entry MUST be in [**VtString**](#Section_60485cf2d8d94a7f99b1d1cf275ae83c) (section 2.3.3.1.11) format. + +The presence of such an associated link for a given property specifies that the property, when written, MUST generate its value from the document content to which it is linked.[\<71\>](#Appendix_A_71) On document load, pursuant to the specification of the [**GKPIDDSI_LINKSDIRTY**](#Section_3ef02e83afef4b6c9585c109edd24e07) property flag (section 2.3.3.2.2.1), the application MUST update the linked document content in accordance with the new value of any linked property that was changed outside of the application. + +### SmartTag Objects + +The [**smart tags**](#gt_2f57a49a-d503-4605-8798-0e53bd637609) are customer-defined semantics which can be embedded in a document. Smart tags allow semantic information to be added around words or types of data (for example, dates, phone numbers or addresses) within a document to provide information about the type of data contained within. + +#### PropertyBagStore + +This structure specifies the shared data for the [**smart tags**](#gt_2f57a49a-d503-4605-8798-0e53bd637609) embedded in the document. + +[TABLE] + +**cFactoidType (4 bytes):** Unsigned integer specifying the count of elements in the **factoidTypes** member. + +**factoidTypes (variable):** An array of [**FactoidType**](#Section_e20c3d1400c8439b87a07cd8bc7dfdd9) (section 2.3.4.2). Specifies the list of smart tag types. + +**cbHdr (2 bytes):** Unsigned integer specifying the size in bytes of the **cbHdr**, **sVer**, **cfactoid**, and **cste** fields. MUST be 0xC. + +**sVer (2 bytes):** Unsigned integer specifying the version number of the structure. The high-order byte specifies the [**major version**](#gt_66583c77-eb07-43c4-8f1b-dd157580db46) number. The low-order byte specifies the [**minor version**](#gt_e0d99b53-9426-4a45-8429-b012184a4045) number. MUST be 0x0100. + +**cfactoid (4 bytes):** Unsigned integer reserved for future use. MUST be ignored. + +**cste (4 bytes):** Unsigned integer specifying the count of elements in the **stringTable** field. + +**stringTable (variable):** An array of [**PBString**](#Section_0f70d2f799e9485398feedfc98825792) (section 2.3.4.5). Specifies the list of strings. Elements of this table are referenced by their indices to form key/value pairs by the **keyIndex** and **valueIndex** fields in [**Property**](#Section_61d78938ed384cb39c6b9f42fdd24894) (section 2.3.4.4), which is in the **properties** field of [**PropertyBag**](#Section_5dbba3b5db16449ebb6286967fa7d21b) (section 2.3.4.3). + +#### FactoidType + +*Referenced by: [PropertyBagStore](#Section_e9e83dea3953448f8cdd2392b6ba76a3)* + +This structure specifies the type of [**smart tag**](#gt_2f57a49a-d503-4605-8798-0e53bd637609). + +[TABLE] + +**cbFactoid (4 bytes):** Unsigned integer specifying the count of total bytes, excluding itself, in the **FactoidType** structure. + +**id (4 bytes):** Unsigned integer specifying the identifier of this smart tag type. There is a many-to-one mapping from the **PropertyBag** (section [2.3.4.3](#Section_5dbba3b5db16449ebb6286967fa7d21b)) to **FactoidType** using their respective **id** fields. MUST be less than or equal to 0xFFFF. + +**rgbUri (variable):** A **PBString** structure (section [2.3.4.5](#Section_0f70d2f799e9485398feedfc98825792)) specifying the [**XML namespace**](#gt_485f05b3-df3b-45ac-b8bf-d05f5d185a24) [**Uniform Resource Identifier (URI)**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95) for the smart tag type. + +**rgbTag (variable):** A **PBString** structure (section 2.3.4.5) specifying the tag name for the smart tag type. + +**rgbDownLoadURL (variable):** A **PBString** structure (section 2.3.4.5) specifying the [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) to download the particular smart tag type. + +#### PropertyBag + +This structure specifies the [**smart tag**](#gt_2f57a49a-d503-4605-8798-0e53bd637609) data. + +[TABLE] + +**id (2 bytes):** Unsigned integer specifying the **id** of [**FactoidType**](#Section_e20c3d1400c8439b87a07cd8bc7dfdd9) (section 2.3.4.2) in the **factoidTypes** list of the [**PropertyBagStore**](#Section_e9e83dea3953448f8cdd2392b6ba76a3) (section 2.3.4.1). + +**cProp (2 bytes):** Unsigned integer specifying the count of elements in the **properties** field. + +**cbUnknown (2 bytes):** Unused, reserved for future use. MUST be 0x0 and MUST be ignored. + +**properties (variable):** An array of [**Property**](#Section_61d78938ed384cb39c6b9f42fdd24894) (section 2.3.4.4). It is a list of key/value indexes into the **stringTable** field of the **PropertyBagStore** (section 2.3.4.1) structure. + +#### Property + +*Referenced by: [PropertyBag](#Section_5dbba3b5db16449ebb6286967fa7d21b)* + +This structure specifies the indexes into the string table entries of the **stringTable** field in the [**PropertyBagStore**](#Section_e9e83dea3953448f8cdd2392b6ba76a3) (section 2.3.4.1) to form a key/value pair. It is used by the [**smart tag recognizer**](#gt_31f2a874-4490-4c2c-9e2c-6267f373bf5c) to store additional information that relates to the smart tag in a collection of key/value pairs, known as a property bag. This information can be later used to perform common tasks for the data type. + +[TABLE] + +**keyIndex (4 bytes):** Unsigned integer specifying the key index. + +**valueIndex (4 bytes):** Unsigned integer specifying the value index. + +#### PBString + +*Referenced by: [FactoidType](#Section_e20c3d1400c8439b87a07cd8bc7dfdd9), [PropertyBagStore](#Section_e9e83dea3953448f8cdd2392b6ba76a3)* + +This structure specifies a null-terminated string encoded either using a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) or [**ANSI character set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583) format. + +[TABLE] + +**cch (15 bits):** Specifies the count of characters in the string **rgxch**. + +**A - fAnsiString (1 bit):** If set to 0x1 the string **rgxch** MUST be an ANSI character set string. If set to 0x0 then it MUST be a Unicode string. + +**rgxch (variable):** A null-terminated ANSI character set or a Unicode string depending on the value of **fAnsiString** field. + +### RefEdit Control + +A TextBox control, as specified by a **MorphData** control structure in [\[MS-OFORMS\]](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a) section 2.2.5, with the following exceptions: + +- +- + +**ShowDropButtonWhen**, specified in \[MS-OFORMS\] section 2.5.77, MUST have the value fmShowDropButtonWhenAlways.**DropButtonStyle**, specified in \[MS-OFORMS\] section 2.5.22, MUST have the value fmDropButtonStyleReduce.All other properties of a **RefEdit** control are specified to have the same file format default values as a **MorphData** control structure, as specified in \[MS-OFORMS\] section 2.2.5, with a **DisplayStyle** property value of "fmDisplayStyleText", as specified in \[MS-OFORMS\] section 2.5.20. + +### Custom XML Data Storage + +The Custom XML Data Storage specifies how to store a collection of XML fragments. It can be used to roundtrip arbitrary custom XML data with the document. This [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) SHOULD[\<72\>](#Appendix_A_72) be created to store any XML fragment. + +The name of this storage MUST be "MsoDataStore". Within this storage, zero or more sub-storages exist. The name of each of these sub-storages MUST be unique. Each of these sub-storages MUST contain two [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) within it as specified in section [2.3.6.1](#Section_4bd09eb4a447471ebb34b6be107ab54d) and [2.3.6.2](#Section_8d4c97e66af4473aa6acef7ce89ccbf2) respectively. + +#### Custom XML Data Storage Item + +The name of this [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST be "Item". An instance of this stream contains an XML fragment. + +Custom XML Data Storage items whose root namespace appears in the following table are further specified. + +| Root namespace | Explanation | +|----|----| +| http://schemas.microsoft.com/office/2006/customDocumentInformationPanel | [Custom Property Editor](#Section_85d6920daf9f49d9873bbab3e41ae0ff) (section 2.3.6.1.1) | +| http://schemas.microsoft.com/office/2006/metadata/customXsn | [Custom Xsn](#Section_cadcb03133274023952d6607c1ab634e) (section 2.3.6.1.2) | +| http://schemas.microsoft.com/office/2006/metadata/contentType | [Schema for Content Type](#Section_5a76628af8624994a57eec37de5c6c78) (section 2.3.6.1.3) | +| http://schemas.microsoft.com/office/2006/coverPageProps | [Cover Page Properties](#Section_1deeffdeda944ce78188af1ef5d29e67) (section 2.3.6.1.4) | +| http://schemas.microsoft.com/office/2006/metadata/longProperties | [Long Properties](#Section_6ad9a50924ce46ffb28f77bcd3139b32) (section 2.3.6.1.5) | +| office.server.policy | Collaborative Application Markup Language (CAML) Structure ([\[MS-WSSCAML\]](%5bMS-WSSCAML%5d.pdf#Section_8d6156fd646842949594644a946ed6a6) section 2.5.1.7) | + +##### Custom Property Editor + +This section specifies the [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067) for the list and settings for any XSN files (as specified by InfoPath Form Template Format Structure Specification [\[MS-IPFF\]](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)) that are associated with the document to edit information in its custom XML data items. + +###### XMLNamespace + +Specifies the root namespace of custom XML data items that are appropriate for editing by the XSN specified in the [**XSNLocation**](#Section_47b70b8b19764430ade6b3f6adf2262f) element (section 2.3.6.1.1.2). + +**Parent element:** [**customPropertyEditor**](#Section_2169d00b14074f15abcab1ee8aa2a2a1) (section 2.3.6.1.1.5) + +\ + +###### XSNLocation + +Specifies the path to the XSN file. + +**Parent element:** [**customPropertyEditor**](#Section_2169d00b14074f15abcab1ee8aa2a2a1) (section 2.3.6.1.1.5) + +\ + +###### showOnOpen + +This element specifies whether to present a UI to edit either the core properties or properties in one of the custom XML data items in the document as specified by the [**defaultPropertyEditorNamespace**](#Section_b820dac0f2cf405f9da3912331ed527f) (section 2.3.6.1.1.4). A setting of "true" specifies that the editing UI is displayed. If set to any other value or not present, the editing UI is not presented. + +**Parent element:** [**customPropertyEditors**](#Section_67e2ad00a4b74887a5b5f96ec69765a9) (section 2.3.6.1.1.6) + +\ + +###### defaultPropertyEditorNamespace + +This element specifies the [**XML namespace**](#gt_485f05b3-df3b-45ac-b8bf-d05f5d185a24) that identifies the XSN to be shown by default when editing the properties contained in the custom XML data items of the document. + +**Parent element:** [**customPropertyEditors**](#Section_67e2ad00a4b74887a5b5f96ec69765a9) (section 2.3.6.1.1.6) + +\ + +###### customPropertyEditor + +This element associates a namespace with the location of an XSN file (as specified by InfoPath Form Template Format Structure Specification [\[MS-IPFF\]](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)). The [**XMLNamespace**](#Section_4eff429624e14042a785bc135c4d63df) (section 2.3.6.1.1.1) child specifies which custom XML data items are suitable for editing; the [**XSNLocation**](#Section_47b70b8b19764430ade6b3f6adf2262f) (section 2.3.6.1.1.2) child specifies a path to the XSN file. + +**Parent element:** [**customPropertyEditors**](#Section_67e2ad00a4b74887a5b5f96ec69765a9) (section 2.3.6.1.1.6) + +| Child elements | +|----------------------------------------| +| **XMLNamespace** (section 2.3.6.1.1.1) | +| **XSNLocation** (section 2.3.6.1.1.2) | + +\ + +\ + +\ + +\ + +\ + +\ + +###### customPropertyEditors + +This element specifies the list and settings for any XSN files (as specified by InfoPath Form Template Format Structure Specification [\[MS-IPFF\]](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)) that are associated with the document to edit information in its custom XML data items. + +| Child elements | +|----| +| [**customPropertyEditor**](#Section_2169d00b14074f15abcab1ee8aa2a2a1) (section 2.3.6.1.1.5) | +| [**defaultPropertyEditorNamespace**](#Section_b820dac0f2cf405f9da3912331ed527f) (section 2.3.6.1.1.4) | +| [**showOnOpen**](#Section_b529581ef7d94e4086694155b82ca0d5) (section 2.3.6.1.1.3) | + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +##### Custom Xsn + +This section specifies the [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067) for specifying whether an XSN file (as specified by InfoPath Form Template Format Structure Specification [\[MS-IPFF\]](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)) is presented for editing information in the custom XML data item with the namespace of http://schemas.microsoft.com/office/2006/metadata/properties in the document. + +###### ST_TrueFalse + +This simple type specifies restriction for specifying the Boolean values. + +**False** : **false** + +**True** : **true** + +*Referenced by:* *[cached](#Section_47752cf7ea8b4994a685259f261254e7), [openByDefault](#Section_4feeb65bf49248b2bc25bd0155c9bf1f)* + +\ + +\ + +\ + +\ + +\ + +\ + +###### xsnLocation + +This element specifies the location of an XSN file (as specified by InfoPath Form Template Format Structure Specification [\[MS-IPFF\]](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)) to use for editing information in the custom XML data item with the namespace http://schemas.microsoft.com/office/2006/metadata/properties in the document. + +**Parent element:** [**customXsn**](#Section_ceb529d2572a46a7a8d33951e059de4f) (section 2.3.6.1.2.6) + +\ + +###### cached + +This element specifies whether to use the XSN specified by the [**xsnLocation**](#Section_6a40521d8a294cc9b8590078594cd322) (section 2.3.6.1.2.2) for editing the information in the custom XML data item with the namespace http://schemas.microsoft.com/office/2006/metadata/properties in the document. If set to **false** the specified XSN MUST be used. If set to "True" the specified XSN MUST NOT be used. + +**Parent element:** [**customXsn**](#Section_ceb529d2572a46a7a8d33951e059de4f) (section 2.3.6.1.2.6) + +\ + +###### openByDefault + +This element specifies whether to present UI to edit information in the custom XML data item with the namespace http://schemas.microsoft.com/office/2006/metadata/properties in the document, immediately after opening the same. + +A value of **true** specifies that the UI is shown by default. A value of **false** or the absence of the element specifies that the UI is not shown. + +**Parent element:** [**customXsn**](#Section_ceb529d2572a46a7a8d33951e059de4f) (section 2.3.6.1.2.6) + +\ + +###### xsnScope + +Specifies the path to use for resolving any [**relative paths**](#gt_f0a8c9c7-1368-4989-addb-4792c3206387) that appear within the XSN specified by [**xsnLocation**](#Section_6a40521d8a294cc9b8590078594cd322) (section 2.3.6.1.2.2). + +**Parent element:** [**customXsn**](#Section_ceb529d2572a46a7a8d33951e059de4f) (section 2.3.6.1.2.6) + +\ + +###### customXsn + +This element specifies whether an XSN file (as specified by InfoPath Form Template Format Structure Specification [\[MS-IPFF\]](%5bMS-IPFF%5d.pdf#Section_93482ffc8be24c288de5324a835e66b1)) is to be presented for editing information in the custom XML data item with the namespace of "http://schemas.microsoft.com/office/2006/metadata/properties" in the document. + +*Child elements:* + +[**cached**](#Section_47752cf7ea8b4994a685259f261254e7) (section 2.3.6.1.2.3) + +[**openByDefault**](#Section_4feeb65bf49248b2bc25bd0155c9bf1f) (section 2.3.6.1.2.4) + +[**xsnLocation**](#Section_6a40521d8a294cc9b8590078594cd322) (section 2.3.6.1.2.2) + +[**xsnScope**](#Section_b7a74aaeac8e4670987baac055ce7125) (section 2.3.6.1.2.5) + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +##### Schema for Content Type + +This section specifies the [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067) for the custom XML data item that specifies properties of the content type associated with the document. + +###### ContentTypeId + +This simple type specifies restriction for specifying a content type identifier for a document. + +*Referenced by: [contentTypeSchema.SchemaForContentType@contentTypeID](#Section_708783bb2f0e4fa490372a952688f757)* + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +###### IntNonNegative + +This simple type specifies the restriction for specifying non-negative integers. + +*Referenced by:* *[contentTypeSchema.SchemaForContentType@contentTypeVersion](#Section_708783bb2f0e4fa490372a952688f757), [DummyContentTypeElement.DummyContentType@index](#Section_e1f362d7a9e543b387fafa73531ad4e2)* + +\ + +\ + +\ + +\ + +\ + +###### UniqueIdentifierWithoutBraces + +This simple type specifies the restriction on the [**UniqueIdentifierWithoutBracesOrEmpty**](#Section_50ffad9914214f9e9e601b1bf1fedf28) (section 2.3.6.1.3.4) data type for specifying a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1). + +*Referenced by:* [*DummyContentTypeElement.DummyContentType@web*](#Section_e1f362d7a9e543b387fafa73531ad4e2) + +\ + +\ + +\ + +\ + +\ + +###### UniqueIdentifierWithoutBracesOrEmpty + +This simple type specifies the restrictions for specifying a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) without braces or an empty string. + +*Referenced by:* [*DummyContentTypeElement.DummyContentType@web*](#Section_e1f362d7a9e543b387fafa73531ad4e2) + +\ + +\ + +\ + +\ + +\ + +\ + +###### DummyContentTypeElement + +This specifies the child schema for the [**contentTypeSchema**](#Section_708783bb2f0e4fa490372a952688f757) (section 2.3.6.1.3.7). + +Attributes: + +**anchorId :** Specifies the term that parents all terms that can be selected as a valid value for the property corresponding to this **xsd:element**. + +If set to 00000000-0000-0000-0000-000000000000, specifies that all terms in the term set specified by the **termSetId** attribute MUST be treated as valid values for the property corresponding to this **xsd:element**. + +MUST be present on **xsd:elements** for which the **taxonomy** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**decimals :** When applied to an **xsd:element** in a schema other than the root schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Currency or {http://schemas.microsoft.com/office/2006/documentManagement/types}Number, specifies the number of fractional digits to display in the property-editing UI for the property corresponding to this **xsd:element**. + +If applied to any other element, this attribute MUST be ignored. + +**default :** When applied to an xsd:element in a schema other than the root schema or the core schema, specifies the initial value of the property corresponding to this **xsd:element**. + +When applied to an xsd:element in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}DateTime, if set to "\[today\]", specifies that the initial value of the property corresponding to this **xsd:element** MUST be set to the current [**UTC**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7) date and time. + +When applied to an xsd:element in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Boolean, the value of 1 is interpreted as logical **true** and all other values as logical **false** in determining the initial value of the property corresponding to this **xsd:element**. + +If applied to any other element, this attribute MUST be ignored. + +**description :** When applied to an xsd:element in a schema other than the root schema, specifies the description of the property corresponding to this xsd:element. + +If applied to any other element, this attribute MUST be ignored. + +**displayName :** When applied to an **xsd:element** in a schema other than the root schema or core schema, specifies the display name for the property corresponding to this xsd:element. + +If applied to any other element, this attribute MUST be ignored. + +**fieldId :** Specifies a unique identifier for the field. + +MUST be present on xsd:elements for which the **taxonomy** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**fieldsID :** This attribute MUST be ignored. + +**format :** When applied to an **xsd:element** in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}DateTime, if set to "DateTime" specifies that the property value corresponding to this **xsd:element** MUST include both the date and time, and if not present or set to any other value, specifies that the property value MUST include only the date. + +If applied to any other element, this attribute MUST be ignored. + +**hidden :** When applied to an xsd:element in a schema other than the root schema or core schema, if set to **true**, specifies that the property corresponding to this **xsd:element** MUST NOT be presented for editing. + +If applied to any other element, this attribute MUST be ignored. + +**index :** Specifies the ordering on the property-editing UI of **xsd:elements** bearing this attribute from schemas other than the root schema. + +First, the **xsd:elements** are broken into groups, as follows. + +The first group is composed of any **xsd:element** that is all of the following: + +- +- +- + +Is not the "description" element in the core properties.Is not a simpleType restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Note.Is not a complex content based on any of {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiChoice, {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiChoiceFillIn, or {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiChoiceLookup.The second group is composed of the remaining xsd:elements bearing this attribute from schemas other than the root schema. + +The order within each group is the ascending order of the **index** attribute values. + +If an xsd:element in a schema other than the root schema or core schema does not have this attribute, it MUST NOT be presented for editing. + +If applied to any other element, this attribute MUST be ignored. + +**indexed :** When applied to an **xsd:element** for which neither the **hidden** nor **readOnly** attributes are set to **true** in a schema other than the root schema or core schema, if set to **true**, specifies that the property corresponding to **this xsd:element** MUST be presented for editing. + +If applied to any other element, this attribute MUST be ignored. + +**internalName :** Specifies an internal name for the xsd:element bearing this attribute. It MUST be present on **xsd:elements** in a schema other than the root schema or core schema. + +If applied to any other element, this attribute MUST be ignored. + +**isKeyword :** If set to **true**, specifies that the property-editing UI for the property corresponding to this xsd:element uses all available term stores and term sets. If set to **false**, specifies that the property-editing UI for the property corresponding to this xsd:element uses the term set specified by the **termSetId** attribute. + +MUST be present on xsd:elements for which the **taxonomy** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**LCID :** When applied to an xsd:element in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Currency, specifies the [**locale**](#gt_7b78ebef-e35d-45ab-abfd-4121b60995de) identifier as specified in [\[MS-LCID\]](%5bMS-LCID%5d.pdf#Section_70feba9f294e491eb6eb56532684c37f) used to determine the currency symbol used in the display of the property corresponding to this xsd:element in the property-editing UI. + +If applied to any other element, this attribute MUST be ignored. + +**list :** Specifies the list to obtain data from, when displaying the property corresponding to this xsd:element in the property-editing UI. + +MUST be present on xsd:elements for which neither the **hidden** nor **readOnly** attributes are set to **true** in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Lookup or {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiLookup. + +If applied to any other element, this attribute MUST be ignored. + +**open :** If set to **true**, specifies that new terms are allowed to be added to the term set specified by the **termSetId** attribute. If set to **false**, the property-editing UI MUST NOT allow new terms to be added to the term set specified by the **termSetId** attribute. + +MUST be present on xsd:elements for which the **taxonomy** attribute is set to **true**, and MUST be set to **true** if new terms are allowed to be added to the term set specified by the **termSetId** attribute. MUST be set to **false** otherwise. + +If applied to any other element, this attribute MUST be ignored. + +**percentage :** When applied to an **xsd:element** in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Currency or {http://schemas.microsoft.com/office/2006/documentManagement/types}Number, if set to **true**, specifies that the property corresponding to this xsd:element MUST be displayed as a percentage in the property-editing UI, and if not present or set to any other value, specifies that the property corresponding to this xsd:element MUST NOT be displayed as a percentage in the property-editing UI. + +If applied to any other element, this attribute MUST be ignored. + +**readOnly :** When applied to an **xsd:element** in a schema other than the root schema or core schema, if set to **true**, specifies that the property corresponding to this **xsd:element** MUST NOT be presented for editing. + +If applied to any other element, this attribute MUST be ignored. + +**requiredMultiChoice :** When applied to an **xsd:element** in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiChoice, {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiChoiceFillIn, or {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiChoiceLookup, if set to "true", choices MUST be selected for the property corresponding to this **xsd:element**. + +If applied to any other element, this attribute MUST be ignored. + +**root :** MUST be set to **true** on the root schema element specified in the **contentTypeSchema** (section 2.3.6.1.3.7). It MUST NOT be applied to any other element. + +**showField :** Specifies the text displayed in the property-editing UI for the lookup options of the property corresponding to this **xsd:element**. + +MUST be present on **xsd:elements** for which neither the **hidden** nor **readOnly** attributes are set to **true** in a schema other than the root schema or core schema whose content model is an **xsd:restriction** based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Lookup or {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiLookup. + +If applied to any other element, this attribute MUST be ignored. + +**sspId :** Specifies the term store identifier used in the property-editing UI for the property corresponding to this **xsd:element**. + +MUST be present on **xsd:elements** for which the **taxonomy** attribute is set to **true**, and MUST be set to 00000000-0000-0000-0000-000000000000 on **xsd:elements** for which the **isKeyword** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**taxonomy :** MUST be set to **true** on **xsd:elements** in a schema other than the root schema or core schema whose content model has the following structure. + +204. \ + + \ + + \ + + \ + + \ + + \ + +It MUST NOT be applied to any other element. + +**taxonomyFieldName :** MUST be present on **xsd:elements** for which the **taxonomy** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**taxonomyMulti :** If set to **false**, specifies that only single values are displayed as valid in the property-editing UI for the property corresponding to this **xsd:element**. + +MUST be present on **xsd:elements** for which the **taxonomy** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**termSetId :** Specifies the term set used in the property-editing UI for the property corresponding to this xsd:element. + +MUST be present on xsd:elements for which the **taxonomy** attribute is set to "true", and MUST be set to 00000000-0000-0000-0000-000000000000 on **xsd:elements** for which the **isKeyword** attribute is set to **true**. + +If applied to any other element, this attribute MUST be ignored. + +**web :** When applied to an **xsd:element** for which neither the **hidden** nor **readOnly** attributes are set to **true** in a schema other than the root schema or core schema whose content model is an xsd:restriction based on {http://schemas.microsoft.com/office/2006/documentManagement/types}Lookup or {http://schemas.microsoft.com/office/2006/documentManagement/types}MultiLookup, specifies the location of the website containing the list from which data is obtained to display the property corresponding to this xsd:element in the property-editing UI. + +If applied to any other element, this attribute MUST be ignored. + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +###### schema + +This element specifies an [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067). + +**Parent element:** [**contentTypeSchema**](#Section_708783bb2f0e4fa490372a952688f757) (section 2.3.6.1.3.7) + +\ + +###### contentTypeSchema + +The attributes and child elements of this element collectively specify a schema for the custom XML data item that specifies properties of the content type associated with the document. Each child of this element is an [**xsd:schema**](#Section_a19e7eeb1ab54d64bcc9dff9a6399ba4) (section 2.3.6.1.3.6) element (as specified by [\[W3C-XSD\]](https://go.microsoft.com/fwlink/?LinkId=90563)) that specifies one or more elements that appear in the custom XML data item. These xsd:schema elements are decorated with attributes from the http://schemas.microsoft.com/office/2006/metadata/properties/metaAttributes namespace as specified in section [2.3.6.1.3.5](#Section_e1f362d7a9e543b387fafa73531ad4e2). + +This element MUST contain an xsd:schema child element that has the **ma:root** Root (**DummyContentTypeElement.DummyContentType@root** (section 2.3.6.1.3.5)) attribute with value **true**. This **xsd:schema** specifies the structure of the root element of this Custom XML Data Storage item. This **xsd:schema** MUST have its **targetNamespace** attribute set to http://schemas.microsoft.com/office/2006/metadata/properties. It MUST declare and import any namespaces used by its child elements that are specified by other **xsd:schema** child elements. This xsd:schema element MUST have a **ma:fieldsID** Field IDs Hash (**DummyContentTypeElement.DummyContentType@fieldsID** (section 2.3.6.1.3.5)) attribute. + +Additionally, this **xsd:schema** element MUST declare an element called **properties** with the following structure. The child elements of the **xsd:all** are not shown, but are instead specified following this XML markup. + +210. \ + + \ + + \ + + \ + + \ + + \ + + ... + + \ + + \ + + \ + + \ + + \ + + \ + +In the following description, the term "content type" refers specifically to the root element of the Content Type Definition Type as specified in Collaborative Application Markup Language (CAML) Structure ([\[MS-WSSCAML\]](%5bMS-WSSCAML%5d.pdf#Section_8d6156fd646842949594644a946ed6a6) section 2.4.1.1). + +Let the term "fields" denote the list of all Field elements that are the fields used in the content type, as specified in Collaborative Application Markup Language (CAML) Structure (\[MS-WSSCAML\] section 2.3.2.6). Furthermore, let the term "filtered fields" denote the list of all filtered fields to be those Field elements from the fields that satisfy all of the following conditions (the quotes are not included): + +- +- +- + +The value of the **Type** attribute is not "Computed", "Calculated", "WorkflowStatus", "TaxonomyFieldType", or "TaxonomyFieldTypeMulti".The value of the **Name** attribute is not "Modified_x0020_By", "Created_x0020_By", "Modified", "Created", or "FileLeafRef".The value of the **StaticName** attribute is not "Title", "Subject", "\_Author", "Keywords", "\_Comments", "\_Category", "Slides", "ContentType", or "Status".The xsd:all element from the structure described previously MUST contain an xsd:element element for each Field element in the filtered fields set. This xsd:element MUST have a **ref** attribute. The value of the **ref** attribute MUST be a qualified reference to a type whose name is the value of the **StaticName** attribute of the Field element, and which resides in the namespace identified by the **SourceID** attribute of the Field element. Furthermore, if the **Required** attribute is not present on the Field element, or if the attribute is present but its value is not **true**, or if the value of the **Type** attribute is "MultiChoice" or "LookupMulti", then a **minOccurs** attribute with value of 0 MUST be present on the xsd:element element. + +For each unique string that appears as the value of the **SourceID** attributes on any Field element in fields, the contentTypeSchema element MUST contain an xsd:schema child whose **targetNamespace** attribute has that same value. Each **xsd:schema** MUST contain one xsd:element element for each Field whose **SourceID** attribute is the same as the **targetNamespace** of the xsd:schema. + +Each xsd:element element MUST have a **Name** attribute whose value is the value of the **StaticName** attribute on the corresponding Field element. Each **xsd:element** element MUST have a **ma:index** Index (**DummyContentTypeElement.DummyContentType@index** (section 2.3.6.1.3.5)) attribute whose value is the number of Field elements that appear before the corresponding Field element within the Fields element in the content type. If the **Required** attribute is not present on the corresponding Field element, or if the attribute is present but its value is not **true**, or if the value of the **Type** attribute is "MultiChoice" or "LookupMulti", a **nullable** attribute (\[W3C-XSD\]) with value of **true** MUST be present on the **xsd:element** element. + +The following attributes can appear on each **xsd:element** element: + +- +- +- +- +- +- +- +- +- +- +- +- +- + +**ma:displayName** Display Name (**DummyContentTypeElement.DummyContentType@displayName** (section 2.3.6.1.3.5))**ma:decimals** Decimals (**DummyContentTypeElement.DummyContentType@decimals** (section 2.3.6.1.3.5))**ma:default** Default (**DummyContentTypeElement.DummyContentType@default** (section 2.3.6.1.3.5))**ma:description** Description (**DummyContentTypeElement.DummyContentType@description** (section 2.3.6.1.3.5)); **ma:format** Format (**DummyContentTypeElement.DummyContentType@format** (section 2.3.6.1.3.5))**ma:hidden** Hidden (**DummyContentTypeElement.DummyContentType@hidden** (section 2.3.6.1.3.5))**ma:LCID** LCID (**DummyContentTypeElement.DummyContentType@LCID** (section 2.3.6.1.3.5))**ma:list** List (**DummyContentTypeElement.DummyContentType@list** (section 2.3.6.1.3.5))**ma:internalName** Internal Name (**DummyContentTypeElement.DummyContentType@internalName** (section 2.3.6.1.3.5))**ma:readOnly** Read Only (**DummyContentTypeElement.DummyContentType@readOnly** (section 2.3.6.1.3.5))**ma:showField** Show Field (**DummyContentTypeElement.DummyContentType@showField** (section 2.3.6.1.3.5))**ma:percentage** Percentage (**DummyContentTypeElement.DummyContentType@percentage** (section 2.3.6.1.3.5))**ma:web** Web (**DummyContentTypeElement.DummyContentType@web** (section 2.3.6.1.3.5))**ma:requiredMultiChoice** Required Multiple Choice (**DummyContentTypeElement.DummyContentType@requiredMultiChoice** (section 2.3.6.1.3.5))The **contentTypeSchema** MUST have an **xsd:schema** child element whose **targetNamespace** attribute has the value "http://schemas.openxmlformats.org/package/2006/metadata/core-properties". + +**Child element:** **schema** (section 2.3.6.1.3.6) + +Attributes: + +**contentTypeDescription :** MUST be the same value as the **Description** attribute of the ContentType element (as specified in Collaborative Application Markup Language (CAML) Structure (\[MS-WSSCAML\] section 2.4.1.1) for the content type associated with the document. + +**contentTypeID :** Identifies the content type associated with the document. + +**contentTypeName :** MUST be the same value as the **Name** attribute of the ContentType element as specified in Collaborative Application Markup Language (CAML) Structure (\[MS-WSSCAML\] section 2.4.1.1) for the content type associated with the document. + +**contentTypeScope :** MUST be empty and MUST be ignored. + +**contentTypeVersion :** MUST be the same value as the **Version** attribute of the ContentType element as specified in Collaborative Application Markup Language (CAML) Structure (\[MS-WSSCAML\] section 2.4.1.1) for the content type associated with the document. + +**versionID :** Specifies the string hash used to determine if the definition of the content type associated with the document has changed since the last time the content type was applied to the document. The value MUST be computed as an MD5 hash (as specified in [\[RFC1321\]](https://go.microsoft.com/fwlink/?LinkId=90275)) of the substring that represents the **ContentType** element (beginning with "\", both strings included) within the SOAP result of the **GetListContentType** web service request ([\[MS-LISTSWS\]](%5bMS-LISTSWS%5d.pdf#Section_30b364cc38374e839ce81963292e2ee5) section 3.1.4.17). + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +##### Cover Page Properties + +This section specifies the [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067) for specifying properties used for the document cover page[\<73\>](#Appendix_A_73). + +###### ST_PublishDate + +This simple type specifies the document publish date. + +\ + +\ + +\ + +###### PublishDate + +Specifies the date the document was published. + +**Parent element:** [**CoverPageProperties**](#Section_252c6032cf674f6c91d65f56ea66c7da) (section 2.3.6.1.4.8) + +\ + +###### Abstract + +Specifies the abstract of the document’s content. + +**Parent element:** [**CoverPageProperties**](#Section_252c6032cf674f6c91d65f56ea66c7da) (section 2.3.6.1.4.8) + +\ + +###### CompanyAddress + +Specifies the address of the company to be used in the document. + +**Parent element:** [**CoverPageProperties**](#Section_252c6032cf674f6c91d65f56ea66c7da) (section 2.3.6.1.4.8) + +\ + +###### CompanyPhone + +Specifies the phone number of the company to be used in the document. + +**Parent element:** [**CoverPageProperties**](#Section_252c6032cf674f6c91d65f56ea66c7da) (section 2.3.6.1.4.8) + +\ + +###### CompanyFax + +Specifies the fax number of the company to be used in the document. + +**Parent element:** [**CoverPageProperties**](#Section_252c6032cf674f6c91d65f56ea66c7da) (section 2.3.6.1.4.8) + +\ + +###### CompanyEmail + +Specifies the email address of the company to be used in the document. + +**Parent element:** [**CoverPageProperties**](#Section_252c6032cf674f6c91d65f56ea66c7da) (section 2.3.6.1.4.8) + +\ + +###### CoverPageProperties + +Specifies the parent element for properties used for the document cover page. + +*Child elements:* + +[**Abstract**](#Section_df05d7588d6647b4bbff5a7f11ae446c) (section 2.3.6.1.4.3) + +[**CompanyAddress**](#Section_c09e991e764a40748c201214c6634a48) (section 2.3.6.1.4.4) + +[**CompanyEmail**](#Section_e212a2749e464501afa1d4cf1f7f1256) (section 2.3.6.1.4.7) + +[**CompanyFax**](#Section_eb00ac2c2e4447f9a150dee3880a2947) (section 2.3.6.1.4.6) + +[**CompanyPhone**](#Section_5a6b2056449a4ad4935ee114c8cf1218) (section 2.3.6.1.4.5) + +[**PublishDate**](#Section_9dccbce275e24276a0bbf066c67dbbae) (section 2.3.6.1.4.2) + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +##### Long Properties + +This section specifies the [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067) for specifying the full content of the [User Defined Properties](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) whose values exceed 255 characters. + +###### LongProp + +This element specifies the full value of a user-defined property that exceeds 255 characters. + +**Parent element:** [**LongProperties**](#Section_3e0d6857c12443a6a14493ee50a79e44) (section 2.3.6.1.5.2) + +Attributes: + +**name :** Specifies the name of the user-defined property. + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +###### LongProperties + +This element specifies the full content of user defined properties whose values exceed 255 characters. + +**Child element:** [**LongProp**](#Section_8ed57b888c0841dba4a93471853de759) (section 2.3.6.1.5.1) + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +\ + +#### Custom XML Data Storage Properties + +The name of this [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST be "Properties". An instance of this stream contains an XML fragment conforming to the namespace http://schemas.openxmlformats.org/officeDocument/2006/customXml. It contains the set of properties which are specified for the corresponding custom XML data item. These properties consist of a unique ID for the custom XML data item and information about the set of [**XML schemas**](#gt_bd0ce6f9-c350-4900-827e-951265294067) used by the custom XML data item. + +##### ST_Guid + +This simple type specifies the restriction for specifying a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1). + +*Referenced by:* [*datastoreItem.CustomXmlDataProperties@itemID*](#Section_a8fb433020724dd8962bfc57e7dfc5dd) + +\ + +\ + +\ + +\ + +\ + +##### schemaRef + +This element specifies a single [**XML schema**](#gt_bd0ce6f9-c350-4900-827e-951265294067) that is associated with the custom XML data item. This XML schema is identified using its target namespace. + +**Parent element:** [**schemaRefs**](#Section_40b3b0b5243e4f6f8e645f446fb70ac2) (section 2.3.6.2.3) + +Attributes: + +**uri :** Specifies the target namespace for the XML Schema associated with this schema reference. + +\ + +\ + +\ + +##### schemaRefs + +This element specifies the set of [**XML schemas**](#gt_bd0ce6f9-c350-4900-827e-951265294067) that are associated with the corresponding custom XML data item. If this element is present, then the set of XML schemas provided within MUST be used to validate the contents of the corresponding custom XML data item. If no child [**schemaRef**](#Section_9cb777251f9c465bb7e880ef27929002) (section 2.3.6.2.2) elements exist then XML schema validation MUST NOT be performed on the custom XML data item. + +**Parent element:** [**datastoreItem**](#Section_a8fb433020724dd8962bfc57e7dfc5dd) (section 2.3.6.2.4) + +**Child element:** **schemaRef** (section 2.3.6.2.2) + +\ + +\ + +\ + +\ + +\ + +##### dataStoreItem + +This element specifies the properties for the corresponding custom XML data item. The set of properties specified within this element is attached to the custom XML data item. + +**Child element:** [**schemaRefs**](#Section_40b3b0b5243e4f6f8e645f446fb70ac2) (section 2.3.6.2.3) + +Attributes: + +**itemID :** Specifies a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that uniquely identifies a single custom XML data item within the document. Each **itemID** value MUST be unique among all custom XML data items in the document. + +\ + +\ + +\ + +\ + +\ + +\ + +### Hyperlinks + +This section specifies [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e)-related objects. + +#### Hyperlink Object + +This structure specifies a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) and hyperlink-related information. + +[TABLE] + +**streamVersion (4 bytes):** An unsigned integer that specifies the version number of the serialization implementation used to save this structure. This value MUST equal 2. + +**A - hlstmfHasMoniker (1 bit):** A bit that specifies whether this structure contains a [**moniker**](#gt_b88df1f8-e55a-4d08-9861-e7d6a4ed9abc). If **hlstmfMonikerSavedAsStr** equals 1, this value MUST equal 1. + +**B - hlstmfIsAbsolute (1 bit):** A bit that specifies whether this hyperlink is an [**absolute path**](#gt_e2edaf4f-a7f6-463e-9fe5-9b8bd3ce83c6) or [**relative path**](#gt_f0a8c9c7-1368-4989-addb-4792c3206387). + +| **Value** | **Meaning** | +|-----------|-------------------------------------| +| 0 | This hyperlink is a relative path. | +| 1 | This hyperlink is an absolute path. | + +**C - hlstmfSiteGaveDisplayName (1 bit):** A bit that specifies whether the creator of the hyperlink specified a display name. + +**D - hlstmfHasLocationStr (1 bit):** A bit that specifies whether this structure contains a [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). + +**E - hlstmfHasDisplayName (1 bit):** A bit that specifies whether this structure contains a display name. + +**F - hlstmfHasGUID (1 bit):** A bit that specifies whether this structure contains a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) as specified by [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2). + +**G - hlstmfHasCreationTime (1 bit):** A bit that specifies whether this structure contains the creation time of the file that contains the hyperlink. + +**H - hlstmfHasFrameName (1 bit):** A bit that specifies whether this structure contains a [**target frame**](#gt_1553572d-5903-4ce6-b842-fcfe103d72e8) name. + +**I - hlstmfMonikerSavedAsStr (1 bit):** A bit that specifies whether the moniker was saved as a string. + +**J - hlstmfAbsFromGetdataRel (1 bit):** A bit that specifies whether the hyperlink specified by this structure is an absolute path generated from a relative path. + +**reserved (22 bits):** MUST be zero and MUST be ignored. + +**displayName (variable):** An optional [**HyperlinkString**](#Section_1a9f6231df634a95b9985c2b95b82965) (section 2.3.7.9) that specifies the display name for the hyperlink. MUST exist if and only if **hlstmfHasDisplayName** equals 1. + +**targetFrameName (variable):** An optional **HyperlinkString** (section 2.3.7.9) that specifies the target frame. MUST exist if and only if **hlstmfHasFrameName** equals 1. + +**moniker (variable):** An optional **HyperlinkString** (section 2.3.7.9) that specifies the hyperlink moniker. MUST exist if and only if **hlstmfHasMoniker** equals 1 and **hlstmfMonikerSavedAsStr** equals 1. + +**oleMoniker (variable):** An optional [**HyperlinkMoniker**](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5) (section 2.3.7.2) that specifies the hyperlink moniker. MUST exist if and only if **hlstmfHasMoniker** equals 1 and **hlstmfMonikerSavedAsStr** equals 0. + +**location (variable):** An optional **HyperlinkString** (section 2.3.7.9) that specifies the hyperlink location. MUST exist if and only if **hlstmfHasLocationStr** equals 1. + +**guid (16 bytes):** An optional GUID as specified by \[MS-DTYP\] that identifies this hyperlink. MUST exist if and only if **hlstmfHasGUID** equals 1. + +**fileTime (8 bytes):** An optional **FileTime** structure as specified by \[MS-DTYP\] that specifies the [**UTC**](#gt_f2369991-a884-4843-a8fa-1505b6d5ece7) file creation time. MUST exist if and only if **hlstmfHasCreationTime** equals 1. + +#### HyperlinkMoniker + +*Referenced by: [CompositeMoniker](#Section_b5e2deb030694bacbc749433311f691b), [Hyperlink Object](#Section_c04372224868466081f86b7ee236d3f8)* + +This structure specifies a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) [**moniker**](#gt_b88df1f8-e55a-4d08-9861-e7d6a4ed9abc). + +[TABLE] + +**monikerClsid (16 bytes):** A [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) that specifies the [**Component Object Model (COM)**](#gt_ef2ebebc-1760-407a-9ace-af48f9050e02) component that saved this structure. MUST be a value from the following table: + +| **Value** | **Meaning** | +|----|----| +| {0x79EAC9E0, 0xBAF9, 0x11CE, 0x8C, 0x82, 0x00, 0xAA, 0x00, 0x4B, 0xA9, 0x0B} | **Data** field contains a [**URLMoniker**](#Section_4948a119c4e446b696090525118552e8) (section 2.3.7.6). | +| {0x00000303, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46} | **Data** field contains a [**FileMoniker**](#Section_c28c62d7adc5405585dbd957069965ac) (section 2.3.7.8). | +| {0x00000309, 0x0000, 0x0000, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46} | **Data** field contains a **CompositeMoniker** (section 2.3.7.3). | +| {0x00000305, 0x0000, 0x0000, { 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 } | **Data** field contains an [**AntiMoniker**](#Section_e56f55e7320d45beb5463250dd314f82) (section 2.3.7.4). | +| {0x00000304, 0x0000, 0x0000, { 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 } | **Data** field contains an [**ItemMoniker**](#Section_fae1319fa20942b4b60fb2bb25cdc22c) (section 2.3.7.5). | + +**data (variable):** A moniker of the type specified by **monikerClsid**. + +#### CompositeMoniker + +*Referenced by: [HyperlinkMoniker](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5)* + +This structure specifies a [**composite moniker**](#gt_1a7bac3d-446c-4dea-8e0f-6f08e8af465a). A composite moniker is a collection of arbitrary [**monikers**](#gt_b88df1f8-e55a-4d08-9861-e7d6a4ed9abc). For more information about composite monikers see [\[MSDN-IMGCMI\]](https://go.microsoft.com/fwlink/?LinkId=121363). + +[TABLE] + +**cMonikers (4 bytes):** An unsigned integer that specifies the count of monikers in **monikerArray**. + +**monikerArray (variable):** An array of **HyperlinkMonikers** (section 2.3.7.2). Each array element specifies a moniker of arbitrary type. + +#### AntiMoniker + +*Referenced by: [HyperlinkMoniker](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5)* + +This structure specifies an [**anti-moniker**](#gt_80b938ff-5999-4c83-a1f2-2819a024136e). An anti-moniker acts as the inverse of any moniker it is composed onto, effectively canceling out that moniker. In a [**composite moniker**](#gt_1a7bac3d-446c-4dea-8e0f-6f08e8af465a), anti-monikers are used to cancel out existing moniker elements, because monikers cannot be removed from a composite moniker. For more information about anti-monikers, see [\[MSDN-IMAMI\]](https://go.microsoft.com/fwlink/?LinkId=121364). + +[TABLE] + +**count (4 bytes):** An unsigned integer that specifies the number of anti-monikers that have been composed together to create this instance. When an anti-moniker is composed with another anti-moniker, the resulting composition would have a **count** field equaling the sum of the two **count** fields of the composed anti-monikers. This value MUST be less than or equal to 1048576. + +#### ItemMoniker + +*Referenced by: [HyperlinkMoniker](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5)* + +This structure specifies an [**item moniker**](#gt_df3f9a0a-d0f0-46f5-912c-2450a4f5f980). Item monikers are used to identify objects within containers, such as a portion of a document, an embedded object within a compound document, or a range of cells within a spreadsheet. For more information about item monikers, see [\[MSDN-IMCOM\]](https://go.microsoft.com/fwlink/?LinkId=121361). + +[TABLE] + +**delimiterLength (4 bytes):** An unsigned integer that specifies the sum of the count of bytes in the **delimiterAnsi** and **delimiterUnicode** fields. + +**delimiterAnsi (variable):** A null-terminated array of ANSI characters that specifies a delimiter for this [**moniker**](#gt_b88df1f8-e55a-4d08-9861-e7d6a4ed9abc). Delimiters are used to separate monikers that are part of a collection of monikers in a [**composite moniker**](#gt_1a7bac3d-446c-4dea-8e0f-6f08e8af465a). The number of characters in the array is determined by the position of the terminating NULL character. + +**delimiterUnicode (variable):** An optional array of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that specifies a delimiter for this moniker if the delimiter cannot be completely specified in ANSI characters. This field MUST exist if and only if **delimiterLength** is greater than the size of **delimiterAnsi** in bytes. The number of characters in the array is determined by (delimiterLength - (size of delimiterAnsi in bytes)) / 2. + +**itemLength (4 bytes):** An unsigned integer that specifies the count of bytes in the **itemAnsi** and **itemUnicode** fields. + +**itemAnsi (variable):** A null-terminated array of ANSI characters that specifies the string used to identify this item in a collection of items. The number of characters in this array is specified by **itemLength**. + +**itemUnicode (variable):** An optional array of Unicode characters that specifies the string used to identify this item in a collection of items, if the string cannot be completely specified in ANSI characters. This field MUST exist if and only if **itemLength** is greater than the size of **itemAnsi** in bytes. The number of characters in the array is determined by (itemLength – (size of itemAnsi field in bytes)) / 2. + +#### URLMoniker + +*Referenced by: [HyperlinkMoniker](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5)* + +This structure specifies a [**URL moniker**](#gt_756cc735-43ee-42b1-aa17-7652c51f9164). For more information about URL monikers, see [\[MSDN-URLM\]](https://go.microsoft.com/fwlink/?LinkId=121360). + +[TABLE] + +**length (4 bytes):** An unsigned integer that specifies the size of this structure in bytes, excluding the size of the **length** field. + +The value of this field MUST be either the byte size of the **url** field (including the terminating NULL character) or the byte size of the **url** field plus 24. + +If the value of this field is set to the byte size of the **url** field, then the **serialGUID**, **serialVersion**, and **uriFlags** fields MUST NOT be present. + +If the value of this field is set to the byte size of the **url** field plus 24, then the **serialGUID**, **serialVersion**, and **uriFlags** fields MUST be present. + +**url (variable):** A null-terminated array of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters that specifies the [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1). The number of characters in the array is determined by the position of the terminating NULL character. + +**serialGUID (16 bytes):** An optional [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) as specified by [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) for this implementation of the URL moniker serialization. This field MUST equal {0xF4815879, 0x1D3B, 0x487F, 0xAF, 0x2C, 0x82, 0x5D, 0xC4, 0x85, 0x27, 0x63} if present. + +**serialVersion (4 bytes):** An optional unsigned integer that specifies the version number of this implementation of the URL moniker serialization. This field MUST equal 0 if present. + +**uriFlags (4 bytes):** An optional [**URICreateFlags**](#Section_1786df8eb7924a28b7c54d9a91d2e401) structure (section 2.3.7.7) that specifies creation flags for an [\[RFC3986\]](https://go.microsoft.com/fwlink/?LinkId=90453) compliant URI. + +#### URICreateFlags + +*Referenced by: [URLMoniker](#Section_4948a119c4e446b696090525118552e8)* + +This structure specifies creation flags for an [\[RFC3986\]](https://go.microsoft.com/fwlink/?LinkId=90453) compliant [**URI**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95). For more information about URI creation flags, see [\[MSDN-CreateUri\]](https://go.microsoft.com/fwlink/?LinkId=120601). + +[TABLE] + +**A - createAllowRelative (1 bit):** A bit that specifies that if the [**URI scheme**](#gt_f5d40fa3-8fb6-4644-a8cf-2df732d2f7cf) is unspecified and not implicitly "file," a relative scheme is assumed during creation of the URI. + +**B - createAllowImplicitWildcardScheme (1 bit):** A bit that specifies that if the URI scheme is unspecified and not implicitly "file," a wildcard scheme is assumed during creation of the URI. + +**C - createAllowImplicitFileScheme (1 bit):** A bit that specifies that if the URI scheme is unspecified and the URI begins with a drive letter or a [**UNC**](#gt_c9507dca-291d-4fd6-9cba-a9ee7da8c908) path, a file scheme is assumed during creation of the URI. + +**D - createNoFrag (1 bit):** A bit that specifies that if a [**URI query**](#gt_5fc09267-f219-4b37-9d55-606f96ada4c0) string is present, the [**URI fragment**](#gt_f19ecb2f-edbb-4bdf-b601-23119d7dccf4) is not looked for during creation of the URI. + +**E - createNoCanonicalize (1 bit):** A bit that specifies that the scheme, host, authority, path, and fragment will not be canonicalized during creation of the URI. This value MUST be 0 if **createCanonicalize** equals 1. + +**F - createCanonicalize (1 bit):** A bit that specifies that the scheme, host, authority, path, and fragment will be canonicalized during creation of the URI. This value MUST be 0 if **createNoCanonicalize** equals 1. + +**G - createFileUseDosPath (1 bit):** A bit that specifies that [**MS-DOS path compatibility mode**](#gt_f685c67b-3b1b-4c3c-be3a-5041756627f3) will be used during creation of file URIs. + +**H - createDecodeExtraInfo (1 bit):** A bit that specifies that percent encoding and percent decoding canonicalizations will be performed on the URI query and URI fragment during creation of the URI. This field takes precedence over the **createNoCanonicalize** field. This value MUST be 0 if **createNoDecodeExtraInfo** equals 1. The value 1 can also be saved. This will cause a return value of E_INVALIDARG from CreateUri(). + +**I - createNoDecodeExtraInfo (1 bit):** A bit that specifies that percent encoding and percent decoding canonicalizations will not be performed on the URI query and URI fragment during creation of the URI. This field takes precedence over the **createCanonicalize** field. This value MUST be 0 if **createDecodeExtraInfo** equals 1. The value 1 can also be saved. This will cause a return value of E_INVALIDARG from CreateUri(). + +**J - createCrackUnknownSchemes (1 bit):** A bit that specifies that hierarchical URIs with unrecognized URI schemes will be treated like hierarchical URIs during creation of the URI. This value MUST be 0 if **createNoCrackUnknownSchemes** equals 1. + +**K - createNoCrackUnknownSchemes (1 bit):** A bit that specifies that hierarchical URIs with unrecognized URI schemes will be treated like opaque URIs during creation of the URI. This value MUST be 0 if **createCrackUnknownSchemes** equals 1. + +**L - createPreProcessHtmlUri (1 bit):** A bit that specifies that preprocessing will be performed on the URI to remove control characters and white space during creation of the URI. This value MUST be 0 if **createNoPreProcessHtmlUri** equals 1. + +**M - createNoPreProcessHtmlUri (1 bit):** A bit that specifies that preprocessing will not be performed on the URI to remove control characters and white space during creation of the URI. This value MUST be 0 if **createPreProcessHtmlUri** equals 1. + +**N - createIESettings (1 bit):** A bit that specifies that registry settings will be used to determine default [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) parsing behavior during creation of the URI. This value MUST be 0 if **createNoIESettings** equals 1. + +**O - createNoIESettings (1 bit):** A bit that specifies that registry settings will not be used to determine default URL parsing behavior during creation of the URI. This value MUST be 0 if **createIESettings** equals 1. + +**P - createNoEncodeForbiddenCharacters (1 bit):** A bit that specifies that URI characters forbidden in \[RFC3986\] will not be percent-encoded during creation of the URI. + +**reserved (16 bits):** MUST be zero and MUST be ignored. + +#### FileMoniker + +*Referenced by: [HyperlinkMoniker](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5)* + +This structure specifies a [**file moniker**](#gt_1817f7bc-637d-4bcf-8f7a-27e96f1e7e07). For more information about file monikers, see [\[MSDN-FM\]](https://go.microsoft.com/fwlink/?LinkId=121362). + +[TABLE] + +**cAnti (2 bytes):** An unsigned integer that specifies the number of [**parent directory indicators**](#gt_368cbdb8-5432-442d-9565-59193bad0d29) at the beginning of the **ansiPath** field. + +**ansiLength (4 bytes):** An unsigned integer that specifies the number of ANSI characters in **ansiPath**, including the terminating NULL character. This value MUST be less than or equal to 32767. + +**ansiPath (variable):** A null-terminated array of ANSI characters that specifies the file path. The number of characters in the array is specified by **ansiLength**. + +**endServer (2 bytes):** An unsigned integer that specifies the number of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters used to specify the server portion of the path if the path is a [**UNC**](#gt_c9507dca-291d-4fd6-9cba-a9ee7da8c908) path (including the leading "\\"). If the path is not a UNC path, this field MUST equal 0xFFFF. + +**versionNumber (2 bytes):** An unsigned integer that specifies the version number of this file moniker serialization implementation. MUST equal 0xDEAD. + +**reserved1 (16 bytes):** MUST be zero and MUST be ignored. + +**reserved2 (4 bytes):** MUST be zero and MUST be ignored. + +**cbUnicodePathSize (4 bytes):** An unsigned integer that specifies the size, in bytes, of **cbUnicodePathBytes**, **usKeyValue**, and **unicodePath**. + +If the file path specified in **ansiPath** cannot be completely specified by ANSI characters, the value of this field MUST be equal to the size, in bytes, of the path as a Unicode string (without a terminating NULL character) + 6. If the path can be fully specified in ANSI characters then the value of this field MUST be set to zero. + +If the value of this field is greater than zero, then the **cbUnicodePathBytes, usKeyValue** and **unicodePath** fields MUST exist. + +If the value of this field is zero, then the **cbUnicodePathBytes**, **usKeyValue**, and **unicodePath** fields MUST NOT exist. + +**cbUnicodePathBytes (4 bytes):** An optional unsigned integer that specifies the size, in bytes, of the **unicodePath** field. This field exists if and only if **cbUnicodePathSize** is greater than zero. + +**usKeyValue (2 bytes):** An optional unsigned integer that MUST be 3 if present. This field exists if and only if **cbUnicodePathSize** is greater than zero. + +**unicodePath (variable):** An optional array of Unicode characters that specifies the complete file path. This path MUST be the complete Unicode version of the file path specified in **ansiPath** and MUST include additional Unicode characters that cannot be completely specified in ANSI characters. The number of characters in this array is specified by **cbUnicodePathBytes**/2. This array MUST NOT include a terminating NULL character. This field exists if and only if **cbUnicodePathSize** is greater than zero. + +#### HyperlinkString + +*Referenced by: [Hyperlink Object](#Section_c04372224868466081f86b7ee236d3f8)* + +This structure specifies a string for a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e). + +[TABLE] + +**length (4 bytes):** An unsigned integer that specifies the number of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters in the **string** field, including the null-terminating character. + +**string (variable):** A null-terminated array of Unicode characters. The number of characters in the array is specified by the **length** field. + +### MsoEnvelope + +This section specifies structures related to the [**MsoEnvelope**](#Section_52f153930e4f4bd9a521dcb8f0a869ef) structure (section 2.3.8.2). + +#### MsoEnvelopeCLSID + +A structure that specifies the type of data in **EnvelopeData** based on the value of [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99). + +[TABLE] + +**CLSID (16 bytes):** A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1), as specified by [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2), that specifies the type of data in **EnvelopeData**. If this GUID equals { 0x0006F01A, 0x0000, 0x0000, { 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46 } }, then the data in **EnvelopeData** is specified by [**MsoEnvelope**](#Section_52f153930e4f4bd9a521dcb8f0a869ef) structure (section 2.3.8.2). If not, then the data in **EnvelopeData** is out of scope for this document. + +**EnvelopeData (variable):** An array of bytes that is either specified by **MsoEnvelope** structure (section 2.3.8.2) or is out of scope, depending on the value of CLSID. + +#### MsoEnvelope + +A structure that contains information about the email message being sent. + +[TABLE] + +**Ver (4 bytes):** An unsigned integer that specifies the version of this envelope. + +**LastSentTime (4 bytes):** A signed integer that specifies the last time this email message was sent. Time is represented as the number of minutes since 12:00 AM January 1, 1601. The value MUST be greater than or equal to 0 and less than or equal to 0x5AE980E0. The default value is 0x5AE980E0, which means no time was specified. + +**FlagStatus (4 bytes):** An unsigned integer that specifies the follow-up status of this email message. Values are zero for not flagged for follow-up, 1 for flagged for follow-up, and 2 for completed follow-up. + +**ReplyTime (4 bytes):** A signed integer that specifies when the last reply was received for this email message. The time is represented as the number of minutes since 12:00 AM January 1, 1601. The value MUST be greater than or equal to zero and less than or equal to 0x5AE980E0. The default value is 0x5AE980E0, which means no time was specified. + +**RequestStrSize (2 bytes):** An unsigned integer that contains the size, in characters, of **RequestStr**. + +**RequestStr (variable):** A character array that contains the request string. For example, if the sender has set a flag on this email message with "No Response Necessary", this string contains "No Response Necessary". If **Ver** is 6, this is an [**ANSI character set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583) array. If **Ver** is 8, this is a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character array. + +**SentRepresentingEntryIdSize (4 bytes):** An unsigned integer that contains the size, in bytes, of **SentRepresentingEntryId**. + +**SentRepresentingEntryId (variable):** An array of bytes that specifies the PR_SENT_REPRESENTING_ENTRYID as specified in [\[MS-OXPROPS\]](%5bMS-OXPROPS%5d.pdf#Section_f6ab1613aefe447da49c18217230b148). + +**SentRepresentingNameSize (2 bytes):** An unsigned integer that contains the size, in characters, of **SentRepresentingName**. + +**SentRepresentingName (variable):** A character array that specifies the PR_SENT_REPRESENTING_NAME as specified in \[MS-OXPROPS\]. If **Ver** is 6, this is an ANSI character set array. If **Ver** is 8, this is a Unicode character array. + +**InetAcctStampSize (2 bytes):** An unsigned integer that contains the size, in characters, of **InetAcctStamp**. + +**InetAcctStamp (variable):** A character array that specifies the **dispidInetAcctStamp** as specified in \[MS-OXPROPS\]. If **Ver** is 6, this is an ANSI character set array. If **Ver** is 8, this is a Unicode character array. + +**InetAcctNameSize (2 bytes):** An unsigned integer that contains the size, in characters, of **InetAcctName**. + +**InetAcctName (variable):** A character array that contains the **dispidInetAcctName** as specified in \[MS-OXPROPS\]. If **Ver** is 6, this is an ANSI character set array. If **Ver** is 8, this is a Unicode character array. + +**ExpiryTime (4 bytes):** A signed integer that specifies the time this email message expires. The time is represented as the number of minutes since 12:00 AM January 1, 1601. The value MUST be greater than or equal to 0 and less than or equal to 0x5AE980E0. The default value is 0x5AE980E0, which means no time was specified. + +**DeferredDeliveryTime (4 bytes):** A signed integer that specifies the time to send this email message. The time is represented as the number of minutes since 12:00 AM January 1, 1601. The value MUST be greater than or equal to 0 and less than or equal to 0x5AE980E0. The default value is 0x5AE980E0, which means no time was specified. + +**DeleteAfterSubmit (4 bytes):** An unsigned integer that specifies whether to delete the message after a recipient has submitted a reply. Values are zero for no, and 1 for yes. MUST be zero or 1. + +**SecurityFlags (4 bytes):** A bit field that specifies the security settings for this email message. The least significant bit specifies whether the email message is signed, and the next bit specifies whether the email message is encrypted. All other bits MUST be zero. + +**OriginatorDeliveryReportRequested (4 bytes):** An unsigned integer that specifies whether to send a delivery receipt to the sender. Values are zero for no and 1 for yes. MUST be zero or 1. + +**ReadReceiptRequested (4 bytes):** An unsigned integer that specifies whether to send a read receipt to the sender. Values are zero for no and 1 for yes. MUST be zero or 1. + +**CategoriesStrSize (2 bytes):** An unsigned integer that contains the size, in characters, of **CategoriesStr**. + +**CategoriesStr (variable):** A character array that contains the category for this email message. For example, "Business" or "Favorites". If **Ver** is 6, this is an ANSI character set array. If **Ver** is 8, this is a Unicode character array. + +**Sensitivity (4 bytes):** An unsigned integer that specifies the sensitivity of the email message. Values are zero for Normal, 1 for Personal, 2 for Private, and 3 for Confidential. MUST be less than 4. + +**Importance (4 bytes):** An unsigned integer that specifies the importance flag of the email message. Values are 0 for Low, 1 for Normal, and 2 for High. MUST be less than 3. + +**SubjectSize (2 bytes):** An unsigned integer that contains the size, in characters, of **Subject**. + +**Subject (variable):** A character array that contains the subject of the email message. If **Ver** is 6, this is an ANSI character set array. If **Ver** is 8, this is a Unicode character array. + +**VotingOptionsSize (2 bytes):** An unsigned integer that contains the size, in characters, of the **VotingOptions**. + +**VotingOptions (variable):** An ANSI character array that contains the voting option choices separated by a semicolon. For example, "Yes;No;Maybe". + +**ReplyRecipients (variable):** An [**EnvRecipientCollection**](#Section_5deabdf8d4604a4ca0a64cb7cefaf75d) (section 2.3.8.3) that contains the recipients of replies to this email message. + +**ContactLinkRecipients (variable):** An **EnvRecipientCollection** (section 2.3.8.3) that contains the sender contacts to whom the email message is to be sent. This is not present if **Ver** does not equal 8. + +**Recipients (variable):** An **EnvRecipientCollection** (section 2.3.8.3) that contains the recipients to receive this email message. + +**Attachments (variable):** An [**EnvAttachmentCollection**](#Section_706192e0b6734ba2a1548f4dfc9f0165) (section 2.3.8.17) that contains information about attachments for this email message. + +**IntroText (variable):** If **Ver** equals 8, this is an [**IntroText**](#Section_01e96fcbe7504b1f94249d05b8545403) (section 2.3.8.19). This is not present if **Ver** does not equal 8. + +#### EnvRecipientCollection + +*Referenced by: [MsoEnvelope](#Section_f7c1375ecff349c6b62f39492273827c)* + +A collection that contains information about recipients for an email message. + +[TABLE] + +**RecipientCollTag (4 bytes):** An unsigned integer that contains a version tag for the recipient collection. MUST be 0xDCCA0123. + +**RecipientCollVer (4 bytes):** An unsigned integer that contains a version for the recipient collection. MUST be 1. + +**Count (4 bytes):** An unsigned integer that contains the number of recipients in the **Recipients** array. + +**Recipients (variable):** An array of [**EnvRecipientProperties**](#Section_f9e2a31453104779b5a8ecf6817703bd) (section 2.3.8.4) that contains the properties for each recipient. + +#### EnvRecipientProperties + +*Referenced by: [EnvRecipientCollection](#Section_5deabdf8d4604a4ca0a64cb7cefaf75d)* + +An **EnvRecipientProperties** structure that contains the properties of a single email message recipient. + +[TABLE] + +**Count (4 bytes):** An unsigned integer that contains the number of properties for this recipient. + +**Ignored (4 bytes):** MUST be ignored. + +**Properties (variable):** An array of [**EnvRecipientProperty**](#Section_8df36d0a49eb4f41910bcec9ba5120e8) (section 2.3.8.5) that has the size of **Count**. + +#### EnvRecipientProperty + +*Referenced by: [EnvRecipientProperties](#Section_f9e2a31453104779b5a8ecf6817703bd)* + +A single property for an email message recipient. These properties are specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). Only the sizes of the properties are described here. + +[TABLE] + +**PropTag (4 bytes):** An unsigned integer that contains the property identifier tag. + +**PropData (variable):** An [**EnvRecipientPropertyBlob**](#Section_2ce2498ef44f4ceaaf7059c3abc4c129) (section 2.3.8.6), the type of which is specified by **PropTag**. + +#### EnvRecipientPropertyBlob + +*Referenced by: [EnvRecipientProperty](#Section_8df36d0a49eb4f41910bcec9ba5120e8)* + +A structure that describes the size of the data for a single recipient property. The type of this structure is specified by the **PropTag** of a **EnvRecipientProperty** (section 2.3.8.5). + +| Value | Meaning | +|----|----| +| 0x0003 | The property data is a [**PT_LONG**](#Section_14c87459b96747838c07c577771d4692) (section 2.3.8.7). | +| 0x0001 | The property data is a [**PT_NULL**](#Section_baff4515df094c9f85ecc5c1b2750111) (section 2.3.8.8). | +| 0x000B | The property data is a [**PT_BOOLEAN**](#Section_bfed9f7b80e24683b8aae31c269edc37) (section 2.3.8.9). | +| 0x0040 | The property data is a [**PT_SYSTIME**](#Section_b9f7856615ae419fafa944265c9f4092) (section 2.3.8.10). | +| 0x000A | The property data is a [**PT_ERROR**](#Section_b26e9a2c53c047e89961999b63be162a) (section 2.3.8.11). | +| 0x001E | The property data is a [**PT_STRING8**](#Section_0c75d01a68c844bf9b4480a73d052db5) section 2.3.8.12). | +| 0x001F | The property data is a [**PT_UNICODE**](#Section_274cc379b1964a8f89baeb9cf0baf7fc) (section 2.3.8.13). | +| 0x0102 | The property data is a [**PT_BINARY**](#Section_5eb7ad4f284c427ea7f6b2b418a0b403) (section 2.3.8.14). | +| 0x101E | The property data is a [**PT_MV_STRING8**](#Section_19c08692116741bf9801053c11225c69) (section 2.3.8.15). | +| 0x1102 | The property data is a [**PT_MV_BINARY**](#Section_21b12ab606c44eaabf302224ccac74f1) (section 2.3.8.16). | + +#### PT_LONG + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that is an unsigned integer as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Value (4 bytes):** The value for this property as specified in \[MS-OXCDATA\]. + +#### PT_NULL + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that is an unsigned integer as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Value (4 bytes):** The value for this property as specified in \[MS-OXCDATA\]. + +#### PT_BOOLEAN + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that is an unsigned integer as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Value (2 bytes):** The value of the property as specified in \[MS-OXCDATA\]. + +#### PT_SYSTIME + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that is a **FILETIME** value as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**HighValue (4 bytes):** The first part of the property's value. + +**LowValue (4 bytes):** The second part of the property's value. + +#### PT_ERROR + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that is an unsigned integer as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Value (4 bytes):** The value of the property as specified in \[MS-OXCDATA\]. + +#### PT_STRING8 + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129), [PT_MV_STRING8](#Section_19c08692116741bf9801053c11225c69)* + +A recipient property that is an [**ANSI character set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583) string as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Size (2 bytes):** An unsigned integer that specifies the size, in bytes, of **Value**. + +**Value (variable):** An array of characters from the ANSI character set as specified in \[MS-OXCDATA\]. + +#### PT_UNICODE + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that is a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Size (2 bytes):** An unsigned integer that specifies the size, in bytes, of **Value**. + +**Value (variable):** A Unicode string as specified in \[MS-OXCDATA\]. + +#### PT_BINARY + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129), [PT_MV_BINARY](#Section_21b12ab606c44eaabf302224ccac74f1)* + +A recipient property that is an array of bytes as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Size (2 bytes):** An unsigned integer that contains the size, in bytes, of **Data**. + +**Data (variable):** An array of bytes as specified in \[MS-OXCDATA\]. + +#### PT_MV_STRING8 + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that consists of multiple [**ANSI character set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583) strings as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Count (4 bytes):** An unsigned integer that specifies the number of elements in **Data**. + +**Data (variable):** An array of [**PT_STRING8**](#Section_0c75d01a68c844bf9b4480a73d052db5) (section 2.3.8.12) as specified in \[MS-OXCDATA\]. + +#### PT_MV_BINARY + +*Referenced by: [EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129)* + +A recipient property that consists of multiple byte arrays as specified in [\[MS-OXCDATA\]](%5bMS-OXCDATA%5d.pdf#Section_1afa0cd9b1a04520b623bf15030af5d8). + +[TABLE] + +**Count (4 bytes):** An unsigned integer that specifies the number of elements in **Data**. + +**Data (variable):** An array of [**PT_BINARY**](#Section_5eb7ad4f284c427ea7f6b2b418a0b403) (section 2.3.8.14) as specified in \[MS-OXCDATA\]. + +#### EnvAttachmentCollection + +*Referenced by: [MsoEnvelope](#Section_f7c1375ecff349c6b62f39492273827c)* + +A collection that contains the data for each of the attachments for an email message. + +[TABLE] + +**Count (4 bytes):** An unsigned integer that contains the number of attachments for an email message. + +**Attachments (variable):** An array of [**EnvAttachment**](#Section_a8ff6fd332d14fd0ad6a5f3a0cf3bcce) (section 2.3.8.18) of size **Count** that contains the data for each attachment. + +#### EnvAttachment + +*Referenced by: [EnvAttachmentCollection](#Section_706192e0b6734ba2a1548f4dfc9f0165)* + +A structure that contains the data for a single email message attachment. + +[TABLE] + +**AttachmentMethod (4 bytes):** An unsigned integer that represents the MAPI property **PR_ATTACH_METHOD**, as specified in [\[MS-OXPROPS\]](%5bMS-OXPROPS%5d.pdf#Section_f6ab1613aefe447da49c18217230b148). + +**AttachmentNameSize (1 byte):** A byte that contains the size, in characters, of **AttachmentName**. + +**AttachmentName (variable):** A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character array that contains the file name of the attachment. + +**AttachmentSizeLowOrderBits (4 bytes):** An unsigned integer that contains the low-order bits for the file size of the attachment. + +**AttachmentSizeHighOrderBits (4 bytes):** An unsigned integer that contains the high-order bits for the file size of the attachment. + +**Data (variable):** An array of bytes that contains the content of the attachment. + +#### IntroText + +Specifies the text of the introduction for the document when sent as an email message. + +[TABLE] + +**IntroTextSize (4 bytes):** An unsigned integer that specifies the size, in bytes, of **IntroText**. MUST be evenly divisible by two. + +**IntroText (variable):** A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character array that specifies the introduction text. + +### Document Signature Serialized Certificate Store Structure + +This section specifies a serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) that is persisted as part of a collection of document signatures, as specified in [\[MS-OFFCRYPTO\]](%5bMS-OFFCRYPTO%5d.pdf#Section_3c34d72a1a614b52a893196f9157f083) section 2.5. + +#### DocSigSerializedCertStore + +The serialized [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) specifies structures for storing a digital certificate store containing zero or more [**digital certificates**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) and, optionally, a list of properties associated with each certificate. + +[TABLE] + +**version (4 bytes):** An unsigned integer identifying the version of the structure. MUST be 0x00000000. + +**fileType (4 bytes):** An unsigned integer that specifies the type of data contained in the structure. MUST be the value 0x54524543. + +**certificateList (variable):** An array of [**CertStoreCertificateGroup**](#Section_462654f19be347f59c1ea6d328ac52e0) (section 2.3.2.5.4). This array can contain zero or more elements. Each element of the array specifies a digital certificate and a collection of optional properties associated with the certificate. Elements of this array are read and processed until a **CertStoreCertificateGroup.SerializedPropertyEntry.id** is read with the unsigned integer value 0x00000000, which specifies the end of this array and the beginning of the **endMarkerElement** field. The terminating **CertStoreCertificateGroup.SerializedPropertyEntry.id** value read is actually the **endMarkerElement.id** field and not part of this field. + +**endMarkerElement (12 bytes):** An [**EndElementMarkerEntry**](#Section_020eb66c88e3466b80f60e3ce84d0544) structure (section 2.3.2.5.2) specifying the end of the structure. + +## Common Algorithms + +### Unicode String to Unsigned Integer Hash + +Given a null-terminated [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string, a 4-byte unsigned integer [**hash**](#gt_b7e2b611-0af5-4fec-8af2-3f9ce7bad205) value can be obtained by performing the following algorithm: + +1. +2. +3. +4. + +Set a 4-byte unsigned integer value **dwHash** equal to 0x00000000.Truncate the **input string** to 255 characters plus the null-terminating character.Convert the **input string** to lower case.For each set of 2 characters (**Char1**, **Char2**) from position 0 to the end of the **input string** (for example, \[0,1\], \[2,3\], \[4,5\], …, \[255, \\]) perform the following steps.Example: + +223. for (i=0; i\.%....... + + 00000540: 00 00 03 00 00 00 00 00 00 00 03 00 00 00 05 00 ................ + + 00000550: 00 00 1F 00 00 00 31 00 00 00 68 00 74 00 74 00 ......1...h.t.t. + + 00000560: 70 00 3A 00 2F 00 2F 00 65 00 6E 00 2E 00 61 00 p.:././.e.n...a. + + 00000570: 64 00 61 00 74 00 75 00 6D 00 2E 00 63 00 6F 00 d.a.t.u.m...c.o. + + 00000580: 6D 00 2F 00 61 00 63 00 63 00 6F 00 75 00 6E 00 m./.a.c.c.o.u.n. + + 00000590: 74 00 69 00 6E 00 67 00 2F 00 6D 00 61 00 6E 00 t.i.n.g./.m.a.n. + + 000005A0: 61 00 67 00 65 00 72 00 6C 00 69 00 73 00 74 00 a.g.e.r.l.i.s.t. + + 000005B0: 2E 00 68 00 74 00 6D 00 6C 00 00 00 00 00 1F 00 ..h.t.m.l....... + + 000005C0: 00 00 0F 00 00 00 65 00 6D 00 61 00 69 00 6C 00 ......e.m.a.i.l. + + 000005D0: 41 00 64 00 64 00 72 00 65 00 73 00 73 00 65 00 A.d.d.r.e.s.s.e. + + 000005E0: 73 00 00 00 00 00 03 00 00 00 28 00 6B 00 03 00 s.........(.k... + + 000005F0: 00 00 FF FF FF FF 03 00 00 00 03 04 00 00 03 00 ................ + + 00000600: 00 00 04 00 00 00 1F 00 00 00 01 00 00 00 00 00 ................ + + 00000610: 79 32 1F 00 00 00 19 00 00 00 5F 00 53 00 6B 00 y2........\_.S.k. + + 00000620: 69 00 70 00 2D 00 6C 00 65 00 76 00 65 00 6C 00 i.p.-.l.e.v.e.l. + + 00000630: 5F 00 56 00 65 00 72 00 69 00 66 00 69 00 63 00 \_.V.e.r.i.f.i.c. + + 00000640: 61 00 74 00 69 00 6F 00 6E 00 00 00 00 00 1E 00 a.t.i.o.n....... + + 00000650: 00 00 0C 00 00 00 41 63 63 6F 75 6E 74 69 6E 67 ......Accounting + + 00000660: 00 00 03 00 00 00 05 00 00 00 0B 00 00 00 00 00 ................ + + 00000670: 00 00 1E 00 00 00 18 00 00 00 53 69 67 6E 20 74 ..........Sign t + + 00000680: 68 65 20 61 70 70 72 6F 76 61 6C 20 66 6F 72 6D he approval form + + 00000690: 00 00 1E 00 00 00 1C 00 00 00 53 6B 69 70 4C 65 ..........SkipLe + + 000006A0: 76 65 6C 56 65 72 69 66 69 63 61 74 69 6F 6E 53 velVerificationS + + 000006B0: 74 61 72 74 00 00 00 00 tart.... + +### Document Summary Information Stream Overview + +The following table contains the beginning part of a Document Summary Information [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). There are two [**FilePointers**](#Section_0566aac8327c404186e5e4142458d93e) (section 2.2.1.5) in this section that point to a [**Document Summary Information property set**](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2) and a [**User Defined property set**](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3), respectively. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 06B8 | PropertySetStream **- DocumentSummaryInfoStream** | | +| 00000000 | 0044 | Stream header **- PropertySetStream** | | +| 00000000 | 0002 | WORD **- byteOrder** | 0xFFFE | +| 00000002 | 0002 | WORD **- version** | 0x0000 | +| 00000004 | 0004 | [PropertySetSystemIdentifier](#Section_6ac486b48d634cdebd729c2306a482fe) **- sysId** | | +| 00000004 | 0001 | BYTE **- OSMajorVersion** | 0x05 | +| 00000005 | 0001 | BYTE **- OSMinorVersion** | 0x01 | +| 00000006 | 0002 | WORD **- OSType** | 0x0002 | +| 00000008 | 0010 | GUID **- applicationClsid** | 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 | +| 00000018 | 0004 | DWORD **- cSections** | 0x00000002 | +| 0000001C | 0028 | Array of identifier and offset **- rgIdOffset** | | +| 0000001C | 0014 | Identifier and offset **- IdOffsetElement-1** | | +| 0000001C | 0010 | GUID **- formatId** | 02 D5 CD D5 9C 2E 1B 10 93 97 08 00 2B 2C F9 AE | +| 0000002C | 0004 | FilePointer **- sectionOffset** | 0x00000044 | +| 00000030 | 0014 | Identifier and offset **- IdOffsetElement-2** | | +| 00000030 | 0010 | GUID **- formatId** | 05 D5 CD D5 9C 2E 1B 10 93 97 08 00 2B 2C F9 AE | +| 00000040 | 0004 | FilePointer **- sectionOffset** | 0x00000298 | +| 00000044 | 0254 | **A**: PropertySet **- DocumentSummaryInformation** | | +| 00000298 | 0420 | **B**: PropertySet **- UserDefinedProperties** | | + +Figure 15: Overview of a DocumentSummaryInfoStream + +**DocumentSummaryInfoStream:** This is an example of the **PropertySetStream** as described in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.21](http://msdn.microsoft.com/en-us/library/6e65d6fa-6044-4e23-ae71-d65d1e3b1249/). + +**PropertySetStream.byteOrder:** 0xFFFE is a reserved value. + +**PropertySetStream.version:** 0x0000 is the version number of the property set. + +**PropertySetStream.sysId.OSMajorVersion:** 0x05 indicates that the [**major version**](#gt_66583c77-eb07-43c4-8f1b-dd157580db46) of the operating system that created the file is 5. + +**PropertySetStream.sysId.OSMinorVersion:** 0x01 indicates that the [**minor version**](#gt_e0d99b53-9426-4a45-8429-b012184a4045) of the operating system that created the file is 1. + +**PropertySetStream.sysId.OSType:** 0x0002 is a reserved value. + +**PropertySetStream.applicationClsid:** 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 is the CLID_NULL. It is a reserved value. + +**PropertySetStream.cSections:** 0x00000002 indicates that this instance of a Document Summary Information stream contains two property sets, the **Document Summary Information property set** (section 2.3.3.2.2) and the **User Defined property set** (section 2.3.3.2.3). + +**PropertySetStream.rgIdOffset.IdOffsetElement-1:** The first element in the **rgIdOffset** array. + +**PropertySetStream.rgIdOffset.IdOffsetElement-1.formatId:** 02 D5 CD D5 9C 2E 1B 10 93 97 08 00 2B 2C F9 AE is the FMTID_DocSummaryInformation. It indicates that the associated **sectionOffset** points to a **Document Summary Information property set** (section 2.3.3.2.2). + +**PropertySetStream.rgIdOffset.IdOffsetElement-1.sectionOffset:** 0x00000044 indicates that the beginning of the **Document Summary Information property set** (section 2.3.3.2.2) is 0x00000044 bytes after the beginning of the Document Summary Information stream. In this example, **DocumentSummaryInfoStream** begins at offset 0x00000000. Therefore, the **Document Summary Information property set** (section 2.3.3.2.2) begins at offset 0x00000044. See [Document Summary Information Property Set Overview](#Section_c0e0190a08284638ab746fc190da3582) (section 3.2.2) for an example of this. + +**PropertySetStream.rgIdOffset.IdOffsetElement-2:** The second element in the **rgIdOffset** array. + +**PropertySetStream.rgIdOffset.IdOffsetElement-2.formatId:** 05 D5 CD D5 9C 2E 1B 10 93 97 08 00 2B 2C F9 AE is the FMTID_UserDefinedProperties. It indicates that the associated **sectionOffset** points to a **User Defined property set** (section 2.3.3.2.3). + +**PropertySetStream.rgIdOffset.IdOffsetElement-2.sectionOffset:** 0x00000298 indicates that the beginning of the **User Defined property set** (section 2.3.3.2.3) is 0x00000298 bytes after the beginning of the Document Summary Information stream. In this example, **DocumentSummaryInfoStream** begins at offset 0x00000000. Therefore, the **User Defined property set** (section 2.3.3.2.3) begins at offset 0x00000298. See [User Defined Property Set Overview](#Section_283eeaa13610403da42032c8a16945e0) (section 3.2.3) for an example of this. + +### Document Summary Information Property Set Overview + +The following table contains the beginning of a [**Document Summary Information property set**](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2) [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000044 | 0254 | **A**: PropertySet **- DocumentSummaryInformation** | | +| 00000044 | 0004 | DWORD **- cbSection** | 0x00000254 | +| 00000048 | 0004 | DWORD **- cProps** | 0x0000000F | +| 0000004C | 0078 | Array of PropertyIdentifierAndOffset **- rgProps** | | +| 0000004C | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-1** | | +| 0000004C | 0004 | DWORD **- propId** | 0x00000001 | +| 00000050 | 0004 | FilePointer **- propOffset** | 0x00000080 | +| 00000054 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-2** | | +| 00000054 | 0004 | DWORD **- propId** | 0x00000002 | +| 00000058 | 0004 | FilePointer **- propOffset** | 0x00000088 | +| 0000005C | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-3** | | +| 0000005C | 0004 | DWORD **- propId** | 0x0000000E | +| 00000060 | 0004 | FilePointer **- propOffset** | 0x0000009C | +| 00000064 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-4** | | +| 00000064 | 0004 | DWORD **- propId** | 0x0000000F | +| 00000068 | 0004 | FilePointer **- propOffset** | 0x000000B0 | +| 0000006C | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-5** | | +| 0000006C | 0004 | DWORD **- propId** | 0x0000001B | +| 00000070 | 0004 | FilePointer **- propOffset** | 0x000000C0 | +| 00000074 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-6** | | +| 00000074 | 0004 | DWORD **- propId** | 0x00000005 | +| 00000078 | 0004 | FilePointer **- propOffset** | 0x000000D0 | +| 0000007C | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-7** | | +| 0000007C | 0004 | DWORD **- propId** | 0x00000006 | +| 00000080 | 0004 | FilePointer **- propOffset** | 0x000000D8 | +| 00000084 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-8** | | +| 00000084 | 0004 | DWORD **- propId** | 0x00000011 | +| 00000088 | 0004 | FilePointer **- propOffset** | 0x000000E0 | +| 0000008C | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-9** | | +| 0000008C | 0004 | DWORD **- propId** | 0x00000017 | +| 00000090 | 0004 | FilePointer **- propOffset** | 0x000000E8 | +| 00000094 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-10** | | +| 00000094 | 0004 | DWORD **- propId** | 0x0000000B | +| 00000098 | 0004 | FilePointer **- propOffset** | 0x000000F0 | +| 0000009C | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-11** | | +| 0000009C | 0004 | DWORD **- propId** | 0x00000010 | +| 000000A0 | 0004 | FilePointer **- propOffset** | 0x000000F8 | +| 000000A4 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-12** | | +| 000000A4 | 0004 | DWORD **- propId** | 0x00000013 | +| 000000A8 | 0004 | FilePointer **- propOffset** | 0x00000100 | +| 000000AC | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-13** | | +| 000000AC | 0004 | DWORD **- propId** | 0x00000016 | +| 000000B0 | 0004 | FilePointer **- propOffset** | 0x00000108 | +| 000000B4 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-14** | | +| 000000B4 | 0004 | DWORD **- propId** | 0x0000000D | +| 000000B8 | 0004 | FilePointer **- propOffset** | 0x00000110 | +| 000000BC | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-15** | | +| 000000BC | 0004 | DWORD **- propId** | 0x0000000C | +| 000000C0 | 0004 | FilePointer **- propOffset** | 0x0000021D | +| 000000C4 | 01D4 | Array of TypedPropertyValue structures **- DocSumProperties** | | + +Figure 16: Overview of a DocumentSummaryInformation property set + +In this table, there is an array of 15 elements, **rgProps**. Each element in **rgProps** is a **PropertyIdentifierAndOffset** structure ([\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.19](http://msdn.microsoft.com/en-us/library/f59e6c94-a0ae-4d1b-85d3-f01c35779a22/)). Each of these structures represents a property that is stored in this **Document Summary Information property set** (section 2.3.3.2.2). Each **PropertyIdentifierAndOffset** structure (**PidOffsetElement-1** through **PidOffsetElement-15**) contains two fields, **propId** and **propOffset**. The **propId** field indicates the property of that element according to **PIDDSI** (section [2.3.3.2.2.1](#Section_3ef02e83afef4b6c9585c109edd24e07)). The **propOffset** field indicates the offset to the **TypedPropertyValue** (\[MS-OLEPS\] section [2.15](http://msdn.microsoft.com/en-us/library/f122b9d7-e5cf-4484-8466-83f6fd94b3cc/)) structure containing the value of the property. + +In this example, some **PidOffsetElements** share the same structure and therefore are omitted for brevity. **PidOffsetElement-2** to **PidOffsetElement-5** are [**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) properties (section 2.3.3.1.4). For the structure of an **Lpstr** property (section 2.3.3.1.4), see the [Category Property Example](#Section_29d75dd8a0654c23948c8f705f01f986) (section 3.2.2.2). **PidOffsetElement-6** to **PidOffsetElement-9** are VT_I4 **TypedPropertyValue** properties. For the structure of a VT_I4 **TypedPropertyValue** property, see the [**LineCount Property Example**](#Section_c93a7a10a41945639a2ed4b4dc51cf94) section 3.2.2.3). **PidOffsetElement-10** to **PidOffsetElement-13** are VT_BOOL **TypedPropertyValue** properties. For the structure of a VT_BOOL **TypedPropertyValue** property, see the [**LinksDirty Property Example**](#Section_073efdcc7d75400396a9c48f4a3ce77c) (section 3.2.2.4). + +**DocumentSummaryInformation:** A **DocumentSummaryInformation** is a property set as described in \[MS-OLEPS\] section [2.20](http://msdn.microsoft.com/en-us/library/aefcbddf-f299-4f5e-a9da-65ce4ca55075/). + +**cbSection:** 0x00000254 indicates the count of bytes from the beginning of the DocumentSummaryInformation property set (at offset 0x00000044) to the end of the last property in the property set, [**HeadingPairs**](#Section_887bb6a81f9c4d4abf3dcf6062e4c6a4) (section 3.2.2.6), at offset 0x00000297 inclusive. + +**cProps:** 0x0000000F indicates that this **Document Summary Information property set** (section 2.3.3.2.2) contains 0x0000000F (15) properties. + +**rgProps:** This is the container of an array of **PropertyIdentifierAndOffset** structures. In this example, there are 15 elements, one for each property. + +**rgProps.PidOffsetElement-1:** CodePage (VT_I2 **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-1.propId:** 0x00000001 (**GKPIDDSI_CODEPAGE** (section 2.3.3.2.2.1) indicates that there is a **CodePage** property value at the stream offset indicated by **propOffset**. + +**rgProps.PidOffsetElement-1.propOffset:** 0x00000080 indicates that the beginning of the **CodePage** property data is 0x00000080 bytes after the beginning of the **Document Summary Information property set** (section 2.3.3.2.2). In this example, **DocumentSummaryInformation** begins at offset 0x00000044. Therefore, the **CodePage** property begins at offset 0x000000C4. See the [**CodePage Property Example**](#Section_ee2488688fde440db81bbc27d1c7811d) (section 3.2.2.1). + +**rgProps.PidOffsetElement-2:** Category (**Lpstr** property (section 2.3.3.1.4)). + +**rgProps.PidOffsetElement-2.propId:** 0x00000002 (**GKPIDDSI_CATEGORY** (section 2.3.3.2.2.1)) indicates that there is a **Category** property value at the stream offset indicated by **propOffset**. + +**rgProps.PidOffsetElement-2.propOffset:** 0x00000088 indicates that the beginning of the **Category** property data is 0x00000088 bytes after the beginning of the **Document Summary Information property set** (section 2.3.3.2.2). In this example, **DocumentSummaryInformation** begins at offset 0x00000044. Therefore, the **Category** property begins at offset 0x000000CC. See the Category Property Example (section 3.2.2.2). + +**rgProps.PidOffsetElement-3:** Manager (**Lpstr** property (section 2.3.3.1.4)). + +**rgProps.PidOffsetElement-4:** Company (**Lpstr** property (section 2.3.3.1.4)). + +**rgProps.PidOffsetElement-5:** ContentStatus (**Lpstr** property (section 2.3.3.1.4)). + +**rgProps.PidOffsetElement-6:** LineCount (VT_I4 **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-6.propId:** 0x00000005 (**GKPIDDSI_LINECOUNT** (section 2.3.3.2.2.1) indicates that there is a **LineCount** property value at the stream offset indicated by **propOffset**. + +**rgProps.PidOffsetElement-6.propOffset:** 0x000000D0 indicates that the **LineCount** property data is 0x000000D0 bytes after the beginning of the **Document Summary Information property set** (section 2.3.3.2.2). In this example, **DocumentSummaryInformation** begins at offset 0x00000044. Therefore, the **LineCount** property begins at offset 0x00000114. See the **LineCount Property Example** (section 3.2.2.3). + +**rgProps.PidOffsetElement-7:** ParagraphCount (VT_I4 **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-8:** CountCharsWithSpaces (VT_I4 **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-9:** Version (VT_I4 **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-10:** Scale (VT_BOOL **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-11:** LinksDirty (VT_BOOL **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-11.propId:** 0x00000010 (**GKPIDDSI_LINKSDIRTY** (section 2.3.3.2.2.1)) indicates that there is a **LinksDirty** property value at the stream offset indicated by **propOffset**. + +**rgProps.PidOffsetElement-11.propOffset:** 0x000000F8 indicates that the **LinksDirty** property data is 0x000000F8 bytes after the beginning of the **Document Summary Information property set** (section 2.3.3.2.2). In this example, **DocumentSummaryInformation** begins at offset 0x00000044. Therefore, the **LinksDirty** property begins at offset 0x00000013C. See the **LinksDirty Property Example** (section 3.2.2.4). + +**rgProps.PidOffsetElement-12:** SharedDoc (VT_BOOL **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-13:** HyperlinksChanged (VT_BOOL **TypedPropertyValue** property). + +**rgProps.PidOffsetElement-14:** DocumentParts ([**VtVecUnalignedLpstr**](#Section_523af67dd69a4eb1848ba299674ac9b8) property (section 2.3.3.1.10)). + +**rgProps.PidOffsetElement-14.propId:** 0x0000000D (**GKPIDDSI_DOCPARTS** (section 2.3.3.2.2.1)) indicates that there is a **DocumentParts** property value at the stream offset indicated by **propOffset**. + +**rgProps.PidOffsetElement-14.propOffset:** 0x00000110 indicates that the **DocumentParts** property data is 0x00000110 bytes after the beginning of **Document Summary Information property set** (section 2.3.3.2.2). In this example, **DocumentSummaryInformation** begins at offset 0x00000044. Therefore, the **DocumentParts** property begins at offset 0x00000154. See the [**DocumentParts Property Example**](#Section_742bc556d7884900b7aeb8fe1f2e4322) (section 3.2.2.5). + +**rgProps.PidOffsetElement-15:** HeadingPairs ([**VtVecHeadingPair**](#Section_3aaaf9e84f1a42fa9359fe0ab0c1cccc) property (section 2.3.3.1.10)). + +**rgProps.PidOffsetElement-15.propId:** 0x0000000C (**GKPIDDSI_HEADINGPAIR** (section 2.3.3.2.2.1)) indicates that there is a **HeadingPairs** property value at the stream offset indicated by **propOffset**. + +**rgProps.PidOffsetElement-15.propOffset:** 0x0000021D indicates that the **HeadingPairs** property data is 0x0000021D bytes after the beginning of the **Document Summary Information property set** (section 2.3.3.2.2). In this example, **DocumentSummaryInformation** begins at offset 0x00000044. Therefore, the **HeadingPairs** property begins at offset 0x00000261. See the **HeadingPairs Property Example** (section 3.2.2.6). + +#### CodePage Property Example + +This is an example of a **CodePage** property (VT_I2 **TypedPropertyValue** property). + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|--------------------------------------------|-----------| +| 000000C4 | 0008 | TypedPropertyValue **- GKPIDDSI_CODEPAGE** | | +| 000000C4 | 0002 | WORD **- wType** | 0x0002 | +| 000000C6 | 0002 | WORD **- padding** | 0x0000 | +| 000000C8 | 0002 | WORD **- value** | 0x04E4 | +| 000000CA | 0002 | WORD **- unused** | 0x0000 | + +Figure 17: Structure of a CodePage property + +**GKPIDDSI_CODEPAGE:** CodePage. + +**wType:** 0x0002 indicates this property is a VT_I2 **TypedPropertyValue** property (2-byte integer). + +**value:** 0x04E4 (1252) indicates the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) used for the property values of the [**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) (section 2.3.3.1.4) and [**UnalignedLpstr**](#Section_a8f75582c3d34a5bbbca62ed6a05711d) (section 2.3.3.1.5) properties in the [Document Summary Information property set](#Section_fe59ffd979e944fba1c92466057b05c6) (section 2.3.3.2.2). + +#### Category Property Example + +This is an example of a **Category** property ([**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) property (section 2.3.3.1.4)). + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|--------------------------------------------|------------| +| 000000CC | 0014 | TypedPropertyValue **- GKPIDDSI_CATEGORY** | | +| 000000CC | 0002 | WORD **- wType** | 0x001E | +| 000000CE | 0002 | WORD **- padding** | 0x0000 | +| 000000D0 | 0010 | Lpstr **- stringValue** | | +| 000000D0 | 0004 | DWORD **- cch** | 0x0000000C | +| 000000D4 | 000C | Array of CHAR **- value** | Tutorials | + +Figure 18: Structure of a Category property + +**GKPIDDSI_CATEGORY:** Category. + +**wType:** 0x001E indicates that this property is an **Lpstr** property (section 2.3.3.1.4). + +**stringValue.cch:** 0x0000000C indicates that the count of characters of the **Lpstr** (section 2.3.3.1.4) value is 12. The **value** field contains 10 characters (9 for "Tutorials" plus a terminating NULL character). There are 2 additional bytes after the terminating NULL character which pad the **value** field to a multiple of 4 bytes. + +**stringValue.value:** The value of this field is "Tutorials" followed by a null-terminator and 2 bytes of padding, so the length of this field is 0x0000000C (12). The 2 bytes of padding is added to make the length a multiple of 4 bytes. + +#### LineCount Property Example + +This is an example of a **LineCount** property (VT_I4 **TypedPropertyValue** property). + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|---------------------------------------------|------------| +| 00000114 | 0008 | TypedPropertyValue **- GKPIDDSI_LINECOUNT** | | +| 00000114 | 0002 | WORD **- wType** | 0x0003 | +| 00000116 | 0002 | WORD **- padding** | 0x0000 | +| 00000118 | 0004 | DWORD **- value** | 0x0000001F | + +Figure 19: Structure of a LineCount property + +**GKPIDDSI_LINECOUNT:** LineCount. + +**wType:** 0x0003 indicates that this property is a VT_I4 **TypedPropertyValue** property (4-byte integer). + +**value:** 0x0000001F indicates that the count of lines in the example document is 0x0000001F (31). + +#### LinksDirty Property Example + +This is an example of a **LinksDirty** property (VT_BOOL **TypedPropertyValue** property). + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|----------------------------------------------|------------| +| 0000013C | 0008 | TypedPropertyValue **- GKPIDDSI_LINKSDIRTY** | | +| 0000013C | 0002 | WORD **- wType** | 0x000B | +| 0000013E | 0002 | WORD **- padding** | 0x0000 | +| 00000140 | 0004 | DWORD **- value** | 0x00000000 | + +Figure 20: Structure of a LinksDirty property + +**GKPIDDSI_LINKSDIRTY:** LinksDirty. + +**wType:** 0x000B indicates that this property is a VT_BOOL **TypedPropertyValue** property (false if the **value** field is 0x00000000, or true if it is any other value). + +**value:** 0x00000000 is the value of the **value** field of this VT_BOOL **TypedPropertyValue** property, meaning false. This indicates that the linked properties (**propId** 0x00000006 in the [**UserDefined property set**](#Section_283eeaa13610403da42032c8a16945e0) (section 3.2.3) in this example) do not require updating the next time the file is opened. + +#### DocumentParts Property Example + +This is an example of a **DocumentParts** property ([**VtVecUnalignedLpstr**](#Section_523af67dd69a4eb1848ba299674ac9b8) property (section 2.3.3.1.10)). + +The **DocumentParts** property ought to be viewed together with the [**HeadingPairs Property**](#Section_887bb6a81f9c4d4abf3dcf6062e4c6a4) (section 3.2.2.6) because the data in the two are closely related. This relationship is illustrated by the following diagram. + +![Relationship between the DocumentParts property and the HeadingPairs property](media/image9.bin "Relationship between the DocumentParts property and the HeadingPairs property") + +Figure 21: Relationship between the DocumentParts property and the HeadingPairs property + +In the figure, the first element of the **HeadingPairs** property has a **headingString** value of "Title", meaning it is associated with the title group in the **DocumentParts** property. The value of the **headerParts** field is 1, meaning there is only 1 element in the **DocumentParts** property that is in the title group, **LpstrElement-1**. The **headingString** of the second element in the **HeadingPairs** property is "Headings", meaning this element is associated with the headings group in the **DocumentParts** property. **HeaderParts** equals 8, meaning there are 8 elements in the **DocumentParts** property that are in the headings group. They are **LpstrElement-2** through **LpstrElement-9**. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000154 | 010D | TypedPropertyValue **- GKPIDDSI_DOCPARTS** | | +| 00000154 | 0002 | WORD **- wType** | 0x101E | +| 00000156 | 0002 | WORD **- padding** | 0x0000 | +| 00000158 | 0109 | [VtVecUnalignedLpstrValue](#Section_cd95ca9770c748288b5bb86263348026) **- UnalignedLpstr Vector** | | +| 00000158 | 0004 | DWORD **- cElements** | 0x00000009 | +| 0000015C | 0105 | Array of UnalignedLpstr **- rgString** | | +| 0000015C | 0020 | [UnalignedLpstr](#Section_a8f75582c3d34a5bbbca62ed6a05711d) **- LpstrElement-1** | | +| 0000015C | 0004 | DWORD **- cch** | 0x0000001C | +| 00000160 | 001C | Array of CHAR **- value** | Invoice Approval Procedures | +| 0000017C | 0017 | UnalignedLpstr **- LpstrElement-2** | | +| 0000017C | 0004 | DWORD **- cch** | 0x00000013 | +| 00000180 | 0013 | Array of CHAR **- value** | Approval Procedure | +| 00000193 | 0019 | UnalignedLpstr **- LpstrElement-3** | | +| 00000193 | 0004 | DWORD **- cch** | 0x00000015 | +| 00000197 | 0015 | Array of CHAR **- value** | Manager Approval | +| 000001AC | 001C | UnalignedLpstr **- LpstrElement-4** | | +| 000001AC | 0004 | DWORD **- cch** | 0x00000018 | +| 000001B0 | 0018 | Array of CHAR **- value** | Skip-level Approval | +| 000001C8 | 0021 | UnalignedLpstr **- LpstrElement-5** | | +| 000001C8 | 0004 | DWORD **- cch** | 0x0000001D | +| 000001CC | 001D | Array of CHAR **- value** | Organizational Chart | +| 000001E9 | 0024 | UnalignedLpstr **- LpstrElement-6** | | +| 000001E9 | 0004 | DWORD **- cch** | 0x00000020 | +| 000001ED | 0020 | Array of CHAR **- value** | Skip-level verification | +| 0000020D | 0017 | UnalignedLpstr **- LpstrElement-7** | | +| 0000020D | 0004 | DWORD **- cch** | 0x00000013 | +| 00000211 | 0013 | Array of CHAR **- value** | Verification Steps | +| 00000224 | 001D | UnalignedLpstr **- LpstrElement-8** | | +| 00000224 | 0004 | DWORD **- cch** | 0x00000019 | +| 00000228 | 0019 | Array of CHAR **- value** | Manager Verification | +| 00000241 | 0020 | UnalignedLpstr **- LpstrElement-9** | | +| 00000241 | 0004 | DWORD **- cch** | 0x0000001C | +| 00000245 | 001C | Array of CHAR **- value** | Skip-level Verification | + +Figure 22: Structure of a DocumentParts property + +In this example, the **LpstrElements** share the same structure. For brevity, only one of them is explained in the following section. **LpstrElement-2** is explained because it is more representative in the calculation of count of bytes. + +**GKPIDDSI_DOCPARTS:** DocumentParts. + +**wType:** 0x101E indicates this property value is an array of single-byte character strings. In the case of **DocumentParts** this indicates the property is a **VtVecUnalignedLpstr** property (section 2.3.3.1.10). + +**UnalignedLpstr Vector.cElements:** 0x00000009 indicates there are 9 elements in the **VtVecUnalignedLpstr** (section 2.3.3.1.10). + +**UnalignedLpstr Vector.rgString.LpstrElement-2:** The second **UnalignedLpstr** (section 2.3.3.1.5) in this vector. + +**UnalignedLpstr Vector.rgString.LpstrElement-2.cch:** 0x00000013 (19) is the count of bytes of the **value** field of the **UnalignedLpstr** (section 2.3.3.1.5) ("Approval Procedure" followed by a terminating NULL character). The **UnalignedLpstr** (section 2.3.3.1.5) structure does not require padding. Therefore, in this example, even though 19 is not a multiple of 4 bytes, no padding is added to the value field. + +**UnalignedLpstr Vector.rgString.LpstrElement-2.value:** "Approval Procedure" is the value of the **value** field of this **UnalignedLpstr** (section 2.3.3.1.5). + +The rest of the **UnalignedLpstr** (section 2.3.3.1.5) structures in this example have the same format as the Vector.rgString.LpstrElement-2 structure defined previous. + +#### HeadingPairs Property Example + +This is an example of a **HeadingPairs** property ([**VtVecHeadingPair**](#Section_3aaaf9e84f1a42fa9359fe0ab0c1cccc) property (section 2.3.3.1.15)). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000261 | 0037 | TypedPropertyValue **- GKPIDDSI_HEADINGPAIR** | | +| 00000261 | 0002 | WORD **- wType** | 0x100C | +| 00000263 | 0002 | WORD **- padding** | 0x0000 | +| 00000265 | 0033 | [VtVecHeadingPairValue](#Section_7eaa201d3fe149178e393690a3a36c11) **- GKPIDDSI_HEADINGPAIR** | | +| 00000265 | 0004 | DWORD **- cElements** | 0x00000004 | +| 00000269 | 002F | Array of VtHeadingPair **- rgHeadingPairs** | | +| 00000269 | 0016 | [VtHeadingPair](#Section_8d8db7dc9a0c4bcc9ad5a2937bb559b0) **- VtHeadingPairElement-1** | | +| 00000269 | 000E | [VtUnalignedString](#Section_eb04ce67f96b4ea4adf77f75847c7abb) **- headingString** | | +| 00000269 | 0002 | WORD **- stringType** | 0x001E | +| 0000026B | 0002 | WORD **- padding** | 0x0000 | +| 0000026D | 000A | [UnalignedLpstr](#Section_a8f75582c3d34a5bbbca62ed6a05711d) **- stringValue** | | +| 0000026D | 0004 | DWORD **- cch** | 0x00000006 | +| 00000271 | 0006 | Array of CHAR **- value** | Title | +| 00000277 | 0008 | TypedPropertyValue **- headerParts** | | +| 00000277 | 0002 | WORD **- wType** | 0x0003 | +| 00000279 | 0002 | WORD **- padding** | 0x0000 | +| 0000027B | 0004 | DWORD **- value** | 0x00000001 | +| 0000027F | 0019 | VtHeadingPair **- VtHeadingPairElement-2** | | +| 0000027F | 0011 | VtUnalignedString **- headingString** | | +| 0000027F | 0002 | WORD **- stringType** | 0x001E | +| 00000281 | 0002 | WORD **- padding** | 0x0000 | +| 00000283 | 000D | UnalignedLpstr **- stringValue** | | +| 00000283 | 0004 | DWORD **- cch** | 0x00000009 | +| 00000287 | 0009 | Array of CHAR **- value** | Headings | +| 00000290 | 0008 | TypedPropertyValue **- headerParts** | | +| 00000290 | 0002 | WORD **- wType** | 0x0003 | +| 00000292 | 0002 | WORD **- padding** | 0x0000 | +| 00000294 | 0004 | DWORD **- value** | 0x00000008 | + +Figure 23: Structure of a HeadingPairs property + +The **HeadingPairs** property needs to be viewed together with the [**DocumentParts property**](#Section_742bc556d7884900b7aeb8fe1f2e4322) (section 3.2.2.5), because data in the two are closely related. See the **DocumentParts property** (section 3.2.2.5) example for more explanation. + +**wType:** 0x100C indicates this property is a vector of variant types. + +**GKPIDDSI_HEADINGPAIR.cElements:** 0x00000004 indicates there are two elements in **rgHeadingPairs**. **cElements** is twice the number of elements in **rgHeadingPairs** because each **VtHeadingPair** (section 2.3.3.1.13) element contains two values, **headingString** and **headerParts**. + +**GKPIDDSI_HEADINGPAIR.rgHeadingPairs:** This is a container of the array of **VtHeadingPair** (section 2.3.3.1.13). + +**GKPIDDSI_HEADINGPAIR.rgHeadingPairs.VtHeadingPairElement-1:** The first **VtHeadingPair** (section 2.3.3.1.13) in this array. This maps to **LpstrElement-1** of the table labeled "Structure of a DocumentParts property" in section 3.2.2.5, in the **DocumentParts** property. + +**GKPIDDSI_HEADINGPAIR.rgHeadingPairs.VtHeadingPairElement-1.headingString:** The **headingString** in this **VtHeadingPair** (section 2.3.3.1.13) element is an **UnalignedLpstr** (section 2.3.3.1.5) structure. The **value** field of this structure is "Title" and indicates that the associated group in the **DocumentParts** property contains the title of this document. + +**GKPIDDSI_HEADINGPAIR.rgHeadingPairs.VtHeadingPairElement-1.headerParts:** The **headingParts** of this **headingPair** is a VT_I4 **TypedPropertyValue** property. The value of it is 0x00000001, meaning this **headingPair** is associated with 1 element in the **DocumentParts** property. + +**GKPIDDSI_HEADINGPAIR.rgHeadingPairs.VtHeadingPairElement-2:** This is the second **VtHeadingPair** (section 2.3.3.1.13) element in this vector. It conforms to the same structure as the first element but contains different data. The **value** field of **headingString** is "Headings", indicating that the associated elements in the **DocumentParts** property specify the heading of the document. The **value** field of the **headerParts** has a value of 8, meaning there are eight elements of **UnalignedLpstr** (section 2.3.3.1.5) structure in the **DocumentParts** property associated with **VtHeadingPairElement-2**. They are **LpstrElement-2** through to **LpstrElement-9** of the table labeled "Structure of a DocumentParts property" in section 3.2.2.5, in the **DocumentParts** property. + +### User Defined Property Set Overview + +The following table contains the beginning of a [**User Defined property set**](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3). In this table, there is an array, **rgUserProps**. Each element in **rgUserProps** is a **PropertyIdentifierAndOffset** structure ([\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.19](http://msdn.microsoft.com/en-us/library/f59e6c94-a0ae-4d1b-85d3-f01c35779a22/)). The structure of this section of the **User Defined property set** (section 2.3.3.2.3) is similar to that described in [Document Summary Information Property Set Overview](#Section_c0e0190a08284638ab746fc190da3582) (section 3.2.2). The major difference is that in the **User Defined property set** (section 2.3.3.2.3) most **propId** values do not have a meaning defined by this specification, but instead have a meaning defined by their names as found in the [**Dictionary property**](#Section_8890a6721688463d9c0a46b5e72b5012) (section 3.2.3.1). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000298 | 0420 | **B**: PropertySet **- UserDefinedProperties** | | +| 00000298 | 0004 | DWORD **- cbSection** | 0x00000420 | +| 0000029C | 0004 | DWORD **- cProps** | 0x00000009 | +| 000002A0 | 0048 | Array of PropertyIdentifierAndOffset **- rgUserProps** | | +| 000002A0 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-1** | | +| 000002A0 | 0004 | DWORD **- propId** | 0x00000000 | +| 000002A4 | 0004 | FilePointer **- dictionaryOffset** | 0x00000050 | +| 000002A8 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-2** | | +| 000002A8 | 0004 | DWORD **- propId** | 0x00000001 | +| 000002AC | 0004 | FilePointer **- codepageOffset** | 0x000000D2 | +| 000002B0 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-3** | | +| 000002B0 | 0004 | DWORD **- propId** | 0x00000002 | +| 000002B4 | 0004 | FilePointer **- linkbaseOffset** | 0x000000DA | +| 000002B8 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-4** | | +| 000002B8 | 0004 | DWORD **- propId** | 0x00000003 | +| 000002BC | 0004 | FilePointer **- hyperlinksOffset** | 0x000000E6 | +| 000002C0 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-5** | | +| 000002C0 | 0004 | DWORD **- propId** | 0x00000004 | +| 000002C4 | 0004 | FilePointer **- propOffset** | 0x000003B6 | +| 000002C8 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-6** | | +| 000002C8 | 0004 | DWORD **- propId** | 0x00000005 | +| 000002CC | 0004 | FilePointer **- propOffset** | 0x000003CA | +| 000002D0 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-7** | | +| 000002D0 | 0004 | DWORD **- propId** | 0x00000006 | +| 000002D4 | 0004 | FilePointer **- propOffset** | 0x000003D2 | +| 000002D8 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-8** | | +| 000002D8 | 0004 | DWORD **- propId** | 0x00000007 | +| 000002DC | 0004 | FilePointer **- propOffset** | 0x000003DA | +| 000002E0 | 0008 | PropertyIdentifierAndOffset **- PidOffsetElement-9** | | +| 000002E0 | 0004 | DWORD **- propId** | 0x01000007 | +| 000002E4 | 0004 | FilePointer **- propLinkOffset** | 0x000003FA | +| 000002E8 | 03D0 | Array of properties **- UserDefinedProperties** | | + +Figure 24: Overview of a User Defined property set + +**UserDefinedProperties:** **UserDefinedProperties** is a **PropertySet** as detailed in \[MS-OLEPS\] section [2.20](http://msdn.microsoft.com/en-us/library/aefcbddf-f299-4f5e-a9da-65ce4ca55075/). + +**cbSection:** 0x00000420 indicates the count of bytes from the beginning of the **UserDefinedProperties** property set (0x00000298) to the end of the last property in the property set, the [**CriticalSection_Link**](#Section_6a83ba1334764be18f7fa609adbcded4) property (section 3.2.3.4). If the size is calculated as 0x0000069A + 0x001C - 0x00000298, it actually results in a size of 0x0000041E instead of 0x00000420. This is because the property set is padded to a multiple of 4 bytes. After the end of the **CriticalSection_Link** property (section 3.2.3.4) property, there are 2 bytes of padding to make the count of bytes of the property set a multiple of 4 bytes, resulting in a length of 0x00000420. + +**cProps:** 0x00000009 indicates that this **User Defined property set** (section 2.3.3.2.3) contains nine properties. + +**rgUserProps:** This is the container of an array of **PropertyIdentifierAndOffset** structures. In this example, there are nine elements, one for each property. + +**rgUserProps.PidOffsetElement-1:** Dictionary (**Dictionary** property). + +**rgUserProps.PidOffsetElement-1.propId:** 0x00000000 indicates that there is a **Dictionary** property value at the [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) offset indicated by the **dictionaryOffset** value. + +**rgUserProps.PidOffsetElement-1.dictionaryOffset:** 0x00000050 indicates that the beginning of the **Dictionary** property data is 0x00000050 bytes after the beginning of the **UserDefinedProperties** property set (0x00000298). In this example, the **Dictionary** property begins at offset 0x000002E8. See the **Dictionary property** example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-2:** CodePage (VT_I2 **TypedPropertyValue** property). + +**rgUserProps.PidOffsetElement-2.propId:** 0x00000001 indicates that there is a **CodePage** property value at the stream offset indicated by the **codepageOffset** value. + +**rgUserProps.PidOffsetElement-2.codepageOffset:** 0x000000D2 indicates that the beginning of the **CodePage** property data is 0x000000D2 bytes after the beginning of the **UserDefinedProperties** property set. + +**rgUserProps.PidOffsetElement-3:** User-defined property. + +**rgUserProps.PidOffsetElement-3.propId:** 0x00000002 indicates there is a user-defined property value at the stream offset indicated by the **linkbaseOffset** value. The name of this user-defined property is specified in the **Dictionary** property as "\_PID_LINKBASE". See the Dictionary Property Example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-3.linkbaseOffset:** 0x000000DA indicates the user-defined property with **propId** 0x00000002 begins 0x000000DA bytes after the beginning of the **UserDefinedProperties** property set. In this example, this property begins at offset 0x00000372. See the [LinkBase Property Example](#Section_9109a8bb3495457e9cd01955490a063f) (section 3.2.3.2). + +**rgUserProps.PidOffsetElement-4:** User-defined property. + +**rgUserProps.PidOffsetElement-4.propId:** 0x00000003 indicates there is a user-defined property value at the stream offset indicated by the **hyperlinksOffset** value. The name of this user-defined property is specified in the **Dictionary** property as "\_PID_HLINKS". See the Dictionary Property Example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-4.hyperlinksOffset:** 0x000000E6 indicates the user-defined property with **propId** 0x00000003 begins 0x000000E6 bytes after the beginning of the **UserDefinedProperties** property set. In this example, this property begins at offset 0x0000037E. See the [Hyperlinks Property Example](#Section_fbfec8b87db44a60bc0e5ea0b1bc2328) (section 3.2.3.3). + +**rgUserProps.PidOffsetElement-5:** User-defined property. + +**rgUserProps.PidOffsetElement-5.propId:** 0x00000004 indicates there is a user-defined property value at the stream offset indicated by the **propOffset** value. The name of this user-defined property is specified in the **Dictionary** property as "Department". See the Dictionary Property Example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-5.propOffset:** 0x000003B6 indicates the user-defined property with **propId** 0x00000004 begins 0x000003B6 bytes after the beginning of the **UserDefinedProperties** property set. This property is a [**Lpstr**](#Section_fac324c9ff39442ebd181a91a723a818) (section 2.3.3.1.4) property, see [Category Property Example](#Section_29d75dd8a0654c23948c8f705f01f986) (section 3.2.2.2) for an example of a **Lpstr** (section 2.3.3.1.4) property. + +**rgUserProps.PidOffsetElement-6:** User-defined property. + +**rgUserProps.PidOffsetElement-6.propId:** 0x00000005 indicates there is a user-defined property value at the stream offset indicated by the **propOffset** value. The name of this user-defined property is specified in the **Dictionary** property as "Document number". See the Dictionary Property Example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-6.propOffset:** 0x000003CA indicates the user-defined property with **propId** 0x00000005 begins 0x000003CA bytes after the beginning of the **UserDefinedProperties** property set. This property is a VT_I4 **TypedPropertyValue** property. See the [LineCount Property Example](#Section_c93a7a10a41945639a2ed4b4dc51cf94) (section 3.2.2.3) for an example of a VT_I4 **TypedPropertyValue** property. + +**rgUserProps.PidOffsetElement-7:** User-defined property. + +**rgUserProps.PidOffsetElement-7.propId:** 0x00000006 indicates there is a user-defined property value at the stream offset indicated by the **propOffset** value. The name of this user-defined property is specified in the **Dictionary** property as "Approved". See the Dictionary Property Example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-7.propOffset:** 0x000003D2 indicates the user-defined property with **propId** 0x00000006 begins 0x000003D2 bytes after the beginning of the **UserDefinedProperties** property set. This property is a VT_BOOL **TypedPropertyValue** property. See the [LinksDirty Property Example](#Section_073efdcc7d75400396a9c48f4a3ce77c) (section 3.2.2.4) for an example of a VT_BOOL **TypedPropertyValue** property. + +**rgUserProps.PidOffsetElement-8:** User-defined linked property. + +**rgUserProps.PidOffsetElement-8.propId:** 0x00000007 indicates there is a user-defined property value at the stream offset indicated by the **propOffset** value. The name of this user-defined property is specified in the **Dictionary** property as "CriticalSection". See the **Dictionary property** example (section 3.2.3.1). + +**rgUserProps.PidOffsetElement-8.propOffset:** 0x000003DA indicates the user-defined property with **propId** 0x00000007 begins 0x000003DA bytes after the beginning of the **UserDefinedProperties** property set. In this example, this property begins at offset 0x00000672. See the Linked Property Example (section 3.2.3.4). + +**rgUserProps.PidOffsetElement-9:** User-defined Link. + +**rgUserProps.PidOffsetElement-9.propId:** 0x01000007 indicates that the user-defined property in this property set with **propId** 0x01000007 is linked to document content. This user-defined Link value is at the stream offset indicated by the **propLinkOffset** value. See the Linked Property Example (section 3.2.3.4). + +**rgUserProps.PidOffsetElement-9.propLinkOffset:** 0x000003FA indicates that the user-defined property link with **propId** 0x10000007 begins 0x000003FA bytes after the beginning of the **UserDefinedProperties** property set. In this example, this property begins at offset 0x00000692. See the Linked Property Example (section 3.2.3.4). + +#### Dictionary Property Example + +This is an example of a **Dictionary** property as detailed in [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) section [2.17](http://msdn.microsoft.com/en-us/library/99127b7f-c440-4697-91a4-c853086d6b33/). This property gives a mapping between **propertyId** and **propertyName** for the [**User Defined property set**](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3), except for the **Dictionary** property, the **CodePage** property, and the [**Links**](#Section_6a83ba1334764be18f7fa609adbcded4) (section 3.2.3.4). In this example, there are 9 elements in the array of **PropertyIdentifierAndOffset** (**rgUserProps** of the previous table). Each element represents a property. However there are only 6 DictionaryEntry elements (\[MS-OLEPS\] section [2.16](http://msdn.microsoft.com/en-us/library/333959a3-a999-4eca-8627-48a224e63e77/)) in the **rgEntries** in the **Dictionary** property of following table. The 3 elements that are excluded are the element associated with the **Dictionary** property (**PidOffsetElement-1** in **rgUserProps**), the element associated with the **CodePage** property (**PidOffsetElement-2** in **rgUserProps**), and the element associated with the property link (**PidOffsetElement-9** in **rgUserProps**). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000002E8 | 0082 | Dictionary **- Dictionary** | | +| 000002E8 | 0004 | DWORD **- cEntries** | 0x00000006 | +| 000002EC | 007E | Array of DictionaryEntry **- rgEntries** | | +| 000002EC | 0016 | DictionaryEntry **- LpstrNameIdElement-1** | | +| 000002EC | 0004 | DWORD **- propertyId** | 0x00000002 | +| 000002F0 | 0012 | [UnalignedLpstr](#Section_a8f75582c3d34a5bbbca62ed6a05711d) **- propertyName** | | +| 000002F0 | 0004 | DWORD **- cch** | 0x0000000E | +| 000002F4 | 000E | Array of CHAR **- value** | \_PID_LINKBASE | +| 00000302 | 0014 | DictionaryEntry **- LpstrNameIdElement-2** | | +| 00000302 | 0004 | DWORD **- propertyId** | 0x00000003 | +| 00000306 | 0010 | UnalignedLpstr **- propertyName** | | +| 00000306 | 0004 | DWORD **- cch** | 0x0000000C | +| 0000030A | 000C | Array of CHAR **- value** | \_PID_HLINKS | +| 00000316 | 0013 | DictionaryEntry **- LpstrNameIdElement-3** | | +| 00000316 | 0004 | DWORD **- propertyId** | 0x00000004 | +| 0000031A | 000F | UnalignedLpstr **- propertyName** | | +| 0000031A | 0004 | DWORD **- cch** | 0x0000000B | +| 0000031E | 000B | Array of CHAR **- value** | Department | +| 00000329 | 0018 | DictionaryEntry **- LpstrNameIdElement-4** | | +| 00000329 | 0004 | DWORD **- propertyId** | 0x00000005 | +| 0000032D | 0014 | UnalignedLpstr **- propertyName** | | +| 0000032D | 0004 | DWORD **- cch** | 0x00000010 | +| 00000331 | 0010 | Array of CHAR **- value** | Document number | +| 00000341 | 0011 | DictionaryEntry **- LpstrNameIdElement-5** | | +| 00000341 | 0004 | DWORD **- propertyId** | 0x00000006 | +| 00000345 | 000D | UnalignedLpstr **- propertyName** | | +| 00000345 | 0004 | DWORD **- cch** | 0x00000009 | +| 00000349 | 0009 | Array of CHAR **- value** | Approved | +| 00000352 | 0018 | DictionaryEntry **- LpstrNameIdElement-6** | | +| 00000352 | 0004 | DWORD **- propertyId** | 0x00000007 | +| 00000356 | 0014 | UnalignedLpstr **- propertyName** | | +| 00000356 | 0004 | DWORD **- cch** | 0x00000010 | +| 0000035A | 0010 | Array of CHAR **- value** | CriticalSection | + +Figure 25: Structure of a Dictionary property + +**cEntries:** 0x00000006 indicates there are six entries in **rgEntrie**s. + +**rgEntries:** This is an array of **DictionaryEntry**. The **CodePage** property value in **UserDefinedProperties** is not CP_WINUNICODE (0x04B0) so each **DictionaryEntry** contains an **UnalignedLpstr** (section 2.3.3.1.5), see \[MS-OLEPS\] section 2.16. + +**rgEntries.LpstrNameIdElement-1:** This is the first element in this array. + +**rgEntries.LpstrNameIdElement-1.propertyId:** 0x00000002 is the same as one of the **propId** elements in **rgUserProps**, which indicates that this **DictionaryEntry** corresponds to the user-defined property with **propId** 0x00000002. + +**rgEntries.LpstrNameIdElement-1.propertyName:** This is an **UnalignedLpstr** (section 2.3.3.1.5) structure. + +**rgEntries.LpstrNameIdElement-1.propertyName.cch:** 0x0000000E is the count of character value for this **UnalignedLpstr** (section 2.3.3.1.5) structure. The **cch** field in **LpstrNameIdElement-1** to **LpstrNameIdElement-6** is the count of character value for each of the **UnalignedLpstr** structures. See the [DocumentParts Property Example](#Section_742bc556d7884900b7aeb8fe1f2e4322) (section 3.2.2.5) for the structure of an **UnalignedLpstr**. + +**rgEntries.LpstrNameIdElement-1.propertyName.value:** "\_PID_LINKBASE" indicates the property name of the user-defined property with **propId** 0x00000002. See the [LinkBase Property Example](#Section_9109a8bb3495457e9cd01955490a063f) (section 3.2.3.2). + +**rgEntries.LpstrNameIdElement-2:** This is the second element in this array. + +**rgEntries.LpstrNameIdElement-2.propertyId:** 0x00000003 is the same as one of the **propId** elements in **rgUserProps**, which indicates that this **DictionaryEntry** corresponds to the user-defined property with **propId** 0x00000003. + +**rgEntries.LpstrNameIdElement-2.propertyName:** This is an **UnalignedLpstr** (section 2.3.3.1.5) structure. + +**rgEntries.LpstrNameIdElement-2.propertyName.value:** "\_PID_HLINKS" indicates the property name of the user-defined property with **propId** 0x00000003. See the [Hyperlinks Property Example](#Section_fbfec8b87db44a60bc0e5ea0b1bc2328) (section 3.2.3.3). + +**rgEntries.LpstrNameIdElement-3:** This is the third element in this array. + +**rgEntries.LpstrNameIdElement-3.propertyId:** 0x00000004 is the same as one of the **propId** elements in **rgUserProps**, which indicates that this **DictionaryEntry** corresponds to the user-defined property with **propId** 0x00000004. + +**rgEntries.LpstrNameIdElement-3.propertyName:** This is an **UnalignedLpstr** (section 2.3.3.1.5) structure. + +**rgEntries.LpstrNameIdElement-3.propertyName.value:** "Department" indicates the property name of the user-defined property with **propId** 0x00000004. + +**rgEntries.LpstrNameIdElement-4:** This is the fourth element in this array. + +**rgEntries.LpstrNameIdElement-4.propertyId:** 0x00000005 is the same as one of the **propId** elements in **rgUserProps**, which indicates that this **DictionaryEntry** corresponds to the user-defined property with **propId** 0x00000005. + +**rgEntries.LpstrNameIdElement-4.propertyName:** This is an **UnalignedLpstr** (section 2.3.3.1.5) structure. + +**rgEntries.LpstrNameIdElement-4.propertyName.value:** "Document number" indicates the property name of the user-defined property with **propId** 0x00000005. + +**rgEntries.LpstrNameIdElement-5:** This is the fifth element in this array. + +**rgEntries.LpstrNameIdElement-5.propertyId:** 0x00000006 is the same as one of the **propId** elements in **rgUserProps**, which indicates that this **DictionaryEntry** corresponds to the user-defined property with **propId** 0x00000006. + +**rgEntries.LpstrNameIdElement-5.propertyName:** This is the container for an **UnalignedLpstr** (section 2.3.3.1.5) structure. + +**rgEntries.LpstrNameIdElement-5.propertyName.value:** "Approved" indicates the property name of the user-defined property with **propId** 0x00000006. + +**rgEntries.LpstrNameIdElement-6:** This is the sixth element in this array. + +**rgEntries.LpstrNameIdElement-6.propertyId:** 0x00000007 is the same as one of the **propId** elements in **rgUserProps**, which indicates that this **DictionaryEntry** corresponds to the user-defined property with **propId** 0x00000007. + +**rgEntries.LpstrNameIdElement-6.propertyName:** This is an **UnalignedLpstr** (section 2.3.3.1.5) structure. + +**rgEntries.LpstrNameIdElement-6.propertyName.value:** "CriticalSection" indicates the property name of the user-defined property with **propId** 0x00000007. See the Linked Property Example (section 3.2.3.4). + +#### LinkBase Property Example + +This is an example of the **LinkBase** property (VT_BLOB **TypedPropertyValue** property). + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|-----------------------------------------|------------| +| 00000372 | 000A | TypedPropertyValue **- \_PID_LINKBASE** | | +| 00000372 | 0002 | WORD **- wType** | 0x0041 | +| 00000374 | 0002 | WORD **- padding** | 0x0000 | +| 00000376 | 0004 | DWORD **- cb** | 0x00000002 | +| 0000037A | 0002 | Array of WCHAR **- value** | 0x0000 | +| 0000037C | 0002 | Array of bytes **- padding** | 0x0000 | + +Figure 26: Structure of a LinkBase property + +**wType:** 0x0041 indicates the property is a VT_BLOB **TypedPropertyValue** property. + +**cb:** 0x00000002 indicates the count of bytes of the value of this property. In this example, the **value** field contains an empty string, so 0x00000002 refers to the count of bytes of the [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) terminating NULL character. + +**value:** The **value** field of the property contains only a Unicode terminating NULL character. + +**padding:** 0x0000 is 2 bytes of padding. This padding is added so that the length of this VT_BLOB **TypedPropertyValue** property structure is a multiple of 4 bytes. + +#### Hyperlinks Property Example + +This is an example of **a [VtHyperlinks](#Section_4df4d1a8bb4746bdacd7944e817338e7)** property (section 2.3.3.1.21). There is a **rgHyperlink** vector in the property, which contains all the [**hyperlinks**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) within this sample document. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 0000037E | 02D0 | VtHyperlinks **- \_PID_HLINKS** | | +| 0000037E | 0002 | WORD **- wType** | 0x0041 | +| 00000380 | 0002 | WORD **- padding** | 0x0000 | +| 00000382 | 02CC | [VtHyperlinkValue](#Section_f65d95215c8d4888a23ecc1b9f9d7da5) **- vtValue** | | +| 00000382 | 0004 | DWORD **- cbData** | 0x000002C8 | +| 00000386 | 02C8 | [VecVtHyperlink](#Section_754880cc03d448e794fcd9f6573f11af) **- vecHyperlink** | | +| 00000386 | 0004 | DWORD **- cElements** | 0x00000024 | +| 0000038A | 02C4 | Array of VtHyperlink **- rgHyperlink** | | +| 0000038A | 006C | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-1** | | +| 000003F6 | 0074 | VtHyperlink **- linkElement-2** | | +| 0000046A | 006C | VtHyperlink **- linkElement-3** | | +| 000004D6 | 005C | VtHyperlink **- linkElement-4** | | +| 00000532 | 00B4 | VtHyperlink **- linkElement-5** | | +| 000005E6 | 0068 | VtHyperlink **- linkElement-6** | | + +Figure 27: Structure of a Hyperlinks property + +**wType:** 0x0041 indicates the property is of VT_BLOB **TypedPropertyValue** property. + +**vtValue.cbData:** 0x000002C8 indicates the count of bytes of the **vecHyperlink** field. In this example, it is 0x000005E6 + 0x0068 – 0x00000386 = 0x000002C8. + +**vtValue.vecHyperlink.cElements:** 0x00000024 indicates there are six **VtHyperlink** structures (section 2.3.3.1.18) in this array. The number of elements is 1/6 of the value of **cElements** property as each **VtHyperlink** element (section 2.3.3.1.18) contains six values. + +**vtValue.vecHyperlink.rgHyperlink:** This is a vector of **VtHyperlink** structures (section 2.3.3.1.21). + +**vtValue.vecHyperlink.rgHyperlink.linkElement-1:** See the [LinkElement-3.2.3.3.1 Example](#Section_37a17baf223446bc95d4cd0ad42735f6) (section 3.2.3.3.1) for the structure of this **VtHyperlink** (section 2.3.3.1.18). The 6 **linkElements** here share the same structure and are described in the following sections. + +##### LinkElement-1 Example + +This is an example of a **linkElement** which consists of 6 structures: **dwHash**, **dwApp**, **dwOfficeArt**, **dwInfo**, **hlink1**, and **hlink2**. The values of **dwApp**, **dwOfficeArt**, and **dwInfo** define where the [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) is applied. The hyperlink can be applied to a shape, a picture in the document, an external link to a picture, or other content in the documents. The values of **hlink1** and **hlink2** define where the hyperlink links. The hyperlink can point to a specific item (for example, a bookmark or a heading) within the same document, or an external file, or an external site, or a specific item in the external site or file. **dwHash** is the calculated value of the [**Hyperlink Hash**](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2) algorithm with the values of **hlink1** and **hlink2** as inputs. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 0000038A | 006C | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-1** | | +| 0000038A | 0008 | TypedPropertyValue **- dwHash** | | +| 0000038A | 0002 | WORD **- wType** | 0x0003 | +| 0000038C | 0002 | WORD **- padding** | 0x0000 | +| 0000038E | 0004 | DWORD **- value** | 0x00670069 | +| 00000392 | 0008 | TypedPropertyValue **- dwApp** | | +| 00000392 | 0002 | WORD **- wType** | 0x0003 | +| 00000394 | 0002 | WORD **- padding** | 0x0000 | +| 00000396 | 0004 | DWORD **- value** | 0x0000000C | +| 0000039A | 0008 | TypedPropertyValue **- dwOfficeArt** | | +| 0000039A | 0002 | WORD **- wType** | 0x0003 | +| 0000039C | 0002 | WORD **- padding** | 0x0000 | +| 0000039E | 0004 | DWORD **- value** | 0x00000000 | +| 000003A2 | 0008 | TypedPropertyValue **- dwInfo** | | +| 000003A2 | 0002 | WORD **- wType** | 0x0003 | +| 000003A4 | 0002 | WORD **- padding** | 0x0000 | +| 000003A6 | 0004 | DWORD **- value** | 0x00000005 | +| 000003AA | 000C | TypedPropertyValue **- hlink1** | | +| 000003AA | 0002 | WORD **- wType** | 0x001F | +| 000003AC | 0002 | WORD **- padding** | 0x0000 | +| 000003AE | 0008 | [Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) **- vtValue** | | +| 000003AE | 0004 | DWORD **- cch** | 0x00000001 | +| 000003B2 | 0002 | Array of WCHAR **- value** | | +| 000003B4 | 0002 | Array of bytes **- padding** | | +| 000003B4 | 0001 | BYTE **- paddingByte-1** | 0x79 | +| 000003B5 | 0001 | BYTE **- paddingByte-2** | 0x32 | +| 000003B6 | 0040 | TypedPropertyValue **- hlink2** | | +| 000003B6 | 0002 | WORD **- wType** | 0x001F | +| 000003B8 | 0002 | WORD **- padding** | 0x0000 | +| 000003BA | 003C | Lpwstr **- vtValue** | | +| 000003BA | 0004 | DWORD **- cch** | 0x0000001B | +| 000003BE | 0036 | Array of WCHAR **- value** | SkipLevelVerificationStart | +| 000003F4 | 0002 | Array of bytes **- padding** | | +| 000003F4 | 0001 | BYTE **- paddingByte-1** | 0x00 | +| 000003F5 | 0001 | BYTE **- paddingByte-2** | 0x00 | + +Figure 28: LinkElement example 1 + +**linkElement-1:** This is a hyperlink that is applied to text content in the document and that links to a bookmark in the same document. + +**dwHash:** The **value** field of this structure is described in Hyperlink Hash (section 2.4.2). + +**dwApp:** In this example, the hyperlink is not applied on a shape or a picture or an external link to a picture in this document. Therefore, the value of the **dwApp** structure is an index into a **PlcFld** ([\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.8.35) that corresponds to the beginning character of the hyperlink field in the document content. The algorithm to determine the value of **dwApp** for this example is described in \[MS-DOC\] section 2.4.7. + +**dwOfficeArt:** This hyperlink is not applied to a shape, so the **value** field of this structure is 0x00000000. + +**dwInfo:** The **value** field of this structure is 0x00000005 as the hyperlink is not applied to a shape and is in a document file as specified by \[MS-DOC\]. + +**hlink1:** This is the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). The **value** field of this structure is an empty string as this hyperlink target is the document itself. + +**hlink2:** This is the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). In this example, the **value** field of the structure, "SkipLevelVerificationStart", is the bookmark in the document that this hyperlink links to. + +**hlink2.wType:** 0x001F indicates that **vtValue** is an **Lpwstr** (section 2.3.3.1.6). + +**hlink2.vtValue.cch:** 0x0000001B indicates the count of characters of the **value** field of the property. 0x0000001B (27) is the count of characters of "SkipLevelVerificationStart" (26) plus the terminating NULL character (1). + +**hlink2.vtValue.value:** The value of this field is the [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) string "SkipLevelVerificationStart" followed by a terminating NULL character. + +**hlink2.vtValue.padding:** This field adds 2 bytes of padding so that the total length of the **Lpwstr** structure (section 2.3.3.1.6) is a multiple of 4 bytes. + +##### LinkElement-2 Example + +This is an example of a **linkElement** that illustrates a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) to a document other than the document that contains the link. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000003F6 | 0074 | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-2** | | +| 000003F6 | 0008 | TypedPropertyValue **- dwHash** | | +| 000003F6 | 0002 | WORD **- wType** | 0x0003 | +| 000003F8 | 0002 | WORD **- padding** | 0x0000 | +| 000003FA | 0004 | DWORD **- value** | 0x003C0014 | +| 000003FE | 0008 | TypedPropertyValue **- dwApp** | | +| 000003FE | 0002 | WORD **- wType** | 0x0003 | +| 00000400 | 0002 | WORD **- padding** | 0x0000 | +| 00000402 | 0004 | DWORD **- value** | 0x00000009 | +| 00000406 | 0008 | TypedPropertyValue **- dwOfficeArt** | | +| 00000406 | 0002 | WORD **- wType** | 0x0003 | +| 00000408 | 0002 | WORD **- padding** | 0x0000 | +| 0000040A | 0004 | DWORD **- value** | 0x00000000 | +| 0000040E | 0008 | TypedPropertyValue **- dwInfo** | | +| 0000040E | 0002 | WORD **- wType** | 0x0003 | +| 00000410 | 0002 | WORD **- padding** | 0x0000 | +| 00000412 | 0004 | DWORD **- value** | 0x00000005 | +| 00000416 | 0048 | TypedPropertyValue **- hlink1** | | +| 00000416 | 0002 | WORD **- wType** | 0x001F | +| 00000418 | 0002 | WORD **- padding** | 0x0000 | +| 0000041A | 0044 | [Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) **- vtValue** | | +| 0000041A | 0004 | DWORD **- cch** | 0x0000001F | +| 0000041E | 003E | Array of WCHAR **- value** | C:\MicrosoftOfficeOrgChart.vsd | +| 0000045C | 0002 | Array of bytes **- padding** | | +| 0000045C | 0001 | BYTE **- paddingByte** | 0x00 | +| 0000045D | 0001 | BYTE **- paddingByte** | 0x00 | +| 0000045E | 000C | TypedPropertyValue **- hlink2** | | +| 0000045E | 0002 | WORD **- wType** | 0x001F | +| 00000460 | 0002 | WORD **- padding** | 0x0000 | +| 00000462 | 0008 | Lpwstr **- vtValue** | | +| 00000462 | 0004 | DWORD **- cch** | 0x00000001 | +| 00000466 | 0002 | Array of WCHAR **- value** | | +| 00000468 | 0002 | Array of bytes **- padding** | | +| 00000468 | 0001 | BYTE **- paddingByte** | 0x79 | +| 00000469 | 0001 | BYTE **- paddingByte** | 0x32 | + +Figure 29: LinkElement example 2 + +**linkElement-2:** This is a hyperlink applied to text content in the document and links to an external file. + +**dwHash:** The **value** field of this structure is calculated as specified in the [**Hyperlink Hash**](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2). + +**dwApp:** In this example, the hyperlink is not applied on a shape or a picture or an external link to a picture in this document. Therefore, the value of the **dwApp** structure is an index into a **PlcFld** ([\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.8.35) that corresponds to the beginning character of the hyperlink field in the document content. The algorithm to determine the value of **dwApp** for this example is described in \[MS-DOC\] section 2.4.7. + +**dwOfficeArt:** This hyperlink is not applied to a shape, so the **value** field of this structure is 0x00000000. + +**dwInfo:** The **value** field of this structure is 0x00000005 as the hyperlink is not applied to a shape and it is in a document specified by \[MS-DOC\]. + +**hlink1:** This is the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). The **value** field of this structure is "C:\MicrosoftOfficeOrgChart.vsd" indicating the name of the file that the hyperlink links to. + +**hlink2:** This is the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). The **value** field of the structure is an empty string because the hyperlink is not referring to a specific item within that file. + +##### LinkElement-3 Example + +This is an example of a **linkElement** that illustrates a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) to a web resource outside of the document that contains the link. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 0000046A | 006C | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-3** | | +| 0000046A | 0008 | TypedPropertyValue **- dwHash** | | +| 0000046A | 0002 | WORD **- wType** | 0x0003 | +| 0000046C | 0002 | WORD **- padding** | 0x0000 | +| 0000046E | 0004 | DWORD **- value** | 0x00320064 | +| 00000472 | 0008 | TypedPropertyValue **- dwApp** | | +| 00000472 | 0002 | WORD **- wType** | 0x0003 | +| 00000474 | 0002 | WORD **- padding** | 0x0000 | +| 00000476 | 0004 | DWORD **- value** | 0x00000006 | +| 0000047A | 0008 | TypedPropertyValue **- dwOfficeArt** | | +| 0000047A | 0002 | WORD **- wType** | 0x0003 | +| 0000047C | 0002 | WORD **- padding** | 0x0000 | +| 0000047E | 0004 | DWORD **- value** | 0x00000000 | +| 00000482 | 0008 | TypedPropertyValue **- dwInfo** | | +| 00000482 | 0002 | WORD **- wType** | 0x0003 | +| 00000484 | 0002 | WORD **- padding** | 0x0000 | +| 00000486 | 0004 | DWORD **- value** | 0x00000005 | +| 0000048A | 0040 | TypedPropertyValue **- hlink1** | | +| 0000048A | 0002 | WORD **- wType** | 0x001F | +| 0000048C | 0002 | WORD **- padding** | 0x0000 | +| 0000048E | 003C | [Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) **- vtValue** | | +| 0000048E | 0004 | DWORD **- cch** | 0x0000001C | +| 00000492 | 0038 | Array of WCHAR **- value** | http://www.wingtiptoys.com/ | +| 000004CA | 000C | TypedPropertyValue **- hlink2** | | +| 000004CA | 0002 | WORD **- wType** | 0x001F | +| 000004CC | 0002 | WORD **- padding** | 0x0000 | +| 000004CE | 0008 | Lpwstr **- vtValue** | | +| 000004CE | 0004 | DWORD **- cch** | 0x00000001 | +| 000004D2 | 0002 | Array of WCHAR **- value** | | +| 000004D4 | 0002 | Array of bytes **- padding** | | +| 000004D4 | 0001 | BYTE **- paddingByte** | 0x79 | +| 000004D5 | 0001 | BYTE **- paddingByte** | 0x32 | + +Figure 30: LinkElement example 3 + +**linkElement-3:** This is a hyperlink associated with a hyperlink field applied to a picture in the document and linked to an external site. + +**dwHash:** The **value** field of this structure is calculated as specified in the [**Hyperlink Hash**](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2). + +**dwApp:** In this example, the hyperlink is not applied on a shape or a picture or an external link to a picture in this document. Therefore, the value of the **dwApp** structure is an index into a **PlcFld** ([\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.8.35) that corresponds to the beginning character of the hyperlink field in the document content. The algorithm to determine the value of **dwApp** for this example is described in \[MS-DOC\] section 2.4.7. + +**dwOfficeArt:** This hyperlink is not applied to a shape, so the **value** field of this structure is 0x00000000. + +**dwInfo:** The **value** field of this structure is 0x00000005 as the hyperlink is not applied to a shape and it is in a document specified by \[MS-DOC\]. + +**hlink1:** This is the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). The **value** field of this structure is "http://www.wingtiptoys.com/" specifying the site that the hyperlink links to. + +**hlink2:** This is the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). The **value** field of the structure is an empty string because the hyperlink is not referring to a specific item within that hyperlink target. + +##### LinkElement-4 Example + +This is an example of a **linkElement** that illustrates a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) to a header inside of the document that contains the link. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000004D6 | 005C | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-4** | | +| 000004D6 | 0008 | TypedPropertyValue **- dwHash** | | +| 000004D6 | 0002 | WORD **- wType** | 0x0003 | +| 000004D8 | 0002 | WORD **- padding** | 0x0000 | +| 000004DA | 0004 | DWORD **- value** | 0x0041004A | +| 000004DE | 0008 | TypedPropertyValue **- dwApp** | | +| 000004DE | 0002 | WORD **- wType** | 0x0003 | +| 000004E0 | 0002 | WORD **- padding** | 0x0000 | +| 000004E2 | 0004 | DWORD **- value** | 0x00000003 | +| 000004E6 | 0008 | TypedPropertyValue **- dwOfficeArt** | | +| 000004E6 | 0002 | WORD **- wType** | 0x0003 | +| 000004E8 | 0002 | WORD **- padding** | 0x0000 | +| 000004EA | 0004 | DWORD **- value** | 0x00000000 | +| 000004EE | 0008 | TypedPropertyValue **- dwInfo** | | +| 000004EE | 0002 | WORD **- wType** | 0x0003 | +| 000004F0 | 0002 | WORD **- padding** | 0x0000 | +| 000004F2 | 0004 | DWORD **- value** | 0x00000005 | +| 000004F6 | 000C | TypedPropertyValue **- hlink1** | | +| 000004F6 | 0002 | WORD **- wType** | 0x001F | +| 000004F8 | 0002 | WORD **- padding** | 0x0000 | +| 000004FA | 0008 | [Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) **- vtValue** | | +| 000004FA | 0004 | DWORD **- cch** | 0x00000001 | +| 000004FE | 0002 | Array of WCHAR **- value** | | +| 00000500 | 0002 | Array of bytes **- padding** | | +| 00000500 | 0001 | BYTE **- paddingByte** | 0x79 | +| 00000501 | 0001 | BYTE **- paddingByte** | 0x32 | +| 00000502 | 0030 | TypedPropertyValue **- hlink2** | | +| 00000502 | 0002 | WORD **- wType** | 0x001F | +| 00000504 | 0002 | WORD **- padding** | 0x0000 | +| 00000506 | 002C | Lpwstr **- vtValue** | | +| 00000506 | 0004 | DWORD **- cch** | 0x00000014 | +| 0000050A | 0028 | Array of WCHAR **- value** | \_Verification_Steps | + +Figure 31: LinkElement example 4 + +**linkElement-4:** This is a hyperlink applied to text content in the document and linked to a heading section in the same document. + +**dwHash:** The **value** field of this structure is calculated as specified in the [**Hyperlink Hash**](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2). + +**dwApp:** In this example, the hyperlink is not applied on a shape or a picture or an external link to a picture in this document. Therefore, the value of the **dwApp** structure is an index into a **PlcFld** ([\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.8.35) that corresponds to the beginning character of the hyperlink field in the document content. The algorithm to determine the value of **dwApp** for this example is described in \[MS-DOC\] section 2.4.7. + +**dwOfficeArt:** This hyperlink is not applied to a shape, so the **value** field of this structure is 0x00000000. + +**dwInfo:** The **value** field of this structure is 0x00000005 as the hyperlink is not applied to a shape and it is in a document specified by \[MS-DOC\]. + +**hlink1:** This is the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). The **value** field of this structure is an empty string as the hyperlink target is the document itself. + +**hlink2:** This is the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). The **value** field of the structure, "\_Verification_Steps", is the heading in this document that this hyperlink links to. + +##### LinkElement-5 Example + +This is an example of a **linkElement** that illustrates a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) to a web resource outside of the document that contains the link, along with an anchor value within that web resource. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000532 | 00B4 | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-5** | | +| 00000532 | 0008 | TypedPropertyValue **- dwHash** | | +| 00000532 | 0002 | WORD **- wType** | 0x0003 | +| 00000534 | 0002 | WORD **- padding** | 0x0000 | +| 00000536 | 0004 | DWORD **- value** | 0x0025003E | +| 0000053A | 0008 | TypedPropertyValue **- dwApp** | | +| 0000053A | 0002 | WORD **- wType** | 0x0003 | +| 0000053C | 0002 | WORD **- padding** | 0x0000 | +| 0000053E | 0004 | DWORD **- value** | 0x00000000 | +| 00000542 | 0008 | TypedPropertyValue **- dwOfficeArt** | | +| 00000542 | 0002 | WORD **- wType** | 0x0003 | +| 00000544 | 0002 | WORD **- padding** | 0x0000 | +| 00000546 | 0004 | DWORD **- value** | 0x00000000 | +| 0000054A | 0008 | TypedPropertyValue **- dwInfo** | | +| 0000054A | 0002 | WORD **- wType** | 0x0003 | +| 0000054C | 0002 | WORD **- padding** | 0x0000 | +| 0000054E | 0004 | DWORD **- value** | 0x00000005 | +| 00000552 | 006C | TypedPropertyValue **- hlink1** | | +| 00000552 | 0002 | WORD **- wType** | 0x001F | +| 00000554 | 0002 | WORD **- padding** | 0x0000 | +| 00000556 | 0068 | [Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) **- vtValue** | | +| 00000556 | 0004 | DWORD **- cch** | 0x00000031 | +| 0000055A | 0062 | Array of WCHAR **- value** | http://en.adatum.com/accounting/managerlist.html | +| 000005BC | 0002 | Array of bytes **- padding** | | +| 000005BC | 0001 | BYTE **- paddingByte** | 0x00 | +| 000005BD | 0001 | BYTE **- paddingByte** | 0x00 | +| 000005BE | 0028 | TypedPropertyValue **- hlink2** | | +| 000005BE | 0002 | WORD **- wType** | 0x001F | +| 000005C0 | 0002 | WORD **- padding** | 0x0000 | +| 000005C2 | 0024 | Lpwstr **- vtValue** | | +| 000005C2 | 0004 | DWORD **- cch** | 0x0000000F | +| 000005C6 | 001E | Array of WCHAR **- value** | emailAddresses | +| 000005E4 | 0002 | Array of bytes **- padding** | | +| 000005E4 | 0001 | BYTE **- paddingByte** | 0x00 | +| 000005E5 | 0001 | BYTE **- paddingByte** | 0x00 | + +Figure 32: LinkElement example 5 + +**linkElement-5:** This is a hyperlink applied to text content in the document and linked to a bookmark on an external site. + +**dwHash:** The **value** field of this structure is calculated as specified in the [**Hyperlink Hash**](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2). + +**dwApp:** In this example, the hyperlink is not applied on a shape or a picture or an external link to a picture in this document. Therefore, the value of the **dwApp** structure is an index into a **PlcFld** ([\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.8.35) that corresponds to the beginning character of the hyperlink field in the document content. The algorithm to determine the value of **dwApp** for this example is described in \[MS-DOC\] section 2.4.7. + +**dwOfficeArt:** This hyperlink is not applied to a shape, so the **value** field of this structure is 0x00000000. + +**dwInfo:** The **value** field of this structure is 0x00000005 as the hyperlink is not applied to a shape and it is in a document specified by \[MS-DOC\]. + +**hlink1:** This is the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). The **value** field of this structure is "http://en.adatum.com/accounting/managerlist.html" indicating the site that the hyperlink links to. + +**hlink2:** This is the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). The **value** field of the structure, "emailAddresses", is the anchor in the target site that this hyperlink links to. + +##### LinkElement-6 Example + +This is an example of a **linkElement** that illustrates a [**hyperlink**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) located on a shape embedded in the document to a header within the document that contains the link. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000005E6 | 0068 | [VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) **- linkElement-6** | | +| 000005E6 | 0008 | TypedPropertyValue **- dwHash** | | +| 000005E6 | 0002 | WORD **- wType** | 0x0003 | +| 000005E8 | 0002 | WORD **- padding** | 0x0000 | +| 000005EA | 0004 | DWORD **- value** | 0x006B0028 | +| 000005EE | 0008 | TypedPropertyValue **- dwApp** | | +| 000005EE | 0002 | WORD **- wType** | 0x0003 | +| 000005F0 | 0002 | WORD **- padding** | 0x0000 | +| 000005F2 | 0004 | DWORD **- value** | 0xFFFFFFFF | +| 000005F6 | 0008 | TypedPropertyValue **- dwOfficeArt** | | +| 000005F6 | 0002 | WORD **- wType** | 0x0003 | +| 000005F8 | 0002 | WORD **- padding** | 0x0000 | +| 000005FA | 0004 | DWORD **- value** | 0x00000402 | +| 000005FE | 0008 | TypedPropertyValue **- dwInfo** | | +| 000005FE | 0002 | WORD **- wType** | 0x0003 | +| 00000600 | 0002 | WORD **- padding** | 0x0000 | +| 00000602 | 0004 | DWORD **- value** | 0x00000004 | +| 00000606 | 000C | TypedPropertyValue **- hlink1** | | +| 00000606 | 0002 | WORD **- wType** | 0x001F | +| 00000608 | 0002 | WORD **- padding** | 0x0000 | +| 0000060A | 0008 | [Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) **- vtValue** | | +| 0000060A | 0004 | DWORD **- cch** | 0x00000001 | +| 0000060E | 0002 | Array of WCHAR **- value** | | +| 00000610 | 0002 | Array of bytes **- padding** | | +| 00000610 | 0001 | BYTE **- paddingByte** | 0x79 | +| 00000611 | 0001 | BYTE **- paddingByte** | 0x32 | +| 00000612 | 003C | TypedPropertyValue **- hlink2** | | +| 00000612 | 0002 | WORD **- wType** | 0x001F | +| 00000614 | 0002 | WORD **- padding** | 0x0000 | +| 00000616 | 0038 | Lpwstr **- vtValue** | | +| 00000616 | 0004 | DWORD **- cch** | 0x00000019 | +| 0000061A | 0032 | Array of WCHAR **- value** | \_Skip-level_Verification | +| 0000064C | 0002 | Array of bytes **- padding** | | +| 0000064C | 0001 | BYTE **- paddingByte** | 0x00 | +| 0000064D | 0001 | BYTE **- paddingByte** | 0x00 | + +Figure 33: LinkElement example 6 + +**linkElement-6:** This is a hyperlink applied to a shape in the document and linked to a heading section within the same document. + +**dwHash:** The **value** field of this structure is calculated as specified in the [**Hyperlink Hash**](#Section_beb6ef90fb234c9f9d3acf1d68616441) (section 2.4.2). + +**dwApp:** The **value** field of this structure is 0xFFFFFFFF as the hyperlink is applied to a shape. + +**dwOfficeArt:** The **value** field of this structure is 0x00000402. It indicates the identifier of the shape to which the hyperlink is applied. + +**dwInfo:** The **value** field of this structure is 0x00000004 because the hyperlink is applied to a shape as defined in [\[MS-ODRAW\]](%5bMS-ODRAW%5d.pdf#Section_8560795e77594745838ff7f2ef2f1872) section 2.5.1. + +**hlink1:** This is the [**hyperlink target**](#gt_8ab050fe-a310-4912-ba19-859186089962). The **value** field of this structure is an empty string when the hyperlink target is the document itself. + +**hlink2:** This is the [**hyperlink location**](#gt_8b9cd56d-fa77-4360-a03f-9a2d5b5e0ff9). The **value** field of the structure, "\_Skip-level_Verification", is the heading in this document that this hyperlink links to. + +#### Linked Property Example + +The following table illustrates the value property of a link/value property pair that defines a [**Linked Property**](#Section_97ac7ca64fab4fb582527bb52a36fde2) (section 2.3.3.2.3.3). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000672 | 0020 | TypedPropertyValue **- CriticalSection** | | +| 00000672 | 0002 | WORD **- wType** | 0x001E | +| 00000674 | 0002 | WORD **- padding** | 0x0000 | +| 00000676 | 001C | [Lpstr](#Section_fac324c9ff39442ebd181a91a723a818) **- stringValue** | | +| 00000676 | 0004 | DWORD **- cch** | 0x00000018 | +| 0000067A | 0018 | Array of CHAR **- value** | Sign the approval form | + +Figure 34: Structure of the CriticalSection property + +The **CriticalSection** property is an **Lpstr** property (section 2.3.3.1.4), see [Category Property Example](#Section_29d75dd8a0654c23948c8f705f01f986) (section 3.2.2.2). The **value** field of **CriticalSection** has been populated with the string contained by the bookmark specified in **CriticalSection_Link**. + +The following table illustrates the link property of a link/value property pair that defines a **Linked Property** (section 2.3.3.2.3.3). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000692 | 0024 | [VtString](#Section_60485cf2d8d94a7f99b1d1cf275ae83c) **- CriticalSection_Link** | | +| 00000692 | 0002 | WORD **- stringType** | 0x001E | +| 00000694 | 0002 | WORD **- padding** | 0x0000 | +| 00000696 | 0020 | Lpstr **- stringValue** | | +| 00000696 | 0004 | DWORD **- cch** | 0x0000001C | +| 0000069A | 001C | Array of CHAR **- value** | SkipLevelVerificationStart | + +Figure 35: Structure of the CriticalSection_Link property + +The **CriticalSection_Link** property is an **Lpstr** property (section 2.3.3.1.4), see Category Property Example (section 3.2.2.2). The **value** field of **CriticalSection_Link** is a bookmark in the document content of the containing document file. The value contained in this bookmark is stored in the **CriticalSection** property. + +The previous two tables have **propId** values of 0x00000007 and 0x01000007 in **rgUserProps**, see [UserDefined Property Set Overview](#Section_283eeaa13610403da42032c8a16945e0) (section 3.2.3). Taken together they are an example of a **Linked Property** (section 2.3.3.2.3.3). The table with **propID** 0x01000007 (**CriticalSection_Link**) stores the name of the bookmark. The table with **propID** 0x00000007 (**CriticalSection**) stores the value of the bookmark. When the example file was saved, the value of the bookmark, the name of which was saved in the **CriticalSection_Link** property, was saved in the **CriticalSection** property. + +## SmartTag Examples + +This section contains an example about how [**smart tag**](#gt_2f57a49a-d503-4605-8798-0e53bd637609) information is embedded in the document. + +In the following example, two smart tags of the following types are embedded in the document: + +- +- + +StocktickerDateThe following is the example for the shared data stored in the [**PropertyBagStore**](#Section_e9e83dea3953448f8cdd2392b6ba76a3) structure (section 2.3.4.1). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 0000142A | 00BA | PropertyBagStore **- propBagStore** | | +| 0000142A | 0004 | ULONG **- cFactoidType** | 0x00000002 | +| 0000142E | 007F | FactoidTypes **- factoidTypes** | | +| 0000142E | 0043 | **A**: [FactoidType](#Section_e20c3d1400c8439b87a07cd8bc7dfdd9) **- factoidType-0** | | +| 00001471 | 003C | **B**: FactoidType **- factoidType-1** | | +| 000014AD | 0002 | USHORT **- cbHdr** | 0x000C | +| 000014AF | 0002 | USHORT **- sVer** | 0x0100 | +| 000014B1 | 0004 | ULONG **- cfactoid** | 0x089A7948 | +| 000014B5 | 0004 | ULONG **- cste** | 0x00000008 | +| 000014B9 | 002B | **C**: IndexedStringTable **- stringTable** | | + +Figure 36: PropertyBagStore structure + +For simplicity this structure is broken down into substructures that are explained after the following descriptions. + +**propBagStore:** Structure of type **PropertyBagStore** (section 2.3.4.1). + +**cFactoidType:** 0x00000002 specifies the number of distinct smart tag types embedded in the document. + +**factoidTypes:** Array of two **FactoidType** structures (section 2.3.4.2) as specified by the **cFactoidType** field. + +**cbHdr:** 0x000C specifies the count of total bytes, including itself and the **sVer**, **cfactoid**, and **cste** fields. + +**sVer:** 0x0100 specifies the version of this structure. + +**cfactoid:** 0x089A7948 is an arbitrary and ignored value. + +**cste:** 0x00000008 specifies the total number of entries in the **stringTable**. + +The substructures identified by label **A**, **B**, and **C** in the preceding example are shown in the table labeled "FactoidType structure for Stockticker smart tag type", the table labeled "FactoidType structure for Date smart tag type", and the table labeled "IndexedStringTable structure", respectively. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 0000142E | 0043 | **A**: FactoidType **- factoidType-0** | | +| 0000142E | 0004 | ULONG **- cbFactoid** | 0x0000003F | +| 00001432 | 0004 | ULONG **- id** | 0x00000001 | +| 00001436 | 002C | [PBString](#Section_0f70d2f799e9485398feedfc98825792) **- rgbUri** | | +| 00001436 | 15 bits | USHORT **- cch** | 0x002A | +| 00001436 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 00001438 | 002A | array of bytes **- rgxch** | urn:schemas-microsoft-com:office:smarttags | +| 00001462 | 000D | PBString **- rgbTag** | | +| 00001462 | 15 bits | USHORT **- cch** | 0x000B | +| 00001462 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 00001464 | 000B | array of bytes **- rgxch** | stockticker | +| 0000146F | 0002 | PBString **- rgbDownLoadURL** | | +| 0000146F | 15 bits | USHORT **- cch** | 0x0000 | +| 0000146F | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 00001471 | 0000 | array of bytes **- rgxch** | | + +Figure 37: FactoidType structure for Stockticker smart tag type + +This is the first **FactoidType** structure (section 2.3.4.2) corresponding to the Stockticker smart tag type. For simplicity, detailed descriptions for the subfields **cch** and **fAnsiString** of **rgbTag** and **rgbDownloadURL** have been omitted. + +**cbFactoid:** 0x0000003F specifies the size of this structure excluding the **cbFactoid** field. + +**id:** 0x00000001 specifies the unique id (across this document) for this smart tag type. + +**rgbUri.cch:** 0x002A specifies the number of characters in the string pointed to by **rbgUri.rgxch**. + +**rgbUri.fAnsiString:** 0x1 specifies that the string pointed to by **rgbUri.rgxch** is an [**ANSI character set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583) string. + +**rgbUri.rgxch:** "urn:schemas-microsoft-com:office:smarttags" specifies the [**XML namespace**](#gt_485f05b3-df3b-45ac-b8bf-d05f5d185a24) [**URI**](#gt_e18af8e8-01d7-4f91-8a1e-0fb21b191f95) for this smart tag type. + +**rgbTag.rgxch:** "stockticker" specifies the tag name for this smart tag type. + +**rgbDownLoadURL.rgxch:** This field is empty because there is no download [**URL**](#gt_433a4fb7-ef84-46b0-ab65-905f5e3a80b1) specified for this particular smart tag type. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00001471 | 003C | **B**: FactoidType **- factoidType-1** | | +| 00001471 | 0004 | ULONG **- cbFactoid** | 0x00000038 | +| 00001475 | 0004 | ULONG **- id** | 0x00000002 | +| 00001479 | 002C | PBString **- rgbUri** | | +| 00001479 | 15 bits | USHORT **- cch** | 0x002A | +| 00001479 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 0000147B | 002A | array of bytes **- rgxch** | urn:schemas-microsoft-com:office:smarttags | +| 000014A5 | 0006 | PBString **- rgbTag** | | +| 000014A5 | 15 bits | USHORT **- cch** | 0x0004 | +| 000014A5 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014A7 | 0004 | array of bytes **- rgxch** | date | +| 000014AB | 0002 | PBString **- rgbDownLoadURL** | | +| 000014AB | 15 bits | USHORT **- cch** | 0x0000 | +| 000014AB | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014AD | 0000 | array of bytes **- rgxch** | | + +Figure 38: FactoidType structure for Date smart tag type + +This is the second **FactoidType** structure (section 2.3.4.2) corresponding to the Date smart tag type. For simplicity, detailed descriptions for all the fields except **id** have been omitted. + +**id:** 0x00000002 specifies the unique id (across this document) for the Date smart tag. + +| **Offset** | **Size** | **Structure** | **Value** | +|------------|----------|---------------------------------------------|-----------| +| 000014B9 | 002B | **C**: IndexedStringTable **- stringTable** | | +| 000014B9 | 0004 | PBString **- stringTableEntry-0** | | +| 000014B9 | 15 bits | USHORT **- cch** | 0x0002 | +| 000014B9 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014BB | 0002 | array of bytes **- rgxch** | 10 | +| 000014BD | 0006 | PBString **- stringTableEntry-1** | | +| 000014BD | 15 bits | USHORT **- cch** | 0x0004 | +| 000014BD | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014BF | 0004 | array of bytes **- rgxch** | 2003 | +| 000014C3 | 0004 | PBString **- stringTableEntry-2** | | +| 000014C3 | 15 bits | USHORT **- cch** | 0x0002 | +| 000014C3 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014C5 | 0002 | array of bytes **- rgxch** | 21 | +| 000014C7 | 0005 | PBString **- stringTableEntry-3** | | +| 000014C7 | 15 bits | USHORT **- cch** | 0x0003 | +| 000014C7 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014C9 | 0003 | array of bytes **- rgxch** | Day | +| 000014CC | 0004 | PBString **- stringTableEntry-4** | | +| 000014CC | 15 bits | USHORT **- cch** | 0x0002 | +| 000014CC | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014CE | 0002 | array of bytes **- rgxch** | ls | +| 000014D0 | 0007 | PBString **- stringTableEntry-5** | | +| 000014D0 | 15 bits | USHORT **- cch** | 0x0005 | +| 000014D0 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014D2 | 0005 | array of bytes **- rgxch** | Month | +| 000014D7 | 0007 | PBString **- stringTableEntry-6** | | +| 000014D7 | 15 bits | USHORT **- cch** | 0x0005 | +| 000014D7 | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014D9 | 0005 | array of bytes **- rgxch** | trans | +| 000014DE | 0006 | PBString **- stringTableEntry-7** | | +| 000014DE | 15 bits | USHORT **- cch** | 0x0004 | +| 000014DE | 1 bit | USHORT **- fAnsiString** | 0x1 | +| 000014E0 | 0004 | array of bytes **- rgxch** | Year | + +Figure 39: IndexedStringTable structure + +This is an array of string table entries. For simplicity, only the detailed description for entries at indexes 1 and 7 are shown. These two entries are referred to by the Date smart tag’s [**PropertyBag**](#Section_5dbba3b5db16449ebb6286967fa7d21b) structure (section 2.3.4.3) to form a key/value pair. The descriptions for the **cch** and **fAnsiString** subfields are also omitted. + +**stringTableEntry-1:** String table entry at index 1. + +**stringTableEntry-1.rgxch:** "2003" specifies this particular string entry. + +**stringTableEntry-7:** String table entry at index 7. + +**stringTableEntry-7.rgxch:** "Year" specifies this particular string entry. + +The following example shows how data private to the individual smart tag is persisted. In this example, the smart tags for the following data items were embedded in the document: + +- +- + +10/21/2003MSFTThe first data item was recognized as a date by the Date smart tag, and the second data item was recognized as a stock symbol by the Stockticker smart tag. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000014E4 | 002C | PropertyBags **- propBags** | | +| 000014E4 | 0026 | PropertyBag **- propertyBag-0** | | +| 000014E4 | 0002 | USHORT **- id** | 0x0002 | +| 000014E6 | 0002 | USHORT **- cProp** | 0x0004 | +| 000014E8 | 0002 | USHORT **- cbUnknown** | 0x0000 | +| 000014EA | 0020 | Properties **- properties** | | +| 000014EA | 0008 | [Property](#Section_61d78938ed384cb39c6b9f42fdd24894) **- property-0** | | +| 000014EA | 0004 | ULONG **- keyIndex** | 0x00000004 | +| 000014EE | 0004 | ULONG **- valueIndex** | 0x00000006 | +| 000014F2 | 0008 | Property **- property-1** | | +| 000014F2 | 0004 | ULONG **- keyIndex** | 0x00000005 | +| 000014F6 | 0004 | ULONG **- valueIndex** | 0x00000000 | +| 000014FA | 0008 | Property **- property-2** | | +| 000014FA | 0004 | ULONG **- keyIndex** | 0x00000003 | +| 000014FE | 0004 | ULONG **- valueIndex** | 0x00000002 | +| 00001502 | 0008 | Property **- property-3** | | +| 00001502 | 0004 | ULONG **- keyIndex** | 0x00000007 | +| 00001506 | 0004 | ULONG **- valueIndex** | 0x00000001 | +| 0000150A | 0006 | PropertyBag **- propertyBag-1** | | +| 0000150A | 0002 | USHORT **- id** | 0x0001 | +| 0000150C | 0002 | USHORT **- cProp** | 0x0000 | +| 0000150E | 0002 | USHORT **- cbUnknown** | 0x0000 | +| 00001510 | 0000 | Properties **- properties** | | + +Figure 40: PropertyBag structures + +For simplicity detailed descriptions for **propertyBag-1.cProp** and **propertyBag-1.cbUnknown** have been omitted. + +**propBags:** An array of **PropertyBag** (section 2.3.4.3). + +**propertyBag-0:** The first **PropertyBag** (section 2.3.4.3). + +**propertyBag-0.id:** 0x0002 specifies the **FactoidType** (section 2.3.4.2) **id**. This value maps it to the Date smart tag type as shown in the **factoidTypes.factoidType-1** field of **PropertyBag** (section 2.3.4.3). + +**propertyBag-0.cProp:** 0x0004 specifies the number of properties stored as part of this smart tag. + +**propertyBag-0.cbUnknown:** 0x0000 specifies that this field is ignored. + +**propertyBag-0.properties:** An array of key/value pair indexes in the **StringTable** field as shown in the preceding example. For simplicity, only the entry at index 3 is shown. + +**propertyBag-0.properties.property-3:** Key/value pair at index 3. The pair as shown evaluates to "Year"="2003". + +**propertyBag-0.properties.property-3.keyIndex:** 0x00000007 specifies index in the **stringTable** field of **PropertyBag** (section 2.3.4.3). This maps to the string "Year". + +**propertyBag-0.properties.property-3.valueIndex:** 0x00000001 specifies the index in the **stringTable** field of **PropertyBag** (section 2.3.4.3). This maps to the string "2003". + +**propertyBag-1:** The second **PropertyBag** (section 2.3.4.3). + +**propertyBag-1.id:** 0x0001 specifies the **FactoidType** (section 2.3.4.2) **id**. This value maps it to the Stockticker smart tag type as shown in the **factoidTypes.factoidType-0** field of the **PropertyBag** (section 2.3.4.3). + +**propertyBag-1.properties:** This smart tag does not have any properties. + +## Visual Basic for Applications Digital Signature Example Structures + +This is an example of a [**Visual Basic for Applications (VBA)**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) storage structure. In this example, the structure of the digital signature is for a document as specified by [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06). The digital signature of a document specified by [\[MS-PPT\]](%5bMS-PPT%5d.pdf#Section_6be79dde33c14c1b8ccc4b2301c08662) has the same structure as described in this example. The digital signature of a document specified by [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) is slightly different than this example. The difference is described in [Visual Basic for Applications Digital Signature](#Section_210c866a8b2f40ad8db8874130e1383a) (section 1.3.4). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000120 | 0754 | [DigSigBlob](#Section_bc21c922b7ae473690aa86afb6403462) **- vbaDigSig** | | +| 00000120 | 0004 | ULONG **- cb** | 0x0000074C | +| 00000124 | 0004 | ULONG **- serializedPointer** | 0x00000008 | +| 00000128 | 074C | [DigSigInfoSerialized](#Section_30a00273dbee422fb488f4b8430ae046) **- signatureInfo** | | +| 00000128 | 0004 | DWORD **- cbSignature** | 0x000003E4 | +| 0000012C | 0004 | DWORD **- signatureOffset** | 0x0000002C | +| 00000130 | 0004 | DWORD **- cbSigningCertStore** | 0x00000340 | +| 00000134 | 0004 | DWORD **- certStoreOffset** | 0x00000410 | +| 00000138 | 0004 | DWORD **- cbProjectName** | 0x00000000 | +| 0000013C | 0004 | DWORD **- projectNameOffset** | 0x00000750 | +| 00000140 | 0004 | BOOL **- fTimestamp** | 0x00000000 | +| 00000144 | 0004 | DWORD **- cbTimestampUrl** | 0x00000000 | +| 00000148 | 0004 | DWORD **- timestampUrlOffset** | 0x00000752 | +| 0000014C | 03E4 | SignedData **- pbSignatureBuffer** | 30 82 03 E0 06 09 ... | +| 00000530 | 0340 | [VBASigSerializedCertStore](#Section_e88d644c80f84016a2c093fc5b110877) **- pbSigningCertStoreBuffer** | | +| 00000530 | 0004 | DWORD **- version** | 0x00000000 | +| 00000534 | 0004 | DWORD **- fileType** | 0x54524543 | +| 00000538 | 032C | [CertStoreCertificateGroup](#Section_462654f19be347f59c1ea6d328ac52e0) **- certGroup** | | +| 00000538 | 0108 | Array of SerializedPropertyEntry **- elementList** | | +| 00000538 | 0020 | [SerializedPropertyEntry](#Section_b8e9c71efe594c568419a2ed2a5858f0) **- certStorePropElement-1** | | +| 00000538 | 0004 | DWORD **- id** | 0x00000014 | +| 0000053C | 0004 | DWORD **- encodingType** | 0x00000001 | +| 00000540 | 0004 | DWORD **- length** | 0x00000014 | +| 00000544 | 0014 | Array of bytes **- value** | 3C 6B 4E A5 18 10 4F 7F 8F 6F 03 AD 5D FB D1 B5 71 1E 93 21 | +| 00000558 | 00A8 | SerializedPropertyEntry **- certStorePropElement-2** | | +| 00000600 | 0020 | SerializedPropertyEntry **- certStorePropElement-3** | | +| 00000620 | 0020 | SerializedPropertyEntry **- certStorePropElement-4** | | +| 00000640 | 0224 | [SerializedCertificateEntry](#Section_38a1970aa95e49a4bcaf6d8c10ddd5ac) **- certificateElement** | | +| 00000640 | 0004 | DWORD **- id** | 0x00000020 | +| 00000644 | 0004 | DWORD **- encodingType** | 0x00000001 | +| 00000648 | 0004 | DWORD **- length** | 0x00000218 | +| 0000064C | 0218 | Array of bytes **- certificate** | 30 82 02 14 30 82 ... | +| 00000864 | 000C | [EndElementMarkerEntry](#Section_020eb66c88e3466b80f60e3ce84d0544) **- endMarkerElement** | | +| 00000864 | 0004 | DWORD **- id** | 0x00000000 | +| 00000868 | 0008 | Array of bytes **- marker** | 00 00 00 00 00 00 00 00 | +| 00000870 | 0002 | Array of WCHAR **- rgchProjectNameBuffer** | | +| 00000872 | 0002 | Array of WCHAR **- rgchTimestampBuffer** | | +| 00000874 | 0000 | Array of bytes **- padding** | | + +Figure 41: VBA digital signature + +In this example, **certStorePropElement-2** through **certStorePropElement-4** have the same structure as **certStorePropElement-1**. See the certStorePropElement-1 element for details. + +**cb:** 0x0000074C is the count of bytes of the **signatureInfo** and **padding** fields combined. + +**serializedPointer:** 0x00000008 is the offset for the **signatureInfo** structure. + +**signatureInfo:** This is the structure that contains detailed data for the VBA digital signature. + +**signatureInfo.cbSignature:** 0x000003E4 is the count of bytes for the **pbSignatureBuffer** field. + +**signatureInfo.signatureOffset:** 0x0000002C indicates that the **pbSignatureBuffer** field begins 0x0000002C bytes after the beginning of its parent **DigSigBlob** (section 2.3.2.2). In this example, the parent **DigSigBlob** begins at offset 0x00000120. Therefore, the **pbSignatureBuffer** field begins at offset 0x0000014C. + +**signatureInfo.cbSigningCertStore:** 0x00000340 is the count of bytes of the **pbSigningCertStoreBuffer**. + +**signatureInfo.certStoreOffset:** 0x00000410 indicates that the **pbSignatureCertStoreBuffer** field begins 0x00000410 bytes after the beginning of its parent **DigSigBlob** (section 2.3.2.2). In this example, the parent **DigSigBlob** begins at offset 0x00000120. Therefore, the **pbSigningCertStoreBuffer** field begins at offset 0x00000530. + +**signatureInfo.cbProjectName:** 0x00000000 is the count of bytes not including the terminating NULL character of the **rgchProjectNameBuffer** field. + +**signatureInfo.projectNameOffset:** 0x00000750 indicates that the **rgchProjectNameBuffer** field begins 0x00000750 bytes after the beginning of its parent **DigSigBlob** (section 2.3.2.2). In this example, the parent **DigSigBlob** begins at offset 0x00000120. Therefore, the **rgchProjectNameBuffer** field begins at offset 0x00000870. + +**signatureInfo.fTimestamp:** 0x00000000 is a reserved value. + +**signatureInfo.cbTimestampUrl:** 0x00000000 is the count of bytes not including the terminating NULL character of the **rgchTimestampBuffer** field. + +**signatureInfo.timestampUrlOffset:** 0x00000752 indicates that the **rgchTimestampBuffer** field begins 0x00000752 bytes after the beginning of its parent **DigSigBlob** (section 2.3.2.2). In this example, the parent **DigSigBlob** begins at offset 0x00000120. Therefore, the **rgchTimestampBuffer** field begins at offset 0x00000872. + +**signatureInfo.pbSignatureBuffer:** The value of this field is a VBA digital signature as described in [VBA Digital Signature](#Section_7c4ce2e22a714b028f51b9f0eeed756a) (section 2.3.2.4). + +**signatureInfo.pbSigningCertStoreBuffer:** The value of this field is a **VBASigSerializedCertStore** structure (section 2.3.2.5.5) containing the [**digital certificate**](#gt_a1dfa70d-7803-413d-8697-c40021a3f3d0) used to create the digital signature. + +**signatureInfo.pbSigningCertStoreBuffer.version:** 0x00000000 indicates the version of the structure. + +**signatureInfo.pbSigningCertStoreBuffer.fileType:** 0x54524543 indicates that the data contained in **pbSigningCertStoreBuffer** is a digital certificate store type. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup:** This is a container of [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) elements representing a single digital certificate and a collection of properties associated with that certificate. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.elementList:** This is the container of an array of **SerializedPropertyEntry** (section 2.3.2.5.3). + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.elementList.certStorePropElement-1:** This is the first element in this **SerializedPropertyEntry** (section 2.3.2.5.3) array. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.elementList.certStorePropElement-1.id:** 0x00000014 is the identifier of the property. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.elementList.certStorePropElement-1.encodingType:** 0x00000001 is a reserved value. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.elementList.certStorePropElement-1.length:** 0x00000014 is the count of bytes of the **value** field in this element. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.elementList.certStorePropElement-1.value:** The value of this field is ignored on read. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.certificateElement:** This is a **SerializedCertificateEntry** structure (section 2.3.2.5.1) containing the certificate stored in this digital certificate store. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.certificateElement.id:** 0x00000020 indicates the beginning of a **certificateElement**. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.certificateElement.encodingType:** 0x00000001 is a reserved value. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.certificateElement.length:** 0x00000218 is the count of bytes of the certificate field in this element. + +**signatureInfo.pbSigningCertStoreBuffer.certGroup.certificateElement.certificate:** The value of this field is the certificate data ([\[RFC3280\]](https://go.microsoft.com/fwlink/?LinkId=90414)). + +**signatureInfo.pbSigningCertStoreBuffer.endMarkerElement:** This is the container of a special entry in the **VBASigSerializedCertStore** structure (section 2.3.2.5.5) that marks the end of the **VBASigSerializedCertStore** structure. + +**signatureInfo.pbSigningCertStoreBuffer.endMarkerElement.id:** 0x00000000 is a reserved value. + +**signatureInfo.pbSigningCertStoreBuffer.endMarkerElement.marker:** 00 00 00 00 00 00 00 00 is the sentinel value for the end of the store. + +**signatureInfo.rgchProjectNameBuffer:** The value of the field is an empty string (a single null [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) character). + +**signatureInfo.rgchTimestampBuffer:** The value of the field is an empty string (a single null Unicode character). + +**padding:** The **padding** field is an array of bytes. The size of this array is the number of bytes necessary to pad the size of the **signatureInfo** field to a multiple of 4 bytes. In this example, the count of bytes of the **signatureInfo** field is 0x0000074C, a multiple of 4 bytes. Therefore, no padding is needed. + +# Security Considerations + +## Toolbar Customization + +None. + +## Property Set Storage + +None. + +## Visual Basic for Applications Digital Signature + +The [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project data [**hash**](#gt_b7e2b611-0af5-4fec-8af2-3f9ce7bad205) as described in [\[MS-OVBA\]](%5bMS-OVBA%5d.pdf#Section_575462babf6741909facc275523c75fc) section 2.4.2 continues to require MD5 hash, even if the digital signing of that data uses a different algorithm. This requirement exists to support cross-version compatibility. This means that even if the [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189) uses an alternate algorithm, the **digest** field of **DigestInfo** in **[SpcIndirectData](#Section_1537695a28f048288b7bd6dab62b8030)Content** (section 2.3.2.4.3.1) contains a 16-byte MD5 hash, even if the **digestAlgorithm** field of **DigestInfo** in **SpcIndirectDataContent** (section 2.3.2.4.3.1) indicates a non-MD5 digest algorithm[\<74\>](#Appendix_A_74). + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- +- +- +- +- +- +- +- +- +- +- + +Microsoft Office 97Microsoft Office 2000Microsoft Office XPMicrosoft Office 2003the 2007 Microsoft Office systemMicrosoft Office 2010 suitesMicrosoft Office 2013Microsoft Office 2016Microsoft Office 2019Microsoft Office 2021Microsoft Office LTSC 2024Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 1.5](#Appendix_A_Target_1): These persistence formats provide interoperability with applications that create or read documents conforming to this structure, including Microsoft Word 97, Microsoft Word 2000, Microsoft Word 2002, Microsoft Office Word 2003, Microsoft Excel 97, Microsoft Excel 2000, Microsoft Excel 2002, Microsoft Office Excel 2003, Microsoft PowerPoint 97, Microsoft PowerPoint 2000, Microsoft PowerPoint 2002, and Microsoft Office PowerPoint 2003. These persistence formats can also be used for interoperability with Microsoft Office Word 2007, Microsoft Word 2010, Microsoft Word 2013, Microsoft Office Excel 2007, Microsoft Excel2010, Microsoft Excel 2013, Microsoft Office PowerPoint 2007, Microsoft PowerPoint 2010, or Microsoft PowerPoint 2013 when compatibility with Word 97, Word 2000, Word 2002, Office Word 2003, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003 is a primary concern. + +[\<2\> Section 2.3.1.6](#Appendix_A_Target_2): In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **cCL** specifies the number of [**toolbar controls**](#gt_8077f5ab-e200-481c-9980-3ea64760ce9d) in the toolbar. In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 **cCL** does not specify the number of toolbar controls in the [**toolbar**](#gt_c57c58f2-a71c-4dc0-ae75-471d52b62f13) and the value of **cCL** is equal to 0xFF (-1). + +[\<3\> Section 2.3.1.8](#Appendix_A_Target_3): In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013, **fCtlModified** can be 0 and the toolbar can still save its toolbar controls to the file. In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fCtlModified** is equal to 1 and ignored. + +[\<4\> Section 2.3.1.12](#Appendix_A_Target_4): In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013, **fNoSetCursor** is equal to 0 if the **tcid** value of the [**TBCHeader**](#Section_6fec0363d40148aaacdf46b7a8bf31db) structure that contains this structure does not equal 0x0001. In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fNoSetCursor** is equal to the appropriate value listed in [\[MS-CTXLS\]](%5bMS-CTXLS%5d.pdf#Section_b461dcd9933e471081bcdc1c74801b6b) section 2.2 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +[\<5\> Section 2.3.1.12](#Appendix_A_Target_5): In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fNoAccel** is equal to 0 if the **tct** value of the **TBCHeader** structure (section 2.3.1.10) that contains this structure is equal to 0x0F. Otherwise, if **tct** is not equal to 0x0F, **fNoAccel** is equal to 1. In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013, **fNoAccel** is equal to the appropriate value listed in [\[MS-CTDOC\]](%5bMS-CTDOC%5d.pdf#Section_aff21c961b434bcf8c8a677e012c7e6a) section 2.2 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +[\<6\> Section 2.3.1.12](#Appendix_A_Target_6): In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 **fAlwaysEnabled** is equal to 0 if the **tcid** value of the **TBCHeader** structure (section 2.3.1.10) that contains this structure does not equal 0x0001. In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fAlwaysEnabled** is equal to the appropriate value listed in \[MS-CTXLS\] section 2.2 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +[\<7\> Section 2.3.1.12](#Appendix_A_Target_7): In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013, **fExclusivePopup** is equal to 0. In Excel 97, and Excel 2000, **fExclusivePopup** is equal to 1 when the **tcid** field of the **TBCHeader** structure (section 2.3.1.10) that contains this structure equals 0x0001. In Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fExclusivePopup** is equal to 1 when the **tcid** field of the **TBCHeader** structure that contains this structure equals 0x0001 and when the **tct** field the **TBCHeader** structure (section 2.3.1.10) that contains this structure equals one of the following values: 0x0A, 0x0B, 0x0C, 0x0D, or 0x0E. In Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fExclusivePopup** is equal to 0 when the **tcid** field of the **TBCHeader** structure that contains this structure equals 1 and when the **tct** field the **TBCHeader** structure that contains this structure does not equal any of the following values: 0x0A, 0x0B, 0x0C, 0x0D, and 0x0E. In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fExclusivePopup** is equal to the appropriate value listed in \[MS-CTXLS\] section 2.2 if the **tcid** value of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +[\<8\> Section 2.3.1.12](#Appendix_A_Target_8): In Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013, **fDefaultBehavior** is equal to 0. In Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **fDefaultBehavior** is equal to 0 when the **tcid** field of the **TBCHeader** structure (section 2.3.1.10) that contains this structure equals 0x0001 and is equal to 1 when the **tcid** field of the **TBCHeader** structure that contains this structure does not equal 0x0001. + +[\<9\> Section 2.3.1.18](#Appendix_A_Target_9): In Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013, **reserved1** is equal to 1. In Word 97, and Excel 97, **reserved1** is equal to 0 and ignored. + +[\<10\> Section 2.3.2.4.1](#the-digestalgorithms-field-must-contain-only-one-digestalgorithmidentifier-pkcs7-section-6.3-and-that-digestalgorithmidentifier-must-specify-the-identifier-of-the-algorithm-used-to-create-the-digest-of-the-signature.10the-contentinfo-fields-contenttype-must-be-an-object-identifier-itux680-with-the-value-1.3.6.1.4.1.311.2.1.4.-the-content-field-of-the-contentinfo-of-this-signeddata-structure-must-be-a-spcindirectdatacontent-structure-section-2.3.2.4.3.1.the-certificates-field-must-contain-certificates-as-specified-by-pkcs7-section-9.1.-this-must-include-the-signature-verification-certificate-and-can-contain-any-intermediate-certificates-between-that-end-entity-and-the-root-including-the-root.-if-the-signeddata-contains-a-countersignature-pkcs9-section-6.6-the-certificates-associated-with-the-countersignature-also-must-be-contained-in-the-certificates-field.the-crls-field-should-be-absent.-if-present-the-crls-field-must-be-ignored.the-signerinfos-field-must-contain-a-single-signerinfo-structure-section-2.3.2.4.2-pkcs7-section-9.2.signerinfo-constraints): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 use the MD5 algorithm to create the signature digest, specified by the identifier "1.2.840.113549.2.5". + +[\<11\> Section 2.3.2.4.4.2](#Appendix_A_Target_11): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 do not provide a value for the **programName** string when signing the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project. However, if one is provided the applications interpret it. + +[\<12\> Section 2.3.2.4.4.2](#Appendix_A_Target_12): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the **moreInfo** field when signing the VBA project. However, if the field is provided, the applications interpret it. + +[\<13\> Section 2.3.2.5.3](#Appendix_A_Target_13): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 write properties in the [**digital certificate store**](#gt_d6f48603-2840-4629-a813-8ed96f69928b) as a byproduct of the way the digital certificate store is constructed, but none of the properties specify any behavior and are ignored when encountered. + +[\<14\> Section 2.3.3](#Appendix_A_Target_14): A minimal document is not required to contain this property set storage, but all files written through a standard save operation by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 include this property set storage. + +[\<15\> Section 2.3.3.1.4](#Appendix_A_Target_15): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 do not constrain this value on write, but enforce this constraint on read. + +[\<16\> Section 2.3.3.1.4](#Appendix_A_Target_16): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 write out the count of bytes including padding and the null-terminating character. + +[\<17\> Section 2.3.3.1.4](#Appendix_A_Target_17): The [\[MS-OLEPS\]](%5bMS-OLEPS%5d.pdf#Section_bf7aeae8c47a49399f45700158dac3bc) specification requires that padding is done with 0x00 values, but Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 write out arbitrary values for their padding in this case. + +[\<18\> Section 2.3.3.1.5](#Appendix_A_Target_18): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 do not constrain this value on write, but enforce this constraint on read. + +[\<19\> Section 2.3.3.1.6](#Appendix_A_Target_19): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 do not constrain this value on write, but enforce this constraint on read. + +[\<20\> Section 2.3.3.1.6](#Appendix_A_Target_20): The \[MS-OLEPS\] specification requires that padding is done with 0x00 values, but Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 write out arbitrary values for their padding in this case. + +[\<21\> Section 2.3.3.1.18](#Appendix_A_Target_21): For PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 document content, other than [**hyperlinks**](#gt_dbe6a2d4-1841-4b4a-a9f6-562c6df7897e) on shapes, the value is 0x00000007. + +[\<22\> Section 2.3.3.1.18](#Appendix_A_Target_22): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 generate this value as specified in [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) section 2.4.7. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 generate this value as specified in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.7.1. For PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013, the value is 0x00000006. + +[\<23\> Section 2.3.3.1.18](#Appendix_A_Target_23): For hyperlinks on shapes, this value is generated as specified in [\[MS-ODRAW\]](%5bMS-ODRAW%5d.pdf#Section_8560795e77594745838ff7f2ef2f1872) section 2.5.1. For hyperlinks in other Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 document content, this value is 0x00000005. For hyperlinks in other Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 document content, this value is 0x00000006. For hyperlinks in other PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 document content, this value is 0x0000007. + +[\<24\> Section 2.3.3.2.1.1](#Appendix_A_Target_24): The **GKPIDSI_PAGECOUNT** property is written and interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 only. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or preserve an existing value but ignore it. + +[\<25\> Section 2.3.3.2.1.1](#Appendix_A_Target_25): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 can write an estimate for this value. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 will calcuPIDSIlate an accurate value for this property on each save. + +[\<26\> Section 2.3.3.2.1.1](#Appendix_A_Target_26): The **GKPIDSI_WORDCOUNT** property is written and interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or preserve an existing value but ignore it. + +[\<27\> Section 2.3.3.2.1.1](#Appendix_A_Target_27): The **GKPIDSI_CHARCOUNT** property is written and interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 only. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or preserve an existing value but ignore it. + +[\<28\> Section 2.3.3.2.2.1](#Appendix_A_Target_28): The **GKPIDDSI_PRESFORMAT** property is written and interpreted by PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 only. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, write an empty string for the value, or preserve a read value from an existing file but ignore it. + +[\<29\> Section 2.3.3.2.2.1](#Appendix_A_Target_29): Only written by PowerPoint 97, PowerPoint 2000, PowerPoint 2002, and Office PowerPoint 2003. + +[\<30\> Section 2.3.3.2.2.1](#Appendix_A_Target_30): Only written by Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. + +[\<31\> Section 2.3.3.2.2.1](#Appendix_A_Target_31): Only written by Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. + +[\<32\> Section 2.3.3.2.2.1](#Appendix_A_Target_32): Only written by Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. + +[\<33\> Section 2.3.3.2.2.1](#Appendix_A_Target_33): The **GKPIDDSI_BYTECOUNT** property is written by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 only. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or preserve an existing value but ignore it. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 usually omit this property or in some scenarios write a value that is inaccurate for this property, because Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 only set or update this property when the **BuiltInDocumentProperties** property is called from the application’s document object model and do not recalculate it on save. + +[\<34\> Section 2.3.3.2.2.1](#Appendix_A_Target_34): The **GKPIDDSI_LINECOUNT** property is written and interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 only. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or preserve an existing value but ignore it. + +[\<35\> Section 2.3.3.2.2.1](#Appendix_A_Target_35): In some cases Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 write an estimate for this value. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 will calculate an accurate value for this property on each save. + +[\<36\> Section 2.3.3.2.2.1](#Appendix_A_Target_36): The **GKPIDDSI_PARACOUNT** property is written and interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or preserve an existing value but ignore it. + +[\<37\> Section 2.3.3.2.2.1](#Appendix_A_Target_37): The **GKPIDDSI_SLIDECOUNT** property is written and interpreted by PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 only. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, write 0, or preserve an existing value but ignore it. + +[\<38\> Section 2.3.3.2.2.1](#Appendix_A_Target_38): The **GKPIDDSI_NOTECOUNT** property is written and interpreted by PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 only. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, write 0, or preserve an existing value but ignore it. + +[\<39\> Section 2.3.3.2.2.1](#Appendix_A_Target_39): The **GKPIDDSI_HIDDENCOUNT** property is written and interpreted by PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 only. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, write 0, or preserve an existing value but ignore it. + +[\<40\> Section 2.3.3.2.2.1](#Appendix_A_Target_40): The **GKPIDDSI_MMCLIPCOUNT** property is written and interpreted by PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 only. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, write 0, or preserve an existing value but ignore it. + +[\<41\> Section 2.3.3.2.2.1](#Appendix_A_Target_41): The **GKPIDDSI_LINKSDIRTY** property is interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 only. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 write 0x00000000 for the property value. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 will preserve an existing value but ignore it (though in the value preservation case, a nonzero value will get converted to the value 0xFFFFFFF on save). PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 fix up linked fields regardless of the state of this property. Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 write the **GKPIDDSI_LINKSDIRTY** property as FALSE (0x00000000) because they write out updated linked property values, if applicable, in the [**User Defined Property Set**](#Section_54514afbff194348be71395854d4432d) (section 2.3.3.2.3) when saving a document. + +[\<42\> Section 2.3.3.2.2.1](#Appendix_A_Target_42): The **GKPIDDSI_CCHWITHSPACES** property is written and interpreted by Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 only. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 omit the property, or will preserve an existing value but ignore it. + +[\<43\> Section 2.3.3.2.2.1](#Appendix_A_Target_43): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 write the **GKPIDDSI_HYPERLINKSCHANGED** property as FALSE because the applications write out an updated **"\_PID_HLINKS"** property, if applicable, in the User Defined Property Set (section 2.3.3.2.3) when saving a document. + +[\<44\> Section 2.3.3.2.2.1](#Appendix_A_Target_44): Word 97, Word 2000, Word 2002, Office Word 2003, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 write their respective application [**minor version**](#gt_e0d99b53-9426-4a45-8429-b012184a4045) numbers as the minor version number portion of the **GKPIDDSI_VERSION** property. + +[\<45\> Section 2.3.3.2.2.1](#Appendix_A_Target_45): PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 use this property for storing their VBA [**digital signature**](#gt_ad0cf6e3-05c3-482d-ab0f-617f91871189). Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 store their VBA digital signature in an unrelated location and will not write this property. Word 97, PowerPoint 97, and Excel 97 do not write digital signatures for VBA. + +[\<46\> Section 2.3.3.2.2.1](#Appendix_A_Target_46): Word 97, Word 2000, Word 2002, Office Word 2003, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 do not write this property, but preserve an existing value if it already exists. Office Word 2007, Word 2010, Word 2013, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Office Excel 2007, Excel 2010, and Excel 2013 will write this property if opening a file from or saving a file to a Windows SharePoint Services document library, in which case they will write the value "document". + +[\<47\> Section 2.3.3.2.2.1](#Appendix_A_Target_47): Word 97, Word 2000, Word 2002, Office Word 2003, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 do not write this property, but preserve an existing value if it already exists. + +[\<48\> Section 2.3.3.2.2.1](#Appendix_A_Target_48): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 do not write this property, but preserve an existing value if it already exists. + +[\<49\> Section 2.3.3.2.2.1](#Appendix_A_Target_49): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 do not write this property, but preserve an existing value if it already exists. + +[\<50\> Section 2.3.3.2.3.2](#Appendix_A_Target_50): Excel 97 and Word 97 write a random [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) for the **\_PID_GUID** property if the property does not yet exist. PowerPoint 97 writes a random GUID for this property on document creation only. + +[\<51\> Section 2.3.3.2.3.2](#Appendix_A_Target_51): The **\_MarkAsFinal** property applies only to Office Excel 2007, Excel 2010, Excel 2013, Office Word 2007, Word 2010, Word 2013, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. Other applications do not write this property and ignore it on read, but preserve an existing value. + +[\<52\> Section 2.3.3.2.3.2](#Appendix_A_Target_52): The **Microsoft Theme** property applies only to Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013. Other applications do not write this property and ignore it on read, but preserve an existing value. + +[\<53\> Section 2.3.3.2.3.2](#Appendix_A_Target_53): The **Presentation** property applies only to Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. Other applications do not write this value and ignore it on read, but preserve an existing value. + +[\<54\> Section 2.3.3.2.3.2](#Appendix_A_Target_54): The **SlideDescription** property applies only to Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. Other applications do not write this value and ignore it on read, but preserve an existing value. + +[\<55\> Section 2.3.3.2.3.2](#Appendix_A_Target_55): The **\_AllowSignedDocumentWithoutReadOnly** property applies only to Office Excel 2007, Excel 2010, Excel 2013, Office Word 2007, Word 2010, Word 2013, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013. Previous versions of the applications ignore this property, but preserve an existing value. + +[\<56\> Section 2.3.3.2.3.2](#Appendix_A_Target_56): The **\_TemplateID** property applies only to Office Word 2003, Office PowerPoint 2003, Office Excel 2003, Office Word 2007, Office PowerPoint 2007, Office Excel 2007, Word 2010, Word 2013, PowerPoint 2010, PowerPoint 2013, Excel 2010, and Excel 2013. Previous versions of the applications ignore this property but preserve an existing value. + +[\<57\> Section 2.3.3.2.3.2](#Appendix_A_Target_57): Unless otherwise specified, these properties apply only to Office Word 2003, Office PowerPoint 2003, Office Excel 2003, Office Word 2007, Office PowerPoint 2007, Office Excel 2007, Word 2010, Word 2013, PowerPoint 2010, PowerPoint 2013, Excel 2010, and Excel 2013. Previous versions of the applications do not write these values and ignore them on read, but will preserve an existing value. + +[\<58\> Section 2.3.3.2.3.2](#Appendix_A_Target_58): The **\_CheckOutSrcUrl** property applies only to Office Word 2007, Office PowerPoint 2007, Office Excel 2007, Word 2010, Word 2013, PowerPoint 2010, PowerPoint 2013, Excel 2010, and Excel 2013. Previous versions of the applications do not write this value and ignore it on read, but will preserve an existing value. + +[\<59\> Section 2.3.3.2.3.2](#Appendix_A_Target_59): Regardless of case, "none" is considered an invalid identifier for a [**smart document**](#gt_cc9fe152-6a63-4555-91f1-1543ff84035d) solution by Office Word 2003, Office Word 2007, Word 2010, Word 2013, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013. + +[\<60\> Section 2.3.3.2.3.2](#Appendix_A_Target_60): Office Word 2003, Office Word 2007, Word 2010, Word 2013, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 read and write this property. Other applications do not write this value and ignore it on read, but will preserve an existing value. + +[\<61\> Section 2.3.3.2.3.2](#Appendix_A_Target_61): Office Word 2003, Office Word 2007, Word 2010, Word 2013, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 read and write this property. Other applications do not write this value and ignore it on read, but will preserve an existing value. + +[\<62\> Section 2.3.3.2.3.2](#Appendix_A_Target_62): Office Word 2003, Office Word 2007, Word 2010, and Word 2013 read and write this property. Other applications do not write this value and ignore it on read, but will preserve an existing value. + +[\<63\> Section 2.3.3.2.3.2](#Appendix_A_Target_63): Regardless of case, "none" is considered an invalid identifier for a solution by Office Word 2003, Office Word 2007, Word 2010, and Word 2013. + +[\<64\> Section 2.3.3.2.3.2](#Appendix_A_Target_64): Office Word 2003, Office Word 2007, Word 2010, and Word 2013 read and write this property. Other applications do not write this value and ignore it on read, but will preserve an existing value. + +[\<65\> Section 2.3.3.2.3.2](#Appendix_A_Target_65): For Office Word 2003, Office Excel 2003, Office Word 2007, Office Excel 2007, Word 2010, Word 2013, Excel 2010, and Excel 2013 documents, these solutions are generated through Visual Studio Tools for Office document [**add-in**](#gt_a3be101e-9d37-484a-a5e6-b70d559146c6) solutions. [**Managed code**](#gt_5293dd75-4296-4f8b-bb9a-cfef88c3c44d) document add-in solutions are not supported by other applications or versions. + +[\<66\> Section 2.3.3.2.3.2](#Appendix_A_Target_66): Office Word 2003, Office Excel 2003, Office Word 2007, Office Excel 2007, Word 2010, Word 2013, Excel 2010, and Excel 2013 interpret this property and support managed code document add-in solutions. Other applications ignore the property on read, but will preserve an existing value. + +[\<67\> Section 2.3.3.2.3.2](#Appendix_A_Target_67): Office Word 2003, Office Excel 2003, Office Word 2007, Office Excel 2007, Word 2010, Word 2013, Excel 2010, and Excel 2013 interpret this property and support managed code document add-in solutions. Other applications ignore the property on read, but will preserve an existing value. + +[\<68\> Section 2.3.3.2.3.2](#Appendix_A_Target_68): Unless otherwise specified, these properties apply only to Word 2002, PowerPoint 2002, Excel 2002, Office Word 2003, Office PowerPoint 2003, Office Excel 2003, Office Word 2007, Office PowerPoint 2007, Office Excel 2007, Word 2010, Word 2013, PowerPoint 2010, PowerPoint 2013, Excel 2010, and Excel 2013. Previous versions of the applications do not write these values and ignore them on read, but will preserve an existing value. + +[\<69\> Section 2.3.3.2.3.2](#Appendix_A_Target_69): Office Word 2003, Office PowerPoint 2003, Office Excel 2003, Office Word 2007, Office PowerPoint 2007, Office Excel 2007, Word 2010, Word 2013, PowerPoint 2010, PowerPoint 2013, Excel 2010, and Excel 2013 read and write this property. Previous versions of the applications do not write this value and ignore it on read, but will preserve an existing value. + +[\<70\> Section 2.3.3.2.3.2](#Appendix_A_Target_70): Office Word 2003, Office PowerPoint 2003, Office Excel 2003, Office Word 2007, Office PowerPoint 2007, Office Excel 2007, Word 2010, PowerPoint 2010, Excel 2010, Word 2013, PowerPoint 2013, and Excel 2013 ignore this property unless the registry key **HKEY_CURRENT_USER\Software\Microsoft\Office\\*version*\>\Outlook\Options\Mail** has a **DWORD** value named "AdHocReviewBehavior" with a value of 0, where \<*version*\> is "11.0" for Office Word 2003, Office PowerPoint 2003, and Office Excel 2003; "12.0" for Office Word 2007, Office PowerPoint 2007, and Office Excel 2007; "14.0" for Word 2010, PowerPoint 2010, and Excel 2010; or "15.0" for Word 2013, PowerPoint 2013, and Excel 2013. + +[\<71\> Section 2.3.3.2.3.3](#Appendix_A_Target_71): Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, and Word 2013 create links to bookmarks for their linked properties, where the link entry’s value is the name of the bookmark. Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013 create links to named ranges for their linked properties, where the link entry’s value is the name of the range. PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, and PowerPoint 2013 create links to bookmark portions of slide content for their linked properties, where the link entry’s value is the identifier of the bookmarked slide content. + +[\<72\> Section 2.3.6](#Appendix_A_Target_72): Word 97, Word 2000, Word 2002, Office Word 2003, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Excel 97, Excel 2000, Excel 2002, and Office Excel 2003 do not create this [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84). + +[\<73\> Section 2.3.6.1.4](#Appendix_A_Target_73): Custom XML data item with the target namespace http://schemas.microsoft.com/office/2006/coverPageProps is only written by Office Word 2007, Word 2010, and Word 2013. + +[\<74\> Section 4.3](#Appendix_A_Target_74): If the digest data of the digital signature is not MD5 encoded, the signature will not be verified by existing versions of Word 97, Word 2000, Word 2002, Office Word 2003, Office Word 2007, Word 2010, Word 2013, PowerPoint 97, PowerPoint 2000, PowerPoint 2002, Office PowerPoint 2003, Office PowerPoint 2007, PowerPoint 2010, PowerPoint 2013, Excel 97, Excel 2000, Excel 2002, Office Excel 2003, Office Excel 2007, Excel 2010, and Excel 2013. + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- +- + +A document revision that incorporates changes to interoperability requirements.A document revision that captures changes to protocol functionality.The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [1.2.1](#Section_5b8f8b38b2ed4d89b91a585888ccbf5d) Normative References | Updated to a newer \[ITUX680\] reference throughout the document. | Minor | + +# Index + +A + +[Applicability](#section_b3b33c72826242d7acaad46e1d55985f) 23 + +[property set storage](#section_9f9aa29768344d14831be17d7694002e) 23 + +[toolbar customization](#section_9f1e83998e3144f5b1f0eab03640eadc) 23 + +[Visual Basic for Applications digital signature](#section_1ee62b59b872477b974374470ec3fcbe) 23 + +Apply format exceptions + +[Bhutanese](#section_e8dc883bc79c4dba8cf9bd5b35964b90) 135 + +[Bokmal (Norwegian)](#section_b38c49f616ce4115a5d83a5aeba713b7) 132 + +[Czech](#section_3e6fa7b3d8c341af83d5ce35cfe6818d) 132 + +[Danish](#section_f8dd4ba2ecb1407991e67ce644cc80ac) 132 + +[Dutch](#section_cecb8c679f6f4edab1e4c7f5a43de7fe) 133 + +[Finnish](#section_c6ed18a249414ec59ece73713234cf27) 133 + +[French Canadian](#section_2f434cef271f489cb017011d577a3880) 133 + +[German](#section_5057be85b6344f5781d9fd859c0aaf78) 133 + +[Hungarian](#section_df404400602444eba084c8c8e3570009) 133 + +[Italian](#section_0c8c25de82dc4ba596b6f0ce56a7565b) 133 + +[Japanese](#section_508fa132cc0a46d99100c9599b28bf83) 133 + +[Kazakh](#section_523ebb796f384127ac43a1ec9ddabb0a) 133 + +[Khmer](#section_f530a560001a4bcd8bf335ec0ef07353) 134 + +[Korean](#section_3386fc600ca843be808c809386d40fc1) 134 + +[Lao](#section_49386e4e393641bb9e6494d30d3d0f99) 134 + +[Lithuanian](#section_d29d131e76514a4b997b811a029cb6f6) 134 + +[Polish](#section_e4e74b58661b41bdb47a0a05c564ef60) 134 + +[Portuguese](#section_fade7d578ff04a2094fb6bb97b40d9e6) 134 + +[Russian](#section_3d87821b2b514fe8ac0c74f1792e587a) 134 + +[Spanish](#section_48f983f3e9284d95b194090e4e103981) 134 + +[Swedish](#section_634c533fe82a40ca9c1516b067df6064) 134 + +[Tibetan](#section_a349cd4025df4f4883bb95ec7527797f) 135 + +[Uzbek Cyrillic](#section_827120fff2b244629dc6f8659a383a8c) 135 + +[Vietnamese](#section_0393b3a48fc9418b97bf26d2bc41f68d) 135 + +C + +[Change tracking](#section_7ddc5e929a1e4ca9938181e0f0ac67b2) 195 + +[Common ABNF definitions](#section_5ea38ff9bfa242eb998830ff844edbc8) 25 + +Common algorithms + +[date/time format from format index](#section_8b810eea93e24577bc840d4f05e41faf) 126 + +[hyperlink hash](#the-result-of-the-algorithm-is-the-value-dwhash.hyperlink-hash) 125 + +[MsoCrc32Compute](#section_324014d139aa4038bbf4f3781732f767) 125 + +[Unicode string to unsigned integer hash](#section_fe607d6aedef4a9191a184f537a03554) 124 + +Common data types + +DataViewAspectEnum ([section 2.2.1.1](#Section_2c82dd3e362a42b2a56b44f09fb3cd8f) 27, [section 2.2.1.2](#Section_a503927129944e5795187d5ae9836f0b) 27) + +[FilePointer](#section_0566aac8327c404186e5e4142458d93e) 30 + +[FixedPoint](#section_eaf84504e46e44b087197bd8eff6d35b) 30 + +[MSONFC](#Section_57c8f7d4142644e0b58d6fa1a5a81659) 27 + +[WebScreenSizeEnum](#Section_d033a231279a42daa71c260412bdd451) 29 + +Common objects + +[document signature serialized certificate store structure](#section_3b94f5604aa24c89bd0f55e293c3fbc7) 124 + +[hyperlinks](#section_8826206b935b4daaaa292ee4134ef202) 104 + +[MsoEnvelope](#section_f7c1375ecff349c6b62f39492273827c) 113 + +[toolbar customization](#section_a38b2b42f81045358ffb175863574222) 30 + +Cover page properties + +[Abstract](#section_df05d7588d6647b4bbff5a7f11ae446c) 101 + +[CompanyAddress](#section_c09e991e764a40748c201214c6634a48) 101 + +[CompanyEmail](#section_e212a2749e464501afa1d4cf1f7f1256) 101 + +[CompanyFax](#section_eb00ac2c2e4447f9a150dee3880a2947) 101 + +[CompanyPhone](#section_5a6b2056449a4ad4935ee114c8cf1218) 101 + +[CoverPageProperties](#section_252c6032cf674f6c91d65f56ea66c7da) 102 + +[PublishDate](#section_9dccbce275e24276a0bbf066c67dbbae) 101 + +[ST_PublishDate](#section_0bc1d3233ce34b599dd4143bf9a1a7a9) 101 + +Custom property editor + +[customPropertyEditor](#section_2169d00b14074f15abcab1ee8aa2a2a1) 90 + +[customPropertyEditors](#section_67e2ad00a4b74887a5b5f96ec69765a9) 90 + +[defaultPropertyEditorNamespace](#section_b820dac0f2cf405f9da3912331ed527f) 90 + +[XMLNamespace](#section_4eff429624e14042a785bc135c4d63df) 89 + +[XSNLocator](#section_47b70b8b19764430ade6b3f6adf2262f) 89 + +[Custom XML data storage](#section_e4521fcce23542979351d268ebb7a9d7) 88 + +[custom XML data storage properties](#section_8d4c97e66af4473aa6acef7ce89ccbf2) 103 + +[showOnOpen](#section_b529581ef7d94e4086694155b82ca0d5) 89 + +[Custom XML data storage item](#section_4bd09eb4a447471ebb34b6be107ab54d) 88 + +[cover page properties](#section_1deeffdeda944ce78188af1ef5d29e67) 101 + +[custom property editor](#section_85d6920daf9f49d9873bbab3e41ae0ff) 89 + +[custom Xsn](#section_cadcb03133274023952d6607c1ab634e) 91 + +[Long properties](#section_6ad9a50924ce46ffb28f77bcd3139b32) 102 + +Custom XML data storage properties + +[dataStoreItem](#section_a8fb433020724dd8962bfc57e7dfc5dd) 104 + +[schemaRef](#section_9cb777251f9c465bb7e880ef27929002) 103 + +[schemaRefs](#section_40b3b0b5243e4f6f8e645f446fb70ac2) 103 + +[ST_Guid](#section_2f3a48cb3142403c962afa02061b7d9b) 103 + +Custom Xsn + +[cached](#section_47752cf7ea8b4994a685259f261254e7) 91 + +[customXsn](#section_ceb529d2572a46a7a8d33951e059de4f) 92 + +[openByDefault](#section_4feeb65bf49248b2bc25bd0155c9bf1f) 91 + +[ST_TrueFalse](#section_eb5c4d8a0cb745c5b46700c35243cc5a) 91 + +[xsnLocation](#section_6a40521d8a294cc9b8590078594cd322) 91 + +[xsnScope](#section_b7a74aaeac8e4670987baac055ce7125) 92 + +D + +Date/time format from format index + +[apply format exceptions](#section_e060e93ec7a948b58994b41e6bfef893) 132 + +[base format strings](#section_7c195e8c262d42ef9c7d2bf9a8880c3e) 127 + +[format indices](#section_155503da75d84f02a1a4b13e7bba430b) 126 + +[retrieve format](#section_991de52a78bd474ebaa658a675501996) 127 + +Document signature serialized certificate store structure + +[DocSigSerializedCertStore](#Section_37d4b77da7d340fe9c3bcd327444f6ff) 124 + +Document summary information examples + +[Category property](#section_29d75dd8a0654c23948c8f705f01f986) 151 + +[CodePage property](#section_ee2488688fde440db81bbc27d1c7811d) 150 + +[document summary information property set overview](#section_c0e0190a08284638ab746fc190da3582) 147 + +[document summary information stream overview](#section_2ea8be67a4a04e2eb42f49a182645562) 145 + +[DocumentParts property](#section_742bc556d7884900b7aeb8fe1f2e4322) 152 + +[HeadingPairs property](#section_887bb6a81f9c4d4abf3dcf6062e4c6a4) 155 + +[Hyperlinks property](#section_fbfec8b87db44a60bc0e5ea0b1bc2328) 163 + +[LineCount property](#section_c93a7a10a41945639a2ed4b4dc51cf94) 151 + +[LinkElement - 1](#section_37a17baf223446bc95d4cd0ad42735f6) 164 + +[LinkElement - 2](#section_e49f3f560ff446e89e2b113cdc0df22e) 166 + +[LinkElement - 3](#section_fcb66d121ea0407bae648ac68881703e) 168 + +[LinkElement - 4](#section_c0c7621ea29d4f5583baaabdbca3d932) 169 + +[LinkElement - 5](#section_542e43e1ae964e63be5e9012ec4d1128) 171 + +[LinkElement - 6](#section_caafc24928e04955af22541a9084e45c) 173 + +[LinksDirty property](#section_073efdcc7d75400396a9c48f4a3ce77c) 152 + +[Document Summary Information Examples example](#section_56b90d28302b40f6ba611b024fcdf29c) 143 + +Document summary information property set + +[PIDDSI](#Section_3ef02e83afef4b6c9585c109edd24e07) 75 + +Document summary information property set overview + +[Category property](#section_29d75dd8a0654c23948c8f705f01f986) 151 + +[CodePage property](#section_ee2488688fde440db81bbc27d1c7811d) 150 + +[DocumentParts property](#section_742bc556d7884900b7aeb8fe1f2e4322) 152 + +[HeadingPairs property](#section_887bb6a81f9c4d4abf3dcf6062e4c6a4) 155 + +[LineCount property](#section_c93a7a10a41945639a2ed4b4dc51cf94) 151 + +[LinksDirty property](#section_073efdcc7d75400396a9c48f4a3ce77c) 152 + +E + +Examples + +[Category property](#section_29d75dd8a0654c23948c8f705f01f986) 151 + +[CodePage property](#section_ee2488688fde440db81bbc27d1c7811d) 150 + +[document summary information](#section_56b90d28302b40f6ba611b024fcdf29c) 143 + +[Document Summary Information Examples](#section_56b90d28302b40f6ba611b024fcdf29c) 143 + +[document summary information property set overview](#section_c0e0190a08284638ab746fc190da3582) 147 + +[document summary information stream overview](#section_2ea8be67a4a04e2eb42f49a182645562) 145 + +[DocumentParts property](#section_742bc556d7884900b7aeb8fe1f2e4322) 152 + +[HeadingPairs property](#section_887bb6a81f9c4d4abf3dcf6062e4c6a4) 155 + +[Hyperlinks property](#section_fbfec8b87db44a60bc0e5ea0b1bc2328) 163 + +[LineCount property](#section_c93a7a10a41945639a2ed4b4dc51cf94) 151 + +[LinkElement - 1](#section_37a17baf223446bc95d4cd0ad42735f6) 164 + +[LinkElement - 2](#section_e49f3f560ff446e89e2b113cdc0df22e) 166 + +[LinkElement - 3](#section_fcb66d121ea0407bae648ac68881703e) 168 + +[LinkElement - 4](#section_c0c7621ea29d4f5583baaabdbca3d932) 169 + +[LinkElement - 5](#section_542e43e1ae964e63be5e9012ec4d1128) 171 + +[LinkElement - 6](#section_caafc24928e04955af22541a9084e45c) 173 + +[LinksDirty property](#section_073efdcc7d75400396a9c48f4a3ce77c) 152 + +[SmartTag](#section_1e45e265a6c0418f9b902d1fc53ad7ae) 175 + +[SmartTag Examples](#section_1e45e265a6c0418f9b902d1fc53ad7ae) 175 + +[toolbar control](#section_1a66784c61e64ee58e499d39be874354) 136 + +[toolbar customization](#section_9bece780e23c4b249fbf34b879863a34) 136 + +[Toolbar Customization Examples](#section_9bece780e23c4b249fbf34b879863a34) 136 + +[toolbar delta](#section_8209042370e744b29ea0c69f55208358) 141 + +[user defined property set overview](#section_283eeaa13610403da42032c8a16945e0) 157 + +[Visual Basic for Applications Digital Signature Example Structures](#section_715a782baacd4743acadab3c55d694ee) 181 + +[Visual Basic for Applications digital signature storage structure](#section_715a782baacd4743acadab3c55d694ee) 181 + +F + +[Fields - vendor-extensible](#structure-versions-there-is-only-one-version-of-the-vba-digital-signature-defined-in-visual-basic-for-applications-digital-signature-storage-section-2.3.2.localization-the-vba-digital-signature-structures-define-no-locale-specific-processes-or-data.vendor-extensible-fields) 24 + +G + +[Glossary](#glossary) 9 + +H + +Hyperlinks + +[AntiMoniker](#Section_e56f55e7320d45beb5463250dd314f82) 107 + +[CompositeMoniker](#Section_b5e2deb030694bacbc749433311f691b) 107 + +[FileMoniker](#Section_c28c62d7adc5405585dbd957069965ac) 111 + +[Hyperlink object](#Section_c04372224868466081f86b7ee236d3f8) 104 + +[HyperlinkMoniker](#Section_0cc5cf392a1645a9a7fb8994ce3f01a5) 106 + +[HyperlinkString](#Section_1a9f6231df634a95b9985c2b95b82965) 112 + +[ItemMoniker](#Section_fae1319fa20942b4b60fb2bb25cdc22c) 107 + +[URICreateFlags](#Section_1786df8eb7924a28b7c54d9a91d2e401) 109 + +[URLMoniker](#Section_4948a119c4e446b696090525118552e8) 109 + +Hyperlinks property example + +[LinkElement - 1](#section_37a17baf223446bc95d4cd0ad42735f6) 164 + +[LinkElement - 2](#section_e49f3f560ff446e89e2b113cdc0df22e) 166 + +[LinkElement - 3](#section_fcb66d121ea0407bae648ac68881703e) 168 + +[LinkElement - 4](#section_c0c7621ea29d4f5583baaabdbca3d932) 169 + +[LinkElement - 5](#section_542e43e1ae964e63be5e9012ec4d1128) 171 + +[LinkElement - 6](#section_caafc24928e04955af22541a9084e45c) 173 + +I + +[Informative references](#informative-references) 17 + +[Introduction](#introduction) 9 + +L + +Long properties + +[LongProp](#section_8ed57b888c0841dba4a93471853de759) 102 + +[LongProperties](#section_3e0d6857c12443a6a14493ee50a79e44) 102 + +M + +MsoCrc32Compute + +[caching algorithm](#section_4186e6d756d6456992e814a9c93f2af1) 125 + +[CRC computation](#section_ba71f3bafa454b65bb36ac3b465d6761) 126 + +MsoEnvelope + +[EnvAttachment](#Section_a8ff6fd332d14fd0ad6a5f3a0cf3bcce) 122 + +[EnvAttachmentCollection](#Section_706192e0b6734ba2a1548f4dfc9f0165) 122 + +[EnvRecipientCollection](#Section_5deabdf8d4604a4ca0a64cb7cefaf75d) 117 + +[EnvRecipientProperties](#Section_f9e2a31453104779b5a8ecf6817703bd) 117 + +[EnvRecipientProperty](#Section_8df36d0a49eb4f41910bcec9ba5120e8) 118 + +[EnvRecipientPropertyBlob](#Section_2ce2498ef44f4ceaaf7059c3abc4c129) 118 + +[IntroText](#Section_01e96fcbe7504b1f94249d05b8545403) 123 + +[MsoEnvelope](#Section_52f153930e4f4bd9a521dcb8f0a869ef) 113 + +[MsoEnvelopeCLSID](#Section_d1be9a70298942a0a6e873473fe98911) 113 + +[PT_BINARY](#Section_5eb7ad4f284c427ea7f6b2b418a0b403) 121 + +[PT_BOOLEAN](#Section_bfed9f7b80e24683b8aae31c269edc37) 119 + +[PT_ERROR](#Section_b26e9a2c53c047e89961999b63be162a) 120 + +[PT_LONG](#Section_14c87459b96747838c07c577771d4692) 119 + +[PT_MV_BINARY](#Section_21b12ab606c44eaabf302224ccac74f1) 122 + +[PT_MV_STRING8](#Section_19c08692116741bf9801053c11225c69) 121 + +[PT_NULL](#Section_baff4515df094c9f85ecc5c1b2750111) 119 + +[PT_STRING8](#Section_0c75d01a68c844bf9b4480a73d052db5) 120 + +[PT_SYSTIME](#Section_b9f7856615ae419fafa944265c9f4092) 120 + +[PT_UNICODE](#Section_274cc379b1964a8f89baeb9cf0baf7fc) 120 + +N + +[Normative references](#normative-references) 15 + +O + +[OLE property sets](#section_0105a8ee6e664b1281a5d3d39c8270f2) 72 + +[document summary information property set](#section_fe59ffd979e944fba1c92466057b05c6) 74 + +[summary information property set](#section_11b5612735f44bfaa23f23935a6edf54) 72 + +[Overview (synopsis)](#structure-overview-synopsis) 17 + +P + +[Product behavior](#section_76e644d885d243f3bbc8c649f080e101) 186 + +[Property set storage](#section_9673a168c71544eb882502cfa2b4627d) 61 + +[Property types](#section_0bc7362e62d4496995ff4c19edb1b104) 61 + +[Lpstr](#Section_fac324c9ff39442ebd181a91a723a818) 63 + +[Lpwstr](#Section_e5f5c0973b4440f293ccab4ce521f82d) 64 + +[PropertySetSystemIdentifier](#Section_6ac486b48d634cdebd729c2306a482fe) 61 + +[UnalignedLpstr](#Section_a8f75582c3d34a5bbbca62ed6a05711d) 64 + +[VecVtHyperlink](#Section_754880cc03d448e794fcd9f6573f11af) 71 + +[VtDigSig](#Section_e1f6b35d7e064dbc880ba074fabcd06d) 69 + +[VtDigSigValue](#Section_a7c3987feaa64f8cbc5cf0dd124eb32f) 69 + +[VtHeadingPair](#Section_8d8db7dc9a0c4bcc9ad5a2937bb559b0) 67 + +[VtHyperlink](#Section_2225d544e06344ff9f70739f1c14d592) 69 + +[VtHyperlinks](#Section_4df4d1a8bb4746bdacd7944e817338e7) 71 + +[VtHyperlinkValue](#Section_f65d95215c8d4888a23ecc1b9f9d7da5) 71 + +[VtString](#Section_60485cf2d8d94a7f99b1d1cf275ae83c) 66 + +[VtThumbnail](#Section_4af3a094890c4ecc832cf212bfebbfa9) 63 + +[VtThumbnailValue](#Section_427efceff31c4d9e9e4ed28ff9bb6e0b) 62 + +[VtUnalignedString](#Section_eb04ce67f96b4ea4adf77f75847c7abb) 67 + +[VtVecHeadingPair](#Section_3aaaf9e84f1a42fa9359fe0ab0c1cccc) 68 + +[VtVecHeadingPairValue](#Section_7eaa201d3fe149178e393690a3a36c11) 68 + +[VtVecLpwstr](#Section_2dc59d31a90349bba1f145fc01c8b8b0) 65 + +[VtVecLpwstrValue](#Section_112762c273624710afad1f4c8bc6a814) 65 + +[VtVecUnalignedLpstr](#Section_523af67dd69a4eb1848ba299674ac9b8) 66 + +[VtVecUnalignedLpstrValue](#Section_cd95ca9770c748288b5bb86263348026) 65 + +R + +[RefEdit control](#section_45556c0e0f424c79864e503cd04e38ba) 88 + +[References](#references) 15 + +[informative](#informative-references) 17 + +[normative](#normative-references) 15 + +Relationship to protocols and other structures + +[property set storage](#ms-ctdoc-for-the-persistence-format-for-word-processing-documents.ms-ctxls-for-the-persistence-format-for-spreadsheet-toolbar-customization-structures-defined-in-this-document.-property-set-storage) 23 + +[toolbar customization](#section_884451bdb7a5486c93632b984d92226e) 22 + +[Visual Basic for Applications Digital Signature](#section_1281abccebd9419f8c0be995c5789d7d) 23 + +Retrieve format + +[Chinese formats](#section_fc1c7b8a34fa4e669449fb8e5719d368) 127 + +[formats for all other locales](#section_06344de126ec4490a4d73d6311fc0bb5) 131 + +[Hindi formats](#section_58059fc1f2494a10bab4faf361360e88) 128 + +[Japanese formats](#section_0f59a13d46d04835bec88c430ba26f54) 128 + +[Korean formats](#section_d3008e516ff043798b441a9569c4dbba) 129 + +[Taiwanese formats](#section_28531aa4ed214946a5e64d2cff6f843f) 129 + +[Thai formats](#section_6fa4db1946f841afa974beb3f4aa053e) 130 + +[Yi formats](#section_db987d364d92407aa9699aa4173d8692) 130 + +S + +[Schema for content type](#section_5a76628af8624994a57eec37de5c6c78) 92 + +[ContentTypeId](#section_e03d125c11a44decae95996d808aa344) 92 + +[contentTypeSchema](#section_708783bb2f0e4fa490372a952688f757) 98 + +[DummyContentTypeElement](#section_e1f362d7a9e543b387fafa73531ad4e2) 93 + +[IntNonNegative](#section_7100e5ee24f74cec89d01e03ed3129ee) 93 + +[schema](#section_a19e7eeb1ab54d64bcc9dff9a6399ba4) 98 + +[UniqueIdentifierWithoutBraces](#section_7632be5c7d4844a5959ea5b4bdcc8ffc) 93 + +[UniqueIdentifierWithoutBracesOrEmpty](#section_50ffad9914214f9e9e601b1bf1fedf28) 93 + +Security + +[property set storage](#section_a55c16e74ec94e1f91e157c007ab04b3) 185 + +[toolbar customization](#section_a50bb0b780f849a8b1f03c0b3dde3cfa) 185 + +[visual basic for applications digital signature](#section_40c8dab3e8db4c66a6be8cec06351b1e) 185 + +Security considerations + +[property set storage](#section_a55c16e74ec94e1f91e157c007ab04b3) 185 + +[toolbar customization](#section_a50bb0b780f849a8b1f03c0b3dde3cfa) 185 + +[Visual Basic for Applications digital signature](#section_40c8dab3e8db4c66a6be8cec06351b1e) 185 + +[Serialized certificate store structure](#the-certificate-chain-for-the-countersignature-must-be-built-according-to-a-trusted-root-certificate-by-using-x.509-path-validation-rules-as-specified-by-rfc3280-section-6.the-time-stamp-authority-tsa-certificate-that-was-used-to-sign-the-timestamp-must-contain-the-eku-value-for-timestamping-1.3.6.1.5.5.7.3.8.serialized-certificate-store-structure) 58 + +[CertStoreCertificateGroup](#Section_462654f19be347f59c1ea6d328ac52e0) 60 + +[EndElementMarkerEntry](#Section_020eb66c88e3466b80f60e3ce84d0544) 59 + +[SerializedCertificateEntry](#Section_38a1970aa95e49a4bcaf6d8c10ddd5ac) 58 + +[SerializedPropertyEntry](#Section_b8e9c71efe594c568419a2ed2a5858f0) 59 + +[VBASigSerializedCertStore](#Section_e88d644c80f84016a2c093fc5b110877) 60 + +SignedData contentInfo structures + +[SpcIndirectDataContent](#section_1537695a28f048288b7bd6dab62b8030) 54 + +[SpcIndirectDataContentV2](#the-digestalgorithm-field-must-be-an-algorithmidentifier-structure.-the-algorithm-field-of-digestalgorithm-specifies-the-object-identifier-itux680-of-the-digest-algorithm-that-was-used-to-hash-the-vba-project-contents-producing-the-value-for-the-digest-field.-this-object-identifier-itux680-value-must-be-set-to-the-same-algorithm-identifier-as-specified-in-the-digestalgorithm-field-of-the-signeddata-structure-section-2.3.2.4.1.-the-parameters-field-of-digestalgorithm-must-be-set-to-the-null-type-itux680-with-a-length-of-zero.the-digest-field-must-be-an-octetstring-itux680.-the-value-of-the-octetstring-must-be-produced-by-means-of-the-hash-algorithm-specified-in-ms-ovba-section-2.4.2.spcindirectdatacontentv2) 55 + +SignerInfo authenticatedAttributes structures + +[SpcLink](#section_7cb90c30902f48d7a5ee686ce1ff0d36) 57 + +[SpcSpOpusInfo](#section_917556324b0d44ca89a99699afbbd268) 57 + +[SpcStatementType](#section_c541e3e43d044cbd82db1b73163427fd) 57 + +[SpcString](#section_d5bcc38d051f47758c4474d52e301702) 57 + +[SignerInfo unauthenticatedAttributes](#section_2dca257e8a014526adc2bbc62861f05b) 57 + +[SmartTag Examples example](#section_1e45e265a6c0418f9b902d1fc53ad7ae) 175 + +[SmartTag objects](#section_55082f95b0e94cdc98dde89bc184c1b0) 85 + +[FactoidType](#Section_e20c3d1400c8439b87a07cd8bc7dfdd9) 86 + +[PBString](#Section_0f70d2f799e9485398feedfc98825792) 88 + +[Property](#Section_61d78938ed384cb39c6b9f42fdd24894) 87 + +[PropertyBag](#Section_5dbba3b5db16449ebb6286967fa7d21b) 87 + +[PropertyBagStore](#Section_e9e83dea3953448f8cdd2392b6ba76a3) 85 + +Structure overview (synopsis) + +[byte ordering](#section_d6caa7df142c4991b863541235e23a07) 22 + +[property set storage](#section_8419d374b2ec49fbb73650dd19108910) 19 + +[RefEdit control](#section_85f8bdd6a41b4b28b2c365ab1e335853) 20 + +[toolbar customization](#toolbar-customization) 17 + +[Visual Basic for Applications digital signature](#section_210c866a8b2f40ad8db8874130e1383a) 20 + +Summary information property set + +[PIDSI](#Section_87667163ea1e4d679eec47cad74e8030) 72 + +T + +Toolbar customization ([section 1.3.1](#toolbar-customization) 17, [section 1.4.1](#section_884451bdb7a5486c93632b984d92226e) 22, [section 1.5.1](#section_9f1e83998e3144f5b1f0eab03640eadc) 23, [section 1.6.1](#section_d85df01755284489a94f8fd5cf42369a) 23, [section 1.7.1](#section_efed041370ae47b48db2bf9f1e0e3ca1) 24, [section 2.3.1](#section_a38b2b42f81045358ffb175863574222) 30) + +[BITMAPINFOHEADER](#Section_5eb5fc23797e4e428ef1ef844994d7d4) 31 + +[RGBQuad](#Section_635c7c9d5a7f45dc98c1577be7d0f7ac) 32 + +[SRECT](#Section_21c05acf851f4874bdcbd69e94bffed1) 33 + +[TB](#Section_4b59413771ec456fbaf9ba1dd0a28c5c) 34 + +[TBCBitmap](#Section_24c6da6cfc9f4815ad189a7a3a6d9205) 30 + +[TBCBSFlags](#Section_d6b3333d6f7042848b41752d3ede4116) 47 + +[TBCBSpecific](#Section_6f6f5f9fe2f04f0d9d6fb15395b364c0) 46 + +[TBCCDData](#Section_aa9aecdd1d154724adecc1f6bd7e8c59) 49 + +[TBCComboDropdownSpecific](#Section_d264bd1960084eb5ba7ce1e12a80c7a3) 48 + +[TBCData](#Section_2abc9423fd1b49c490986846ddc07283) 43 + +[TBCExtraInfo](#Section_feebb647ba9c40378718babc740201c5) 45 + +[TBCFlags](#Section_8b35e28b45f14e92ab1a39fa84e0fb2b) 40 + +[TBCGeneralInfo](#Section_99109267262941139ceca9481d6d606d) 44 + +[TBCGIFlags](#Section_5a7caae568844e45b93687022aa2f2d6) 44 + +[TBCHeader](#Section_6fec0363d40148aaacdf46b7a8bf31db) 39 + +[TBCMenuSpecific](#Section_912bf645a367471b9d4efc29583a01bc) 49 + +[TBCSFlags](#Section_df3f6f9b34c6451fad13765c2cb63c09) 40 + +[TBFlags](#Section_2809bc150e0d4c959444e624aa9b76ec) 36 + +[TBTRFlags](#Section_e51860d90eb74d6b8608a6eaf078dd53) 34 + +[TBVisualData](#Section_1b41ab5402664559bc7b92a02483362b) 36 + +[WString](#Section_9aa198843ab34da3a4aff2db446befda) 33 + +Toolbar customization examples + +[toolbar control](#section_1a66784c61e64ee58e499d39be874354) 136 + +[toolbar delta](#section_8209042370e744b29ea0c69f55208358) 141 + +[Toolbar Customization Examples example](#section_9bece780e23c4b249fbf34b879863a34) 136 + +[Tracking changes](#section_7ddc5e929a1e4ca9938181e0f0ac67b2) 195 + +U + +[User defined property set](#section_54514afbff194348be71395854d4432d) 78 + +[linked properties](#section_97ac7ca64fab4fb582527bb52a36fde2) 85 + +[reserved properties](#vtstring-section-2.3.3.1.11typedpropertyvalue-ms-oleps-section-2.15-the-type-of-which-must-be-one-of-the-following-typesvt_i4-0x0003vt_r8-0x0005vt_bool-0x000bvt_filetime-0x0040vt_blob-0x0041reserved-properties) 79 + +[User defined property set constraints](#section_1edd5ada132a4108af3323225e159aa8) 79 + +[required properties](#section_1414f765ea8e4a1ea19c641500e5f93d) 79 + +[supported types](#section_f49b1757718e4292a42f4164ce9abdf1) 79 + +User defined property set examples + +[user defined property set overview](#section_283eeaa13610403da42032c8a16945e0) 157 + +User defined property set overview + +[Hyperlinks property](#section_fbfec8b87db44a60bc0e5ea0b1bc2328) 163 + +[LinkElement - 1](#section_37a17baf223446bc95d4cd0ad42735f6) 164 + +[LinkElement - 2](#section_e49f3f560ff446e89e2b113cdc0df22e) 166 + +[LinkElement - 3](#section_fcb66d121ea0407bae648ac68881703e) 168 + +[LinkElement - 4](#section_c0c7621ea29d4f5583baaabdbca3d932) 169 + +[LinkElement - 5](#section_542e43e1ae964e63be5e9012ec4d1128) 171 + +[LinkElement - 6](#section_caafc24928e04955af22541a9084e45c) 173 + +V + +[VBA Digital Signature](#section_7c4ce2e22a714b028f51b9f0eeed756a) 53 + +[SignedData constraints](#section_708462617bc14c3094fe29ebf7f697ff) 53 + +[SignedData contentInfo structures](#the-authenticatedattributes-section-2.3.2.4.4-field-must-be-present.this-field-must-contain-the-following-attributesa-content-type-attribute-with-its-value-set-as-specified-in-pkcs7-section-9.2.a-message-digest-attribute-with-its-value-set-as-specified-in-pkcs7-section-9.2.this-field-can-also-containone-spcstatementtype-attribute-section-2.3.2.4.4.1-but-this-attribute-must-be-ignored.one-spcspopusinfo-attribute-section-2.3.2.4.4.2.if-the-signature-has-been-timestamped-then-the-unauthenticatedattributes-field-section-2.3.2.4.5-must-be-present-and-must-contain-a-single-countersignature-attribute-pkcs9-section-6.6.-if-the-signature-has-not-been-timestamped-the-unauthenticatedattributes-field-must-be-absent.signeddata-contentinfo-structures) 54 + +[SignerInfo authenticatedAttributes structures](#the-algorithmidsize-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-size-of-the-algorithmid-field.the-compiledhashsize-field-should-be-zero.the-sourcehashsize-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-size-of-the-sourcehash-field.the-algorithmidoffset-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-position-in-bytes-of-the-algorithmid-field-from-the-beginning-of-the-structure.the-compiledhashoffset-field-should-be-zero.the-sourcehashoffset-field-must-be-an-integer-itux680-and-the-value-must-be-equal-to-the-position-in-bytes-of-the-sourcehash-field-from-the-beginning-of-the-structure.the-algorithmid-field-specifies-the-object-identifier-itux680-of-the-digest-algorithm-that-was-used-to-hash-the-vba-project-contents-producing-the-value-for-the-digest-field.-this-object-identifier-itux680-value-must-be-set-to-the-same-algorithm-identifier-as-specified-in-the-digestalgorithm-field-of-the-signeddata-structure.the-compiledhash-field-should-be-empty.the-sourcehash-field-must-be-an-octetstring-itux680.-the-value-of-the-octetstring-must-be-produced-by-means-of-the-hash-algorithm-specified-in-ms-ovba-section-2.4.2.signerinfo-authenticatedattributes-structures) 56 + +[SignerInfo constraints](#the-digestalgorithms-field-must-contain-only-one-digestalgorithmidentifier-pkcs7-section-6.3-and-that-digestalgorithmidentifier-must-specify-the-identifier-of-the-algorithm-used-to-create-the-digest-of-the-signature.10the-contentinfo-fields-contenttype-must-be-an-object-identifier-itux680-with-the-value-1.3.6.1.4.1.311.2.1.4.-the-content-field-of-the-contentinfo-of-this-signeddata-structure-must-be-a-spcindirectdatacontent-structure-section-2.3.2.4.3.1.the-certificates-field-must-contain-certificates-as-specified-by-pkcs7-section-9.1.-this-must-include-the-signature-verification-certificate-and-can-contain-any-intermediate-certificates-between-that-end-entity-and-the-root-including-the-root.-if-the-signeddata-contains-a-countersignature-pkcs9-section-6.6-the-certificates-associated-with-the-countersignature-also-must-be-contained-in-the-certificates-field.the-crls-field-should-be-absent.-if-present-the-crls-field-must-be-ignored.the-signerinfos-field-must-contain-a-single-signerinfo-structure-section-2.3.2.4.2-pkcs7-section-9.2.signerinfo-constraints) 53 + +[VBA digital signature verification](#section_fb2ddf4fc927478bb27ecf4d3bff2898) 58 + +[certificate processing](#section_d4a5396376c54e8c9c7e459e8426cec7) 58 + +[Timestamp processing](#section_ad34050a39bb4482b973db85586bccd8) 58 + +[Vendor-extensible fields](#structure-versions-there-is-only-one-version-of-the-vba-digital-signature-defined-in-visual-basic-for-applications-digital-signature-storage-section-2.3.2.localization-the-vba-digital-signature-structures-define-no-locale-specific-processes-or-data.vendor-extensible-fields) 24 + +[property set storage](#section_711cba7a97a14411bf707040ee98e9e1) 24 + +[toolbar customization](#section_efed041370ae47b48db2bf9f1e0e3ca1) 24 + +[Visual Basic for Applications digital signature](#section_1b44a4f1c92a4ad6ba6dfca5bce54c96) 24 + +Versioning and localization + +[property set storage](#structure-versions-there-is-only-one-version-of-the-toolbar-customization-structures-section-2.3.1.localization-the-toolbar-customization-structures-define-no-locale-specific-processes-or-data.property-set-storage) 24 + +[toolbar customization](#section_d85df01755284489a94f8fd5cf42369a) 23 + +[Visual Basic for Applications digital signature](#structure-versions-there-is-only-one-version-of-the-property-sets-defined-in-property-set-storage-section-2.3.3.localization-the-encoding-of-strings-contained-in-the-lpstr-section-2.3.3.1.4-data-type-and-the-unalignedlpstr-section-2.3.3.1.5-data-type-depend-on-the-property-sets-codepage-property-described-in-ms-oleps-section-2.18.2.visual-basic-for-applications-digital-signature) 24 + +[Visual Basic for Applications Digital Signature Example Structures example](#section_715a782baacd4743acadab3c55d694ee) 181 + +[Visual Basic for Applications digital signature storage](#section_f80ee18cd72f4c3c9ea5a56f396322e0) 50 + +[DigSigBlob](#Section_bc21c922b7ae473690aa86afb6403462) 52 + +[DigSigInfoSerialized](#Section_30a00273dbee422fb488f4b8430ae046) 50 + +[WordSigBlob](#Section_0a2166b32e294b12886dd89f23c6824c) 52 diff --git a/docs/standards/doc/ms-ovba.md b/docs/standards/doc/ms-ovba.md new file mode 100644 index 0000000..79ef34a --- /dev/null +++ b/docs/standards/doc/ms-ovba.md @@ -0,0 +1,5402 @@ +**\[MS-OVBA\]:** + +**Office VBA File Format Structure** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +| Date | Revision History | Revision Class | Comments | +|----|----|----|----| +| 6/27/2008 | 1.0 | New | Initial Availability | +| 8/15/2008 | 1.01 | Editorial | Revised and edited the technical content | +| 1/16/2009 | 1.02 | Editorial | Revised and edited the technical content | +| 7/13/2009 | 1.03 | Major | Changes made for template compliance | +| 8/28/2009 | 1.04 | Editorial | Revised and edited the technical content | +| 11/6/2009 | 1.05 | Editorial | Revised and edited the technical content | +| 2/19/2010 | 2.0 | Minor | Updated the technical content | +| 3/31/2010 | 2.01 | Editorial | Revised and edited the technical content | +| 4/30/2010 | 2.02 | Editorial | Revised and edited the technical content | +| 6/7/2010 | 2.03 | Editorial | Revised and edited the technical content | +| 6/29/2010 | 2.04 | Editorial | Changed language and formatting in the technical content. | +| 7/23/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/27/2010 | 2.04 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/15/2010 | 2.05 | Editorial | Changed language and formatting in the technical content. | +| 12/17/2010 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 3/18/2011 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/10/2011 | 2.05 | None | No changes to the meaning, language, or formatting of the technical content. | +| 1/20/2012 | 2.6 | Minor | Clarified the meaning of the technical content. | +| 4/11/2012 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 7/16/2012 | 2.6 | None | No changes to the meaning, language, or formatting of the technical content. | +| 10/8/2012 | 2.7 | Minor | Clarified the meaning of the technical content. | +| 2/11/2013 | 2.7.1 | Editorial | Changed language and formatting in the technical content. | +| 7/30/2013 | 2.7.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/18/2013 | 2.7.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 2/10/2014 | 2.7.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/30/2014 | 3.0 | Major | Significantly changed the technical content. | +| 7/31/2014 | 3.1 | Minor | Clarified the meaning of the technical content. | +| 10/30/2014 | 3.2 | Minor | Clarified the meaning of the technical content. | +| 3/16/2015 | 4.0 | Major | Significantly changed the technical content. | +| 9/4/2015 | 4.1 | Minor | Clarified the meaning of the technical content. | +| 7/15/2016 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 9/14/2016 | 4.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 6/20/2017 | 4.2 | Minor | Clarified the meaning of the technical content. | +| 9/19/2017 | 5.0 | Major | Significantly changed the technical content. | +| 12/12/2017 | 5.1 | Minor | Clarified the meaning of the technical content. | +| 4/27/2018 | 6.0 | Major | Significantly changed the technical content. | +| 8/28/2018 | 7.0 | Major | Significantly changed the technical content. | +| 12/11/2018 | 7.1 | Minor | Clarified the meaning of the technical content. | +| 6/18/2019 | 8.0 | Major | Significantly changed the technical content. | +| 11/19/2019 | 9.0 | Major | Significantly changed the technical content. | +| 2/19/2020 | 9.1 | Minor | Clarified the meaning of the technical content. | +| 4/22/2021 | 10.0 | Major | Significantly changed the technical content. | +| 8/17/2021 | 11.0 | Major | Significantly changed the technical content. | +| 11/16/2021 | 12.0 | Major | Significantly changed the technical content. | +| 2/15/2022 | 12.1 | Minor | Clarified the meaning of the technical content. | +| 5/17/2022 | 12.1 | None | No changes to the meaning, language, or formatting of the technical content. | +| 11/15/2022 | 12.2 | Minor | Clarified the meaning of the technical content. | +| 2/21/2023 | 12.3 | Minor | Clarified the meaning of the technical content. | +| 5/16/2023 | 12.4 | Minor | Clarified the meaning of the technical content. | +| 2/20/2024 | 12.4 | None | No changes to the meaning, language, or formatting of the technical content. | +| 4/16/2024 | 13.0 | Major | Significantly changed the technical content. | +| 5/21/2024 | 13.1 | Minor | Clarified the meaning of the technical content. | +| 8/20/2024 | 14.0 | Major | Significantly changed the technical content. | +| 5/19/2026 | 15.0 | Major | Significantly changed the technical content. | + +Table of Contents + +[1 Introduction [8](#introduction)](#introduction) + +[1.1 Glossary [8](#glossary)](#glossary) + +[1.2 References [11](#references)](#references) + +[1.2.1 Normative References [11](#normative-references)](#normative-references) + +[1.2.2 Informative References [11](#informative-references)](#informative-references) + +[1.3 Overview [12](#overview)](#overview) + +[1.3.1 Project Information [12](#project-information)](#project-information) + +[1.3.2 Project References [12](#project-references)](#project-references) + +[1.3.3 Project Items [12](#project-items)](#project-items) + +[1.3.4 Byte Ordering [13](#byte-ordering)](#byte-ordering) + +[1.4 Relationship to Protocols and Other Structures [13](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [14](#applicability-statement)](#applicability-statement) + +[1.6 Versioning and Localization [14](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [14](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [15](#structures)](#structures) + +[2.1 Conventions [15](#conventions)](#conventions) + +[2.1.1 ABNF Rules [15](#abnf-rules)](#abnf-rules) + +[2.1.1.1 Common ABNF Rules [15](#common-abnf-rules)](#common-abnf-rules) + +[2.1.1.2 ANYCHAR [15](#anychar)](#anychar) + +[2.1.1.3 EQ [15](#eq)](#eq) + +[2.1.1.4 FLOAT [15](#float)](#float) + +[2.1.1.5 GUID [16](#guid)](#guid) + +[2.1.1.6 HEXINT32 [16](#hexint32)](#hexint32) + +[2.1.1.7 INT32 [16](#int32)](#int32) + +[2.1.1.8 LibidReference [16](#libidreference)](#libidreference) + +[2.1.1.9 ModuleIdentifier [17](#moduleidentifier)](#moduleidentifier) + +[2.1.1.10 NWLN [17](#nwln)](#nwln) + +[2.1.1.11 PATH [17](#path)](#path) + +[2.1.1.12 ProjectReference [17](#projectreference)](#projectreference) + +[2.1.1.13 QUOTEDCHAR [18](#quotedchar)](#quotedchar) + +[2.1.1.14 VBABOOL [18](#vbabool)](#vbabool) + +[2.1.1.15 VbaIdentifier [18](#vbaidentifier)](#vbaidentifier) + +[2.1.2 Pseudocode [18](#pseudocode)](#pseudocode) + +[2.2 File Structure [19](#file-structure)](#file-structure) + +[2.2.1 Project Root Storage [19](#project-root-storage)](#project-root-storage) + +[2.2.2 VBA Storage [19](#vba-storage)](#vba-storage) + +[2.2.3 \_VBA_PROJECT Stream [20](#vba_project-stream)](#vba_project-stream) + +[2.2.4 dir Stream [20](#dir-stream)](#dir-stream) + +[2.2.5 Module Stream [20](#module-stream)](#module-stream) + +[2.2.6 SRP Streams [20](#srp-streams)](#srp-streams) + +[2.2.7 PROJECT Stream [20](#project-stream)](#project-stream) + +[2.2.8 PROJECTwm Stream [20](#projectwm-stream)](#projectwm-stream) + +[2.2.9 PROJECTlk Stream [20](#projectlk-stream)](#projectlk-stream) + +[2.2.10 Designer Storages [20](#designer-storages)](#designer-storages) + +[2.2.11 VBFrame Stream [21](#vbframe-stream)](#vbframe-stream) + +[2.3 Record Types [21](#record-types)](#record-types) + +[2.3.1 PROJECT Stream: Project Information [21](#project-stream-project-information)](#project-stream-project-information) + +[2.3.1.1 ProjectProperties [21](#projectproperties)](#projectproperties) + +[2.3.1.2 ProjectId [21](#projectid)](#projectid) + +[2.3.1.3 ProjectModule [22](#projectmodule)](#projectmodule) + +[2.3.1.4 ProjectDocModule [22](#projectdocmodule)](#projectdocmodule) + +[2.3.1.5 ProjectStdModule [22](#projectstdmodule)](#projectstdmodule) + +[2.3.1.6 ProjectClassModule [22](#projectclassmodule)](#projectclassmodule) + +[2.3.1.7 ProjectDesignerModule [22](#projectdesignermodule)](#projectdesignermodule) + +[2.3.1.8 ProjectPackage [23](#projectpackage)](#projectpackage) + +[2.3.1.9 ProjectHelpFile [23](#projecthelpfile)](#projecthelpfile) + +[2.3.1.10 ProjectExeName32 [23](#projectexename32)](#projectexename32) + +[2.3.1.11 ProjectName [23](#projectname)](#projectname) + +[2.3.1.12 ProjectHelpId [23](#projecthelpid)](#projecthelpid) + +[2.3.1.13 ProjectDescription [24](#projectdescription)](#projectdescription) + +[2.3.1.14 ProjectVersionCompat32 [24](#projectversioncompat32)](#projectversioncompat32) + +[2.3.1.15 ProjectProtectionState [24](#projectprotectionstate)](#projectprotectionstate) + +[2.3.1.16 ProjectPassword [25](#projectpassword)](#projectpassword) + +[2.3.1.17 ProjectVisibilityState [25](#projectvisibilitystate)](#projectvisibilitystate) + +[2.3.1.18 HostExtenders [26](#hostextenders)](#hostextenders) + +[2.3.1.19 ProjectWorkspace [26](#projectworkspace)](#projectworkspace) + +[2.3.1.20 ProjectWindowRecord [27](#projectwindowrecord)](#projectwindowrecord) + +[2.3.2 PROJECTlk Stream: ActiveX Control Information [28](#projectlk-stream-activex-control-information)](#projectlk-stream-activex-control-information) + +[2.3.2.1 LICENSEINFO Record [28](#licenseinfo-record)](#licenseinfo-record) + +[2.3.3 PROJECTwm Stream: Module Name Information [29](#projectwm-stream-module-name-information)](#projectwm-stream-module-name-information) + +[2.3.3.1 NAMEMAP Record [29](#namemap-record)](#namemap-record) + +[2.3.4 VBA Storage: Visual Basic for Applications Project Information [29](#vba-storage-visual-basic-for-applications-project-information)](#vba-storage-visual-basic-for-applications-project-information) + +[2.3.4.1 \_VBA_PROJECT Stream: Version Dependent Project Information [29](#vba_project-stream-version-dependent-project-information)](#vba_project-stream-version-dependent-project-information) + +[2.3.4.2 dir Stream: Version Independent Project Information [30](#dir-stream-version-independent-project-information)](#dir-stream-version-independent-project-information) + +[2.3.4.2.1 PROJECTINFORMATION Record [31](#projectinformation-record)](#projectinformation-record) + +[2.3.4.2.1.1 PROJECTSYSKIND Record [32](#projectsyskind-record)](#projectsyskind-record) + +[2.3.4.2.1.2 PROJECTCOMPATVERSION Record [33](#projectcompatversion-record)](#projectcompatversion-record) + +[2.3.4.2.1.3 PROJECTLCID Record [33](#projectlcid-record)](#projectlcid-record) + +[2.3.4.2.1.4 PROJECTLCIDINVOKE Record [34](#projectlcidinvoke-record)](#projectlcidinvoke-record) + +[2.3.4.2.1.5 PROJECTCODEPAGE Record [34](#projectcodepage-record)](#projectcodepage-record) + +[2.3.4.2.1.6 PROJECTNAME Record [34](#projectname-record)](#projectname-record) + +[2.3.4.2.1.7 PROJECTDOCSTRING Record [35](#projectdocstring-record)](#projectdocstring-record) + +[2.3.4.2.1.8 PROJECTHELPFILEPATH Record [35](#projecthelpfilepath-record)](#projecthelpfilepath-record) + +[2.3.4.2.1.9 PROJECTHELPCONTEXT Record [36](#projecthelpcontext-record)](#projecthelpcontext-record) + +[2.3.4.2.1.10 PROJECTLIBFLAGS Record [36](#projectlibflags-record)](#projectlibflags-record) + +[2.3.4.2.1.11 PROJECTVERSION Record [37](#projectversion-record)](#projectversion-record) + +[2.3.4.2.1.12 PROJECTCONSTANTS Record [37](#projectconstants-record)](#projectconstants-record) + +[2.3.4.2.2 PROJECTREFERENCES Record [38](#projectreferences-record)](#projectreferences-record) + +[2.3.4.2.2.1 REFERENCE Record [38](#reference-record)](#reference-record) + +[2.3.4.2.2.2 REFERENCENAME Record [39](#referencename-record)](#referencename-record) + +[2.3.4.2.2.3 REFERENCECONTROL Record [40](#referencecontrol-record)](#referencecontrol-record) + +[2.3.4.2.2.4 REFERENCEORIGINAL Record [41](#referenceoriginal-record)](#referenceoriginal-record) + +[2.3.4.2.2.5 REFERENCEREGISTERED Record [42](#referenceregistered-record)](#referenceregistered-record) + +[2.3.4.2.2.6 REFERENCEPROJECT Record [43](#referenceproject-record)](#referenceproject-record) + +[2.3.4.2.3 PROJECTMODULES Record [44](#projectmodules-record)](#projectmodules-record) + +[2.3.4.2.3.1 PROJECTCOOKIE Record [44](#projectcookie-record)](#projectcookie-record) + +[2.3.4.2.3.2 MODULE Record [44](#module-record)](#module-record) + +[2.3.4.2.3.2.1 MODULENAME Record [46](#modulename-record)](#modulename-record) + +[2.3.4.2.3.2.2 MODULENAMEUNICODE Record [46](#modulenameunicode-record)](#modulenameunicode-record) + +[2.3.4.2.3.2.3 MODULESTREAMNAME Record [47](#modulestreamname-record)](#modulestreamname-record) + +[2.3.4.2.3.2.4 MODULEDOCSTRING Record [47](#moduledocstring-record)](#moduledocstring-record) + +[2.3.4.2.3.2.5 MODULEOFFSET Record [48](#moduleoffset-record)](#moduleoffset-record) + +[2.3.4.2.3.2.6 MODULEHELPCONTEXT Record [49](#modulehelpcontext-record)](#modulehelpcontext-record) + +[2.3.4.2.3.2.7 MODULECOOKIE Record [49](#modulecookie-record)](#modulecookie-record) + +[2.3.4.2.3.2.8 MODULETYPE Record [49](#moduletype-record)](#moduletype-record) + +[2.3.4.2.3.2.9 MODULEREADONLY Record [50](#modulereadonly-record)](#modulereadonly-record) + +[2.3.4.2.3.2.10 MODULEPRIVATE Record [50](#moduleprivate-record)](#moduleprivate-record) + +[2.3.4.3 Module Stream: Visual Basic Modules [50](#module-stream-visual-basic-modules)](#module-stream-visual-basic-modules) + +[2.3.5 VBFrame Stream: Designer Information [51](#vbframe-stream-designer-information)](#vbframe-stream-designer-information) + +[2.3.5.1 DesignerProperties [51](#designerproperties)](#designerproperties) + +[2.3.5.2 DesignerCaption [51](#designercaption)](#designercaption) + +[2.3.5.3 DesignerHeight [52](#designerheight)](#designerheight) + +[2.3.5.4 DesignerLeft [52](#designerleft)](#designerleft) + +[2.3.5.5 DesignerTop [52](#designertop)](#designertop) + +[2.3.5.6 DesignerWidth [52](#designerwidth)](#designerwidth) + +[2.3.5.7 DesignerEnabled [52](#designerenabled)](#designerenabled) + +[2.3.5.8 DesignerHelpContextId [53](#designerhelpcontextid)](#designerhelpcontextid) + +[2.3.5.9 DesignerRTL [53](#designerrtl)](#designerrtl) + +[2.3.5.10 DesignerShowModal [53](#designershowmodal)](#designershowmodal) + +[2.3.5.11 DesignerStartupPosition [53](#designerstartupposition)](#designerstartupposition) + +[2.3.5.12 DesignerTag [54](#designertag)](#designertag) + +[2.3.5.13 DesignerTypeInfoVer [54](#designertypeinfover)](#designertypeinfover) + +[2.3.5.14 DesignerVisible [54](#designervisible)](#designervisible) + +[2.3.5.15 DesignerWhatsThisButton [54](#designerwhatsthisbutton)](#designerwhatsthisbutton) + +[2.3.5.16 DesignerWhatsThisHelp [54](#designerwhatsthishelp)](#designerwhatsthishelp) + +[2.4 Algorithms [54](#algorithms)](#algorithms) + +[2.4.1 Compression and Decompression [54](#compression-and-decompression)](#compression-and-decompression) + +[2.4.1.1 Structures [55](#structures-1)](#structures-1) + +[2.4.1.1.1 CompressedContainer [55](#compressedcontainer)](#compressedcontainer) + +[2.4.1.1.2 DecompressedBuffer [56](#decompressedbuffer)](#decompressedbuffer) + +[2.4.1.1.3 DecompressedChunk [56](#decompressedchunk)](#decompressedchunk) + +[2.4.1.1.4 CompressedChunk [57](#compressedchunk)](#compressedchunk) + +[2.4.1.1.5 CompressedChunkHeader [57](#compressedchunkheader)](#compressedchunkheader) + +[2.4.1.1.6 CompressedChunkData [57](#compressedchunkdata)](#compressedchunkdata) + +[2.4.1.1.7 TokenSequence [58](#tokensequence)](#tokensequence) + +[2.4.1.1.8 CopyToken [58](#copytoken)](#copytoken) + +[2.4.1.2 State Variables [59](#state-variables)](#state-variables) + +[2.4.1.3 Algorithms [60](#algorithms-1)](#algorithms-1) + +[2.4.1.3.1 Decompression Algorithm [60](#decompression-algorithm)](#decompression-algorithm) + +[2.4.1.3.2 Decompressing a CompressedChunk [60](#decompressing-a-compressedchunk)](#decompressing-a-compressedchunk) + +[2.4.1.3.3 Decompressing a RawChunk [61](#decompressing-a-rawchunk)](#decompressing-a-rawchunk) + +[2.4.1.3.4 Decompressing a TokenSequence [61](#decompressing-a-tokensequence)](#decompressing-a-tokensequence) + +[2.4.1.3.5 Decompressing a Token [62](#decompressing-a-token)](#decompressing-a-token) + +[2.4.1.3.6 Compression algorithm [62](#compression-algorithm)](#compression-algorithm) + +[2.4.1.3.7 Compressing a DecompressedChunk [63](#compressing-a-decompressedchunk)](#compressing-a-decompressedchunk) + +[2.4.1.3.8 Compressing a TokenSequence [64](#compressing-a-tokensequence)](#compressing-a-tokensequence) + +[2.4.1.3.9 Compressing a Token [64](#compressing-a-token)](#compressing-a-token) + +[2.4.1.3.10 Compressing a RawChunk [65](#compressing-a-rawchunk)](#compressing-a-rawchunk) + +[2.4.1.3.11 Byte Copy [66](#byte-copy)](#byte-copy) + +[2.4.1.3.12 Extract CompressedChunkSize [67](#extract-compressedchunksize)](#extract-compressedchunksize) + +[2.4.1.3.13 Pack CompressedChunkSize [67](#pack-compressedchunksize)](#pack-compressedchunksize) + +[2.4.1.3.14 Pack CompressedChunkSignature [67](#pack-compressedchunksignature)](#pack-compressedchunksignature) + +[2.4.1.3.15 Extract CompressedChunkFlag [67](#extract-compressedchunkflag)](#extract-compressedchunkflag) + +[2.4.1.3.16 Pack CompressedChunkFlag [68](#pack-compressedchunkflag)](#pack-compressedchunkflag) + +[2.4.1.3.17 Extract FlagBit [68](#extract-flagbit)](#extract-flagbit) + +[2.4.1.3.18 Set FlagBit [68](#set-flagbit)](#set-flagbit) + +[2.4.1.3.19 CopyToken Algorithms [69](#copytoken-algorithms)](#copytoken-algorithms) + +[2.4.1.3.19.1 CopyToken Help [69](#copytoken-help)](#copytoken-help) + +[2.4.1.3.19.2 Unpack CopyToken [70](#unpack-copytoken)](#unpack-copytoken) + +[2.4.1.3.19.3 Pack CopyToken [70](#pack-copytoken)](#pack-copytoken) + +[2.4.1.3.19.4 Matching [71](#matching)](#matching) + +[2.4.2 Contents Hashes [72](#contents-hashes)](#contents-hashes) + +[2.4.2.1 Content Normalized Data [72](#content-normalized-data)](#content-normalized-data) + +[2.4.2.2 Forms Normalized Data [74](#forms-normalized-data)](#forms-normalized-data) + +[2.4.2.3 Content Hash [75](#content-hash)](#content-hash) + +[2.4.2.4 Agile Content Hash [76](#agile-content-hash)](#agile-content-hash) + +[2.4.2.5 V3 Content Normalized Data [76](#v3-content-normalized-data)](#v3-content-normalized-data) + +[2.4.2.6 Project Normalized Data [79](#project-normalized-data)](#project-normalized-data) + +[2.4.2.7 V3 Content Hash [80](#v3-content-hash)](#v3-content-hash) + +[2.4.3 Data Encryption [80](#data-encryption)](#data-encryption) + +[2.4.3.1 Encrypted Data Structure [80](#encrypted-data-structure)](#encrypted-data-structure) + +[2.4.3.2 Encryption [81](#encryption)](#encryption) + +[2.4.3.3 Decryption [83](#decryption)](#decryption) + +[2.4.4 Password Hash [85](#password-hash)](#password-hash) + +[2.4.4.1 Password Hash Data Structure [85](#password-hash-data-structure)](#password-hash-data-structure) + +[2.4.4.2 Encode Nulls [86](#encode-nulls)](#encode-nulls) + +[2.4.4.3 Decode Nulls [86](#decode-nulls)](#decode-nulls) + +[2.4.4.4 Password Hash Algorithm [87](#password-hash-algorithm)](#password-hash-algorithm) + +[2.4.4.5 Password Hash Validation [87](#password-hash-validation)](#password-hash-validation) + +[3 Structure Examples [89](#structure-examples)](#structure-examples) + +[3.1 VBA Storage Information Example [89](#vba-storage-information-example)](#vba-storage-information-example) + +[3.1.1 \_VBA_PROJECT Example [89](#vba_project-example)](#vba_project-example) + +[3.1.2 dir Stream Example [89](#dir-stream-example)](#dir-stream-example) + +[3.1.2.1 Project Information Example [89](#project-information-example)](#project-information-example) + +[3.1.2.2 Project Reference Information Example [92](#project-reference-information-example)](#project-reference-information-example) + +[3.1.2.3 Module Information Example [98](#module-information-example)](#module-information-example) + +[3.1.2.3.1 PROJECT MODULES Example [98](#project-modules-example)](#project-modules-example) + +[3.1.2.3.2 Module Record Examples [98](#module-record-examples)](#module-record-examples) + +[3.1.2.3.2.1 ThisWorkbook Document Module Record Example [98](#thisworkbook-document-module-record-example)](#thisworkbook-document-module-record-example) + +[3.1.2.3.2.2 Sheet1 Document Module Record Example [100](#sheet1-document-module-record-example)](#sheet1-document-module-record-example) + +[3.1.2.3.2.3 UserForm1 Designer Module Record Example [102](#userform1-designer-module-record-example)](#userform1-designer-module-record-example) + +[3.1.3 ThisWorkbook Decompressed Module Stream Example [104](#thisworkbook-decompressed-module-stream-example)](#thisworkbook-decompressed-module-stream-example) + +[3.1.4 Sheet1 Decompressed Module Stream Example [104](#sheet1-decompressed-module-stream-example)](#sheet1-decompressed-module-stream-example) + +[3.1.5 UserForm1 Decompressed Module Stream Example [105](#userform1-decompressed-module-stream-example)](#userform1-decompressed-module-stream-example) + +[3.1.6 PROJECT Stream Example [106](#project-stream-example)](#project-stream-example) + +[3.1.7 VBFrame Stream Example [109](#vbframe-stream-example)](#vbframe-stream-example) + +[3.2 Compression/Decompression Examples [110](#compressiondecompression-examples)](#compressiondecompression-examples) + +[3.2.1 No Compression Example [110](#no-compression-example)](#no-compression-example) + +[3.2.2 Normal Compression Example [110](#normal-compression-example)](#normal-compression-example) + +[3.2.3 Maximum Compression Example [111](#maximum-compression-example)](#maximum-compression-example) + +[4 Security Considerations [112](#security-considerations)](#security-considerations) + +[4.1 Project Integrity Verification [112](#project-integrity-verification)](#project-integrity-verification) + +[4.2 Encryption Method [112](#encryption-method)](#encryption-method) + +[5 Appendix A: Product Behavior [113](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [114](#change-tracking)](#change-tracking) + +[7 Index [115](#index)](#index) + +# Introduction + +This document specifies the Office VBA File Format Structure. This file format applies to VBA projects. VBA projects are a collection of embedded macros and custom forms for use in Office documents that can be used to extend a host application to provide custom behavior. This specification describes a storage that contains a VBA project. + +Sections 1.7 and 2 of this specification are normative. All other sections and examples in this specification are informative. + +## Glossary + +This document uses the following terms: + +> **absolute path**: A string that identifies the location of a file and that begins with a drive identifier and root directory or network share and ends with the complete file name. Examples are C:\Documents\Work\example.txt and \\netshare\Documents\Work\example.txt. +> +> **ActiveX control**: A reusable software control, such as a check box or button, that uses ActiveX technology and provides options to users or runs macros or scripts that automate a task. See also ActiveX object. +> +> **ActiveX control library**: A collection of controls that incorporate ActiveX technology and can be called by a Microsoft Visual Basic for Applications (VBA) project. +> +> **aggregatable server**: A COM server that can be contained by another COM server and can allow its interfaces to be used as if they were defined by the containing server. +> +> **automation server**: An application that exposes its functionality through COM interfaces to other applications, which are also called automation clients. +> +> **automation type library**: A COM server that provides descriptions of the automation-compatible types that are defined or referenced in an automation scope. +> +> **big-endian**: Multiple-byte values that are byte-ordered with the most significant byte stored in the memory location with the lowest address. +> +> **class identifier (CLSID)**: A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that identifies a software component; for instance, a DCOM object class or a COM class. +> +> **class module**: A module that contains the definition for a new object. Each instance of a class creates a new object, and procedures that are defined in the module become properties and methods of the object. +> +> **code page**: An ordered set of characters of a specific script in which a numerical index (code-point value) is associated with each character. Code pages are a means of providing support for character sets and keyboard layouts used in different countries/regions. Devices such as the display and keyboard can be configured to use a specific code page and to switch from one code page (such as the United States) to another (such as Portugal) at the user's request. +> +> **compat version**: A 32-bit number that identifies the Office Model version used by a VBA project. +> +> **compilation constant**: A Microsoft Visual Basic identifier that is defined by using the \#Const compiler directive or defined in the host application, and then used by other compiler directives to determine when or if certain blocks of Visual Basic code are compiled. +> +> **designer**: A visual design surface for adding and arranging controls on a user form and writing code for those controls. +> +> **designer module**: A VBA module that extends the methods and properties of an ActiveX control that has been registered with the project. +> +> **digest**: The fixed-length output string from a one-way hash function that takes a variable-length input string and is probabilistically unique for every different input string. Also, a cryptographic checksum of a data (octet) stream. +> +> **document module**: A type of VBA project item that specifies a module for embedded macros and programmatic access operations that are associated with a document. +> +> **embedded macro**: A macro that is saved with a document. +> +> **extended type library**: A component that contains Automation standard descriptions of exposed objects, properties, and methods that are implemented by an [**aggregatable server**](#gt_cb1c7858-f49b-4030-9311-479026cbe832) and supplemented by another [**Automation server**](#gt_5dcdba04-9cfd-40b3-b0e1-0b8e4374aeaa). +> +> **floating-point number**: A number that is represented by a mantissa and an exponent according to a given base. The mantissa is typically a value between "0" and "1". To find the value of a floating-point number, the base is raised to the power of the exponent, and the mantissa is multiplied by the result. +> +> **globally unique identifier (GUID)**: A term used interchangeably with universally unique identifier (UUID) in Microsoft protocol technical documents (TDs). Interchanging the usage of these terms does not imply or require a specific algorithm or mechanism to generate the value. Specifically, the use of this term does not imply or require that the algorithms described in [\[RFC4122\]](https://go.microsoft.com/fwlink/?LinkId=90460) or [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824) have to be used for generating the GUID. See also universally unique identifier (UUID). +> +> **hash**: A fixed-size result that is obtained by applying a one-way mathematical function, which is sometimes referred to as a hash algorithm, to an arbitrary amount of data. If the input data changes, the hash also changes. The hash can be used in many operations, including authentication and digital signing. +> +> **Help file**: A file that contains the documentation for a specific product or technology. +> +> **Help topic identifier**: A unique identifier for an article that contains Help content. +> +> **host extender**: An Automation type that is provided by a host application to extend the functionality of an [**Automation server**](#gt_5dcdba04-9cfd-40b3-b0e1-0b8e4374aeaa). +> +> **language code identifier (LCID)**: A 32-bit number that identifies the user interface human language dialect or variation that is supported by an application or a client computer. +> +> **license key**: An array of bytes that enables access to a control according to the usage policies for that control. +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **module**: A collection of routines and data structures that performs a specific task or implements a specific abstract data type. Modules usually consist of two parts, a module header and a module body. A module header is a set of name/value attribute pairs that specify the linguistic characteristics of the module. A module body is the VBA source code, a set of declarations followed by procedures. VBA supports two types of modules, [**procedural modules**](#gt_bb39b710-62e6-48cc-8c8e-992c6360e521) and class modules. +> +> **multibyte character set (MBCS)**: An alternative to [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) for supporting character sets, like Japanese and Chinese, that cannot be represented in a single byte. Under MBCS, characters are encoded in either one or two bytes. In two-byte characters, the first byte, or "lead" byte, signals that both it and the following byte are to be interpreted as one character. The first byte comes from a range of codes reserved for use as lead bytes. Which ranges of bytes can be lead bytes depends on the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) in use. For example, Japanese [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) 932 uses the range 0x81 through 0x9F as lead bytes, but Korean [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) 949 uses a different range. +> +> **OLE compound file**: A form of structured storage, as described in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). A compound file allows independent storages and streams to exist within a single file. +> +> **parent window**: A primary window that provides window management functionality for a set of child windows. +> +> **procedural module**: A collection of subroutines and functions. +> +> **project package**: An item in a VBA project that specifies a Designer class that can be extended in a designer module. +> +> **reference**: A link in a project to another project, a .NET Framework assembly, or a compatible Component Object Model (COM) library. Adding a reference to a project enables use of the referenced item in a project, but does not copy it to the current project folder. +> +> **relative path**: A path that is implied by the active working directory or is calculated based on a specified directory. If users enter a command that refers to a file and the full path is not entered, the active working directory is the relative path of the referenced file. +> +> **right-to-left**: A reading and display order that is optimized for right-to-left languages. +> +> **run length encoding**: A lossless compression method that replaces a contiguous series (run) of identical values in a data stream with a pair of values that represent the length of the series and the value itself. For example, a data stream that contains 57 consecutive entries with the value "10" could replace them all with the shorter pair of values "57", "10". +> +> **SHA-1**: An algorithm that generates a 160-bit hash value from an arbitrary amount of input data, as described in [\[RFC3174\]](https://go.microsoft.com/fwlink/?LinkId=90408). SHA-1 is used with the Digital Signature Algorithm (DSA) in the Digital Signature Standard (DSS), in addition to other algorithms and standards. +> +> **storage**: An element of a compound file that is a unit of containment for one or more storages and streams, analogous to directories in a file system, as described in \[MS-CFB\]. +> +> **stream**: An element of a compound file, as described in \[MS-CFB\]. A stream contains a sequence of bytes that can be read from or written to by an application, and they can exist only in storages. +> +> **twiddled type library**: A modified [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) in which all controls are marked as extensible. A twiddled type library is generated automatically by the Visual Basic Editor when a user adds one or more controls to a document. +> +> **twip**: A unit of measurement that is used in typesetting and desktop publishing. It equals one-twentieth of a printer's point, or 1/1440 of an inch. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **UTF-16**: A standard for encoding Unicode characters, defined in the Unicode standard, in which the most commonly used characters are defined as double-byte characters. Unless specified otherwise, this term refers to the UTF-16 encoding form specified in \[UNICODE5.0.0/2007\] section 3.9. +> +> **VBA environment**: An execution context that can host multiple VBA projects simultaneously and can be used to run those projects and source code, and track code dependencies. +> +> **VBA host application**: An application that supports a VBA interpreter and can therefore run macros that are written in the VBA language. +> +> **VBA identifier**: A VBA language token that is used to identify the name of an entity, such as a class, module, project, property, field, or variable. +> +> **VBA project**: A collection of the modules, class modules, and user forms that are needed to create an application. Modules, class modules, and user forms can be imported into and exported from a project. +> +> **Visual Basic for Applications (VBA)**: A macro-based programming language that derives from Visual Basic and can be used to customize and extend an application. Unlike Visual Basic, VBA code and macros can be run only from within a host application that supports VBA. +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[C706\] The Open Group, "DCE 1.1: Remote Procedure Call", C706, August 1997, [https://publications.opengroup.org/c706](https://go.microsoft.com/fwlink/?LinkId=89824) + +**Note** Registration is required to download the document. + +\[MS-CFB\] Microsoft Corporation, "[Compound File Binary File Format](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b)". + +\[MS-OAUT\] Microsoft Corporation, "[OLE Automation Protocol](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961)". + +\[MS-OFORMS\] Microsoft Corporation, "[Office Forms Binary File Formats](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a)". + +\[MS-VBAL\] Microsoft Corporation, "[VBA Language Specification](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74)". + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[RFC3174\] Eastlake III, D., and Jones, P., "US Secure Hash Algorithm 1 (SHA1)", RFC 3174, September 2001, [https://www.rfc-editor.org/info/rfc3174](https://go.microsoft.com/fwlink/?LinkId=90408) + +\[RFC4234\] Crocker, D., Ed., and Overell, P., "Augmented BNF for Syntax Specifications: ABNF", RFC 4234, October 2005, [https://www.rfc-editor.org/info/rfc4234](https://go.microsoft.com/fwlink/?LinkId=90462) + +### Informative References + +\[MC-CPB\] Microsoft Corporation, "Code Page Bitfields", [https://learn.microsoft.com/en-us/windows/win32/intl/code-page-bitfields](https://go.microsoft.com/fwlink/?LinkId=206627) + +\[MS-DOC\] Microsoft Corporation, "[Word (.doc) Binary File Format](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22)". + +\[MS-OSHARED\] Microsoft Corporation, "[Office Common Data Types and Objects Structures](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d)". + +\[MS-XLSB\] Microsoft Corporation, "[Excel (.xlsb) Binary File Format](%5bMS-XLSB%5d.pdf#Section_acc8aa921f02416799f584f9f676b95a)". + +\[MS-XLS\] Microsoft Corporation, "[Excel Binary File Format (.xls) Structure](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06)". + +## Overview + +This file format defines an instance of a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). The file format structure is a collection of records that define the VBA project. Each record defines part of one of three aspects of the project: project information, project [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f), and project items. + +### Project Information + +Records providing project information about the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) itself are contained within the following five [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6): + +- The \_VBA_PROJECT Stream (section [2.3.4.1](#vba_project-stream-version-dependent-project-information)) provides basic information about the VBA project, including the version information required to load the remainder of the structure. + +- Project Information (section [2.3.4.2.1](#projectinformation-record)) in the dir Stream (section [2.3.4.2](#dir-stream-version-independent-project-information)) contains information such as the name of the VBA project and help information. + +- Project Properties (section [2.3.1.1](#Section_e4e51a4a6873405995bc2be4d8fc5d44)) in the PROJECT Stream (section [2.3.1](#Section_d88cb9d8a475423db370cc0caaf78628)) contain additional information about the VBA project. + +- The PROJECTwm Stream (section [2.3.3](#projectwm-stream-module-name-information)) contains information for mapping [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) names between [**multibyte character set (MBCS)**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) and [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb). + +- The PROJECTlk Stream (section [2.3.2](#projectlk-stream-activex-control-information)) contains information about [**ActiveX controls**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) used throughout the VBA project. + +### Project References + +Records within Reference Information (section [2.3.4.2.2](#projectreferences-record)) in the dir Stream (section [2.3.4.2](#dir-stream-version-independent-project-information)) define [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) to external resources that are used by the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). Each **REFERENCE** (section [2.3.4.2.2.1](#reference-record)) in Reference Information (section 2.3.4.2.2) corresponds to a reference to an external resource that can interact via OLE Automation as described in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961). + +The three types of external references are as follows: + +- A **REFERENCECONTROL** (section [2.3.4.2.2.3](#referencecontrol-record)) specifies a reference to external [**ActiveX controls**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) that are used by the VBA project. + +- A **REFERENCEREGISTERED** (section [2.3.4.2.2.5](#referenceregistered-record)) specifies a reference to external [**Automation type libraries**](#gt_4057fc86-007f-496f-a966-01c762088a8e) that are used by the VBA project. + +- A **REFERENCEPROJECT** (section [2.3.4.2.2.6](#referenceproject-record)) specifies a reference to external VBA projects that are used by the VBA project. + +### Project Items + +The [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) contains a series of project items for [**embedded macros**](#gt_1c11ab32-e6f4-4153-bd70-cccf1d88d172). Each project item is defined by a combination of records. The five types of project items are as follows: + +- A [**project package**](#gt_af2ed18f-e6ad-43cf-a326-5d6036e3b032) specifies a [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) class that can be extended in a [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92). + +- A [**document module**](#gt_d992176e-7031-4ae8-8c8e-6ea9f4085c71) specifies a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) for embedded macros and programmatic access associated with a document. + +  + +- A [**procedural module**](#gt_bb39b710-62e6-48cc-8c8e-992c6360e521) specifies a module for embedded macros. + +  + +- A [**class module**](#gt_25ca6ee7-698a-45cc-9e3c-8be094d77324) that specifies a module that defines a class. + +- A designer module specifies a module for extending a designer. + +The **PROJECT** Stream (section [2.3.1](#Section_d88cb9d8a475423db370cc0caaf78628)) provides the type of every project item. + +Document modules, procedural modules, class modules, and designer modules are items that can contain source code as described in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74) section 4.2 and other user-configurable settings. Within the dir Stream (section [2.3.4.2](#dir-stream-version-independent-project-information)), a **MODULE** Record (section [2.3.4.2.3.2](#module-record)) exists for each such project item, where the **MODULENAME** (section [2.3.4.2.3.2.1](#modulename-record)) is the same as each **\** in the **PROJECT** Stream (section 2.3.1). + +**ProjectDesignerModule** (section [2.3.1.7](#Section_eee17583018744d7a23504b0d144696f)) specifies a project item that extends a designer. In addition to the source code, a Designer Storage (section [2.2.10](#Section_f614ae641b3d47bea1660e10b8230026)) named **MODULESTREAMNAME** (section [2.3.4.2.3.2.3](#modulestreamname-record)) will be present in the Project Root Storage (section [2.2.1](#Section_637d884f159344569d2f7378ba969c96)) which contains additional, designer-specific information about the project item. The **VBFrame** Stream (section [2.3.5](#Section_76ecef265e1c47298074c76584e25b6b)) specifies the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f)-specific information about the designer. + +### Byte Ordering + +Some computer architectures number bytes in a binary word from left to right, which is referred to as [**big-endian**](#gt_6f6f9e8e-5966-4727-8527-7e02fb864e7e). The byte numbering used for packet diagrams in this specification is big-endian. Other architectures number the bytes in a binary word from right to left, which is referred to as [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7). The byte numbering used for enumerations, objects, and records in this specification is little-endian. + +Using big-endian and little-endian methods, the number 0x12345678 would be stored as shown in the following table: + +| **Byte order** | **Byte 0** | **Byte 1** | **Byte 2** | **Byte 3** | +|----------------|------------|------------|------------|------------| +| Big-endian | 0x12 | 0x34 | 0x56 | 0x78 | +| Little-endian | 0x78 | 0x56 | 0x34 | 0x12 | + +## Relationship to Protocols and Other Structures + +This file format specifies several streams and storages in an [**OLE compound file**](#gt_b39d4d3a-2d16-4bab-b9fd-ba8e1f16e6a4) as described in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). It is related to the structures defined in the following references: + +- [\[MS-DOC\]](%5bMS-DOC%5d.pdf#Section_ccd7b4867881484ca13751170af7cc22) includes an application of Microsoft® Visual Basic® for Applications ([**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f)) for [**embedded macros**](#gt_1c11ab32-e6f4-4153-bd70-cccf1d88d172). + +- [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) includes an application of VBA for embedded macros. + +- [\[MS-XLSB\]](%5bMS-XLSB%5d.pdf#Section_acc8aa921f02416799f584f9f676b95a) includes an application of VBA for embedded macros. + +- [\[MS-OSHARED\]](%5bMS-OSHARED%5d.pdf#Section_d93502fa5b8f4f47a3fe5574046f4b8d) contains an application of the hashing algorithm specified in section [2.4.2](#Section_73422f49565e47a3baf45742e2ba7dad) for securing VBA for embedded macros. + +- [\[MS-OFORMS\]](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a) specifies [**ActiveX controls**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) that can be embedded in VBA as [**designers**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). + +- OLE Automation Protocol, as described in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961), that can be used to execute embedded macros in VBA. + +- The VBA language, as described in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74), specifies the source code language that is used for embedded macros in this format. + +## Applicability Statement + +This document specifies a persistence format for [**embedded macros**](#gt_1c11ab32-e6f4-4153-bd70-cccf1d88d172) within a host document, and is not appropriate for stand-alone use. Embedded macros permit programmatic customization for the applications that use this structure. + +This persistence format provides interoperability with applications that create or read documents conforming to this structure[\<1\>](#Appendix_A_1). + +## Versioning and Localization + +This document covers versioning issues in the following areas: + +- **Structure Versions:** There is only one version of the Office VBA File Format Structure. + +- **Localization:** This structure defines no locale-specific processes or data. + +This file format contains performance caches that are not interoperable between versions. A version identifier (\_VBA_PROJECT_Stream.Version, section [2.2.3](#Section_f1bd0ba9f501410f86823392ba55c958)) is defined to keep track of the exact version that saved a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). When this version number matches the version used by Office, performance caches, specified by \_VBA_PROJECT.PerformanceCache (section 2.2.3), SRP Streams (section [2.2.6](#Section_26f8053a61ed4c6aa5ef8b9933b67ef5)), and Module Stream.PerformanceCache (section [2.3.4.3](#module-stream-visual-basic-modules)), will be used instead of the interoperable representation within the file. To be interoperable, this version number MUST be set to 0xFFFF so that performance caches are ignored. + +## Vendor-Extensible Fields + +This file format provides a mechanism for vendor extension through custom [**designers**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). For details on using designers, see VBFrame Stream (section [2.3.5](#Section_76ecef265e1c47298074c76584e25b6b)). No mechanism is provided for generating a unique [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) for a designer. + +# Structures + +## Conventions + +This section uses the following conventions and common definitions for pseudocode and ABNF rule definitions. + +### ABNF Rules + +This section specifies ABNF rules common throughout section [2](#Section_bc42dbf99d2f403c992668b35b7746a4). + +#### Common ABNF Rules + +The following ABNF rules are used by section [2](#Section_bc42dbf99d2f403c992668b35b7746a4) and are included for reference. For more information, see [\[RFC4234\]](https://go.microsoft.com/fwlink/?LinkId=90462) Appendix B. + +ABNF Syntax: + +1. CR = %x0D + + DIGIT = %x30-39 + + DQUOTE = %x22 + + HEXDIG = DIGIT / "A" / "B" / "C" / "D" / "E" / "F" + + HTAB = %x09 + + LF = %x0A + + SP = %x20 + + VCHAR = %x21-7E + + WSP = SP / HTAB + +#### ANYCHAR + +Specifies any character value that is not a carriage-return, line-feed, or null. + +ABNF syntax: + +18. ANYCHAR = %x01-09 / %x0B / %x0C / %x0E-FF + +#### EQ + +Defines syntax for separating a property name from a value. + +ABNF syntax: + +19. EQ = \*WSP "=" \*WSP + +#### FLOAT + +Specifies a [**floating-point number**](#gt_237156df-b9cf-4b8a-9753-98001801a90d). + +ABNF syntax: + +20. FLOAT = \[SIGN\] ( ( 1\*DIGIT "." 1\*DIGIT \[EXP\] ) / + + ( "." 1\*DIGIT \[EXP\] ) / + + ( 1\*DIGIT \["."\] \[EXP\] ) ) + + EXP = "e" \[SIGN\] 1\*DIGIT + + SIGN = "+" / "-" + +#### GUID + +Specifies a [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1). + +ABNF syntax: + +27. GUID = "{" 8HEXDIG "-" 4HEXDIG "-" 4HEXDIG "-" 4HEXDIG "-" 12HEXDIG "}" + +#### HEXINT32 + +Specifies a hexadecimal-encoded signed integer. MUST be between −2147483648 and 2147483647. + +ABNF syntax: + +28. HEXINT32 = "&H" 8HEXDIG + +#### INT32 + +Specifies a signed integer. MUST be between −2147483648 and 2147483647. + +ABNF syntax: + +29. INT32 = \["-"\] 1\*DIGIT + +#### LibidReference + +Specifies the identifier of an [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e). + +ABNF syntax: + +30. LibidReference = "\*\\ LibidReferenceKind LibidGuid + + "#" LibidMajorVersion "." LibidMinorVersion + + "#" LibidLcid + + "#" LibidPath + + "#" LibidRegName + + LibidReferenceKind = %x47 / %x48 + + LibidGuid = GUID + + LibidMajorVersion = 1\*4HEXDIG + + LibidMinorVersion = 1\*4HEXDIG + + LibidLcid = 1\*8HEXDIG + + LibidPath = \*(%x01-22 / %x24-FF) + + LibidRegName = \*255(%x01-FF) + +**\:** + +| Value | Meaning | +|-------|----------------------------------------------| +| %x47 | \ specifies a Windows file path. | +| %x48 | \ specifies a Macintosh path. | + +**\:** The [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) of the Automation type library. + +**\:** An unsigned integer that specifies the major version of the Automation type library. + +**\:** An unsigned integer that specifies the minor version of the Automation type library. + +**\:** The [**LCID**](#gt_c7f99c66-592f-4053-b62a-878c189653b6) of the Automation type library. + +**\:** The path to the Automation type library. + +**\:** The Automation type library’s display name. + +#### ModuleIdentifier + +Specifies the name of a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1). SHOULD be an identifier as specified by [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74) section 3.3.5. MAY[\<2\>](#Appendix_A_2) be any string of characters. MUST be less than or equal to 31 characters long. + +#### NWLN + +Specifies a new line. + +ABNF syntax: + +49. NWLN = (CR LF) / (LF CR) + +#### PATH + +An array of characters that specifies a path to a file. MUST be less than 260 characters. + +ABNF syntax: + +50. PATH = DQUOTE \*259[QUOTEDCHAR](#Section_c02cff5d40694c18a89d8bc07256fe9c) DQUOTE + +#### ProjectReference + +Specifies the identifier of a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +ABNF syntax: + +51. ProjectReference = "\*\\ ProjectKind ProjectPath + + ProjectKind = %x41-44 + + ProjectPath = \*(%x01-FF) + +**\:** + +| Value | Meaning | +|----|----| +| %x41 | The referenced VBA project is standalone and \ specifies a Windows file path. | +| %x42 | The referenced VBA project is standalone and \ specifies a Macintosh path. | +| %x43 | The referenced VBA project is embedded and \ specifies a Windows file path. | +| %x44 | The referenced VBA project is embedded and \ specifies a Macintosh path. | + +**\:** The path to the VBA project. + +#### QUOTEDCHAR + +Specifies a single character. + +ABNF syntax: + +56. QUOTEDCHAR = WSP / NQCHAR / ( DQUOTE DQUOTE ) + + NQCHAR = %x21 / %x23-FF + +**\:** Specifies a single double-quotation (") character. + +#### VBABOOL + +Specifies a Boolean value. + +| Value | Meaning | +|-------|---------| +| "0" | FALSE | +| "-1" | TRUE | + +ABNF syntax: + +59. VBABOOL = "0" / "-1" + +#### VbaIdentifier + +Specifies a VBA Language identifier as specified by [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74) section 3.3.5. + +### Pseudocode + +All array indexing in pseudocode in this document is zero-based. + +## File Structure + +Specifies a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) and contained project items. All data is stored in a structured storage as specified in [\[MS-CFB\]](%5bMS-CFB%5d.pdf#Section_53989ce47b054f8d829bd08d6148375b). The [**storages**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) and [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) MUST be organized according to a hierarchy rooted at the [Project Root Storage](#Section_637d884f159344569d2f7378ba969c96) (section 2.2.1) as depicted in the following figure. + +![VBA storage hierarchy](media/image1.bin "VBA storage hierarchy") + +Figure 1: VBA storage hierarchy + +### Project Root Storage + +A single root [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84). MUST contain VBA Storage (section [2.2.2](#Section_b693e0ba489f4ac8ac9d6387fb5779bb)) and [PROJECT Stream](#Section_cc848a026f8749a4ad936edb3103f593) (section 2.2.7). Optionally contains **PROJECTwm** Stream (section [2.2.8](#Section_514acc65ea7b4813aaf7fabb1bca0ba2)), **PROJECTlk** Stream (section [2.2.9](#Section_3354e7c2fc7f4eb993ef49387fae8a7c)), and Designer Storages (section [2.2.10](#Section_f614ae641b3d47bea1660e10b8230026)). + +### VBA Storage + +A [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) that specifies [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) and [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) information. MUST have the name "VBA" (case-insensitive). MUST contain **\_VBA_PROJECT** Stream (section [2.3.4.1](#vba_project-stream-version-dependent-project-information)) and [**dir Stream**](#dir-stream-version-independent-project-information) (section 2.3.4.2). MUST contain a Module Stream (section [2.2.5](#Section_53b1bd2c050c4b5ebf56de71ae43b58a)) for each module in the VBA project. Optionally contains **SRP** Streams (section [2.2.6](#Section_26f8053a61ed4c6aa5ef8b9933b67ef5)). + +### \_VBA_PROJECT Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies the version-dependent project information. MUST have the name "\_VBA_PROJECT" (case-insensitive). MUST contain data as specified by **\_VBA_PROJECT** Stream (section [2.3.4.1](#vba_project-stream-version-dependent-project-information)). + +### dir Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) properties, project [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f), and [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) properties. MUST have the name "dir" (case-insensitive). MUST contain data as specified by **dir** Stream (section [2.3.4.2](#dir-stream-version-independent-project-information)). + +### Module Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies the source code of [**modules**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) in the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). The name of this stream is specified by **MODULESTREAMNAME** (section [2.3.4.2.3.2.3](#modulestreamname-record)). MUST contain data as specified by Module Stream (section [2.3.4.3](#module-stream-visual-basic-modules)). + +### SRP Streams + +[**Streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specify an implementation-specific and version-dependent performance cache. MUST be ignored on read. MUST NOT be present on write. + +The name of each of these streams is specified by the following ABNF grammar: + +60. SRPStreamName = "\_\_SRP\_" 1\*25HEXDIG + +### PROJECT Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) properties. MUST have the name "PROJECT" (case-insensitive). MUST contain data as specified by **PROJECT** Stream (section [2.3.1](#Section_d88cb9d8a475423db370cc0caaf78628)). + +### PROJECTwm Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies names of [**modules**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) represented in both [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) and [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) encoding. MUST have the name "PROJECTwm" (case-insensitive). MUST contain data as specified by **PROJECTwm** Stream (section [2.3.3](#projectwm-stream-module-name-information)). + +### PROJECTlk Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies license information for [**ActiveX controls**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) used in the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). MUST have the name "PROJECTlk" (case-insensitive). MUST contain data as specified by **PROJECTlk** Stream (section [2.3.2](#projectlk-stream-activex-control-information)). + +### Designer Storages + +A [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) MUST be present for each [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92) in the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). The name is specified by **MODULESTREAMNAME** (section [2.3.4.2.3.2.3](#modulestreamname-record)). MUST contain **VBFrame** Stream (section [2.3.5](#Section_76ecef265e1c47298074c76584e25b6b)). If the designer is an Office Form [**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2), then this storage MUST contain storages and [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) as specified by [\[MS-OFORMS\]](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a) section 2. + +### VBFrame Stream + +A [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) that specifies [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92) properties. MUST contain data as specified by **VBFrame** Stream (section [2.3.5](#Section_76ecef265e1c47298074c76584e25b6b)). Name of this stream MUST start with the [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) character 0x0003 followed by the UTF-16 string "VBFrame" (case-insensitive). + +## Record Types + +### PROJECT Stream: Project Information + +The PROJECT [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) specifies properties of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +This stream is an array of bytes that specifies properties of the VBA project. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). + +ABNF syntax: + +61. VBAPROJECTText = [ProjectProperties](#Section_e4e51a4a6873405995bc2be4d8fc5d44) [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + [HostExtenders](#Section_9b5165d1c585425c8d55605d11bdbca0) + + \[NWLN [ProjectWorkspace](#Section_8be329b17b794485a3c88ad37e70df1e)\] + +#### ProjectProperties + +Specifies project-wide properties. + +ABNF syntax: + +64. ProjectProperties = [ProjectId](#Section_20f4aad3b646431183015948fb1c2ded) + + \*ProjectItem + + \[[ProjectHelpFile](#Section_db080517cf01434087514884a24cb91c)\] + + \[[ProjectExeName32](#Section_0dd049d3d4e748f88684f6fdde5963b2)\] + + [ProjectName](#Section_d8912a96773540838b00d9eb7112f195) + + [ProjectHelpId](#Section_c766f0d96e2847caadf055cdd9c9d0a3) + + \[[ProjectDescription](#Section_febac5d4111a42c89ad54ddaf2ac93a7)\] + + \[[ProjectVersionCompat32](#Section_4f2b5590e5334bc882a6a416eedbd4da)\] + + [ProjectProtectionState](#Section_55e770e2e1a44d1ca8a4dcfca27d6663) + + [ProjectPassword](#Section_7968542630fe43cd9cbf7f161c3de7d8) + + [ProjectVisibilityState](#Section_690c96e8e862497fbb7d5eacf4dc742a) + + ProjectItem = ( [ProjectModule](#Section_dadaf8510a23465b9f64952ca6d88031) / + + [ProjectPackage](#Section_db81c7c092d6476cb6718cef969edcfe) ) [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + +#### ProjectId + +Specifies the [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +ABNF syntax: + +78. ProjectId = "ID=" DQUOTE ProjectCLSID DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + ProjectCLSID = [GUID](#Section_dcef074c31e84261a49a15e5513d0b27) + +**\:** Specifies the class identifier (CLSID) of the VBA project’s [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e). MUST be "{00000000-0000-0000-0000-000000000000}" when **ProjectPassword** (section [2.3.1.16](#Section_7968542630fe43cd9cbf7f161c3de7d8)) specifies a password [**hash**](#gt_b7e2b611-0af5-4fec-8af2-3f9ce7bad205). + +#### ProjectModule + +Specifies a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) that contains [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) language source code as specified in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74) section 4.2. + +ABNF syntax: + +79. ProjectModule = ( [ProjectDocModule](#Section_f58d24a823504fab8d1e3861f112b786) / + + [ProjectStdModule](#Section_570bc7e44a30434cb1e120ccde0024ac) / + + [ProjectClassModule](#Section_02e00ce3a9214dff9f8c56894d3bd12a) / + + [ProjectDesignerModule](#Section_eee17583018744d7a23504b0d144696f) ) + +**\:** Specifies the name and type of a specific module. MUST have a corresponding [**MODULE Record**](#module-record) (section 2.3.4.2.3.2) in the [**dir Stream**](#dir-stream-version-independent-project-information) (section 2.3.4.2). + +#### ProjectDocModule + +Specifies a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) that extends a [**document module**](#gt_d992176e-7031-4ae8-8c8e-6ea9f4085c71). + +ABNF syntax: + +84. ProjectDocModule = "Document=" [ModuleIdentifier](#Section_bfe1e37a368f4d1684337c0a62e95865) %x2f DocTlibVer + + DocTlibVer = [HEXINT32](#Section_a8b192ef02e348e2826a8c8d30e84b76) + +**\:** Specifies the document module’s [**Automation server**](#gt_5dcdba04-9cfd-40b3-b0e1-0b8e4374aeaa) version as specified by [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961). + +#### ProjectStdModule + +Specifies a [**procedural module**](#gt_bb39b710-62e6-48cc-8c8e-992c6360e521). + +ABNF syntax: + +87. ProjectStdModule = "Module=" [ModuleIdentifier](#Section_bfe1e37a368f4d1684337c0a62e95865) + +#### ProjectClassModule + +Specifies a [**class module**](#gt_25ca6ee7-698a-45cc-9e3c-8be094d77324). + +ABNF syntax: + +88. ProjectClassModule = "Class=" [ModuleIdentifier](#Section_bfe1e37a368f4d1684337c0a62e95865) + +#### ProjectDesignerModule + +Specifies a [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92). + +ABNF syntax: + +89. ProjectDesignerModule = "BaseClass=" [ModuleIdentifier](#Section_bfe1e37a368f4d1684337c0a62e95865) + +#### ProjectPackage + +Specifies the [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) for a [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) extended by one or more [**modules**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1). + +ABNF syntax: + +90. ProjectPackage = "Package=" [GUID](#Section_dcef074c31e84261a49a15e5513d0b27) + +#### ProjectHelpFile + +Specifies a path to a [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) associated with this [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). MUST be the same value as specified in **PROJECTHELPFILEPATH** (section [2.3.4.2.1.8](#projecthelpfilepath-record)). MUST be present if **PROJECTHELPFILEPATH** specifies a value. + +ABNF syntax: + +91. ProjectHelpFile = "HelpFile=" [PATH](#Section_758ef9ebc9084d6ba814e84d4637a8b1) [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + +#### ProjectExeName32 + +Specifies a path. MUST be ignored. + +ABNF syntax: + +92. ProjectExeName32 = "ExeName32=" [PATH](#Section_758ef9ebc9084d6ba814e84d4637a8b1) [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + +#### ProjectName + +Specifies the short name of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +ABNF syntax: + +93. ProjectName = "Name=" DQUOTE ProjectIdentifier DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + ProjectIdentifier = 1\*128[QUOTEDCHAR](#Section_c02cff5d40694c18a89d8bc07256fe9c) + +**\:** Specifies the name of the VBA project. MUST be less than or equal to 128 characters long. MUST be the same value as specified in **PROJECTNAME** (section [2.3.4.2.1.6](#projectname-record)). SHOULD be an identifier as specified by [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74) section 3.3.5. MAY[\<3\>](#Appendix_A_3) be any string of characters. + +#### ProjectHelpId + +Specifies a [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) in **ProjectHelpFile** (section [2.3.1.9](#Section_db080517cf01434087514884a24cb91c)) associated with this [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +ABNF syntax: + +96. ProjectHelpId = "HelpContextID=" DQUOTE TopicId DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + TopicId = [INT32](#Section_5241dce5263140e19fd5246e6c34f3fb) + +**\:** Specifies a Help topic identifier. MUST be the same value as specified in **PROJECTHELPCONTEXT** (section [2.3.4.2.1.9](#projecthelpcontext-record)). + +#### ProjectDescription + +Specifies the description of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +ABNF syntax: + +99. ProjectDescription = "Description=" DQUOTE DescriptionText DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + DescriptionText = \*2000[QUOTEDCHAR](#Section_c02cff5d40694c18a89d8bc07256fe9c) + +**\:** MUST be the same value as specified in **PROJECTDOCSTRING** (section [2.3.4.2.1.7](#projectdocstring-record)). + +#### ProjectVersionCompat32 + +Specifies the storage format version of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). MAY be missing[\<4\>](#Appendix_A_4). + +ABNF syntax: + +102. ProjectVersionCompat32 = "VersionCompatible32=" DQUOTE "393222000" DQUOTE + + [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + +#### ProjectProtectionState + +Specifies whether access to the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) was restricted by the user, the [**VBA host application**](#gt_589d8ccf-dd80-4468-8dbc-94b3a642c453), or the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) project editor. + +ABNF syntax: + +104. ProjectProtectionState = "CMG=" DQUOTE EncryptedState DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + EncryptedState = 22\*28HEXDIG + +**\:** Specifies whether access to the VBA project was restricted by the user, the VBA host application, or the VBA project editor, obfuscated by Data Encryption (section [2.4.3.2](#Section_1ad481e07df44caca9a49c29a1340123)). + +The **Data** parameter for Data Encryption (section 2.4.3.2) SHOULD be four bytes that specify the protection state of the VBA project. MAY[\<5\>](#Appendix_A_5) be 0x00000000. The **Length** parameter for Data Encryption (section 2.4.3.2) MUST be 4. + +Values for **Data** are defined by the following bits: + +[TABLE] + +**A - fUserProtected (1 bit):** Specifies whether the user elected to protect the VBA project. + +**B - fHostProtected (1 bit)**: Specifies whether the VBA host application elected to protect the VBA project. + +**C - fVBEProtected (1 bit):** Specifies whether the VBA project editor elected to protect the VBA project. + +**Reserved (29 bits):** MUST be 0. MUST be ignored. + +#### ProjectPassword + +Specifies the password [**hash**](#gt_b7e2b611-0af5-4fec-8af2-3f9ce7bad205) of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +The syntax of ProjectPassword is defined as follows. + +107. ProjectPassword = "DPB=" DQUOTE EncryptedPassword DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + EncryptedPassword = 16\*HEXDIG + +**\:** Specifies the password protection for the VBA project. + +A VBA project without a password MUST use 0x00 for the **Data** parameter for Data Encryption (section [2.4.3.2](#Section_1ad481e07df44caca9a49c29a1340123)) and the **Length** parameter MUST be 1. + +A VBA project with a password SHOULD specify the password hash of the VBA project, obfuscated by Data Encryption (section 2.4.3.2). The **Data** parameter for Data Encryption (section 2.4.3.2) MUST be an array of bytes that specifies a Hash Data Structure (section [2.4.4.1](#Section_9d9f81e6f92e4338a242d38c1fcceed6)) and the **Length** parameter for Data Encryption MUST be 29. The Hash Data Structure (section 2.4.4.1) specifies a hash key and password hash encoded to remove null bytes as specified by section [2.4.4](#Section_ec1b8759522b46d4bff537ed2b1f2ebb). + +A VBA project with a password MAY[\<6\>](#Appendix_A_6) specify the plain text password of the VBA project, obfuscated by Data Encryption (section 2.4.3.2). In this case, the **Data** parameter Data Encryption (section 2.4.3.2) MUST be an array of bytes that specifies a null terminated password string encoded using [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified by **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)), and a **Length** parameter equal to the number of bytes in the password string including the terminating null character. + +When the data specified by **\** is a password hash, **[ProjectId](#Section_20f4aad3b646431183015948fb1c2ded).ProjectCLSID** (section 2.3.1.2) MUST be "{00000000-0000-0000-0000-000000000000}". + +#### ProjectVisibilityState + +Specifies whether the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) is visible. + +ABNF syntax: + +110. ProjectVisibilityState = "GC=" DQUOTE + + EncryptedProjectVisibility + + DQUOTE [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + EncryptedProjectVisibility = 16\*22HEXDIG + +**\:** Specifies whether the VBA project is visible, obfuscated by Data Encryption (section [2.4.3.2](#Section_1ad481e07df44caca9a49c29a1340123)). + +The **Data** parameter for Data Encryption (section 2.4.3.2) is one byte that specifies the visibility state of the VBA project. The **Length** parameter for Data Encryption (section 2.4.3.2) MUST be 1. + +Values for **Data** are: + +| Value | Meaning | +|----|----| +| 0x00 | VBA project is NOT visible. **\**.**fVBEProtected** (section [2.3.1.15](#Section_55e770e2e1a44d1ca8a4dcfca27d6663)) MUST be TRUE. | +| 0xFF | VBA project is visible. | + +The default is 0xFF. + +#### HostExtenders + +Specifies a list of [**host extenders**](#gt_ae4ac5b2-257c-4c60-88bf-616b75ca6f3c). + +ABNF syntax: + +115. HostExtenders = "\[Host Extender Info\]" [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + \*HostExtenderRef + + HostExtenderRef = ExtenderIndex "=" ExtenderGuid ";" + + LibName ";" CreationFlags NWLN + + ExtenderIndex = [HEXINT32](#Section_a8b192ef02e348e2826a8c8d30e84b76) + + ExtenderGuid = [GUID](#Section_dcef074c31e84261a49a15e5513d0b27) + + LibName = "VBE" / \*(%x21-3A / %x3C-FF) + + CreationFlags = HEXINT32 + +**\:** Specifies a [**reference**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) to an [**aggregatable server**](#gt_cb1c7858-f49b-4030-9311-479026cbe832)’s [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e). + +**\:** Specifies the index of the host extender entry. MUST be unique to the list of HostExtenders. + +**\:** Specifies the [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) of the Automation type library to extend. + +**\:** Specifies a host-provided Automation type library name. "VBE" specifies a built in name for the VBA Automation type library. + +**\:** Specifies a host-provided flag as follows: + +| Value | Meaning | +|----|----| +| 0x00000000 | MUST NOT create a new [**extended type library**](#gt_978a0d25-372e-494a-b189-654118c11be5) for the aggregatable server if one is already available to the [**VBA environment**](#gt_909acb3c-2bc2-4f5c-a12d-794b4e55fd9e). | +| 0x00000001 | MUST create a new extended type library for the aggregatable server. | + +#### ProjectWorkspace + +Specifies a list of [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) editor window states. + +ABNF syntax: + +127. ProjectWorkspace = "\[Workspace\]" [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + \*[ProjectWindowRecord](#Section_4b6575938ab540c6b2ec1904b146463d) + +#### ProjectWindowRecord + +Specifies the coordinates and state of a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) editor window. + +ABNF syntax: + +129. ProjectWindowRecord = [ModuleIdentifier](#Section_bfe1e37a368f4d1684337c0a62e95865) "=" ProjectWindowState [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + + ProjectWindowState = CodeWindow \[ ", " DesignerWindow \] + + CodeWindow = ProjectWindow + + DesignerWindow = ProjectWindow + + ProjectWindow = WindowLeft ", " + + WindowTop ", " + + WindowRight ", " + + WindowBottom ", " + + WindowState + + WindowLeft = [INT32](#Section_5241dce5263140e19fd5246e6c34f3fb) + + WindowTop = INT32 + + WindowRight = INT32 + + WindowBottom = INT32 + + WindowState = \["C"\] \["Z"\] \["I"\] + +**\:** Specifies the name of the module. MUST have a corresponding **ProjectModule** (section [2.3.1.3](#Section_dadaf8510a23465b9f64952ca6d88031)). + +**\:** Specifies the coordinates and the state of a window used to edit the source code of a module. + +**\:** Specifies the coordinates and the state of a window used to edit the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) associated with a module. + +**\:** Specifies the distance of the left edge of a window relative to a [**parent window**](#gt_bbeda13b-cd86-49b8-bb10-d15488223bf8). + +**\:** Specifies the distance of the top edge of a window relative to a parent window. + +**\:** Specifies the distance of the right edge of a window relative to a parent window. + +**\:** Specifies the distance of the bottom edge of a window relative to a parent window. + +**\:** Specifies the window state. + +Values are defined as follows: + +| Value | Meaning | +|-------|--------------------------------------------| +| C | Closed. | +| Z | Zoomed to fill the available viewing area. | +| I | Minimized to an icon. | + +### PROJECTlk Stream: ActiveX Control Information + +Specifies license information for [**ActiveX controls**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2). + +[TABLE] + +**Version (2 bytes):** An unsigned integer that specifies the version of this structure. MUST be 0x0001. + +**Count (4 bytes):** An unsigned integer that specifies the number of elements in **LicenseInfoRecords**. + +**LicenseInfoRecords (variable):** An array of **LICENSEINFO** (section [2.3.2.1](#licenseinfo-record)). + +#### LICENSEINFO Record + +Specifies the information saved for each [**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) in the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**ClassID (16 bytes):** A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that specifies the [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of an ActiveX control. + +**SizeOfLicenseKey (4 bytes):** An unsigned integer that specifies the length of **LicenseKey** in bytes. + +**LicenseKey (variable):** An array of **SizeOfLicenseKey** bytes that specifies the [**license key**](#gt_555fdaf4-dd5e-4ccb-bf55-56a7ba7ff56d) for the ActiveX control. + +**LicenseRequired (4 bytes):** An unsigned integer that specifies a Boolean value. Specifies that the ActiveX control can be instantiated only by using a license-aware object creation method. SHOULD be 0x00000001 when the value of **SizeOfLicenseKey** is not zero. Otherwise SHOULD be 0x00000000. If a document is originally created with an ActiveX control that requires license-aware object creation, and then resaved after the ActiveX control removes that requirement, it can be 0x00000000 even though **SizeOfLicenseKey** is not zero. + +### PROJECTwm Stream: Module Name Information + +Specifies a map from [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) names to [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) module names. + +[TABLE] + +**NameMap (variable):** An array of **NAMEMAP** Record (section [2.3.3.1](#namemap-record)). The length of **NameMap** MUST be two bytes less than the size of the **PROJECTwm** Stream (section [2.2.8](#Section_514acc65ea7b4813aaf7fabb1bca0ba2)). Array items MUST appear in the same order as they appear in the **PROJECTMODULES** Record (section [2.3.4.2.3](#projectmodules-record)). + +**Terminator (2 bytes):** An unsigned integer that specifies the end of the stream. MUST be 0x0000. + +#### NAMEMAP Record + +Maps a [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) name to a [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) module name. + +[TABLE] + +**ModuleName (variable):** A null-terminated string that specifies a module name. MUST contain MBCS characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified by **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST match a module name specified by **MODULENAME** (section [2.3.4.2.3.2.1](#modulename-record)). The first byte MUST NOT be 0x00. + +**ModuleNameUnicode (variable):** A null-terminated string that specifies a module name. MUST contain [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) encoded characters. The first two bytes MUST NOT be 0x0000. MUST contain the UTF-16 encoding of **ModuleName**. + +### VBA Storage: Visual Basic for Applications Project Information + +The VBA [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) contains the **\_VBA_PROJECT** Stream (section [2.3.4.1](#vba_project-stream-version-dependent-project-information)), the **dir** Stream (section [2.3.4.2](#dir-stream-version-independent-project-information)), and **Module** Streams (section [2.3.4.3](#module-stream-visual-basic-modules)) for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). It also contains optional **SRP** Streams (section [2.2.6](#Section_26f8053a61ed4c6aa5ef8b9933b67ef5)) that MUST be ignored. + +#### \_VBA_PROJECT Stream: Version Dependent Project Information + +The \_VBA_PROJECT [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains the version-dependent description of a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +The first seven bytes of the stream are version-independent and therefore can be read by any version. + +[TABLE] + +**Reserved1 (2 bytes):** MUST be 0x61CC. MUST be ignored. + +**Version (2 bytes):** An unsigned integer that specifies the version of [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) used to create the VBA project. MUST be ignored on read. MUST be 0xFFFF on write. + +**Reserved2 (1 byte):** MUST be 0x00. MUST be ignored. + +**Reserved3 (2 bytes):** Undefined. MUST be ignored. + +**PerformanceCache (variable):** An array of bytes that forms an implementation-specific and version-dependent performance cache for the VBA project. The length of **PerformanceCache** MUST be seven bytes less than the size of **\_VBA_PROJECT** Stream (section 2.3.4.1). MUST be ignored on read. MUST NOT be present on write. + +#### dir Stream: Version Independent Project Information + +The dir [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains a series of bytes that specifies information for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e), including project information, project [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f), and [**modules**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1). The entire stream MUST be compressed as specified in Compression (section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd)). + +[TABLE] + +**InformationRecord (variable):** A **PROJECTINFORMATION** Record (section [2.3.4.2.1](#projectinformation-record)). + +**ReferencesRecord (variable):** A **PROJECTREFERENCES** Record (section [2.3.4.2.2](#projectreferences-record)). + +**ModulesRecord (variable):** A **PROJECTMODULES** Record (section [2.3.4.2.3](#projectmodules-record)). + +**Terminator (2 bytes):** An unsigned integer that specifies the end of the version-independent information in this stream. MUST be 0x0010. + +**Reserved (4 bytes):** MUST be 0x00000000. MUST be ignored. + +##### PROJECTINFORMATION Record + +Specifies version-independent information for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**SysKindRecord (10 bytes):** A **PROJECTSYSKIND** Record (section [2.3.4.2.1.1](#projectsyskind-record)). + +**CompatVersionRecord (10 bytes):** A PROJECTCOMPATVERSION Record (section [2.3.4.2.1.2](#projectcompatversion-record)). This field is optional. + +**LcidRecord (10 bytes):** A **PROJECTLCID** Record (section [2.3.4.2.1.3](#projectlcid-record)). + +**LcidInvokeRecord (10 bytes):** A **PROJECTLCIDINVOKE** Record (section [2.3.4.2.1.4](#projectlcidinvoke-record)). + +**CodePageRecord (8 bytes):** A **PROJECTCODEPAGE** Record (section [2.3.4.2.1.5](#projectcodepage-record)). + +**NameRecord (variable):** A **PROJECTNAME** Record (section [2.3.4.2.1.6](#projectname-record)). + +**DocStringRecord (variable):** A **PROJECTDOCSTRING** Record (section [2.3.4.2.1.7](#projectdocstring-record)). + +**HelpFilePathRecord (variable):** A **PROJECTHELPFILEPATH** Record (section [2.3.4.2.1.8](#projecthelpfilepath-record)). + +**HelpContextRecord (10 bytes):** A **PROJECTHELPCONTEXT** Record (section [2.3.4.2.1.9](#projecthelpcontext-record)). + +**LibFlagsRecord (10 bytes):** A **PROJECTLIBFLAGS** Record (section [2.3.4.2.1.10](#projectlibflags-record)). + +**VersionRecord (12 bytes):** A **PROJECTVERSION** Record (section [2.3.4.2.1.11](#projectversion-record)). + +**ConstantsRecord (variable):** A **PROJECTCONSTANTS** Record (section [2.3.4.2.1.12](#projectconstants-record)). This field is optional. + +###### PROJECTSYSKIND Record + +Specifies the platform for which the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) is created. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0001. + +**Size (4 bytes):** An unsigned integer that specifies the size of **SysKind**. MUST be 0x00000004. + +**SysKind (4 bytes):** An unsigned integer that specifies the platform for which the VBA project is created. MUST have one of the following values: + +| Value | Meaning | +|------------|-------------------------------| +| 0x00000000 | For 16-bit Windows Platforms. | +| 0x00000001 | For 32-bit Windows Platforms. | +| 0x00000002 | For Macintosh Platforms. | +| 0x00000003 | For 64-bit Windows Platforms. | + +###### PROJECTCOMPATVERSION Record + +Specifies the VBA project’s [**compat version**](#gt_cedaaf25-8a7a-4fbc-af14-c9e7683d988f). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x004A. + +**Size (4 bytes):** An unsigned integer that specifies the size of compat version. MUST be 0x00000004. + +**CompatVersion (4 bytes):** An unsigned integer that specifies the compat version value for the VBA project. + +###### PROJECTLCID Record + +Specifies the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e)’s [**LCID**](#gt_c7f99c66-592f-4053-b62a-878c189653b6). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0002. + +**Size (4 bytes):** An unsigned integer that specifies the size of **Lcid**. MUST be 0x00000004. + +**Lcid (4 bytes):** An unsigned integer that specifies the LCID value for the VBA project. MUST be 0x00000409. + +###### PROJECTLCIDINVOKE Record + +Specifies an [**LCID**](#gt_c7f99c66-592f-4053-b62a-878c189653b6) value used for Invoke calls on an [**Automation server**](#gt_5dcdba04-9cfd-40b3-b0e1-0b8e4374aeaa) as specified in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961) section [3.1.4.4](http://msdn.microsoft.com/en-us/library/5c2a1997-60d7-496d-8d9a-ed940bbb82eb/). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0014. + +**Size (4 bytes):** An unsigned integer that specifies the size of **LcidInvoke**. MUST be 0x00000004. + +**LcidInvoke (4 bytes):** An unsigned integer that specifies the LCID value used for Invoke calls. MUST be 0x00000409. + +###### PROJECTCODEPAGE Record + +Specifies the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e)’s [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0003. + +**Size (4 bytes):** An unsigned integer that specifies the size of **CodePage**. MUST be 0x00000002. + +**CodePage (2 bytes):** An unsigned integer that specifies the code page for the VBA project. + +###### PROJECTNAME Record + +Specifies a unique [**VBA identifier**](#gt_d7766174-7071-4220-8d78-9554a2163b0b) as the name of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0004. + +**SizeOfProjectName (4 bytes):** An unsigned integer that specifies the size in bytes of **ProjectName**. MUST be greater than or equal to 1. MUST be less than or equal to 128. + +**ProjectName (variable):** An array of **SizeOfProjectName** bytes that specifies the VBA identifier name for the VBA project. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +###### PROJECTDOCSTRING Record + +Specifies the description for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0005. + +**SizeOfDocString (4 bytes):** An unsigned integer that specifies the size in bytes of **DocString**. MUST be less than or equal to 2000. + +**DocString (variable):** An array of **SizeOfDocString** bytes that specifies the description for the VBA project. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +**Reserved (2 bytes):** MUST be 0x0040. MUST be ignored. + +**SizeOfDocStringUnicode (4 bytes):** An unsigned integer that specifies the size in bytes of **DocStringUnicode**. MUST be even. + +**DocStringUnicode (variable):** An array of **SizeOfDocStringUnicode** bytes that specifies the description for the VBA project. MUST contain [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) characters. MUST NOT contain null characters. MUST contain the UTF-16 encoding of **DocString**. + +###### PROJECTHELPFILEPATH Record + +Specifies the path to the [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). **\** MUST be defined in **PROJECT** Stream (section [2.3.1](#Section_d88cb9d8a475423db370cc0caaf78628)) if **SizeOfHelpFile1** is greater than zero. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0006. + +**SizeOfHelpFile1 (4 bytes):** An unsigned integer that specifies the size in bytes of **HelpFile1**. MUST be less than or equal to 260. + +**HelpFile1 (variable):** An array of **SizeOfHelpFile1** bytes that specifies the path to the Help file for the VBA project. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +**Reserved (2 bytes):** MUST be 0x003D. MUST be ignored. + +**SizeOfHelpFile2 (4 bytes):** An unsigned integer that specifies the size in bytes of **HelpFile2**. MUST be equal to **SizeOfHelpFile1**. + +**HelpFile2 (variable):** An array of **SizeOfHelpFile2** bytes that specifies the path to the Help file for the VBA project. MUST contain MBCS characters encoded using the code page specified in **PROJECTCODEPAGE** (section 2.3.4.2.1.5). MUST NOT contain null characters. MUST contain the same bytes as **HelpFile1**. + +###### PROJECTHELPCONTEXT Record + +Specifies the [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0007. + +**Size (4 bytes):** An unsigned integer that specifies the size of **HelpContext**. MUST be 0x00000004. + +**HelpContext (4 bytes):** An unsigned integer that specifies the Help topic identifier in the [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) specified by **PROJECTHELPFILEPATH** (section [2.3.4.2.1.8](#projecthelpfilepath-record)). + +###### PROJECTLIBFLAGS Record + +Specifies the LIBFLAGS for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e)’s [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) as specified in [\[MS-OAUT\]](%5bMS-OAUT%5d.pdf#Section_bbb05720f72445c78d17f83c3d1a3961) section [2.2.20](http://msdn.microsoft.com/en-us/library/08ca1c9a-5ac5-4630-aeaf-b09d495640b1/). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0008. + +**Size (4 bytes):** An unsigned integer that specifies the size of **ProjectLibFlags**. MUST be 0x00000004. + +**ProjectLibFlags (4 bytes):** An unsigned integer that specifies LIBFLAGS for the VBA project’s Automation type library as specified in \[MS-OAUT\] section 2.2.20. MUST be 0x00000000. + +###### PROJECTVERSION Record + +Specifies the version of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0009. + +**Reserved (4 bytes):** MUST be 0x00000004. MUST be ignored. + +**VersionMajor (4 bytes):** An unsigned integer specifying the major version of the VBA project. + +**VersionMinor (2 bytes):** An unsigned integer specifying the minor version of the VBA project. + +###### PROJECTCONSTANTS Record + +Specifies the [**compilation constants**](#gt_ae9af4b8-1ff1-4481-8738-f95640b41ec0) for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x000C. + +**SizeOfConstants (4 bytes):** An unsigned integer that specifies the size in bytes of **Constants**. MUST be less than or equal to 1015. + +**Constants (variable):** An array of **SizeOfConstants** bytes that specifies the compilation constants for the VBA project. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +MUST conform to the following ABNF grammar: + +152. Constants = Constant \*( " : " Constant ) + + Constant = ConstantName " = " ConstantValue + + ConstantName = [VbaIdentifier](#Section_8742ff197a6f40e38a5ed0b1665e1966) + + ConstantValue = \["-"\] 1\*5DIGIT + +**\:** Specifies a unique [**VBA identifier**](#gt_d7766174-7071-4220-8d78-9554a2163b0b) for the constant. + +**\:** Specifies the numeric value for the constant. SHOULD be between −9999 and 32767. MAY be between −32768 and 32767 on read.[\<7\>](#Appendix_A_7) + +**Reserved (2 bytes):** MUST be 0x003C. MUST be ignored. + +**SizeOfConstantsUnicode (4 bytes):** An unsigned integer that specifies the size in bytes of **ConstantsUnicode**. MUST be even. + +**ConstantsUnicode (variable):** An array of **SizeOfConstantsUnicode** bytes that specifies the compilation constants for the VBA project. MUST contain [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) characters. MUST NOT contain null characters. MUST contain the UTF-16 encoding of **Constants**. + +##### PROJECTREFERENCES Record + +Specifies the external [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) as a variably sized array of **REFERENCE** (section [2.3.4.2.2.1](#reference-record)). The termination of the array is indicated by the beginning of **PROJECTMODULES** (section [2.3.4.2.3](#projectmodules-record)), which is indicated by a **REFERENCE** (section 2.3.4.2.2.1) being followed by an unsigned 16-bit integer with a value of 0x000F. + +[TABLE] + +**ReferenceArray (variable):** An array of **REFERENCE** Records (section 2.3.4.2.2.1). + +###### REFERENCE Record + +Specifies a [**reference**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) to an [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) or [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**NameRecord (variable):** A **REFERENCENAME** Record (section [2.3.4.2.2.2](#referencename-record)) that specifies the name of the referenced VBA project or Automation type library. This field is optional. + +**ReferenceRecord (variable):** The type of **ReferenceRecord** is determined by the unsigned 16-bit integer beginning this field. The meanings of the possible values are listed in the following table: + +| Value | Meaning | +|----|----| +| 0x002F | **ReferenceRecord** is a **REFERENCECONTROL** (section [2.3.4.2.2.3](#referencecontrol-record)). | +| 0x0033 | **ReferenceRecord** is a **REFERENCEORIGINAL** (section [2.3.4.2.2.4](#referenceoriginal-record)). | +| 0x000D | **ReferenceRecord** is a **REFERENCEREGISTERED** (section [2.3.4.2.2.5](#referenceregistered-record)). | +| 0x000E | **ReferenceRecord** is a **REFERENCEPROJECT** (section [2.3.4.2.2.6](#referenceproject-record)). | + +###### REFERENCENAME Record + +Specifies the name of a referenced [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) or [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0016. + +**SizeOfName (4 bytes):** An unsigned integer that specifies the size in bytes of **Name**. + +**Name (variable):** An array of **SizeOfName** bytes that specifies the name of the referenced VBA project or Automation type library. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** Record (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. MUST conform to the following ABNF grammar: + +159. ReferenceName = RefProjectName / RefLibraryName + + RefProjectName = [VbaIdentifier](#Section_8742ff197a6f40e38a5ed0b1665e1966) + + RefLibraryName = Identifier + +**\:** The name of a referenced project. **\** MUST use the **\** rule when the **ReferenceRecord** of the parent **REFERENCE** (section [2.3.4.2.2.1](#reference-record)) is a **REFERENCEPROJECT** (section [2.3.4.2.2.6](#referenceproject-record)). + +**\:** The name of a referenced Automation type library. **\** MUST use the **\** rule when the **ReferenceRecord** of the parent **REFERENCE** (section 2.3.4.2.2.1) is a **REFERENCECONTROL** (section [2.3.4.2.2.3](#referencecontrol-record)) or **REFERENCEREGISTERED** (section [2.3.4.2.2.5](#referenceregistered-record)). **\** is defined in [\[C706\]](https://go.microsoft.com/fwlink/?LinkId=89824). + +**Reserved (2 bytes):** MUST be 0x003E. MUST be ignored. + +**SizeOfNameUnicode (4 bytes):** An unsigned integer that specifies the size in bytes of **NameUnicode**. + +**NameUnicode (variable):** An array of **SizeOfNameUnicode** bytes that specifies the name of the referenced VBA project or Automation type library. MUST contain [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) characters. MUST NOT contain null characters. MUST contain the UTF-16 encoding of **Name**. + +###### REFERENCECONTROL Record + +Specifies a [**reference**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) to a [**twiddled type library**](#gt_ef574965-aae0-4087-af88-dbf82f83c0f2) and its [**extended type library**](#gt_978a0d25-372e-494a-b189-654118c11be5). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x002F. + +**SizeTwiddled (4 bytes):** An unsigned integer that specifies the sum of the size in bytes of **SizeOfLibidTwiddled**, **LibidTwiddled**, **Reserved1**, and **Reserved2**. MUST be ignored on read. + +**SizeOfLibidTwiddled (4 bytes):** An unsigned integer that specifies the size in bytes of **LibidTwiddled**. + +**LibidTwiddled (variable):** An array of **SizeOfLibidTwiddled** bytes. SHOULD be "\*\G{00000000-0000-0000-0000-000000000000}#0.0#0##" (case-sensitive). MAY[\<8\>](#Appendix_A_8) specify a twiddled type library’s identifier. The identifier MUST conform to the ABNF grammar **LibidReference** (section [2.1.1.8](#Section_3737ef6ed8194186a5f26e258ddf66a5)). MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +**Reserved1 (4 bytes):** MUST be 0x00000000. MUST be ignored. + +**Reserved2 (2 bytes):** MUST be 0x0000. MUST be ignored. + +**NameRecordExtended (variable):** A **REFERENCENAME** Record (section [2.3.4.2.2.2](#referencename-record)) that specifies the name of the extended type library. This field is optional. + +**Reserved3 (2 bytes):** MUST be 0x0030. MUST be ignored. + +**SizeExtended (4 bytes):** An unsigned integer that specifies the sum of the size in bytes of **SizeOfLibidExtended**, **LibidExtended**, **Reserved4**, **Reserved5**, **OriginalTypeLib**, and **Cookie**. MUST be ignored on read. + +**SizeOfLibidExtended (4 bytes):** An unsigned integer that specifies the size in bytes of **LibidExtended**. + +**LibidExtended (variable):** An array of **SizeOfLibidExtended** bytes that specifies the extended type library’s identifier. MUST contain MBCS characters encoded using the code page specified in **PROJECTCODEPAGE** (section 2.3.4.2.1.5). MUST NOT contain null characters. MUST conform to the ABNF grammar in **LibidReference** (section 2.1.1.8). + +**Reserved4 (4 bytes):** MUST be 0x00000000. MUST be ignored. + +**Reserved5 (2 bytes):** MUST be 0x0000. MUST be ignored. + +**OriginalTypeLib (16 bytes):** A [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) that specifies the [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) the extended type library was generated from. + +**Cookie (4 bytes):** An unsigned integer that specifies the extended type library’s cookie. MUST be unique for each **REFERENCECONTROL** (section 2.3.4.2.2.3) in the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) with the same **OriginalTypeLib**. + +###### REFERENCEORIGINAL Record + +Specifies the identifier of an [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) and a related **REFERENCECONTROL** (section [2.3.4.2.2.3](#referencecontrol-record)). The contained **REFERENCECONTROL**'s [**twiddled type library**](#gt_ef574965-aae0-4087-af88-dbf82f83c0f2) was generated from the Automation type library identifier specified. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0033. + +**SizeOfLibidOriginal (4 bytes):** An unsigned integer that specifies the size in bytes of **LibidOriginal**. + +**LibidOriginal (variable):** An array of **SizeOfLibidOriginal** bytes that specifies the identifier of the Automation type library a **REFERENCECONTROL** (section 2.3.4.2.2.3) was generated from. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. MUST conform to the ABNF grammar in **LibidReference** (section [2.1.1.8](#Section_3737ef6ed8194186a5f26e258ddf66a5)). + +**ReferenceRecord (variable):** A **ReferenceRecord** of type **REFERENCECONTROL** (section 2.3.4.2.2.3) that specifies the type library generated from the Automation type library indicated by **LibidOriginal**. + +###### REFERENCEREGISTERED Record + +Specifies a [**reference**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) to an [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x000D + +**Size (4 bytes):** An unsigned integer that specifies the total size in bytes of **SizeOfLibid**, **Libid**, **Reserved1**, and **Reserved2**. MUST be ignored on read. + +**SizeOfLibid (4 bytes):** An unsigned integer that specifies the size in bytes of **Libid**. + +**Libid (variable):** An array of **SizeOfLibid** bytes that specifies an Automation type library’s identifier. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. MUST conform to the ABNF grammar in **LibidReference** (section [2.1.1.8](#Section_3737ef6ed8194186a5f26e258ddf66a5)). + +**Reserved1 (4 bytes):** MUST be 0x00000000. MUST be ignored. + +**Reserved2 (2 bytes):** MUST be 0x0000. MUST be ignored. + +###### REFERENCEPROJECT Record + +Specifies a [**reference**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) to an external [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x000E. + +**Size (4 bytes):** An unsigned integer that specifies the total size in bytes of **SizeOfLibidAbsolute**, **LibidAbsolute**, **SizeOfLibidRelative**. **LibidRelative**, **MajorVersion**, and **MinorVersion**. MUST be ignored on read. + +**SizeOfLibidAbsolute (4 bytes):** An unsigned integer that specifies the size in bytes of **LibidAbsolute**. + +**LibidAbsolute (variable):** An array of **SizeOfLibidAbsolute** bytes that specifies the referenced VBA project’s identifier with an [**absolute path**](#gt_e2edaf4f-a7f6-463e-9fe5-9b8bd3ce83c6), **\**. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. MUST conform to the ABNF grammar **ProjectReference** (section [2.1.1.12](#Section_9a45ac1af1ff4ebd958e537701aa8131)). + +**SizeOfLibidRelative (4 bytes):** An unsigned integer that specifies the size in bytes of **LibidRelative**. + +**LibidRelative (variable):** An array of **SizeOfLibidRelative** bytes that specifies the referenced VBA project’s identifier with a [**relative path**](#gt_f0a8c9c7-1368-4989-addb-4792c3206387), **\,** that is relative to the current VBA project. MUST contain MBCS characters encoded using the code page specified in **PROJECTCODEPAGE** (section 2.3.4.2.1.5). MUST NOT contain null characters. MUST conform to the ABNF grammar **ProjectReference** (section 2.1.1.12). + +**MajorVersion (4 bytes):** An unsigned integer that specifies the major version of the referenced VBA project. On write MUST be the **PROJECTVERSION.VersionMajor** (section [2.3.4.2.1.11](#projectversion-record)) of the referenced VBA project. + +**MinorVersion (2 bytes):** An unsigned integer that specifies the minor version of the external VBA project. On write MUST be the **PROJECTVERSION.VersionMinor** (section 2.3.4.2.1.11) of the referenced VBA project. + +##### PROJECTMODULES Record + +Specifies data for the [**modules**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) in the project. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x000F. + +**Size (4 bytes):** An unsigned integer that specifies the size of **Count**. MUST be 0x00000002. + +**Count (2 bytes):** An unsigned integer that specifies the number of elements in **Modules**. + +**ProjectCookieRecord (8 bytes):** A **PROJECTCOOKIE** Record (section [2.3.4.2.3.1](#projectcookie-record)). + +**Modules (variable):** An array of **MODULE** Records (section [2.3.4.2.3.2](#module-record)). + +###### PROJECTCOOKIE Record + +Specifies data that is ignored. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0013. + +**Size (4 bytes):** An unsigned integer that specifies the size of **Cookie**. MUST be 0x00000002. + +**Cookie (2 bytes):** MUST be ignored on read. MUST be 0xFFFF on write. + +###### MODULE Record + +Specifies data for a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1). Source code for the module can be found in the **ModuleStream** (section [2.3.4.3](#module-stream-visual-basic-modules)) named as specified in **StreamNameRecord**. Every **MODULE** (section 2.3.4.2.3.2) MUST have a corresponding **\** specified in **PROJECT** Stream (section [2.3.1](#Section_d88cb9d8a475423db370cc0caaf78628)). + +[TABLE] + +**NameRecord (variable):** A **MODULENAME** Record (section [2.3.4.2.3.2.1](#modulename-record)). + +**NameUnicodeRecord (variable):** A **MODULENAMEUNICODE** Record (section [2.3.4.2.3.2.2](#modulenameunicode-record)). This field is optional. + +**StreamNameRecord (variable):** A **MODULESTREAMNAME** Record (section [2.3.4.2.3.2.3](#modulestreamname-record)). + +**DocStringRecord (variable):** A **MODULEDOCSTRING** Record (section [2.3.4.2.3.2.4](#moduledocstring-record)). + +**OffsetRecord (10 bytes):** A **MODULEOFFSET** Record (section [2.3.4.2.3.2.5](#moduleoffset-record)). + +**HelpContextRecord (10 bytes):** A **MODULEHELPCONTEXT** Record (section [2.3.4.2.3.2.6](#modulehelpcontext-record)). + +**CookieRecord (8 bytes):** A **MODULECOOKIE** Record (section [2.3.4.2.3.2.7](#modulecookie-record)). + +**TypeRecord (6 bytes):** A **MODULETYPE** Record (section [2.3.4.2.3.2.8](#moduletype-record)). + +**ReadOnlyRecord (6 bytes):** A **MODULEREADONLY** Record (section [2.3.4.2.3.2.9](#modulereadonly-record)). This field is optional. + +**PrivateRecord (6 bytes):** A **MODULEPRIVATE** Record (section [2.3.4.2.3.2.10](#moduleprivate-record)). This field is optional. + +**Terminator (2 bytes):** An unsigned integer that specifies the end of this record. MUST be 0x002B. + +**Reserved (4 bytes):** MUST be 0x00000000. MUST be ignored. + +####### MODULENAME Record + +Specifies a [**VBA identifier**](#gt_d7766174-7071-4220-8d78-9554a2163b0b) as the name of the containing **MODULE Record** (section [2.3.4.2.3.2](#module-record)). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0019. + +**SizeOfModuleName (4 bytes):** An unsigned integer that specifies the size in bytes of **ModuleName**. + +**ModuleName (variable):** An array of **SizeOfModuleName** bytes that specifies the VBA identifier for the containing **MODULE Record**. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in the **PROJECTCODEPAGE Record** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +####### MODULENAMEUNICODE Record + +Specifies a [**VBA identifier**](#gt_d7766174-7071-4220-8d78-9554a2163b0b) as the name of the containing [**MODULE Record**](#module-record) (section 2.3.4.2.3.2). MUST contain the [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) encoding of **MODULENAME** Record (section [2.3.4.2.3.2.1](#modulename-record)). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0047. + +**SizeOfModuleNameUnicode (4 bytes):** An unsigned integer that specifies the size in bytes of **ModuleNameUnicode**. MUST be even. + +**ModuleNameUnicode (variable):** An array of **SizeOfModuleNameUnicode** bytes that specifies the VBA identifier for the containing **MODULE Record** (section 2.3.4.2.3.2). MUST contain UTF-16 characters. MUST NOT contain null characters. MUST contain the UTF-16 encoding of **MODULENAME** Record (section 2.3.4.2.3.2.1) **ModuleName**. + +####### MODULESTREAMNAME Record + +Specifies the [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) name of the [**ModuleStream**](#module-stream-visual-basic-modules) (section 2.3.4.3) in the [VBA Storage](#Section_170f52a04cd64729b51ad08155cbd213) (section 2.3.4) corresponding to the containing [**MODULE Record**](#module-record) (section 2.3.4.2.3.2). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x001A. + +**SizeOfStreamName (4 bytes):** An unsigned integer that specifies the size in bytes of **StreamName**. + +**StreamName (variable):** An array of **SizeOfStreamName** bytes that specifies the stream name of the **ModuleStream** (section 2.3.4.3). MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in PROJECTCODEPAGE (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +**Reserved (2 bytes):** MUST be 0x0032. MUST be ignored. + +**SizeOfStreamNameUnicode (4 bytes):** An unsigned integer that specifies the size in bytes of **StreamNameUnicode**. MUST be even. + +**StreamNameUnicode (variable):** An array of **SizeOfStreamNameUnicode** bytes that specifies the stream name of the **ModuleStream** (section 2.3.4.3). MUST contain [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) characters. MUST NOT contain null characters. MUST contain the UTF-16 encoding of **StreamName**. + +####### MODULEDOCSTRING Record + +Specifies the description for the containing **MODULE** Record (section [2.3.4.2.3.2](#module-record)). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x001C. + +**SizeOfDocString (4 bytes):** An unsigned integer that specifies the size in bytes of **DocString**. + +**DocString (variable):** An array of **SizeOfDocString** bytes that specifies the description for the containing **MODULE** Record (section 2.3.4.2.3.2). MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in **PROJECTCODEPAGE** (section [2.3.4.2.1.5](#projectcodepage-record)). MUST NOT contain null characters. + +**Reserved (2 bytes):** MUST be 0x0048. MUST be ignored. + +**SizeOfDocStringUnicode (4 bytes):** An unsigned integer that specifies the size in bytes of **DocStringUnicode**. MUST be even. + +**DocStringUnicode (variable):** An array of **SizeOfDocStringUnicode** bytes that specifies the description for the containing **MODULE** Record (section 2.3.4.2.3.2). MUST contain [**UTF-16**](#gt_4c9eef52-69d4-43e7-ac04-ff1fe43a94fb) characters. MUST NOT contain null characters. MUST contain the UTF-16 encoding of **DocString**. + +####### MODULEOFFSET Record + +Specifies the location of the source code within the [**ModuleStream**](#module-stream-visual-basic-modules) (section 2.3.4.3) that corresponds to the containing [**MODULE Record**](#module-record) (section 2.3.4.2.3.2). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0031. + +**Size (4 bytes):** An unsigned integer that specifies the size of **TextOffset**. MUST be 0x00000004. + +**TextOffset (4 bytes):** An unsigned integer that specifies the byte offset of the source code in the **ModuleStream** (section 2.3.4.3) named by **MODULESTREAMNAME** Record (section [2.3.4.2.3.2.3](#modulestreamname-record)). + +####### MODULEHELPCONTEXT Record + +Specifies the [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) for the containing [**MODULE Record**](#module-record) (section 2.3.4.2.3.2). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x001E. + +**Size (4 bytes):** An unsigned integer that specifies the size of **HelpContext**. MUST be 0x00000004. + +**HelpContext (4 bytes):** An unsigned integer that specifies the Help topic identifier in the [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) specified by [**PROJECTHELPFILEPATH Record**](#projecthelpfilepath-record) (section 2.3.4.2.1.8). + +####### MODULECOOKIE Record + +Specifies ignored data. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x002C. + +**Size (4 bytes):** An unsigned integer that specifies the size of **Cookie**. MUST be 0x00000002. + +**Cookie (2 bytes):** MUST be ignored on read. MUST be 0xFFFF on write. + +####### MODULETYPE Record + +Specifies whether the containing [**MODULE Record**](#module-record) (section 2.3.4.2.3.2) is a [**procedural module**](#gt_bb39b710-62e6-48cc-8c8e-992c6360e521), [**document module**](#gt_d992176e-7031-4ae8-8c8e-6ea9f4085c71), [**class module**](#gt_25ca6ee7-698a-45cc-9e3c-8be094d77324), or [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0021 when the containing **MODULE Record** (section 2.3.4.2.3.2) is a procedural module. MUST be 0x0022 when the containing **MODULE Record** (section 2.3.4.2.3.2) is a document module, class module, or designer module. + +**Reserved (4 bytes):** MUST be 0x00000000. MUST be ignored. + +####### MODULEREADONLY Record + +Specifies that the containing **MODULE Record** (section [2.3.4.2.3.2](#module-record)) is read-only. + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0025. + +**Reserved (4 bytes):** MUST be 0x00000000. MUST be ignored. + +####### MODULEPRIVATE Record + +Specifies that the containing [**MODULE Record**](#module-record) (section 2.3.4.2.3.2) is only usable from within the current [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +[TABLE] + +**Id (2 bytes):** An unsigned integer that specifies the identifier for this record. MUST be 0x0028. + +**Reserved (4 bytes):** MUST be 0x00000000. MUST be ignored. + +#### Module Stream: Visual Basic Modules + +Specifies the source code for a [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1). + +[TABLE] + +**PerformanceCache (variable):** An array of bytes that forms an implementation-specific and version-dependent performance cache for the module. MUST be [**MODULEOFFSET**](#moduleoffset-record) (section 2.3.4.2.3.2.5) bytes in size. MUST be ignored on read. + +**CompressedSourceCode (variable):** An array of bytes compressed as specified in [Compression](#Section_4742b896b32b4eb08372fbf01e3c65fd) (section 2.4.1). When decompressed yields an array of bytes that specifies the textual representation of [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) language source code as specified in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74) section 4.2. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in [**PROJECTCODEPAGE**](#projectcodepage-record) (section 2.3.4.2.1.5). + +### VBFrame Stream: Designer Information + +The VBFrame [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) specifies the extended property values of a [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). + +This stream is an array of bytes that specifies the extended property values of a [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92). MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified in [**PROJECTCODEPAGE**](#projectcodepage-record) (section 2.3.4.2.1.5). + +Property values of the designer are set at design-time. Property values are used at run-time as specified to initialize the designer. For example, a designer can be used at run time to display data to and accept data from a user and the following properties could be used to determine the location of the designer. + +ABNF syntax: + +164. VBFrameText = "VERSION 5.00" [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) + "Begin" 1\*WSP DesignerCLSID 1\*WSP DesignerName \*WSP NWLN + [DesignerProperties](#Section_2dc5e2ce4636446ebe83ec51bd785699) "End" NWLN + + DesignerCLSID = [GUID](#Section_dcef074c31e84261a49a15e5513d0b27) + + DesignerName = [ModuleIdentifier](#Section_bfe1e37a368f4d1684337c0a62e95865) + +**\:** Specifies the [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the designer. The [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) that contains the designer specified MUST be referenced with a [**REFERENCECONTROL**](#referencecontrol-record) (section 2.3.4.2.2.3). The value "{C62A69F0-16DC-11CE-9E98-00AA00574A4F}" specifies the designer is an Office Form [**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) specified in [\[MS-OFORMS\]](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a). + +**\:** Specifies the name of the designer module associated with the properties. + +#### DesignerProperties + +Specifies the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f)-specific extended properties of a [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). + +ABNF syntax: + +169. DesignerProperties = \[ \*WSP [DesignerCaption](#Section_86f5bd2de3854a9ea216fc2106be3304) \*WSP \[ Comment \] [NWLN](#Section_28e6ce3ac85449eeb8201e7245faba8a) \] + + \[ \*WSP [DesignerHeight](#Section_1a2414aa73c842a48c3b57699ea99d3e) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerLeft](#Section_df041ec4a8a84bc0b8aa7779b22c6e92) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerTop](#Section_5fd796902e094be0839d2955a9586bf7) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerWidth](#Section_3a131f23104e4e08941dc47fecfe70dc) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerEnabled](#Section_37e79b179a9a41f3bbbc6202202744ae) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerHelpContextId](#Section_d6903fe103e7416b9229302e65104593) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerRTL](#Section_18fc74cda7614a3490e1cbda00d8870d) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerShowModal](#Section_8867a56b275e4f6e8415a93a925529ae) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerStartupPosition](#Section_845d0dbe55f34ffaafc4af4455198969) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerTag](#Section_67e8101081da4bb5b2236dc7f277097f) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerTypeInfoVer](#Section_92534334b0fd43a79447a83d5de52229) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerVisible](#Section_f18768b101b74afbac979f0765b68fb1) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerWhatsThisButton](#Section_69f0b38f65df4360a47ad0c6a176f19f) \*WSP \[ Comment \] NWLN \] + + \[ \*WSP [DesignerWhatsThisHelp](#Section_623053a7de4144f0ab30bbc826d9d743) \*WSP \[ Comment \] NWLN \] + + Comment = "'" \*[ANYCHAR](#Section_0f44ba8ff56a41b780b978f0afcf2b74) + +**\:** Specifies a user-readable comment. + +#### DesignerCaption + +Specifies the title text of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). + +ABNF syntax: + +186. DesignerCaption = "Caption" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) DQUOTE DesignerCaptionText DQUOTE + + DesignerCaptionText = \*130[QUOTEDCHAR](#Section_c02cff5d40694c18a89d8bc07256fe9c) + +#### DesignerHeight + +Specifies the height of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) in [**twips**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382). + +ABNF syntax: + +189. DesignerHeight = "ClientHeight" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [FLOAT](#Section_5c8e5b201c864b5f9d36e749e832e969) + +#### DesignerLeft + +Specifies the left edge of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) in [**twips**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382) relative to the window specified by [**DesignerStartupPosition**](#Section_845d0dbe55f34ffaafc4af4455198969) (section 2.3.5.11). + +ABNF syntax: + +190. DesignerLeft = "ClientLeft" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [FLOAT](#Section_5c8e5b201c864b5f9d36e749e832e969) + +#### DesignerTop + +Specifies the position of the top edge of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) in [**twips**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382) relative to the window specified by [**DesignerStartupPosition**](#Section_845d0dbe55f34ffaafc4af4455198969) (section 2.3.5.11). + +ABNF syntax: + +191. DesignerTop = "ClientTop" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [FLOAT](#Section_5c8e5b201c864b5f9d36e749e832e969) + +#### DesignerWidth + +Specifies the width of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) in [**twips**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382). + +ABNF Syntax: + +192. DesignerWidth = "ClientWidth" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [FLOAT](#Section_5c8e5b201c864b5f9d36e749e832e969) + +#### DesignerEnabled + +Specifies whether the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) is enabled. The default is TRUE. + +ABNF syntax: + +193. DesignerEnabled = "Enabled" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [VBABOOL](#Section_9a3ce8110dca44eb9b66fbbafc383368) + +#### DesignerHelpContextId + +Specifies the [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) associated with this [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) in the [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) as specified by [**ProjectHelpFile**](#Section_db080517cf01434087514884a24cb91c) (section 2.3.1.9). + +ABNF syntax: + +194. DesignerHelpContextId = "HelpContextID" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [INT32](#Section_5241dce5263140e19fd5246e6c34f3fb) + +#### DesignerRTL + +Specifies that the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) be shown with right and left coordinates reversed for [**right-to-left**](#gt_91359688-7863-4e88-b507-f57b3dada5ec) language use. + +ABNF syntax: + +195. DesignerRTL = "RightToLeft" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [VBABOOL](#Section_9a3ce8110dca44eb9b66fbbafc383368) + +#### DesignerShowModal + +Specifies whether the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) is a modal window. The default is TRUE. + +ABNF syntax: + +196. DesignerShowModal = "ShowModal" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [VBABOOL](#Section_9a3ce8110dca44eb9b66fbbafc383368) + +#### DesignerStartupPosition + +Specifies the startup position of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) as follows. + +ABNF syntax: + +197. DesignerStartupPosition = "StartUpPosition" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) RelativeParent + + RelativeParent = "0" / "1" / "2" / "3" + +**\:** Specifies the window used to determine the relative starting coordinates of the control window. + +MUST be one of the following values: + +| Value | Meaning | +|----|----| +| "0" | "Manual" mode. [**DesignerTop**](#Section_5fd796902e094be0839d2955a9586bf7) (section 2.3.5.5) and [**DesignerLeft**](#Section_df041ec4a8a84bc0b8aa7779b22c6e92) (section 2.3.5.4) coordinates of the designer are relative to the desktop window. | +| "1" | "CenterOwner" mode. Center the designer relative to its [**parent window**](#gt_bbeda13b-cd86-49b8-bb10-d15488223bf8). | +| "2" | "Center" mode. Center the designer relative to the desktop window. | +| "3" | "WindowsDefault" mode. Place the designer in the upper-left corner of screen. | + +#### DesignerTag + +Specifies user-defined data associated with the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). + +ABNF syntax: + +200. DesignerTag = "Tag" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) DQUOTE DesignerTagText DQUOTE + + DesignerTagText = \*130[QUOTEDCHAR](#Section_c02cff5d40694c18a89d8bc07256fe9c) + +#### DesignerTypeInfoVer + +Specifies the number of times the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) has been changed and saved. The default is 0. + +ABNF syntax: + +203. DesignerTypeInfoVer = "TypeInfoVer" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [INT32](#Section_5241dce5263140e19fd5246e6c34f3fb) + +#### DesignerVisible + +Specifies whether the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8) is visible. The default is TRUE. + +ABNF syntax: + +204. DesignerVisible = "Visible" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [VBABOOL](#Section_9a3ce8110dca44eb9b66fbbafc383368) + +#### DesignerWhatsThisButton + +Specifies whether a help button is shown for the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). The default is FALSE. + +ABNF syntax: + +205. DesignerWhatsThisButton = "WhatsThisButton" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [VBABOOL](#Section_9a3ce8110dca44eb9b66fbbafc383368) + +#### DesignerWhatsThisHelp + +Specifies whether a help topic is associated with this [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). The [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) is specified by [**DesignerHelpContextId**](#Section_d6903fe103e7416b9229302e65104593) (section 2.3.5.8). + +ABNF syntax: + +206. DesignerWhatsThisHelp = "WhatsThisHelp" [EQ](#Section_daa33f4f6f55485e8229ab52de20c551) [VBABOOL](#Section_9a3ce8110dca44eb9b66fbbafc383368) + +## Algorithms + +### Compression and Decompression + +To preserve space, [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) uses data compression on a contiguous sequence of records on various [**streams**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). The data compression technique is [**run length encoding**](#gt_567c7f4d-ea81-412c-ac8d-351e2fb28b66). + +The compression algorithm repeatedly reads 4096 bytes from the decompressed buffer into an array. Each group of 4096 bytes is called a chunk. The compression algorithm writes each 4096 byte chunk in an encoded and compressed format. Each output chunk is preceded by a two byte header which denotes the number of bytes in the chunk and the format of the chunk. + +The compression algorithm searches for series of bytes that are repeated within the chunk. When series with multiple occurrences are found, the bytes in the first occurrence are encoded as literal tokens and the remaining occurrences are encoded as copy tokens which reference the first occurrence. The encoding for a repeated series of bytes is two bytes in length, thus matches of three bytes or more are required for encoding to be beneficial. Tokens are organized into groups of eight called a Token Sequence, which includes a flag byte. The flag byte is written in advance of the eight tokens. Each bit in the flag byte is used to identify the type of one of the token. + +If the compression algorithm fails in producing enough copy tokens to compensate for the space overhead of the copy tokens and the flag bytes, the 4096 byte input chunk is written to the output chunk without any encoding. + +The decompression algorithm reads one compressed chunk at a time. Each compressed chunk is decoded into 4096 bytes of uncompressed data which is written to output. For each chunk, the size and format style are extracted from the chunk header. The chunk is then read and decoded according to the format specified in the header. + +When the chunk header format specifies that the chunk contains no copy tokens, the 4096 remaining bytes are copied to output. When the chunk header format specifies that copy tokens exist in the chunk, the Token Sequences are decoded. Literal tokens are copied to output. Copy tokens are decoded to find the first occurrence of the byte sequence the copy token represents which is then copied to output. + +The pseudocode and record specifications for Compression and Decompression use the following conventions. + +- LEFT SHIFT: Bits in the operand are moved from the least significant to the most significant positions. High order bits are truncated. Low order bits become zero. + +- RIGHT SHIFT: Bits in the operand are moved from the most significant position to the least significant positions. Low order bits are truncated. High order bits become zero. + +- A literal bit sequence is denoted with the initial characters 0b. For example, the literal constant 0xB721 would appear as the binary literal 0b1011011100100001. + +#### Structures + +##### CompressedContainer + +A **CompressedContainer** is an array of bytes holding the compressed data. The **Decompression** algorithm (section [2.4.1.3.1](#Section_492124cc5afc48c8b439b42ad7087a7b)) processes a **CompressedContainer** to populate a **DecompressedBuffer**. The **Compression** algorithm (section [2.4.1.3.6](#Section_ba73e56541c74aa58c10b869aa136f66)) processes a **DecompressedBuffer** to produce a **CompressedContainer**. + +A **CompressedContainer** MUST be the last array of bytes in a [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6). On read, the end of stream indicator determines when the entire **CompressedContainer** has been read. + +The **CompressedContainer** is a **SignatureByte** followed by array of **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) structures. + +[TABLE] + +**SignatureByte (1 byte):** Specifies the beginning of the **CompressedContainer.** MUST be 0x01. The **Decompression** algorithm (section 2.4.1.3.1) reads **SignatureByte**. The **Compression** algorithm (section 2.4.1.3.6) writes **SignatureByte**. + +**Chunks (variable):** An array of **CompressedChunk** (section 2.4.1.1.4) records. Specifies the compressed data. Read by the **Decompression** algorithm. Written by the **Compression** algorithm. + +##### DecompressedBuffer + +The **DecompressedBuffer** is a resizable array of bytes that contains the same data as the **CompressedContainer** (section [2.4.1.1.1](#Section_546208abf2c142af962ce4c920890c8b)), but the data is in an uncompressed format. + +[TABLE] + +**Chunk (variable):** An array of **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) structures. The number of bytes in the last **DecompressedChunk** in a **DecompressedBuffer** (section 2.4.1.1.2) MUST be greater than zero. The number of bytes in the last **DecompressedChunk** in a **DecompressedBuffer** MUST be less than or equal to 4096. The number of bytes in all other **DecompressedChunks** MUST be 4096. Read by the **Compression** algorithm (section [2.4.1.3.6](#Section_ba73e56541c74aa58c10b869aa136f66)). Written by the **Decompression** algorithm (section [2.4.1.3.1](#Section_492124cc5afc48c8b439b42ad7087a7b)). + +##### DecompressedChunk + +A **DecompressedChunk** is a resizable array of bytes in the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). The byte array is the data from a **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) in uncompressed format. + +[TABLE] + +**Data (variable):** An array of bytes. Each byte specifies a copy of one byte of the **DecompressedBuffer** (section 2.4.1.1.2). + +##### CompressedChunk + +A **CompressedChunk** is a record that encodes all data from a **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) in compressed format. A **CompressedChunk** has two parts: a **CompressedChunkHeader** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)) followed by a **CompressedChunkData** (section [2.4.1.1.6](#Section_c375cbf2b9c64594b0646dfb830f1851)). The number of bytes in a **CompressedChunk** MUST be greater than or equal to 3. The number of bytes in a **CompressedChunk** MUST be less than or equal to 4098. + +[TABLE] + +**CompressedHeader (2 bytes):** A **CompressedChunkHeader**. Read by the **Decompressing a CompressedChunk** algorithm (section [2.4.1.3.2](#Section_3d5ea4dfe8a54079a4549595b840525f)). Written by the **Compressing a** **DecompressedChunk** algorithm (section [2.4.1.3.7](#Section_4cfb2b5e0f224b53b0d27062860e6e45)). + +**CompressedData (variable):** A **CompressedChunkData**. The size of **CompressedData** MUST be greater than zero. The size of **CompressedData** MUST be less than or equal to 4096. Read by the **Decompressing a** **CompressedChunk** algorithm. Written by the **Compressing a** **DecompressedChunk**. + +##### CompressedChunkHeader + +A **CompressedChunkHeader** is the first record in a **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)). A **CompressedChunkHeader** specifies the size of the entire **CompressedChunk** and the data encoding format in **CompressedChunk**.**CompressedData**. A **CompressedChunkHeader** is a two-byte record interpreted as an unsigned 16-bit integer in little-endian order. **CompressedChunkHeader** information is used by the **Decompressing a CompressedChunk** (section [2.4.1.3.2](#Section_3d5ea4dfe8a54079a4549595b840525f)) and **Compressing a DecompressedChunk** (section [2.4.1.3.7](#Section_4cfb2b5e0f224b53b0d27062860e6e45)) algorithms. + +[TABLE] + +**CompressedChunkSize (12 bits)**: An unsigned integer that specifies the number of bytes in the **CompressedChunk** minus 3. MUST be greater than or equal to zero. If **CompressedChunkFlag** is equal to 0b1, this element MUST be less than or equal to 4095. If **CompressedChunkFlag** is equal to 0b0, this element MUST be 4095. Read by the **Extract CompressedChunkSize** (section [2.4.1.3.12](#Section_4994c768d35d497d937dd577611cb17f)) algorithm. Written by the **Pack CompressedChunkSize** (section [2.4.1.3.13](#Section_65772c2a8da743d29e98f527e73e494a)) algorithm. + +**A – CompressedChunkSignature (3 bits)**: MUST be 0b011. Written by the **Pack CompressedChunkSignature** (section [2.4.1.3.14](#Section_3154f7f5285d49f98bd66dc6813b5ecc)) algorithm. + +**B – CompressedChunkFlag (1 bit)**: A bit specifying how **CompressedChunk.CompressedData** is compressed. If this is 0b1, **CompressedChunk.CompressedData** is in compressed format. If this is 0b0, **CompressedChunk.CompressedData** contains uncompressed data. Read by the **Extract CompressedChunkFlag** (section [2.4.1.3.15](#Section_a954990fb3d343e08d523d86d1f5b9af)) algorithm. Written by the **Pack** **CompressedChunkFlag** (section [2.4.1.3.16](#Section_e27e5fca69b94572b421d2290e9cb6c7)) algorithm. + +##### CompressedChunkData + +If **CompressedChunkHeader.CompressedChunkFlag** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)) is 0b0, **CompressedChunkData** contains an array of **CompressedChunkHeader.CompressedChunkSize** elements plus 1 bytes of uncompressed data. + +If **CompressedChunkHeader CompressedChunkFlag** is 0b1, **CompressedChunkData** contains an array of **TokenSequence** (section [2.4.1.1.7](#Section_de5c80afac7542aba0d2a21173f49c9a)) elements. + +[TABLE] + +**Data (variable):** An array of bytes. Specifies an encoding of bytes from the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). The size of **Data** in bytes MUST be **CompressedChunk.CompressedChunkHeader.CompressedChunkSize** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) plus 1. Bytes from the **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) are encoded and written to **Data** by the **Compressing a DecompressedChunk** (section [2.4.1.3.7](#Section_4cfb2b5e0f224b53b0d27062860e6e45)) algorithm. **Data** is read from the **CompressedChunk** to be decoded and written to the **DecompressedChunk** by the **Decompressing a CompressedChunk** (section [2.4.1.3.2](#Section_3d5ea4dfe8a54079a4549595b840525f)) algorithm. + +##### TokenSequence + +A **TokenSequence** is a **FlagByte** followed by an array of **Token**s. The number of **Tokens** in the final **TokenSequence** MUST be greater than or equal to 1. The number of **Token**s in the final **TokenSequence** MUST less than or equal to eight. All other **TokenSequences** in the **CompressedChunkData** MUST contain eight **Token**s. + +[TABLE] + +**FlagByte (1 byte):** An array of bits. Each bit specifies the type of a **Token** in the **TokenSequence**. A value of 0b0 specifies a **LiteralToken**. A value of 0b1 specifies a **CopyToken** (section [2.4.1.1.8](#Section_c821c6f8ec4840a988fa8c2b89589aec)). The least significant bit in the **FlagByte** denotes the first **Token** in the **TokenSequence**. The most significant bit in the **FlagByte** denotes the last **Token** in the **TokenSequence**. The correspondence between a **FlagByte** element and a **Token** element is maintained by the **Decompressing a TokenSequence** (section [2.4.1.3.4](#Section_70ea7393cc0d4efdae18853f29a062c8)) and the **Compressing a TokenSequence** (section [2.4.1.3.8](#Section_068987d953834d09a1f8b0b0f214dfd9)) algorithms. + +**Tokens (variable):** An array of **Token**s. Each **Token** can either be a **LiteralToken** or a **CopyToken** as specified by the corresponding bit in **FlagByte**. A **LiteralToken** is a copy of one byte, in uncompressed format, from the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). A **CopyToken** is a 2-byte encoding of 3 or more bytes from the **DecompressedBuffer**. Read by the **Decompressing a TokenSequence** algorithm. Written by the **Compressing a TokenSequence** algorithm. + +##### CopyToken + +**CopyToken** is a two-byte record interpreted as an unsigned 16-bit integer in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) order. A **CopyToken** is a compressed encoding of an array of bytes from a **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)). The byte array encoded by a **CopyToken** is a byte-for-byte copy of a byte array elsewhere in the same **DecompressedChunk**, called a **CopySequence** (section [2.4.1.3.19](#Section_97fde8bbdf1148a19bdd805b024c65a7)). + +The starting location, in a **DecompressedChunk**, is determined by the **Compressing a Token** (section [2.4.1.3.9](#Section_a306bb45f2234de1b5db31d14661ba52)) and the **Decompressing a Token** (section [2.4.1.3.5](#Section_d7069c13458a402083b31f3f49450e9e)) algorithms. Packed into the **CopyToken** is the **Offset**, the distance, in byte count, to the beginning of the **CopySequence**. Also packed into the **CopyToken** is the **Length**, the number of bytes encoded in the **CopyToken**. **Length** also specifies the count of bytes in the **CopySequence**. The values encoded in **Offset** and **Length** are computed by the **Matching** (section [2.4.1.3.19.4](#Section_541f5a2b9f844729bbacf46af59c4814)) algorithm. + +[TABLE] + +**Length (variable):** A variable bit unsigned integer that specifies the number of bytes contained in a **CopySequence** minus three. MUST be greater than or equal to zero. MUST be less than 4093. The number of bits used to encode **Length** MUST be greater than or equal to four. The number of bits used to encode **Length** MUST be less than or equal to 12. The number of bits used to encode **Length** is computed and used in the **Unpack CopyToken** (section [2.4.1.3.19.2](#Section_6a77ef8179da41a99b7ba4c807f326d5)) and the **Pack** **CopyToken** (section [2.4.1.3.19.3](#Section_dfda3c57841547acabb9918cb63af6b4)) algorithms. + +**Offset (variable):** A variable bit unsigned integer that specifies the distance, in byte count, from the beginning of a duplicate set of bytes in the DecompressedBuffer to the beginning of a CopySequence. The value stored in **Offset** is the distance minus three. MUST be greater than zero. MUST be less than 4096. The number of bits used to encode **Offset** MUST be greater than or equal to four. The number of bits used to encode **Offset** MUST be less than or equal to 12. The number of bits used to encode **Offset** is computed and used in the **Unpack CopyToken** and the **Pack** **CopyToken** algorithms. + +#### State Variables + +The following state is maintained for the **CompressedContainer** (section [2.4.1.1.1](#Section_546208abf2c142af962ce4c920890c8b)): + +**CompressedRecordEnd**: The location of the byte after the last byte in the **CompressedContainer** (section 2.4.1.1.1). + +**CompressedCurrent**: The location of the next byte in the **CompressedContainer** (section 2.4.1.1.1) to be read by decompression or to be written by compression. + +The following state is maintained for the current **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)): + +**CompressedChunkStart**: The location of the first byte of the **CompressedChunk** (section 2.4.1.1.4) within the **CompressedContainer** (section 2.4.1.1.1). + +The following state is maintained for a **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)): + +**DecompressedCurrent:** The location of the next byte in the **DecompressedBuffer** (section 2.4.1.1.2) to be written by decompression or to be read by compression. + +**DecompressedBufferEnd:** The location of the byte after the last byte in the **DecompressedBuffer** (section 2.4.1.1.2). + +The following state is maintained for the current **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)): + +**DecompressedChunkStart**: The location of the first byte of the **DecompressedChunk** (section 2.4.1.1.3) within the **DecompressedBuffer** (section 2.4.1.1.2). + +#### Algorithms + +##### Decompression Algorithm + +The Decompression algorithm pseudocode decodes the data in a **CompressedContainer** (section [2.4.1.1.1](#Section_546208abf2c142af962ce4c920890c8b)) and writes the uncompressed bytes to a **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). The pseudocode first validates **CompressedContainer SignatureByte** (section 2.4.1.1.1). If validation fails, then the **CompressedContainer** (section 2.4.1.1.1) is corrupt and cannot be decoded. The pseudocode then iterates over the **CompressedChunks** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)). On each iteration, the current **CompressedChunk** is decoded. + +The pseudocode to decompress the **CompressedContainer** (section 2.4.1.1.1) into the **DecompressedBuffer** (section 2.4.1.1.2) uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedCurrent**, **CompressedRecordEnd**, and **DecompressedCurrent**. These state variables MUST be initialized by the caller. **CompressedChunkStart** is also used. + +207. IF the byte located at CompressedCurrent EQUALS 0x01 THEN + + INCREMENT CompressedCurrent + + WHILE CompressedCurrent is LESS THAN CompressedRecordEnd + + SET CompressedChunkStart TO CompressedCurrent + + CALL Decompressing a CompressedChunk + + END WHILE + + ELSE + + RAISE ERROR + + ENDIF + +##### Decompressing a CompressedChunk + +The **Decompressing** **a** **CompressedChunk** pseudocode decodes the data in a **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) and writes the uncompressed bytes to the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). + +The **Decompressing** **a** **CompressedChunk** pseudocode inspects **CompressedChunk.CompressedChunkHeader CompressedChunkFlag** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)) to determine the encoding format of **CompressedChunk CompressedData** (section 2.4.1.1.4), and then decodes the **CompressedChunkData** (section [2.4.1.1.6](#Section_c375cbf2b9c64594b0646dfb830f1851)) using the format. + +The pseudocode for **Decompressing a CompressedChunk** uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **DecompressedChunkStart**, **DecompressedCurrent**, **CompressedRecordEnd**, **CompressedCurrent**, and **CompressedChunkStart**. + +224. SET Header TO the **CompressedChunkHeader** (section 2.4.1.1.5) located at **CompressedChunkStart** + + CALL **Extract CompressedChunkSize** (section [2.4.1.3.12](#Section_4994c768d35d497d937dd577611cb17f)) with Header returning **Size** + + CALL **Extract CompressedChunkFlag** (section [2.4.1.3.15](#Section_a954990fb3d343e08d523d86d1f5b9af)) with Header returning **CompressedFlag** + + SET **DecompressedChunkStart** TO **DecompressedCurrent** + + SET **CompressedEnd** TO the minimum of **CompressedRecordEnd** and (**CompressedChunkStart** PLUS **Size**) + + SET **CompressedCurrent** TO **CompressedChunkStart** PLUS 2 + + IF **CompressedFlag** EQUALS 1 THEN + + WHILE **CompressedCurrent** is LESS THAN **CompressedEnd** + + CALL **Decompressing a TokenSequence** (section [2.4.1.3.4](#Section_70ea7393cc0d4efdae18853f29a062c8)) with **CompressedEnd** + + END WHILE + + ELSE + + CALL **Decompressing a RawChunk** (section [2.4.1.3.3](#Section_86ff30e694424232ba00e616c64fd9ac)) + + ENDIF + +##### Decompressing a RawChunk + +The **Decompressing** **a** **RawChunk** pseudocode is called when the **CompressedChunkFlag** of the current **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) is 0b0. **CompressedChunk.CompressedChunkData** (section [2.4.1.1.6](#Section_c375cbf2b9c64594b0646dfb830f1851)) MUST contain 4096 bytes of uncompressed data. The **Decompressing** **a** **RawChunk** pseudocode copies the uncompressed data to the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). + +The pseudocode for **Decompressing a CompressedChunk** uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **DecompressedCurrent**, **CompressedCurrent**. + +249. APPEND 4096 bytes from CompressedCurrent TO DecompressedCurrent + + INCREMENT DecompressedCurrent BY 4096 + + INCREMENT CompressedCurrent BY 4096 + +##### Decompressing a TokenSequence + +The pseudocode for **Decompressing** **a** **TokenSequence** decodes the compressed data in a single **TokenSequence** (section [2.4.1.1.7](#Section_de5c80afac7542aba0d2a21173f49c9a)) out of a **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)). The uncompressed data is written to the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). + +The pseudocode for **Decompressing** **a** **TokenSequence** take the following input parameter. + +**CompressedEnd:** Specifies the location of the byte after the last byte in the current **CompressedChunk** (section 2.4.1.1.4). + +The pseudocode for **Decompressing** **a** **TokenSequence** uses the state variable described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedCurrent**. + +254. SET Byte TO the **FlagByte** (section 2.4.1.1.7) located at CompressedCurrent + + INCREMENT CompressedCurrent + + IF CompressedCurrent is LESS THAN CompressedEnd THEN + + FOR index FROM 0 TO 7 INCLUSIVE + + IF CompressedCurrent is LESS THAN CompressedEnd THEN + + CALL **Decompressing a Token** (section [2.4.1.3.5](#Section_d7069c13458a402083b31f3f49450e9e)) with index and Byte + + ENDIF + + ENDFOR + + ENDIF + +##### Decompressing a Token + +The **Decompressing a Token** pseudocode decodes a single token producing uncompressed data. The uncompressed data is written to the **DecompressedBuffer** (section [2.4.1.1.2](#Section_ec9b2c7bc68e42468d687eef2458180b)). + +The **Decompressing a Token** pseudocode takes the following input parameters: + +**Index:** An unsigned integer that specifies the element of a **TokenSequence** (section [2.4.1.1.7](#Section_de5c80afac7542aba0d2a21173f49c9a)) to decompress. MUST be greater than or equal to zero. MUST be less than or equal to 7. + +**Byte (1 byte):** The **FlagByte** of the current **TokenSequence** (section 2.4.1.1.7). + +The pseudocode for decompressing a token uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedCurrent**, **DecompressedCurrent**. + +271. CALL **Extract FlagBit** (section [2.4.1.3.17](#Section_ff4680fdb2af4d3fbb867d5d296218f6)) with index and Byte returning Flag + + IF Flag EQUALS 0 THEN + + COPY the byte at CompressedCurrent TO DecompressedCurrent + + INCREMENT DecompressedCurrent + + INCREMENT CompressedCurrent + + ELSE + + SET Token TO the **CopyToken** (section [2.4.1.1.8](#Section_c821c6f8ec4840a988fa8c2b89589aec)) at CompressedCurrent + + CALL **Unpack CopyToken** (section [2.4.1.3.19.2](#Section_6a77ef8179da41a99b7ba4c807f326d5)) with Token returning Offset and Length + + SET CopySource TO DecompressedCurrent MINUS Offset + + CALL **Byte Copy** (section [2.4.1.3.11](#Section_7b75cf79b73647db96aba443636518a8)) with CopySource, DecompressedCurrent, and Length + + INCREMENT DecompressedCurrent BY Length + + INCREMENT CompressedCurrent BY 2 + + ENDIF + +##### Compression algorithm + +The pseudocode for the **Compression algorithm** uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **DecompressedCurrent**, **DecompressedBufferEnd**, and **CompressedCurrent**. These state variables MUST be initialized by the caller. **CompressedChunkStart** and **DecompressedChunkStart** are also used. + +296. SET SignatureByte TO 0x01 + + INCREMENT CompressedCurrent + + WHILE DecompressedCurrent is LESS THAN DecompressedBufferEnd + + SET CompressedChunkStart TO CompressedCurrent + + SET DecompressedChunkStart TO DecompressedCurrent + + CALL **Compressing a DecompressedChunk** (section [2.4.1.3.7](#Section_4cfb2b5e0f224b53b0d27062860e6e45)) + + END WHILE + +##### Compressing a DecompressedChunk + +The pseudocode to compress a **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) to a **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedChunkStart,** **CompressedCurrent, DecompressedChunkStart, DecompressedBufferEnd**, and **DecompressedCurrent**. + +309. SET CompressedEnd TO CompressedChunkStart PLUS 4098 + + SET CompressedCurrent TO the CompressedChunkStart PLUS 2 + + SET DecompressedEnd TO the minimum of (DecompressedChunkStart PLUS 4096) and DecompressedBufferEnd + + WHILE (DecompressedCurrent is LESS THAN DecompressedEnd) AND (CompressedCurrent is LESS THAN CompressedEnd) + + CALL Compressing a TokenSequence (section [2.4.1.3.8](#Section_068987d953834d09a1f8b0b0f214dfd9)) with CompressedEnd and DecompressedEnd + + END WHILE + + IF DecompressedCurrent is LESS THAN DecompressedEnd THEN + + CALL Compressing a RawChunk (section [2.4.1.3.10](#Section_09da186d7e14492782ae5e19e018e5b3)) with DecompressedEnd MINUS 1 + + SET CompressedFlag TO 0 + + ELSE + + SET CompressedFlag TO 1 + + ENDIF + + SET Size TO CompressedCurrent MINUS CompressedChunkStart + + SET Header TO 0x0000 + + CALL Pack CompressedChunkSize (section [2.4.1.3.13](#Section_65772c2a8da743d29e98f527e73e494a)) with Size and Header + + CALL Pack CompressedChunkFlag (section [2.4.1.3.16](#Section_e27e5fca69b94572b421d2290e9cb6c7)) with CompressedFlag and Header + + CALL Pack CompressedChunkSignature (section [2.4.1.3.14](#Section_3154f7f5285d49f98bd66dc6813b5ecc)) with Header + + SET the CompressedChunkHeader (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)) located at CompressedChunkStart TO Header + +##### Compressing a TokenSequence + +The **Compressing** **a** **TokenSequence** pseudocode encodes a sub array of the **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) into a **TokenSequence** (section [2.4.1.1.7](#Section_de5c80afac7542aba0d2a21173f49c9a)). The TokenSequence is written to the **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)). The location of the **FlagByte** of the **TokenSequence** (section 2.4.1.1.7) is reserved and then the Compressing a Token algorithm (section [2.4.1.3.9](#Section_a306bb45f2234de1b5db31d14661ba52)) is called to manufacture the individual **Tokens**. After the encoding of each **Token** has been computed, the **FlagByte** is updated. + +The **Compressing** **a** **TokenSequence** pseudocode takes the following input parameters. + +**CompressedEnd:** The location of the next byte after the end of the current **CompressedChunk** (section 2.4.1.1.4). + +**DecompressedEnd:** The location of the next byte after the end of the current **DecompressedChunk** (section 2.4.1.1.3). + +The pseudocode for **Compressing** **a** **TokenSequence** uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedCurrent** and **DecompressedCurrent**. + +344. SET FlagByteIndex TO CompressedCurrent + + SET TokenFlags TO 0b00000000 + + INCREMENT CompressedCurrent + + FOR index FROM 0 TO 7 INCLUSIVE + + IF (DecompressedCurrent is LESS THAN DecompressedEnd) + + AND (CompressedCurrent is LESS THAN CompressedEnd) THEN + + CALL Compressing a Token with CompressedEnd, DecompressedEnd, + + index, and TokenFlags, + + returning TokenFlags + + ENDIF + + ENDFOR + + SET the byte at location FlagByteIndex TO TokenFlags + +##### Compressing a Token + +The **Compressing a Token** pseudocode uses the Matching algorithm (section [2.4.1.3.19.4](#Section_541f5a2b9f844729bbacf46af59c4814)) to determine the type of **Token** that can be placed at **CompressedCurrent**, manufactures the **Token**, and places the **Token** in the **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) at **CompressedCurrent**. If placing the **Token** at **CompressedCurrent** would exceed the boundaries of the current **CompressedChunk** (section 2.4.1.1.4), the **Token** is not inserted and **CompressedCurrent** is set to a value that will signal calling algorithms that the **CompressedChunk** (section 2.4.1.1.4) is full. + +The **Compressing a Token** pseudocode takes the following input parameter. + +**CompressedEnd:** The location of the next byte after the end of the current **CompressedChunk** (section 2.4.1.1.4). + +**DecompressedEnd:** The location of the first byte after the end of the **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)). + +**Index:** An integer that specifies the ordinal of the **Token** within a **TokenSequence** (section [2.4.1.1.7](#Section_de5c80afac7542aba0d2a21173f49c9a)) being encoded. MUST be greater than or equal to 0. MUST be less than or equal to 7. + +The **Compressing a Token** pseudocode takes the following input/output parameter. + +**Flags(1 byte):** The **FlagByte** of the current **TokenSequence** (section 2.4.1.1.7). + +The pseudocode for **Compressing a Token** uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedCurrent** and **DecompressedCurrent**. + +367. SET Offset TO zero + + CALL Matching (section 2.4.1.3.19.4) with DecompressedEnd returning Offset and Length + + IF Offset is not zero THEN + + IF (CompressedCurrent PLUS 1) is LESS THAN CompressedEnd THEN + + CALL Pack CopyToken (section [2.4.1.3.19.3](#Section_dfda3c57841547acabb9918cb63af6b4)) with Offset and Length returning Token + + APPEND the bytes of the CopyToken (section [2.4.1.1.8](#Section_c821c6f8ec4840a988fa8c2b89589aec)) Token TO CompressedCurrent in little-endian order + + CALL Set FlagBit (section [2.4.1.3.18](#Section_772420bcbfd64ceabcf4511a07bf145c)) with index, 1, and Flags + + INCREMENT CompressedCurrent BY 2 + + INCREMENT DecompressedCurrent BY Length + + ELSE + + SET CompressedCurrent TO CompressedEnd + + ENDIF + + ELSE + + IF CompressedCurrent is LESS THAN CompressedEnd THEN + + APPEND the byte of the LiteralToken at DecompressedCurrent + + TO CompressedCurrent + + INCREMENT CompressedCurrent + + INCREMENT DecompressedCurrent + + ELSE + + SET CompressedCurrent TO CompressedEnd + + ENDIF + + ENDIF + +##### Compressing a RawChunk + +The **Compressing a RawChunk** pseudocode is called when the number of bytes in a **CompressedChunk.CompressedData** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) array exceeds 4096. The bytes from the **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) are copied, with no compression, into **CompressedChunk.CompressedData** (section 2.4.1.1.4). If fewer than 4096 bytes are copied then the remaining bytes in **CompressedChunk.CompressedData.Data** array are padded with the literal value 0x00. The 0x00 byte padding is indistinguishable from bytes in the original **DecompressedChunk**. Thus, it is possible for an application of the **Compression** **algorithm** followed by an application of the **Decompression** **algorithm** to result in a **DecompressedBuffer** that contains more bytes than the original. + +**Compressing** **a** **RawChunk** takes the following input parameter. + +**LastByte:** Specifies the location of the last byte of the **DecompressedChunk**. + +The pseudocode for **Compressing a RawChunk** uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **CompressedCurrent, CompressedChunkStart, DecompressedChunkStart,** and **DecompressedCurrent**. + +410. SET CompressedCurrent TO CompressedChunkStart PLUS 2 + + SET DecompressedCurrent TO DecompressedChunkStart + + SET PadCount TO 4096 + + FOR each byte, B, FROM DecompressedChunkStart TO LastByte INCLUSIVE + + COPY B TO CompressedCurrent + + INCREMENT CompressedCurrent + + INCREMENT DecompressedCurrent + + DECREMENT PadCount + + ENDFOR + + FOR counter FROM 1 TO PadCount INCLUSIVE + + COPY 0x00 TO CompressedCurrent + + INCREMENT CompressedCurrent + + ENDFOR + +##### Byte Copy + +The **Byte Copy** pseudocode will copy a source sequence of bytes to a destination sequence of bytes. The source and destination sequences are allowed to overlap; thus it is possible for the **Byte Copy** operation to modify bytes in the source sequence. + +Byte copy takes the following input parameters: + +**CopySource**: Specifies the location, in the **DecompressedBuffer**, of the first byte of the source sequence. + +**DestinationSource**: Specifies the location, in the **DecompressedBuffer**, of the first byte of the destination sequence. + +**ByteCount**: Specifies the number of bytes to copy. MUST be greater than 0. + +The pseudocode follows: + +435. SET SrcCurrent TO CopySource + + SET DstCurrent TO DestinationSource + + FOR counter FROM 1 TO ByteCount INCLUSIVE + + COPY the byte at SrcCurrent TO DstCurrent + + INCREMENT SrcCurrent + + INCREMENT DstCurrent + + ENDFOR + +##### Extract CompressedChunkSize + +The Extract CompressedChunkSize pseudocode is used to unpack the size of a **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)) from its **CompressedChunkHeader** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)). The pseudocode takes the following input parameter: + +**Header (2 bytes)**: An instance of a **CompressedChunkHeader** (section 2.4.1.1.5). + +The Extract CompressedChunkSize pseudocode takes the following output parameter: + +**Size (2 bytes)**: An unsigned 16-bit integer. The number of bytes in the **CompressedChunk** (section 2.4.1.1.4) MUST be less than or equal to 4098. MUST be greater than or equal to three. + +448. SET temp TO Header BITWISE AND 0x0FFF + + SET Size TO temp PLUS 3 + +##### Pack CompressedChunkSize + +Pack CompressedChunkSize pseudocode takes the following input parameters: + +**Size**: An unsigned 16-bit integer. The number of bytes in the **CompressedChunk** (section [2.4.1.1.4](#Section_f1b0ac3ad6f844878e965c318d0c5462)). MUST be less than or equal to 4098. MUST be greater than or equal to three. + +Pack CompressedChunkSize pseudocode take the following input/output parameter: + +**Header**: An instance of a **CompressedChunkHeader** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)). + +451. SET temp1 TO Header BITWISE AND 0xF000 + + SET temp2 TO Size MINUS 3 + + SET Header TO temp1 BITWISE OR temp2 + +##### Pack CompressedChunkSignature + +**Pack CompressedChunkSignature** sets the **CompressedChunkSignature** of a **CompressedChunkHeader** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)) to 0b011. + +The **Pack CompressedChunkSignature** pseudocode takes the following input/output parameter: + +**Header (2 bytes)**: An instance of a **CompressedChunkHeader** (section 2.4.1.1.5). + +456. SET temp TO Header BITWISE AND 0x8FFF + + SET Header TO temp BITWISE OR 0x3000 + +##### Extract CompressedChunkFlag + +The **Extract CompressedChunkFlag** pseudocode takes the following input parameter: + +**Header (2 bytes)**: An instance of a **CompressedChunkHeader** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)). + +The **Extract CompressedChunkFlag** pseudocode takes the following output parameter: + +**CompressedFlag:** An unsigned integer. The value returned MUST be zero or one. + +459. SET temp TO Header BITWISE AND 0x8000 + + SET CompressedFlag TO temp RIGHT SHIFT BY 15 + +##### Pack CompressedChunkFlag + +The **Pack CompressedChunkFlag** pseudocode takes the following input parameter: + +**CompressedFlag:** An unsigned integer. MUST be zero or one. + +The **Pack CompressedChunkFlag** pseudocode takes the following input/output parameter: + +**Header (2 bytes)**: An instance of a **CompressedChunkHeader** (section [2.4.1.1.5](#Section_ec1bc78827de47d98db46be2b5cff52b)). + +462. SET temp1 TO Header BITWISE AND 0x7FFF + + SET temp2 TO CompressedFlag LEFT SHIFT BY 15 + + SET Header TO temp1 BITWISE OR temp2 + +##### Extract FlagBit + +The **Extract FlagBit** pseudocode takes the following input parameters: + +**Index**: An unsigned integer specifying which FlagBit to extract. MUST be greater than or equal to zero and less than eight. + +**Byte (1 byte)**: An instance of a **FlagByte**. + +The **Extract FlagBit** pseudocode returns the following output parameters: + +**Flag**: An integer. The value of the bit in **Byte** at location **Index**. The value returned MUST be zero or one. + +467. SET Flag TO (Byte RIGHT SHIFT BY Index) BITWISE AND 1 + +##### Set FlagBit + +The **Set FlagBit** pseudocode sets a specified bit in a FlagByte to 0b0 or 0b1. + +The **Set FlagBit** pseudocode takes the following input parameters: + +**Index**: An unsigned integer specifying which FlagBit to set. MUST be greater than or equal to zero. MUST be less than eight. + +**Flag**: An integer. Specifies the bit value to set at location **Index** in **Byte**. MUST be zero or one. + +The **Set FlagBit** pseudocode takes the following input/output parameters: + +**Byte (1 byte)**: An instance of a **FlagByte**. + +468. SET temp1 TO Flag LEFT SHIFT BY Index + + SET temp2 TO Byte BITWISE AND (BITWISE NOT temp1) + + SET Byte TO temp2 BITWISE OR temp1 + +##### CopyToken Algorithms + +Packed into a **CopyToken** (section [2.4.1.1.8](#Section_c821c6f8ec4840a988fa8c2b89589aec)) are an **Offset** value and a **Length** value. The **Offset**, **Length** pair specify the start and length of a sequence of bytes, called a **CopySequence**, in the **DecompressedChunk**. A **CopySequence** is an array of bytes in the **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)) that are duplicated starting at **DecompressedCurrent**. The **Matching algorithm** (section [2.4.1.3.19.4](#Section_541f5a2b9f844729bbacf46af59c4814)) will search for a **CopySequence**. + +The start of a **CopySequence** MUST be before **DecompressedCurrent**. The start of the **CopySequence** MUST be at or after **DecompressedChunkStart**. The number of bytes in a **CopySequence** MUST be greater than or equal to three. The number of bytes in a **CopySequence** MUST be less than 4096. + +**Offset** specifies the start of the **CopySequence**. **Offset** is the difference between **DecompressedCurrent** and the start of the **CopySequence** minus one. **Length** is the number of bytes minus three in the **CopySequence**. + +The number of bits used to pack **Offset** and **Length** is a function of the relationship between **DecompressedCurrent** and **DecompressedChunkStart** as specified as: + +| DecompressedCurrent minus DecompressedChunkStart | Number of bits used to pack Length | Largest possible value for Length | Number of bits used to pack Offset | +|----|----|----|----| +| 1 to 16 | 12 | 4098 | 4 | +| 17 to 32 | 11 | 2050 | 5 | +| 33 to 64 | 10 | 1026 | 6 | +| 65 to 128 | 9 | 514 | 7 | +| 129 to 256 | 8 | 258 | 8 | +| 257 to 512 | 7 | 130 | 9 | +| 513 to 1024 | 6 | 66 | 10 | +| 1025 to 2048 | 5 | 34 | 11 | +| 2049 to 4096 | 4 | 18 | 12 | + +The **CopyToken Help algorithm** (section [2.4.1.3.19.1](#Section_220bde4c02b541ef9f9a8608718ce913)) returns values that are used by the **Unpack CopyToken** (section [2.4.1.3.19.2](#Section_6a77ef8179da41a99b7ba4c807f326d5)) and **Pack CopyToken** (section [2.4.1.3.19.3](#Section_dfda3c57841547acabb9918cb63af6b4)) algorithms to manipulate the **Offset** and **Length** fields of a **CopyToken**. + +###### CopyToken Help + +**CopyToken** **Help** derived bit masks are used by the **Unpack CopyToken** (section [2.4.1.3.19.2](#Section_6a77ef8179da41a99b7ba4c807f326d5)) and the **Pack CopyToken** (section [2.4.1.3.19.3](#Section_dfda3c57841547acabb9918cb63af6b4)) algorithms. **CopyToken** **Help** also derives the maximum length for a **CopySequence** (section [2.4.1.3.19](#Section_97fde8bbdf1148a19bdd805b024c65a7)) which is used by the **Matching algorithm** (section [2.4.1.3.19.4](#Section_541f5a2b9f844729bbacf46af59c4814))**.** + +The pseudocode uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **DecompressedCurrent** and **DecompressedChunkStart**. + +The pseudocode for **CopyToken Help** returns the following output parameters: + +**LengthMask (2 bytes):** An unsigned 16-bit integer. A bitmask used to access **CopyToken**.**Length**. + +**OffsetMask (2 bytes):** An unsigned 16-bit integer. A bitmask used to access **CopyToken**.**Offset**. + +**BitCount (2 bytes):** An unsigned 16-bit integer. The number of bits set to 0b1 in **OffsetMask**. + +**MaximumLength (2 bytes):** An unsigned 16-bit integer. The largest possible integral value that can fit into **CopyToken**.**Length**. + +473. SET difference TO DecompressedCurrent MINUS DecompressedChunkStart + + SET BitCount TO the smallest integer that is GREATER THAN OR EQUAL TO LOGARITHM base 2 of difference + + SET BitCount TO the maximum of BitCount and 4 + + SET LengthMask TO 0xFFFF RIGHT SHIFT BY BitCount + + SET OffsetMask TO BITWISE NOT LengthMask + + SET MaximumLength TO (0xFFFF RIGHT SHIFT BY BitCount) PLUS 3 + +###### Unpack CopyToken + +The **Unpack CopyToken** pseudocode will compute the specifications of a **CopySequence** (section [2.4.1.3.19](#Section_97fde8bbdf1148a19bdd805b024c65a7)) that are encoded in a CopyToken. + +The pseudocode for **Unpack CopyToken** takes the following input parameters: + +**Token (2 bytes):** A **CopyToken** (section [2.4.1.1.8](#Section_c821c6f8ec4840a988fa8c2b89589aec)). + +The pseudocode takes the following output parameters: + +**Offset (2 bytes):** An unsigned 16-bit integer that specifies the beginning of a **CopySequence** (section 2.4.1.3.19). + +**Length (2 bytes):** An unsigned 16-bit integer that specifies the length of a **CopySequence** (section 2.4.1.3.19) as follows: + +1. CALL **CopyToken Help** (section [2.4.1.3.19.1](#Section_220bde4c02b541ef9f9a8608718ce913)) returning **LengthMask**, **OffsetMask**, and **BitCount**. + +2. SET **Length** TO (Token **BITWISE** AND **LengthMask**) PLUS 3. + +3. SET **temp1** TO Token **BITWISE** AND **OffsetMask**. + +4. SET **temp2** TO 16 MINUS **BitCount**. + +5. SET **Offset** TO (**temp1** RIGHT SHIFT BY **temp2**) PLUS 1. + +###### Pack CopyToken + +The **Pack CopyToken** pseudocode will take the Offset and Length values that specify a **CopySequence** (section [2.4.1.3.19](#Section_97fde8bbdf1148a19bdd805b024c65a7)) and pack them into a **CopyToken** (section [2.4.1.1.8](#Section_c821c6f8ec4840a988fa8c2b89589aec)). + +The **Pack CopyToken** pseudocode takes the following input parameters: + +**Offset (2 bytes):** An unsigned 16-bit integer that specifies the beginning of a **CopySequence** (section 2.4.1.3.19). + +**Length (2 bytes):** An unsigned 16-bit integer that specifies the length of a **CopySequence** (section 2.4.1.3.19). + +The **Pack CopyToken** pseudocode takes the following output parameters: + +**Token (2 bytes):** A **CopyToken** (section 2.4.1.1.8). + +484. CALL **CopyToken Help** (section [2.4.1.3.19.1](#Section_220bde4c02b541ef9f9a8608718ce913)) returning LengthMask, OffsetMask, and BitCount + + SET temp1 TO Offset MINUS 1 + + SET temp2 TO 16 MINUS BitCount + + SET temp3 TO Length MINUS 3 + + SET Token TO (temp1 LEFT SHIFT BY temp2) BITWISE OR temp3 + +###### Matching + +The **Matching** pseudocode is used to search for a **CopySequence** (section [2.4.1.3.19](#Section_97fde8bbdf1148a19bdd805b024c65a7)) in a **DecompressedChunk** (section [2.4.1.1.3](#Section_1047b6cb53c548079714655b43a76ad7)), based on an array of bytes in the same DecompressedChunk. The pseudocode uses the state variables described in State Variables (section [2.4.1.2](#Section_c01d4c55f44e4ee1b5cde179e4957d01)): **DecompressedCurrent**, and **DecompressedChunkStart**. + +The Matching pseudocode takes the following input parameters: + +**DecompressedEnd:** Specifies the location of the byte after the last byte in the current **DecompressedChunk**. + +The **Matching** pseudocode returns the following output parameters: + +**Offset**: If a match is found, then the number of bytes between the start of the **CopySequence** (section 2.4.1.3.19) and **DecompressedCurrent**. If a match is not found, then zero. + +**Length**: If a match is found, then the number of bytes in the **CopySequence** (section 2.4.1.3.19). If a match is not found, then zero. + +493. SET Candidate TO DecompressedCurrent MINUS 1 + + SET BestLength TO 0 + + WHILE Candidate is GREATER THAN OR EQUAL TO DecompressedChunkStart + + SET C TO Candidate + + SET D TO DecompressedCurrent + + SET Len TO 0 + + WHILE (D is LESS THAN DecompressedEnd) + + and (the byte at D EQUALS the byte at C) + + INCREMENT Len + + INCREMENT C + + INCREMENT D + + END WHILE + + IF Len is GREATER THAN BestLength THEN + + SET BestLength TO Len + + SET BestCandidate TO Candidate + + ENDIF + + DECREMENT Candidate + + END WHILE + + IF BestLength is GREATER THAN OR EQUAL TO 3 THEN + + CALL CopyToken Help (section [2.4.1.3.19.1](#Section_220bde4c02b541ef9f9a8608718ce913)) returning MaximumLength + + SET Length TO the MINIMUM of BestLength and MaximumLength + + SET Offset TO DecompressedCurrent MINUS BestCandidate + + ELSE + + SET Length TO 0 + + SET Offset TO 0 + + ENDIF + +### Contents Hashes + +The Contents Hash is a cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62) of a subset of the information stored in the [VBA Storage](#Section_170f52a04cd64729b51ad08155cbd213) (section 2.3.4). + +Conventions: + +- APPEND specifies appending the bytes of a field to the end of a resizable array of bytes. + +- APPEND specifies appending the [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) bytes of a string without null termination to the end of a resizable array of bytes. + +- FOR EACH specifies iteration over a collection of records in their stored order. + +This Contents Hash algorithm requires one parameter as input: + +**VBAStorage(Variable):** The VBA Storage (section 2.3.4) to calculate a hash for. + +#### Content Normalized Data + +The Contents Normalized Data algorithm produces an array of bytes as output: + +**ContentNormalizedData(Variable)**: A Buffer containing a variable number of bytes that contains the normalized representation of the **VBAStorage**. + +**ContentNormalizedData** is generated by the following pseudocode: + +544. FUNCTION ContentNormalizedData + + PARAMETERS Storage AS VBA Storage (section [2.3.4](#Section_170f52a04cd64729b51ad08155cbd213)) + + RETURNS array of bytes + + DECLARE Buffer AS array of bytes + + SET Buffer TO resizable array of bytes + + APPEND Buffer WITH PROJECTNAME.ProjectName (section [2.3.4.2.1.6](#projectname-record)) of Storage + + APPEND Buffer WITH PROJECTCONSTANTS.Constants (section [2.3.4.2.1.12](#projectconstants-record)) of Storage + + FOR EACH REFERENCE (section [2.3.4.2.2.1](#reference-record)) IN PROJECTREFERENCES.ReferenceArray (section [2.3.4.2.2](#projectreferences-record)) of Storage + + IF REFERENCE.ReferenceRecord.Id = 0x000D THEN + + APPEND Buffer with 0x7B + + ELSE IF REFERENCE.ReferenceRecord.Id = 0x000E THEN + + DECLARE TempBuffer AS array of bytes + + SET TempBuffer TO resizable array of bytes + + APPEND TempBuffer WITH REFERENCE.ReferenceRecord.SizeOfLibidAbsolute + + APPEND TempBuffer WITH REFERENCE.ReferenceRecord.LibidAbsolute + + APPEND TempBuffer WITH REFERENCE.ReferenceRecord.SizeOfLibidRelative + + APPEND TempBuffer WITH REFERENCE.ReferenceRecord.LibidRelative + + APPEND TempBuffer WITH REFERENCE.ReferenceRecord.MajorVersion + + APPEND TempBuffer WITH REFERENCE.ReferenceRecord.MinorVersion + + APPEND TempBuffer WITH 0x00 + + DECLARE CopyIndex AS integer + + DECLARE CopyByte AS byte + + SET CopyIndex TO 0 + + SET CopyByte TO TempBuffer\[CopyIndex\] + + WHILE NOT CopyByte = 0x00 + + APPEND Buffer WITH CopyByte + + SET CopyIndex TO CopyIndex + 1 + + SET CopyByte TO TempBuffer\[CopyIndex\] + + END WHILE + + END IF + + END FOR + + FOR EACH ModuleStream (section [2.3.4.3](#module-stream-visual-basic-modules)) IN VBA Storage (section 2.3.4) of Storage + + DEFINE CompressedContainer AS array of bytes + + DEFINE Text AS array of bytes + + SET CompressedContainer TO ModuleStream.CompressedSourceCode + + SET Text TO result of Decompression(CompressedContainer) (section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd)) + + DECLARE Lines AS array of array of bytes + + DECLARE TextBuffer AS array of bytes + + DECLARE PreviousChar AS byte + + SET Lines TO resizable array of array of bytes + + SET TextBuffer TO resizable array of bytes + + FOR EACH Char IN Text + + IF Char = 0x0D OR (Char = 0x0A AND PreviousChar != 0x0D) THEN + + APPEND Lines WITH TextBuffer + + SET TextBuffer TO resizable array of bytes + + ELSE + + IF Char != 0x0A THEN + + APPEND TextBuffer WITH Char + + END IF + + SET PreviousChar TO Char + + END FOR + + APPEND Lines WITH TextBuffer + + FOR EACH Line IN Lines + + IF NOT Line starts with “attribute” when ignoring case THEN + + APPEND Buffer WITH Line + + END IF + + END FOR + + END FOR + + RETURN Buffer + + END FUNCTION + +#### Forms Normalized Data + +The Contents Hash algorithm produces an array of bytes as output: + +**FormsNormalizedData(Variable)**: A Buffer containing a variable number of bytes that contains the normalized representation of the **Designer Storages** portion of the **VBAStorage**. + +**FormsNormalizedData** is generated by the following pseudocode: + +644. FUNCTION NormalizeStorage + + PARAMETERS Storage AS [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) + + RETURNS array of bytes + + DECLARE StorageBuffer AS array of bytes + + SET StorageBuffer TO resizable array of bytes + + FOR EACH StorageElement ([**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) or storage) IN Storage + + IF StorageElement is a stream THEN + + DECLARE TempBuffer AS array of bytes + + DECLARE TempBufferIndex AS integer + + SET TempBuffer TO array of bytes(1023) initialized to 0 + + SET TempBufferIndex TO 0 + + FOR EACH StreamByte IN StorageElement + + SET TempBuffer\[TempBufferIndex\] TO StreamByte + + SET TempBufferIndex TO TempBufferIndex + 1 + + IF TempBufferIndex = 1023 OR StorageElement.EndOfStream + + APPEND StorageBuffer WITH TempBuffer ' full 1023 bytes + + SET TempBuffer TO array of bytes(1023) initialized to 0 + + SET TempBufferIndex TO 0 + + END IF + + END FOR + + ELSE IF StorageElement is a storage THEN + + APPEND StorageBuffer WITH NormalizeStorage(StorageElement) + + END IF + + END FOR + + RETURN StorageBuffer + + END FUNCTION + + FUNCTION NormalizeDesignerStorage + + FOR EACH StorageElement (stream or storage) IN DesignerStorage + + IF StorageElement is a stream THEN + + DECLARE TempBuffer AS array of bytes + + DECLARE TempBufferIndex AS integer + + SET TempBuffer TO array of bytes(1023) initialized to 0 + + SET TempBufferIndex TO 0 + + FOR EACH StreamByte IN StorageElement + + SET TempBuffer\[TempBufferIndex\] TO StreamByte + + SET TempBufferIndex TO TempBufferIndex + 1 + + IF TempBufferIndex = 1023 OR StorageElement.EndOfStream + + APPEND Buffer WITH TempBuffer ' full 1023 bytes + + SET TempBuffer TO array of bytes(1023) initialized to 0 + + SET TempBufferIndex TO 0 + + END IF + + END FOR + + ELSE IF StorageElement is a storage THEN + + APPEND Buffer WITH NormalizeStorage(StorageElement) + + END IF + + END FOR + + END FUNCTION + + FUNCTION FormsNormalizedData + + PARAMETERS DesignerStorage AS Designer Storage (section [2.2.10](#Section_f614ae641b3d47bea1660e10b8230026)), ProjectStream AS PROJECT Stream (section [2.3.1](#Section_d88cb9d8a475423db370cc0caaf78628)) + + RETURNS array of bytes + + DECLARE Buffer AS array of bytes + + SET Buffer TO resizable array of bytes + + FOR EACH ProjectDesignerModule (section [2.3.1.7](#Section_eee17583018744d7a23504b0d144696f)) IN ProjectStream + +  NormalizeDesignerStorage(ProjectDesignerModule) + + END FOR + + RETURN Buffer + + END FUNCTION + +#### Content Hash + +The Content Hash algorithm produces an array of bytes as output: + +**CryptographicDigest(16 bytes)**: The cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62) of **VBAStorage**. + +**CryptographicDigest** is generated by the following pseudocode: + +740. SET CryptographicDigest TO the cryptographic digest of the ContentNormalizedData Buffer, as generated in the **Content Normalized Data** (section [2.4.2.1](#Section_db76baa971254509b03fb69665781a7e)), as specified by the hashing algorithm. + +#### Agile Content Hash + +The Agile Content Hash algorithm produces an array of bytes as output: + +**CryptographicDigest(Variable)**: The cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62) of **VBAStorage**. + +CryptographicDigest is generated by the following pseudocode: + +741. Set ContentBuffer TO a resizable array of bytes + + APPEND ContentBuffer WITH the ContentNormalizedData Buffer, as generated in Content Normalized Data (section [2.4.2.1](#Section_db76baa971254509b03fb69665781a7e)). + + APPEND ContentBuffer WITH the FormsNormalizedData Buffer, as generated in the **Forms Normalized Data** (section [2.4.2.2](#Section_a2081b9aeb4147c38d2b3405425414ad)). + + SET CryptographicDigest TO the cryptographic digest of ContentBuffer as specified by the hashing algorithm. + +#### V3 Content Normalized Data + +The V3 Contents Normalized Data algorithm produces an array of bytes as output:  + +**ContentNormalizedData(Variable)**: A Buffer containing a variable number of bytes that contains the normalized representation of the **VBAStorage**.  + +**V3ContentNormalizedData** is generated by the following pseudocode:  + +748. FUNCTION V3ContentNormalizedData  + +     PARAMETERS Storage AS VBA Storage (section [2.3.4](#Section_170f52a04cd64729b51ad08155cbd213))    + +     RETURNS array of bytes  + +     + +     DECLARE Buffer AS array of bytes  + +     SET Buffer TO resizable array of bytes  + +     + + APPEND Buffer WITH PROJECTSYSKIND.Id (section [2.3.4.2.1.1](#projectsyskind-record)) of Storage  + + APPEND Buffer WITH PROJECTSYSKIND.Size (section 2.3.4.2.1.1) of Storage  + +   + + APPEND Buffer WITH PROJECTLCID.Id (section [2.3.4.2.1.3](#projectlcid-record)) of Storage  + + APPEND Buffer WITH PROJECTLCID.Size (section 2.3.4.2.1.3) of Storage  + + APPEND Buffer WITH PROJECTLCID.Lcid (section 2.3.4.2.1.3) of Storage  + +   + + APPEND Buffer WITH PROJECTLCIDINVOKE.Id (section [2.3.4.2.1.4](#projectlcidinvoke-record)) of Storage  + + APPEND Buffer WITH PROJECTLCIDINVOKE.Size (section 2.3.4.2.1.4) of Storage  + + APPEND Buffer WITH PROJECTLCIDINVOKE.LcidInvoke (section 2.3.4.2.1.4) of Storage  + +   + + APPEND Buffer WITH PROJECTCODEPAGE.Id (section [2.3.4.2.1.5](#projectcodepage-record)) of Storage  + + APPEND Buffer WITH PROJECTCODEPAGE.Size (section 2.3.4.2.1.5) of Storage  + +   + + APPEND Buffer WITH PROJECTNAME.Id (section [2.3.4.2.1.6](#projectname-record)) of Storage  + + APPEND Buffer WITH PROJECTNAME.SizeOfProjectName (section 2.3.4.2.1.6) of Storage  + + APPEND Buffer WITH PROJECTNAME.ProjectName (section 2.3.4.2.1.6) of Storage  + +   + + APPEND Buffer WITH PROJECTDOCSTRING.Id (section [2.3.4.2.1.7](#projectdocstring-record)) of Storage + + APPEND Buffer WITH PROJECTDOCSTRING.SizeOfDocString (section 2.3.4.2.1.7) of Storage  + + APPEND Buffer WITH PROJECTDOCSTRING.Reserved (section 2.3.4.2.1.7) of Storage + + APPEND Buffer WITH PROJECTDOCSTRING.SizeOfDocStringUnicode (section 2.3.4.2.1.7) of Storage  + +   + + APPEND Buffer WITH PROJECTHELPFILEPATH.Id (section [2.3.4.2.1.8](#projecthelpfilepath-record)) of Storage  + + APPEND Buffer WITH PROJECTHELPFILEPATH.SizeOfHelpFile1 (section 2.3.4.2.1.8) of Storage  + + APPEND Buffer WITH PROJECTHELPFILEPATH.Reserved (section 2.3.4.2.1.8) of Storage  + + APPEND Buffer WITH PROJECTHELPFILEPATH.SizeOfHelpFile2 (section 2.3.4.2.1.8) of Storage  + +   + + APPEND Buffer WITH PROJECTHELPCONTEXT.Id (section [2.3.4.2.1.9](#projecthelpcontext-record)) of Storage  + + APPEND Buffer WITH PROJECTHELPCONTEXT.Size (section 2.3.4.2.1.9) of Storage  + +   + + APPEND Buffer WITH PROJECTLIBFLAGS.Id (section [2.3.4.2.1.10](#projectlibflags-record)) of Storage  + + APPEND Buffer WITH PROJECTLIBFLAGS.Size (section 2.3.4.2.1.10) of Storage  + + APPEND Buffer WITH PROJECTLIBFLAGS.ProjectLibFlags (section 2.3.4.2.1.10) of Storage  + +   + + APPEND Buffer WITH PROJECTVERSION.Id (section [2.3.4.2.1.11](#projectversion-record)) of Storage  + + APPEND Buffer WITH PROJECTVERSION.Reserved (section 2.3.4.2.1.11) of Storage  + + APPEND Buffer WITH PROJECTVERSION.VersionMajor (section 2.3.4.2.1.11) of Storage  + + APPEND Buffer WITH PROJECTVERSION.VersionMinor (section 2.3.4.2.1.11) of Storage  + +   + + APPEND Buffer WITH PROJECTCONSTANTS.Id (section [2.3.4.2.1.12](#projectconstants-record)) of Storage  + + APPEND Buffer WITH PROJECTCONSTANTS.SizeOfConstants (section 2.3.4.2.1.12) of Storage  + + APPEND Buffer WITH PROJECTCONSTANTS.Constants (section 2.3.4.2.1.12) of Storage  + + APPEND Buffer WITH PROJECTCONSTANTS.Reserved (section 2.3.4.2.1.12) of Storage  + + APPEND Buffer WITH PROJECTCONSTANTS.SizeOfConstantsUnicode (section 2.3.4.2.1.12) of Storage  + + APPEND Buffer WITH PROJECTCONSTANTS.ConstantsUnicode (section 2.3.4.2.1.12) of Storage  + +   + + FOR EACH REFERENCE (section [2.3.4.2.2.1](#reference-record)) IN PROJECTREFERENCES.ReferenceArray (section [2.3.4.2.2](#projectreferences-record)) of Storage  + + APPEND Buffer WITH REFERENCENAME.Id (section [2.3.4.2.2.2](#referencename-record))  + + APPEND Buffer WITH REFERENCENAME.SizeOfName (section 2.3.4.2.2.2)  + + APPEND Buffer WITH REFERENCENAME.Name (section 2.3.4.2.2.2)  + + APPEND Buffer WITH REFERENCENAME.Reserved (section 2.3.4.2.2.2)  + + APPEND Buffer WITH REFERENCENAME.SizeOfNameUnicode (section 2.3.4.2.2.2)  + + APPEND Buffer WITH REFERENCENAME.NameUnicode (section 2.3.4.2.2.2)  + + IF REFERENCE.ReferenceRecord.Id = 0x002F THEN  + + APPEND Buffer with REFERENCE.ReferenceControl.Id (section [2.3.4.2.2.3](#referencecontrol-record))  + + APPEND Buffer with REFERENCE.ReferenceControl.SizeOfLibidTwiddled (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.LibidTwiddled (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.Reserved1 (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.Reserved2 (section 2.3.4.2.2.3)  + + IF exists REFERENCE.ReferenceControl.NameRecordExtended (section 2.3.4.2.2.2) THEN + + APPEND Buffer WITH REFERENCE.ReferenceControl.NameRecordExtended.Id (section 2.3.4.2.2.2)   + + APPEND Buffer WITH REFERENCE.ReferenceControl.NameRecordExtended.Size (section 2.3.4.2.2.2) + + APPEND Buffer WITH REFERENCE.ReferenceControl.NameRecordExtended.Name (section 2.3.4.2.2.2)  + + END IF + + IF exists REFERENCE.ReferenceControl.NameRecordExtended.Reserved (section 2.3.4.2.2.2) THEN + + APPEND Buffer WITH REFERENCE.ReferenceControl.NameRecordExtended.Reserved (section 2.3.4.2.2.2)  + + APPEND Buffer WITH REFERENCE.ReferenceControl.NameRecordExtended.SizeOfNameUnicode (section 2.3.4.2.2.2)  + + APPEND Buffer WITH REFERENCE.ReferenceControl.NameRecordExtended.NameUnicode (section 2.3.4.2.2.2)  + + END IF + + APPEND Buffer with REFERENCE.ReferenceControl.Reserved3 (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.SizeOfLibidExtended (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.LibidExtended (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.Reserved4 (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.Reserved5 (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.OriginalTypeLib (section 2.3.4.2.2.3)  + + APPEND Buffer with REFERENCE.ReferenceControl.Cookie (section 2.3.4.2.2.3)  + + ELSE IF REFERENCE.ReferenceRecord.Id = 0x0033 THEN  + + APPEND Buffer with REFERENCE.ReferenceOriginal.Id (section [2.3.4.2.2.4](#referenceoriginal-record))  + + APPEND Buffer with REFERENCE.ReferenceOriginal.SizeOfLibidOriginal (section 2.3.4.2.2.4)  + + APPEND Buffer with REFERENCE.ReferenceOriginal.LibidOriginal (section 2.3.4.2.2.4)  + + ELSE IF REFERENCE.ReferenceRecord.Id = 0x000D THEN  + + APPEND Buffer with REFERENCE.ReferenceRegistered.Id (section [2.3.4.2.2.5](#referenceregistered-record))  + + APPEND Buffer with REFERENCE.ReferenceRegistered.SizeOfLibid (section 2.3.4.2.2.5)  + + APPEND Buffer with REFERENCE.ReferenceRegistered.Libid (section 2.3.4.2.2.5)  + + APPEND Buffer with REFERENCE.ReferenceRegistered.Reserved1 (section 2.3.4.2.2.5)  + + APPEND Buffer with REFERENCE.ReferenceRegistered.Reserved2 (section 2.3.4.2.2.5)  + + ELSE IF REFERENCE.ReferenceRecord.Id = 0x000E THEN   + + APPEND Buffer with REFERENCE.ReferenceProject.Id (section [2.3.4.2.2.6](#referenceproject-record))  + + APPEND Buffer with REFERENCE.ReferenceProject.SizeOfLibidAbsolute (section 2.3.4.2.2.6)  + + APPEND Buffer with REFERENCE.ReferenceProject.LibidAbsolute (section 2.3.4.2.2.6)  + + APPEND Buffer with REFERENCE.ReferenceProject.SizeOfLibidRelative (section 2.3.4.2.2.6)  + + APPEND Buffer with REFERENCE.ReferenceProject.LibidRelative(section 2.3.4.2.2.6)  + + APPEND Buffer with REFERENCE.ReferenceProject.MajorVersion(section 2.3.4.2.2.6)  + + APPEND Buffer with REFERENCE.ReferenceProject.MinorVersion (section 2.3.4.2.2.6)  + + END IF   + + END FOR  + +   + +     APPEND Buffer WITH PROJECTMODULES.Id (section [2.3.4.2.3](#projectmodules-record)) of Storage  + +     APPEND Buffer WITH PROJECTMODULES.Size (section 2.3.4.2.3) of Storage  + +     APPEND Buffer WITH PROJECTCOOKIE.Id (section [2.3.4.2.3.1](#projectcookie-record)) of Storage  + +     APPEND Buffer WITH PROJECTCOOKIE.Size (section 2.3.4.2.3.1) of Storage  + +   + +     DEFINE DefaultAttributes AS array of constant char array  + +         "Attribute VB_Base = \\0{00020820-0000-0000-C000-000000000046}\\",  + +         "Attribute VB_GlobalNameSpace = False",  + +         "Attribute VB_Creatable = False",  + +         "Attribute VB_PredeclaredId = True",  + +         "Attribute VB_Exposed = True",  + +         "Attribute VB_TemplateDerived = False",  + +         "Attribute VB_Customizable = True"  + +   + +     FOR EACH MODULE (section [2.3.4.2.3.2](#module-record)) IN PROJECTMODULES.Modules (section 2.3.4.2.3) of Storage + +     IF MODULE.TypeRecord.Id = 0x21 THEN + +     APPEND Buffer WITH MODULE.TypeRecord.Id (section [2.3.4.2.3.2.8](#moduletype-record)) + +     APPEND Buffer WITH MODULE.TypeRecord.Reserved (section 2.3.4.2.3.2.8) + +     END IF + +     IF MODULE.ReadOnlyRecord exists THEN + +     APPEND Buffer WITH MODULE.ReadOnlyRecord.Id (section [2.3.4.2.3.2.9](#modulereadonly-record)) + +     APPEND Buffer WITH MODULE.ReadOnlyRecord.Reserved (section 2.3.4.2.3.2.9) + +     END IF + +     IF MODULE.PrivateRecord exists THEN + +     APPEND Buffer WITH MODULE.PrivateRecord.Id (section [2.3.4.2.3.2.10](#moduleprivate-record)) + +     APPEND Buffer WITH MODULE.PrivateRecord.Reserved (section 2.3.4.2.3.2.10) + +     END IF + +   + + DEFINE CompressedContainer AS array of bytes   + +        DEFINE Text AS array of bytes  + +        SET CompressedContainer TO ModuleStream.CompressedSourceCode   + +        SET Text TO result of Decompression(CompressedContainer) (section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd))   + +        + +        DECLARE Lines AS array of array of bytes   + +        DECLARE TextBuffer AS array of bytes + +    DECLARE PreviousChar AS byte + +        SET Lines TO resizable array of array of bytes   + +        SET TextBuffer TO resizable array of bytes   + +     + +        FOR EACH Char IN Text   + +           IF Char = 0x0D OR (Char = 0x0A AND PreviousChar != 0x0D) THEN   + +              APPEND Lines WITH TextBuffer   + +              SET TextBuffer TO resizable array of bytes + + ELSE IF Char = 0x0A AND PreviousChar = 0x0D THEN + + CONTINUE + +           ELSE   + +               APPEND TextBuffer WITH Char   + +          END IF + + SET PreviousChar TO Char   + +        END FOR   + + APPEND Lines WITH TextBuffer + +   + +       DEFINE HashModuleNameFlag AS bool  + +        FOR EACH Line IN Lines   + +           IF Line NOT start with “attribute” when ignoring case THEN   + +             SET HashModuleNameFlag TO true  + +             APPEND Buffer WITH Line   + +             APPEND Buffer WITH LF  + +          ELSE IF Line starts with “Attribute VB_Name = ” when ignoring case THEN  + +            CONTINUE  + +           ELSE IF Line not same with any one of DefaultAttributes THEN  + +             SET HashModuleNameFlag TO true   + +             APPEND Buffer WITH Line  + +             APPEND Buffer WITH LF  + +        END FOR   + +        IF HashModuleNameFlag IS true  + +           IF exist MODULE.NameUnicodeRecord.ModuleNameUnicode + +             APPEND Buffer WITH MODULE.NameUnicodeRecord.ModuleNameUnicode (section [2.3.4.2.3.2.2](#modulenameunicode-record)) + +           ELSE IF exist MODULE.NameRecord.ModuleName + +           APPEND Buffer WITH MODULE.NameRecord.ModuleName (section [2.3.4.2.3.2.1](#modulename-record))  + +           END IF + +           APPEND Buffer WITH LF  + +        END IF  + + END FOR  + +       + +    APPEND Buffer WITH Terminator (section [2.3.4.2](#dir-stream-version-independent-project-information)) of Storage  + + APPEND Buffer WITH Reserved (section 2.3.4.2) of Storage  + +   + +    RETURN Buffer   + +     + + END FUNCTION + +#### Project Normalized Data + +The Contents Hash algorithm produces an array of bytes as output:  + +**ProjectNormalizedData(Variable)**: A Buffer containing a variable number of bytes that contains the normalized representation of the PROJECT Stream (section [2.3.1](#project-stream-project-information)) portion of the **VBAStorage**.  + +**ProjectNormalizedData** is generated by the following pseudocode:  + +923. FUNCTION NormalizeProjectStream  + + PARAMETERS Stream AS stream  + + RETURNS array of bytes  + + DECLARE Buffer AS array of bytes  + + SET Buffer TO resizable array of bytes  + +   + + FOR EACH property in ProjectProperties (section [2.3.1.1](#Section_e4e51a4a6873405995bc2be4d8fc5d44))  + + IF property is ProjectDesignerModule THEN + + APPEND Buffer WITH output of NormalizeDesignerStorage(ProjectDesignerModule) (section [2.4.2.2](#Section_a2081b9aeb4147c38d2b3405425414ad)) + + END IF + + IF property NOT is ProjectId (section [2.3.1.2](#Section_20f4aad3b646431183015948fb1c2ded)) OR ProjectDocModule (section [2.3.1.4](#Section_f58d24a823504fab8d1e3861f112b786)) OR ProjectProtectionState (section [2.3.1.15](#Section_55e770e2e1a44d1ca8a4dcfca27d6663)) OR ProjectPassword (section [2.3.1.16](#Section_7968542630fe43cd9cbf7f161c3de7d8)) OR ProjectVisibilityState (section [2.3.1.17](#Section_690c96e8e862497fbb7d5eacf4dc742a)) THEN  + + APPEND Buffer WITH property name  + + APPEND Buffer WITH property value  + + END IF  + + END FOR  + + IF exist string “\[Host Extender Info\]” THEN + + APPEND Buffer WITH the string “Host Extender Info” + + APPEND Buffer WITH HostExtenderRef without NWLN (section [2.3.1.18](#Section_9b5165d1c585425c8d55605d11bdbca0)) + + END IF + + END FUNCTION + +#### V3 Content Hash + +The V3 Content Hash algorithm produces an array of bytes as output:  + +**CryptographicDigest(Variable)**: The cryptographic digest of **VBAStorage**.  + +**CryptographicDigest** is generated by the following pseudocode:  + +944. Set ContentBuffer TO a resizable array of bytes  + + APPEND ContentBuffer WITH the **V3ContentNormalizedData** Buffer, as generated in **V3 Content Normalized Data** (section [2.4.2.5](#Section_becd5647d4e94d7dab86484421a086eb)).  + + APPEND ContentBuffer WITH the ProjectNormalizedData Buffer, as generated in the Project Normalized Data (section [2.4.2.6](#Section_eda9d57aa862492795546750dada9b37)).  + + SET CryptographicDigest TO the cryptographic digest of ContentBuffer as specified by the hashing algorithm.  + +### Data Encryption + +VBA uses a reversible encryption algorithm for selected data. + +Conventions: + +- XOR specifies a bit-wise exclusive OR operation. + +- BAND specifies a bit-wise AND operation. + +- All operations resulting in integer overflow MUST only store low-order bits, resulting in high-order bit truncation. + +#### Encrypted Data Structure + +Specifies encrypted data. This structure has the following format. + +[TABLE] + +**Seed (1 byte):** Specifies the encryption seed. + +**VersionEnc (1 byte):** Encrypted as specified in section [2.4.3.2](#Section_1ad481e07df44caca9a49c29a1340123). Specifies the encryption version. + +**ProjKeyEnc (1 byte):** Encrypted as specified in section 2.4.3.2. Specifies the project-specific encryption key. + +**IgnoredEnc (variable):** Encrypted as specified in section 2.4.3.2. An array of arbitrary bytes for obfuscation. + +**DataLengthEnc (4 bytes):** Encrypted as specified in section 2.4.3.2. Specifies the length in bytes of **DataEnc**. + +**DataEnc (variable):** Encrypted as specified in section 2.4.3.2. Specifies the data encrypted by the algorithm. + +#### Encryption + +This encryption accepts two parameters as input: + +**Data (Variable):** An array of bytes to be obfuscated. + +**Length (4 bytes):** An unsigned integer that specifies the length of **Data**. + +The algorithm will yield an array of bytes as defined in [Encrypted Data Structure](#Section_a2ad3aa7e1804ccb85117e0eb49a0ad9) (section 2.4.3.1). + +To encrypt **Data**, an implementation MUST maintain the following states: + +**UnencryptedByte1 (1 byte):** Specifies the last unencrypted byte read or written. + +**EncryptedByte1 (1 byte):** Specifies the last encrypted byte read or written. + +**EncryptedByte2 (1 byte):** Specifies the next-to-last encrypted byte read or written. + +**Version (1 byte):** Specifies the encryption version. + +**ProjKey (1 byte):** Specifies a project-specific encryption key. + +**IgnoredLength (1 byte):** Specifies the length in bytes of **IgnoredEnc**. + +Each field MUST be encrypted in the following order: + +**VersionEnc** is calculated using the following formula: + +948. VersionEnc = Seed XOR Version + +Version MUST be 2. + +**ProjKey** is the checksum of the project identifier as computed by the following pseudocode: + +949. SET **ProjKey** TO 0. + + FOR each **CharacterByte** IN the string [ProjectId](#Section_20f4aad3b646431183015948fb1c2ded).ProjectCLSID (section 2.3.1.2). + + ADD **CharacterByte** TO **ProjKey**. + + END FOR + +**ProjKeyEnc** is calculated using the following formula: + +956. ProjKeyEnc = Seed XOR ProjKey + +Initialize states for the rest of the encoding: + +957. SET UnencryptedByte1 TO ProjKey. + + SET EncryptedByte1 TO ProjKeyEnc. + + SET EncryptedByte2 TO VersionEnc . + +**IgnoredEnc** is computed by the following pseudocode: + +962. SET **IgnoredLength** TO (Seed BAND 6) / 2. + + FOR Counter FROM 1 TO **IgnoredLength** INCLUSIVE: + + SET **TempValue** TO any value. + + SET **ByteEnc** TO (**TempValue** XOR (EncryptedByte2 + UnencryptedByte1)). + + APPEND **IgnoredEnc** WITH **ByteEnc**. + + SET **EncryptedByte2** TO **EncryptedByte1**. + + SET **EncryptedByte1** TO **ByteEnc**. + + SET **UnencryptedByte1** TO **TempValue**. + + END FOR + +**DataLengthEnc** is computed by the following pseudocode: + +974. FOR each **Byte** IN **Length** in little endian order: + + SET **ByteEnc** TO (Byte XOR (EncryptedByte2 + UnencryptedByte1)). + + APPEND **DataLengthEnc** WITH **ByteEnc**. + + SET **EncryptedByte2** TO **EncryptedByte1**. + + SET **EncryptedByte1** TO **ByteEnc**. + + SET **UnencryptedByte1** TO **Byte**. + + END FOR + +**DataEnc** is computed by the following pseudocode: + +987. FOR each **DataByte** IN **Data**: + + SET **ByteEnc** TO (DataByte XOR (EncryptedByte2 + UnencryptedByte1)). + + APPEND **DataEnc** WITH **ByteEnc**. + + SET **EncryptedByte2** TO **EncryptedByte1**. + + SET **EncryptedByte1** TO **ByteEnc**. + + SET **UnencryptedByte1** TO **DataByte**. + + END FOR + +#### Decryption + +This decryption algorithm accepts an [Encrypted Data Structure](#Section_a2ad3aa7e1804ccb85117e0eb49a0ad9) (section 2.4.3.1) as input and will yield: + +**Length (4 bytes):** An unsigned integer that specifies the length of **Data**. + +**Data (variable):** An array of unencrypted bytes. + +To decrypt **Data** from an Encrypted Data Structure (section 2.4.3.1), an implementation MUST maintain the following states: + +**UnencryptedByte1 (1 byte):** Specifies the last unencrypted byte read or written. + +**EncryptedByte1 (1 byte):** Specifies the last encrypted byte read or written. + +**EncryptedByte2 (1 byte):** Specifies the next-to-last encrypted byte read or written. + +**Version (1 byte):** Specifies the encryption version. + +**ProjKey (1 byte):** Specifies a project-specific encryption key. + +**IgnoredLength (1 byte):** Specifies the length in bytes of **IgnoredEnc**. + +MUST decrypt in order as follows. + +Version is calculated using the following formula. + +1000. Version = Seed XOR VersionEnc + +Version MUST be 2. + +ProjKey is calculated using the following formula. + +1001. ProjKey = Seed XOR ProjKeyEnc + +To initialize states for the rest of the encoding: + +1002. SET UnencryptedByte1 TO ProjKey. + + SET EncryptedByte1 TO ProjKeyEnc. + + SET EncryptedByte2 TO VersionEnc. + +The length of **IgnoredEnc** is computed as follows. + +1007. IgnoredLength = (Seed BAND 6) / 2 + +Decrypting of **IgnoredEnc** MUST be as follows. + +1008. FOR each ByteEnc IN IgnoredEnc: + + SET Byte TO (ByteEnc XOR (EncryptedByte2 + UnencryptedByte1)). + + SET EncryptedByte2 TO EncryptedByte1. + + SET EncryptedByte1 TO ByteEnc. + + SET UnencryptedByte1 TO Byte. + + END FOR + +**Length** is computed by the following pseudocode. + +1019. SET **ByteIndex** TO zero. + + FOR each **ByteEnc** IN **DataLengthEnc**: + + SET **Byte** TO (ByteEnc XOR (EncryptedByte2 + UnencryptedByte1)). + + SET **TempValue** TO 256 raised to the power of **ByteIndex**. + + MULTIPLY **TempValue** by **Byte**. + + ADD **TempValue** TO **Length**. + + SET **EncryptedByte2** TO **EncryptedByte1**. + + SET **EncryptedByte1** TO **ByteEnc**. + + SET **UnencryptedByte1** TO **Byte**. + + INCREMENT **ByteIndex** + + END FOR + +**Length** is equal to the length of **DataEnc**. + +**Data** is computed using the following pseudocode. + +1040. FOR each **ByteEnc** IN **DataEnc**: + + SET **Byte** TO (ByteEnc XOR (EncryptedByte2 + UnencryptedByte1)). + + APPEND **Data** WITH **Byte**. + + SET **EncryptedByte2** TO **EncryptedByte1**. + + SET **EncryptedByte1** TO **ByteEnc**. + + SET **UnencryptedByte1** TO **Byte**. + + END FOR + +### Password Hash + +[**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) employs a custom format for storing a password hash, obfuscating the password with random data. That random data is stored with the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) so the hash can be verified without the need to store the original password string. + +#### Password Hash Data Structure + +The password data structure specifies a password hash and additional random byte data to obfuscate the hash. + +[TABLE] + +**Reserved (1 byte):** MUST be 0xFF. MUST be ignored. + +**GrbitKey (4 bits):** Each bit specifies a corresponding null byte of **Key** as specified by [Encode Nulls](#Section_6d770a4ed3174094afd064863ebed72a) (section 2.4.4.2). + +**GrbitHashNull (20 bits):** Each bit specifies a corresponding null byte of **PasswordHash** as specified by Encode Nulls (section 2.4.4.2). + +**KeyNoNulls (4 bytes):** Specifies the **Key** for the [Password Hash Algorithm](#Section_4370bcd916644428a4c6fca56aa7d7f1) (section 2.4.4.4) with null bytes removed as specified by Encode Nulls (section 2.4.4.2). **Key** is any value. + +**Key** is encoded into **KeyNoNulls** as specified by the following pseudocode: + +1053. CALL Encode Nulls (section 2.4.4.2) with Key RETURNING GrbitKey and KeyNoNulls + +Decoding is specified by the following pseudocode: + +1054. CALL [Decode Nulls](#Section_5797c2e14c864f4489b41edb30da00cc) (section 2.4.4.3) with KeyNoNulls and GrbitKey RETURNING Key + +**PasswordHashNoNulls (20 bytes):** Specifies the **PasswordHash** result of the Password Hash Algorithm (section 2.4.4.4) with null bytes removed as specified by Encode Nulls (section 2.4.4.2). + +**PasswordHash** is the 160-bit cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62) of a password combined with **Key** as specified by Password Hash Algorithm (section 2.4.4.4). + +Encoding is specified by the following pseudocode: + +1055. CALL Encode Nulls (section 2.4.4.2) with PasswordHash RETURNING GrbitHashNull and PasswordHashNoNulls + +Decoding is specified by the following pseudocode: + +1056. CALL Decode Nulls (section 2.4.4.3) with PasswordHashNoNulls and GrbitHashNull RETURNING PasswordHash + +**Terminator (1 byte)**: MUST be 0x00. + +#### Encode Nulls + +The Password Hash stores **Key** and **PasswordHash** with null bytes removed. The fields are encoded by replacing 0x00 bytes with 0x01 and setting a bit on the bit-fields **GrbitKey** and **GrbitHashNull**, respectively. + +This algorithm accepts the following as parameters: + +**InputBytes (variable):** An input array of bytes to be encoded. + +**GrbitNull (variable):** An output array of bits specifying null bytes in **InputBytes**. + +**EncodedBytes (variable):** An output array of encoded bytes. + +Encoding is computed by the following pseudocode: + +1057. FOR each **Byte** IN **InputBytes**: + + IF **Byte** EQUALS 0x00 THEN: + + APPEND **EncodedBytes** WITH 0x01. + + APPEND **GrbitNull** WITH one bit set to FALSE. + + ELSE: + + APPEND **EncodedBytes** WITH **Byte**. + + APPEND **GrbitNull** WITH one bit set to TRUE. + + END IF + + END FOR + +#### Decode Nulls + +The Password Hash stores **Key** and **PasswordHash** with null bytes removed as specified by [Encode Nulls](#Section_6d770a4ed3174094afd064863ebed72a) (section 2.4.4.2). The fields are decoded by reading bit-fields **GrbitKey** and **GrbitHashNull**, and replacing corresponding bytes in **Key** and **PasswordHash** with 0x00. + +This algorithm accepts the following as parameters: + +**EncodedBytes (variable):** An input array of bytes to be encoded. + +**GrbitNull (variable):** An input array of bits specifying null bytes in **DecodedBytes**. + +**DecodedBytes (variable):** An output array of encoded bytes. + +Decoding is computed by the following pseudocode: + +1074. SET **Index** TO 0. + + FOR each **Bit** IN **GrbitNull**: + + IF **Bit** EQUALS FALSE THEN: + + APPEND **DecodedBytes** WITH 0x00. + + ELSE: + + APPEND **DecodedBytes** WITH EncodedBytes\[Index\]. + + END IF + + INCREMENT **Index**. + + END FOR + +#### Password Hash Algorithm + +This Password Hash Algorithm accepts the following as parameters: + +**Password (Variable):** An array of bytes to be obfuscated. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified by [**PROJECTCODEPAGE**](#projectcodepage-record) (section 2.3.4.2.1.5). + +**Key (4 Bytes):** An array of 4 bytes of any value. + +When comparing a new password to an old cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62), MUST be the same value as stored in the old password’s **[Password Hash Data Structure](#Section_9d9f81e6f92e4338a242d38c1fcceed6).Key** (section [2.4.4](#Section_ec1b8759522b46d4bff537ed2b1f2ebb)). + +The algorithm will yield **PasswordHash**, an array of 20 bytes. + +The pseudocode for computing the hash is as follows: + +1091. LET **BytesToHash** be a variable array of bytes. + + APPEND **BytesToHash** WITH **Password**. + + APPEND **BytesToHash** WITH **Key**. + +SET **PasswordHash** TO the [**SHA-1**](#gt_fd3168c9-145e-49ad-ba80-2b838a184cbd) cryptographic digest of **BytesToHash**, as specified by [\[RFC3174\]](https://go.microsoft.com/fwlink/?LinkId=90408). + +#### Password Hash Validation + +To verify a password against the stored hash, a new password hash MUST be generated using the same **Key** as the existing password. The new hash can then be compared to the hash in the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +Validation accepts the following as parameters: + +**NewPassword (Variable):** An array of bytes specifying a password to validate. MUST contain [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters encoded using the [**code page**](#gt_210637d9-9634-4652-a935-ded3cd434f38) specified by [**PROJECTCODEPAGE**](#projectcodepage-record) (section 2.3.4.2.1.5). + +**Key (4 bytes):** An array of 4 bytes. MUST be the value stored in **[Password Hash Data Structure](#Section_9d9f81e6f92e4338a242d38c1fcceed6).Key** (section [2.4.4](#Section_ec1b8759522b46d4bff537ed2b1f2ebb)). + +**OldPasswordHash (20 bytes):** A cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62). MUST be the value stored in **Password Hash Data Structure.PasswordHash** (section 2.4.4). + +The algorithm yields a Boolean value, **Valid**, specifying that **NewPassword** is valid. + +Validation is computed by the following pseudocode: + +1096. LET **NewHash** be an array of 20 bytes. + + CALL [Password Hash Algorithm](#Section_4370bcd916644428a4c6fca56aa7d7f1) (section 2.4.4.4) with **NewPassword** and Key RETURNING **NewHash**. + + IF **NewHash** EQUALS **OldPasswordHash** THEN: + + SET **Valid** TO TRUE. + + ELSE: + + SET **Valid** TO FALSE. + + END IF + +# Structure Examples + +The following sections provide structure examples of features of this file format. Note that these examples are illustrative of this file format specification, and do not cover all possible structure usage scenarios. + +The examples in section [3.1](#Section_7490bb8844e74dc38ef8ec0ee956de9d) illustrate the structures of a single [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) [**storage**](#gt_63525252-3f66-4459-9b64-5b77f57b2f84) as it could be used in a workbook as described in [\[MS-XLS\]](%5bMS-XLS%5d.pdf#Section_cd03cb5fca024934a391bb674cb8aa06) section 2.1.7.18. + +The examples in section [3.2](#Section_01c4e617bdb04bcbaf3d4148297d9cf2) illustrate byte arrays that are compressed and decompressed by using the compression and decompression algorithms in section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd). Note that these examples are illustrative of this file format specification, and do not cover all possible usage scenarios. + +## VBA Storage Information Example + +### \_VBA_PROJECT Example + +The following table illustrates a [**\_VBA_PROJECT**](#vba_project-stream-version-dependent-project-information) (section 2.3.4.1) example that describes the version-dependent information for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 0007 | \_VBA_PROJECT Stream: Version Dependent Project Information **- \_VBA_PROJECT** | | +| 00000000 | 0002 | unsigned integer **- Reserved1** | 0x61CC | +| 00000002 | 0002 | unsigned integer **- Version** | 0xFFFF | +| 00000004 | 0001 | BYTE **- Reserved2** | 0x00 | +| 00000005 | 0002 | unsigned integer **- Reserved3** | 0x0001 | +| 00000007 | 0000 | Blob **- PerformanceCache** | | + +Figure 2: \_VBA_PROJECT stream + +**Version:** 0xFFFF specifies the version of VBA used to create the VBA project. Write this field as 0xFFFF. + +**PerformanceCache:** This record is empty on write. + +### dir Stream Example + +The following examples illustrate a [**dir**](#dir-stream-version-independent-project-information) (section 2.3.4.2) [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) for a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). The **dir** (section 2.3.4.2) stream examples describe project information, project [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f) and modules. The **dir** (section 2.3.4.2) stream ends with an unsigned integer, **Terminator**, and a **Reserved** field. + +#### Project Information Example + +The following example illustrates a [**PROJECTINFORMATION**](#projectinformation-record) (section 2.3.4.2.1) record for a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 0122 | PROJECTINFORMATION Record **- Information Record** | | +| 00000000 | 000A | [PROJECTSYSKIND Record](#projectsyskind-record) **- SysKindRecord** | | +| 00000000 | 0002 | unsigned integer **- Id** | 0x0001 | +| 00000002 | 0004 | unsigned integer **- Size** | 0x00000004 | +| 00000006 | 0004 | unsigned integer **- SysKind** | 0x00000001 | +| 0000000A | 000A | [PROJECTLCID Record](#projectlcid-record) **- LcidRecord** | | +| 0000000A | 0002 | unsigned integer **- Id** | 0x0002 | +| 0000000C | 0004 | unsigned integer **- Size** | 0x00000004 | +| 00000010 | 0004 | unsigned integer **- Lcid** | 0x00000409 | +| 00000014 | 000A | [PROJECTLCIDINVOKE Record](#projectlcidinvoke-record) **- LcidInvokeRecord** | | +| 00000014 | 0002 | unsigned integer **- Id** | 0x0014 | +| 00000016 | 0004 | unsigned integer **- Size** | 0x00000004 | +| 0000001A | 0004 | unsigned integer **- LcidInvoke** | 0x00000409 | +| 0000001E | 0008 | [PROJECTCODEPAGE Record](#projectcodepage-record) **- CodePageRecord** | | +| 0000001E | 0002 | unsigned integer **- Id** | 0x0003 | +| 00000020 | 0004 | unsigned integer **- Size** | 0x00000002 | +| 00000024 | 0002 | unsigned integer **- CodePage** | 0x04E4 | +| 00000026 | 0010 | [PROJECTNAME Record](#projectname-record) **- NameRecord** | | +| 00000026 | 0002 | unsigned integer **- Id** | 0x0004 | +| 00000028 | 0004 | unsigned integer **- SizeOfProjectName** | 0x0000000A | +| 0000002C | 000A | array of bytes **- ProjectName** | VBAProject | +| 00000036 | 0069 | [PROJECTDOCSTRING Record](#projectdocstring-record) **- DocStringRecord** | | +| 00000036 | 0002 | unsigned integer **- Id** | 0x0005 | +| 00000038 | 0004 | unsigned integer **- SizeOfDocString** | 0x0000001F | +| 0000003C | 001F | array of bytes **- DocString** | Example VBA Project Description | +| 0000005B | 0002 | unsigned integer **- Reserved** | 0x0040 | +| 0000005D | 0004 | unsigned integer **- SizeOfDocStringUnicode** | 0x0000003E | +| 00000061 | 003E | array of bytes **- DocStringUnicode** | Example VBA Project Description | +| 0000009F | 0042 | [PROJECTHELPFILEPATH Record](#projecthelpfilepath-record) **- HelpFilePathRecord** | | +| 0000009F | 0002 | unsigned integer **- Id** | 0x0006 | +| 000000A1 | 0004 | unsigned integer **- SizeOfHelpFile1** | 0x0000001B | +| 000000A5 | 001B | array of bytes **- HelpFile1** | c:\example path\example.hlp | +| 000000C0 | 0002 | unsigned integer **- Reserved** | 0x003D | +| 000000C2 | 0004 | unsigned integer **- SizeOfHelpFile2** | 0x0000001B | +| 000000C6 | 001B | array of bytes **- HelpFile2** | c:\example path\example.hlp | +| 000000E1 | 000A | [PROJECTHELPCONTEXT Record](#projecthelpcontext-record) **- HelpContextRecord** | | +| 000000E1 | 0002 | unsigned integer **- Id** | 0x0007 | +| 000000E3 | 0004 | unsigned integer **- Reserved** | 0x00000004 | +| 000000E7 | 0004 | unsigned integer **- HelpContext** | 0x00000001 | +| 000000EB | 000A | [PROJECTLIBFLAGS Record](#projectlibflags-record) **- LibFlagsRecord** | | +| 000000EB | 0002 | unsigned integer **- Id** | 0x0008 | +| 000000ED | 0004 | unsigned integer **- Size** | 0x00000004 | +| 000000F1 | 0004 | unsigned integer **- ProjectLibFlags** | 0x00000000 | +| 000000F5 | 000C | [PROJECTVERSION Record](#projectversion-record) **- VersionRecord** | | +| 000000F5 | 0002 | unsigned integer **- Id** | 0x0009 | +| 000000F7 | 0004 | unsigned integer **- Reserved** | 0x00000004 | +| 000000FB | 0004 | unsigned integer **- VersionMajor** | 0x49B5196B | +| 000000FF | 0002 | unsigned integer **- VersionMinor** | 0x0006 | +| 00000101 | 0021 | [PROJECTCONSTANTS Record](#projectconstants-record) **- ConstantsRecord** | | +| 00000101 | 0002 | unsigned integer **- Id** | 0x000C | +| 00000103 | 0004 | unsigned integer **- SizeOfConstants** | 0x00000007 | +| 00000107 | 0007 | array of bytes **- Constants** | abc = 1 | +| 0000010E | 0002 | unsigned integer **- Reserved** | 0x003C | +| 00000110 | 0004 | unsigned integer **- SizeOfConstantsUnicode** | 0x0000000E | +| 00000114 | 000E | array of bytes **- ConstantsUnicode** | abc = 1 | + +Figure 3: ProjectInformation record + +The preceding table illustrates a **PROJECTINFORMATION** (section 2.3.4.2.1) record. The **PROJECTINFORMATION** (section 2.3.4.2.1) record stores the VBA project’s properties. + +**SysKindRecord.SysKind:** 0x00000001 specifies this project is intended for the 32-bit Windows Platform. + +**CodePageRecord.CodePage:** 0x04E4 specifies 1252 - Western Latin code page. For more information, see specified in [\[MC-CPB\]](%5bMC-CPB%5d.pdf). + +**NameRecord.ProjectName:** "VBAProject" specifies the name of the VBA project in [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters. + +**DocStringRecord:** Specifies the description, "Example VBA Project Description" for the VBA project. The description of the project can be used to provide additional information about the project beyond the **ProjectName**. + +**DocStringRecord.DocString:** "Example VBA Project Description" specifies the description for the project in MBCS characters. + +**DocStringRecord.DocStringUnicode:** "Example VBA Project Description" specifies the description for the project in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. This value is equivalent to the **DocString** field value. + +**HelpFilePathRecord.HelpFile1:** "c:\example path\example.hlp" specifies the path to a [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) for this VBA project in MBCS characters. + +**HelpFilePathRecord.HelpFile2:** "c:\example path\example.hlp" specifies the path to a Help file for this VBA project in MBCS characters. + +**HelpContextRecord.HelpContext:** 0x00000001 specifies the [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) for the VBA project, which is the help topic the user will see when the **HelpFilePathRecord.HelpFile1** is requested. For example, if the user requested help for this context, the **HelpFilePathRecord.HelpFile1,** "c:\example path\example.hlp", would be opened and the user would see the help topic corresponding to the **HelpContext**, 1, in this example. + +**VersionRecord.VersionMajor:** 0x49B5196B specifies the major version of the VBA project. + +**VersionRecord.VersionMinor:** 0x0006 specifies the minor version of the VBA project. + +**ConstantsRecord:** Specifies [**compilation constants**](#gt_ae9af4b8-1ff1-4481-8738-f95640b41ec0) for the VBA project. **Constants** are used to conditionally compile code within the VBA project. The Constant, "abc = 1" from this example is illustrated in the [Sheet3.1.4 Decompressed Module Stream Example](#Section_ca44af2896d54c6f9ec661e2cfe81d64) (section 3.1.4). + +**ConstantsRecord.Constants:** "abc = 1" specifies the compilation constants for the VBA project in MBCS characters. + +**ConstantsRecord.ConstantsUnicode:** "abc = 1" specifies the compilation constants for the VBA project in Unicode characters. This value is equivalent to the **Constants** field value. + +#### Project Reference Information Example + +The following example illustrates the [**PROJECTREFERENCES**](#projectreferences-record) (section 2.3.4.2.2) record for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). This project includes four [**references**](#gt_d90284c0-f6d0-4576-83f8-69ed5a31d87f). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000122 | 0380 | VBA_Canonical_ReferenceArray **- ReferenceArray** | | +| 00000122 | 008C | [REFERENCE Record](#reference-record) **- Reference\[0\]** | | +| 00000122 | 001E | [REFERENCENAME Record](#referencename-record) **- NameRecord** | | +| 00000122 | 0002 | unsigned integer **- Id** | 0x0016 | +| 00000124 | 0004 | unsigned integer **- SizeOfName** | 0x00000006 | +| 00000128 | 0006 | array of bytes **- Name** | stdole | +| 0000012E | 0002 | unsigned integer **- Reserved** | 0x003E | +| 00000130 | 0004 | unsigned integer **- SizeOfNameUnicode** | 0x0000000C | +| 00000134 | 000C | array of bytes **- NameUnicode** | stdole | +| 00000140 | 006E | [REFERENCEREGISTERED Record](#referenceregistered-record) **- ReferenceRecord\[0\]** | | +| 00000140 | 0002 | unsigned integer **- Id** | 0x000D | +| 00000142 | 0004 | unsigned integer **- Size** | 0x00000068 | +| 00000146 | 0004 | unsigned integer **- SizeOfLibid** | 0x0000005E | +| 0000014A | 005E | array of bytes **- Libid** | \*\G{00020430-0000-0000-C000-000000000046}#2.0#0#C:\Windows\system32\stdole2.tlb#OLE Automation | +| 000001A8 | 0004 | unsigned integer **- Reserved1** | 0x00000000 | +| 000001AC | 0002 | unsigned integer **- Reserved2** | 0x0000 | +| 000001AE | 00C2 | REFERENCE Record **- Reference\[1\]** | | +| 000001AE | 001E | REFERENCENAME Record **- NameRecord** | | +| 000001AE | 0002 | unsigned integer **- Id** | 0x0016 | +| 000001B0 | 0004 | unsigned integer **- SizeOfName** | 0x00000006 | +| 000001B4 | 0006 | array of bytes **- Name** | Office | +| 000001BA | 0002 | unsigned integer **- Reserved** | 0x003E | +| 000001BC | 0004 | unsigned integer **- SizeOfNameUnicode** | 0x0000000C | +| 000001C0 | 000C | array of bytes **- NameUnicode** | Office | +| 000001CC | 00A4 | REFERENCEREGISTERED Record **- ReferenceRecord\[1\]** | | +| 000001CC | 0002 | unsigned integer **- Id** | 0x000D | +| 000001CE | 0004 | unsigned integer **- Size** | 0x0000009E | +| 000001D2 | 0004 | unsigned integer **- SizeOfLibid** | 0x00000094 | +| 000001D6 | 0094 | array of bytes **- Libid** | \*\G{2DF8D04C-5BFA-101B-BDE5-00AA0044DE52}#2.0#0#C:\Program Files\Common Files\Microsoft Shared\OFFICE12\MSO.DLL#Microsoft Office 12.0 Object Library | +| 0000026A | 0004 | unsigned integer **- Reserved1** | 0x00000000 | +| 0000026E | 0002 | unsigned integer **- Reserved2** | 0x0000 | +| 00000270 | 0091 | REFERENCE Record **- Reference\[2\]** | | +| 00000270 | 002D | REFERENCENAME Record **- NameRecord** | | +| 00000270 | 0002 | unsigned integer **- Id** | 0x0016 | +| 00000272 | 0004 | unsigned integer **- SizeOfName** | 0x0000000B | +| 00000276 | 000B | array of bytes **- Name** | VBAProject1 | +| 00000281 | 0002 | unsigned integer **- Reserved** | 0x003E | +| 00000283 | 0004 | unsigned integer **- SizeOfNameUnicode** | 0x00000016 | +| 00000287 | 0016 | array of bytes **- NameUnicode** | VBAProject1 | +| 0000029D | 0064 | [REFERENCEPROJECT Record](#referenceproject-record) **- ReferenceRecord\[2\]** | | +| 0000029D | 0002 | unsigned integer **- Id** | 0x000E | +| 0000029F | 0004 | unsigned integer **- Size** | 0x0000005E | +| 000002A3 | 0004 | unsigned integer **- SizeOfLibidAbsolute** | 0x00000030 | +| 000002A7 | 0030 | array of bytes **- LibidAbsolute** | \*\CC:\Example Path\Example-ReferencedProject.xls | +| 000002D7 | 0004 | unsigned integer **- SizeOfLibidRelative** | 0x00000020 | +| 000002DB | 0020 | array of bytes **- LibidRelative** | \*\CExample-ReferencedProject.xls | +| 000002FB | 0004 | unsigned integer **- MajorVersion** | 0x49A95F46 | +| 000002FF | 0002 | unsigned integer **- MinorVersion** | 0x000D | +| 00000301 | 01A1 | REFERENCE Record **- Reference\[3\]** | | +| 00000301 | 0021 | REFERENCENAME Record **- NameRecord** | | +| 00000301 | 0002 | unsigned integer **- Id** | 0x0016 | +| 00000303 | 0004 | unsigned integer **- SizeOfName** | 0x00000007 | +| 00000307 | 0007 | array of bytes **- Name** | MSForms | +| 0000030E | 0002 | unsigned integer **- Reserved** | 0x003E | +| 00000310 | 0004 | unsigned integer **- SizeOfNameUnicode** | 0x0000000E | +| 00000314 | 000E | array of bytes **- NameUnicode** | MSForms | +| 00000322 | 010B | [REFERENCECONTROL Record](#referencecontrol-record) **- ReferenceRecord\[3\]** | | +| 00000322 | 0002 | unsigned integer **- Id** | 0x002F | +| 00000324 | 0004 | unsigned integer **- SizeTwiddled** | 0x0000003B | +| 00000328 | 0004 | unsigned integer **- SizeOfLibidTwiddled** | 0x00000031 | +| 0000032C | 0031 | array of bytes **- LibidTwiddled** | \*\G{00000000-0000-0000-0000-000000000000}#0.0#0## | +| 0000035D | 0004 | unsigned integer **- Reserved1** | 0x00000000 | +| 00000361 | 0002 | unsigned integer **- Reserved2** | 0x0000 | +| 00000363 | 0021 | REFERENCENAME Record **- NameRecordExtended** | | +| 00000363 | 0002 | unsigned integer **- Id** | 0x0016 | +| 00000365 | 0004 | unsigned integer **- SizeOfName** | 0x00000007 | +| 00000369 | 0007 | array of bytes **- Name** | MSForms | +| 00000370 | 0002 | unsigned integer **- Reserved** | 0x003E | +| 00000372 | 0004 | unsigned integer **- SizeOfNameUnicode** | 0x0000000E | +| 00000376 | 000E | array of bytes **- NameUnicode** | MSForms | +| 00000384 | 0002 | unsigned integer **- Reserved3** | 0x0030 | +| 00000386 | 0004 | unsigned integer **- SizeExtended** | 0x000000A3 | +| 0000038A | 0004 | unsigned integer **- SizeOfLibidExtended** | 0x00000085 | +| 0000038E | 0085 | array of bytes **- LibidExtended** | \*\G{896C2D83-5466-46ED-8FAE-4C3E4F85E710}#2.0#0#C:\Users\jsmith\AppData\Local\Temp\VBE\MSForms.exd#Microsoft Forms 2.0 Object Library | +| 00000413 | 0004 | unsigned integer **- Reserved4** | 0x00000000 | +| 00000417 | 0002 | unsigned integer **- Reserved5** | 0x0000 | +| 00000419 | 0010 | GUID **- OriginalTypeLib** | E1 2E 45 0D 8F E0 1A 10 85 2E 02 60 8C 4D 0B B4 | +| 00000429 | 0004 | unsigned integer **- Cookie** | 0x00000001 | + +Figure 4: Project reference record + +The example described in preceding table illustrates a set of four external references for the example VBA project. Description for **Reference\[1\]** is omitted as it duplicates the example of a **REFERENCEREGISTERED** (section 2.3.4.2.2.5) type, illustrated in **Reference\[0\]**. **Reference\[2\]** illustrates an example of a **REFERENCEPROJECT** (section 2.3.4.2.2.6) type. **Reference\[3\]** illustrates an example of a **REFERENCECONTROL** (section 2.3.4.2.2.3) type. + +**ReferenceArray:** Specifies an array of four **REFERENCE** (section 2.3.4.2.2.1) records. In this array, **Reference\[0\]** and **Reference\[1\]** are **REFERENCEREGISTERED** (section 2.3.4.2.2.5) type records. **Reference\[2\]** is a **REFERENCEPROJECT** (section 2.3.4.2.2.6) record. **Reference\[3\]** is a **REFERENCECONTROL** (section 2.3.4.2.2.3) record. + +**Reference\[0\]:** Specifies a record of type **REFERENCEREGISTERED** (section 2.3.4.2.2.5). + +**Reference\[0\].NameRecord.Name:** "stdole" specifies a reference to the stdole2.tlb [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e) in [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters. + +**Reference\[0\].NameRecord.NameUnicode:** "stdole" specifies a reference to the stdole2.tlb Automation type library in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. This value is equivalent to the **Name** field value. + +**Reference\[0\].ReferenceRecord\[0\].Libid:** "\*\G{00020430-0000-0000-C000-000000000046}#2.0#0#C:\Windows\system32\stdole2.tlb#OLE Automation" specifies a [**LibidReference**](#Section_3737ef6ed8194186a5f26e258ddf66a5) (section 2.1.1.8) and conforms to the ABNF Syntax for Libid references. + +The **LibidReferenceKind,** "\*\G", specifies the **LibidPath** is a Windows Path. + +The **LibidGuid,** **"**{00020430-0000-0000-C000-000000000046}", specifies the [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the "OLE Automation" Automation type library. + +The **LibidMajorVersion** is 2. + +The **LibidMinorVersion** is 0. + +The **LibidLCID** is 0. + +The **LibidPath** is "C:\Windows\system32\stdole2.tlb". + +The **LibidRegName** is "OLE Automation". + +**Reference\[2\]:** Specifies a reference of type **REFERENCEPROJECT** (section 2.3.4.2.2.6). This reference illustrates the information required to reference another VBA project that exists in another Excel workbook file. The **ProjectName** of the referenced workbook cannot match the **ProjectName** of the referencing workbook. + +**Reference\[2\].NameRecord.Name:** "VBAProject1" specifies the **ProjectName** of the referenced VBA project in MBCS characters. + +**Reference\[2\].NameRecord.NameUnicode:** "VBAProject1" specifies the **ProjectName** of the referenced VBA project in Unicode characters. This value is equivalent to the **Name** field value. + +**Reference\[2\].ReferenceRecord\[2\].LibidAbsolute:** "\*\CC:\Example Path\Example-ReferencedProject.xls" specifies the absolute path to the file containing the referenced VBA project. + +The **Projectkind,** "\*\C" specifies a Windows file path. + +The **ProjectPath** is "C:\Example Path\ReferencedProject.xls". + +**Reference\[2\].ReferenceRecord\[2\].LibidRelative:** "\*\CExample-ReferencedProject.xls" specifies the relative path to the file containing the referenced VBA project. In this example, both files exist in the same directory ("C:\Example Path"). + +The **Projectkind,** "\*\C" specifies a Windows file path. + +The **ProjectPath** is "Example-ReferencedProject.xls", as it is relative, there is no additional file path. If the referenced file existed in the subdirectory "Test" the Project Path would be "\Test\Example-ReferencedProject.xls". + +**Reference\[2\].ReferenceRecord\[2\].MajorVersion:** "0x49A95F46" specifies the **MajorVersion** of the referenced VBA project. The **MajorVersion** is equivalent to the **VersionMajor** of the referenced VBA project’s [**PROJECTVERSION**](#projectversion-record) record (section 2.3.4.2.1.11). + +**Reference\[2\].ReferenceRecord\[2\].MinorVersion:** "0x000D" specifies the **MinorVersion** of the referenced VBA project. The **MinorVersion** is equivalent to the **VersionMinor** of the referenced VBA project’s **PROJECTVERSION** record (section 2.3.4.2.1.11). + +**Reference\[3\]:** Specifies a reference of type **REFERENCECONTROL** (section 2.3.4.2.2.3) to an [**ActiveX control library**](#gt_6c7b2a46-092b-4821-99ec-774cf7dd0692). + +**Reference\[3\].NameRecord.Name:** "MSForms" specifies the name of an Office Form [**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) in MBCS characters as described in [\[MS-OFORMS\]](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a). + +**Reference\[3\].NameRecord.NameUnicode:** "MSForms" specifies the name of an Office Form ActiveX control in Unicode characters as described in \[MS-OFORMS\]. This value is equivalent to the **Name** field value. + +**Reference\[3\].ReferenceRecord\[3\].LibidTwiddled:** \*\G{00000000-0000-0000-0000-000000000000}#0.0#0## specifies the **ReferenceRecord** does not reference a [**twiddled type library**](#gt_ef574965-aae0-4087-af88-dbf82f83c0f2). + +The **LibidReferenceKind**, "\*\G" specifies a Windows file path. + +The **LibidGuid** is {00000000-0000-0000-0000-000000000000}. + +The **LibidMajorVersion** is 0. + +The **LibidMinorVersion** is 0. + +The **LibidLCID** is 0. + +The **LibidPath** and **LibidRegName** are empty, signifying the **ReferenceRecord** is not a twiddled type library. + +**Reference\[3\].ReferenceRecord\[3\].NameRecordExtended.Name:** "MSForms" specifies the name of the [**extended type library**](#gt_978a0d25-372e-494a-b189-654118c11be5) in MBCS characters + +**Reference\[3\].ReferenceRecord\[3\].NameRecordExtended.NameUnicode:** "MSForms" specifies the name of the extended type library in Unicode characters. This value is equivalent to the **Name** field value. + +**Reference\[3\].ReferenceRecord\[3\].LibidExtended:** \*\G{896C2D83-5466-46ED-8FAE-4C3E4F85E710}#2.0#0#C:\Users\jsmith\AppData\Local\Temp\VBE\MSForms.exd#Microsoft Forms 2.0 Object Library specifies the Office Form ActiveX control library as the extended control library as described in \[MS-OFORMS\]. + +The **LibidReferenceKind,** "\*\G" specifies the **LibidPath** is a Windows path. + +The **LibidGuid,** {896C2D83-5466-46ED-8FAE-4C3E4F85E710} specifies the **ClassID** of the Office Form extended control library described in \[MS-OFORMS\]. + +The **LibidMajorVersion** is 2. + +The **LibidMinorVersion** is 0. + +The **LibidLCID** is 0. + +The **LibidPath** is "C:\Users\jsmith\AppData\Local\Temp\VBE\MSForms.exd". + +The **LibidRegName** is "Microsoft Forms 2.0 Object Library". + +**Reference\[3\].ReferenceRecord\[3\].OriginalTypeLib:** E1 2E 45 0D 8F E0 1A 10 85 2E 02 60 8C 4D 0B B4 specifies the CLSID of the Automation type library the extended type library was generated from. This value is equivalent to the **LibidGuid** value of this record’s **LibidOriginal** field, "{0D452EE1-E08F-101A-852E-02608C4D0BB4}". + +#### Module Information Example + +##### PROJECT MODULES Example + +The following illustrates a [**PROJECTMODULES**](#projectmodules-record) (section 2.3.4.2.3) example that includes three modules for the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000004A2 | 01EA | PROJECTMODULES Record **- ModulesRecord** | | +| 000004A2 | 0002 | unsigned integer **- Id** | 0x000F | +| 000004A4 | 0004 | unsigned integer **- Size** | 0x00000002 | +| 000004A8 | 0002 | unsigned integer **- Count** | 0x0003 | +| 000004AA | 0008 | [PROJECTCOOKIE Record](#projectcookie-record) **- ProjectCookieRecord** | | +| 000004AA | 0002 | unsigned integer **- Id** | 0x0013 | +| 000004AC | 0004 | unsigned integer **- Size** | 0x00000002 | +| 000004B0 | 0002 | unsigned integer **- Cookie** | 0xFFFF | + +Figure 5: Project modules stream + +**Count:** 0x0003 specifies 3 modules for the project. + +**ProjectCookieRecord.Cookie:** 0xFFFF specifies ignored data. Write this field as 0xFFFF. + +##### Module Record Examples + +###### ThisWorkbook Document Module Record Example + +This module record example describes a typical [**document module**](#gt_d992176e-7031-4ae8-8c8e-6ea9f4085c71) record. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 000004B2 | 0094 | [MODULE Record](#module-record) **- ModuleRecord** | | +| 000004B2 | 0012 | [MODULENAME Record](#modulename-record) **- NameRecord** | | +| 000004B2 | 0002 | unsigned integer **- Id** | 0x0019 | +| 000004B4 | 0004 | unsigned integer **- SizeOfModuleName** | 0x0000000C | +| 000004B8 | 000C | array of bytes **- ModuleName** | ThisWorkbook | +| 000004C4 | 001E | [MODULENAMEUNICODE Record](#modulenameunicode-record) **- NameUnicodeRecord** | | +| 000004C4 | 0002 | unsigned integer **- Id** | 0x0047 | +| 000004C6 | 0004 | unsigned integer **- SizeOfModuleNameUnicode** | 0x00000018 | +| 000004CA | 0018 | array of bytes **- ModuleNameUnicode** | ThisWorkbook | +| 000004E2 | 0030 | [MODULESTREAMNAME Record](#modulestreamname-record) **- StreamNameRecord** | | +| 000004E2 | 0002 | unsigned integer **- Id** | 0x001A | +| 000004E4 | 0004 | unsigned integer **- SizeOfStreamName** | 0x0000000C | +| 000004E8 | 000C | array of bytes **- StreamName** | ThisWorkbook | +| 000004F4 | 0002 | unsigned integer **- Reserved** | 0x0032 | +| 000004F6 | 0004 | unsigned integer **- SizeOfStreamNameUnicode** | 0x00000018 | +| 000004FA | 0018 | array of bytes **- StreamNameUnicode** | ThisWorkbook | +| 00000512 | 000C | [MODULEDOCSTRING Record](#moduledocstring-record) **- DocStringRecord** | | +| 00000512 | 0002 | unsigned integer **- Id** | 0x001C | +| 00000514 | 0004 | unsigned integer **- SizeOfDocString** | 0x00000000 | +| 00000518 | 0000 | array of bytes **- DocString** | | +| 00000518 | 0002 | unsigned integer **- Reserved** | 0x0048 | +| 0000051A | 0004 | unsigned integer **- SizeOfDocStringUnicode** | 0x00000000 | +| 0000051E | 0000 | array of bytes **- DocStringUnicode** | | +| 0000051E | 000A | [MODULEOFFSET Record](#moduleoffset-record) **- OffsetRecord** | | +| 0000051E | 0002 | unsigned integer **- Id** | 0x0031 | +| 00000520 | 0004 | unsigned integer **- Size** | 0x00000004 | +| 00000524 | 0004 | unsigned integer **- TextOffset** | 0x00000000 | +| 00000528 | 000A | [MODULEHELPCONTEXT Record](#modulehelpcontext-record) **- HelpContextRecord** | | +| 00000528 | 0002 | unsigned integer **- Id** | 0x001E | +| 0000052A | 0004 | unsigned integer **- Size** | 0x00000004 | +| 0000052E | 0004 | unsigned integer **- HelpContext** | 0x00000000 | +| 00000532 | 0008 | [MODULECOOKIE Record](#modulecookie-record) **- CookieRecord** | | +| 00000532 | 0002 | unsigned integer **- Id** | 0x002C | +| 00000534 | 0004 | unsigned integer **- Size** | 0x00000002 | +| 00000538 | 0002 | unsigned integer **- Cookie** | 0xFFFF | +| 0000053A | 0006 | [MODULETYPE Record](#moduletype-record) **- TypeRecord** | | +| 0000053A | 0002 | unsigned integer **- Id** | 0x0022 | +| 0000053C | 0004 | unsigned integer **- Reserved** | 0x00000000 | +| 00000540 | 0002 | unsigned integer **- Terminator** | 0x002B | +| 00000542 | 0004 | unsigned integer **- Reserved** | 0x00000000 | + +Figure 6: "ThisWorkbook" module record + +The preceding table illustrates the module record for the record named "ThisWorkbook". The **DocStringRecord** and **HelpContextRecord** descriptions for this module example are omitted as they are empty for this example and illustrated in the next example. The decompressed code can be found in the corresponding [**ThisWorkbook Decompressed Module Stream Example**](#Section_1075ecf1679a4a19b68d1fb97e859e9b) (section 3.1.3). + +**NameRecord.ModuleName:** "ThisWorkbook" specifies the name of the module in [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters as specified by the [**PROJECTCODEPAGE**](#projectcodepage-record) (section 2.3.4.2.1.5). + +**NameUnicodeRecord.ModuleNameUnicode:** "ThisWorkbook" specifies the name of the module in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. This value is equivalent to the **NameRecord.ModuleName** field value. + +**StreamNameRecord.StreamName:** "ThisWorkbook" specifies the [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) name in MBCS characters of the [**ModuleStream**](#module-stream-visual-basic-modules) (section 2.3.4.3) in the [VBA Storage](#Section_170f52a04cd64729b51ad08155cbd213) (section 2.3.4) corresponding to the containing **MODULE Record** (section 2.3.4.2.3.2). + +**StreamNameRecord.StreamNameUnicode:** "ThisWorkbook" specifies the stream name in Unicode characters of the **ModuleStream** (section 2.3.4.3) in the VBA Storage (section 2.3.4) corresponding to the containing **MODULE Record** (section 2.3.4.2.3.2). This value is equivalent to the **StreamName** field value. + +**OffsetRecord:** Specifies the location of the source code in the module stream that corresponds to this module record. The corresponding module stream can be found in **ThisWorkbook Decompressed Module Stream Example** (section 3.1.3). + +**OffsetRecord.TextOffset:** 0x00000000 specifies the code in the corresponding Module stream as described by the **ModuleName** record begins at 0x00000000. + +**CookieRecord.Cookie:** 0xFFFF specifies ignored data. Write this field as 0xFFFF. + +**TypeRecord.Id:** 0x0022 specifies this module is a document module, class module, or designer module. + +###### Sheet1 Document Module Record Example + +This example illustrates a [**document module**](#gt_d992176e-7031-4ae8-8c8e-6ea9f4085c71) record, it differs from the previous module record example in record values. This example is included to illustrate the [**MODULEDOCSTRING**](#moduledocstring-record) (section 2.3.4.2.3.2.4) and [**MODULEHELPCONTEXT**](#modulehelpcontext-record) (section 2.3.4.2.3.2.6) records. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000546 | 00BE | [MODULE Record](#module-record) **- ModuleRecord** | | +| 00000546 | 000C | [MODULENAME Record](#modulename-record) **- NameRecord** | | +| 00000546 | 0002 | unsigned integer **- Id** | 0x0019 | +| 00000548 | 0004 | unsigned integer **- SizeOfModuleName** | 0x00000006 | +| 0000054C | 0006 | array of bytes **- ModuleName** | Sheet1 | +| 00000552 | 0012 | [MODULENAMEUNICODE Record](#modulenameunicode-record) **- NameUnicodeRecord** | | +| 00000552 | 0002 | unsigned integer **- Id** | 0x0047 | +| 00000554 | 0004 | unsigned integer **- SizeOfModuleNameUnicode** | 0x0000000C | +| 00000558 | 000C | array of bytes **- ModuleNameUnicode** | Sheet1 | +| 00000564 | 001E | [MODULESTREAMNAME Record](#modulestreamname-record) **- StreamNameRecord** | | +| 00000564 | 0002 | unsigned integer **- Id** | 0x001A | +| 00000566 | 0004 | unsigned integer **- SizeOfStreamName** | 0x00000006 | +| 0000056A | 0006 | array of bytes **- StreamName** | Sheet1 | +| 00000570 | 0002 | unsigned integer **- Reserved** | 0x0032 | +| 00000572 | 0004 | unsigned integer **- SizeOfStreamNameUnicode** | 0x0000000C | +| 00000576 | 000C | array of bytes **- StreamNameUnicode** | Sheet1 | +| 00000582 | 005A | MODULEDOCSTRING Record **- DocStringRecord** | | +| 00000582 | 0002 | unsigned integer **- Id** | 0x001C | +| 00000584 | 0004 | unsigned integer **- SizeOfDocString** | 0x0000001A | +| 00000588 | 001A | array of bytes **- DocString** | Example Module Description | +| 000005A2 | 0002 | unsigned integer **- Reserved** | 0x0048 | +| 000005A4 | 0004 | unsigned integer **- SizeOfDocStringUnicode** | 0x00000034 | +| 000005A8 | 0034 | array of bytes **- DocStringUnicode** | Example Module Description | +| 000005DC | 000A | [MODULEOFFSET Record](#moduleoffset-record) **- OffsetRecord** | | +| 000005DC | 0002 | unsigned integer **- Id** | 0x0031 | +| 000005DE | 0004 | unsigned integer **- Size** | 0x00000004 | +| 000005E2 | 0004 | unsigned integer **- TextOffset** | 0x00000000 | +| 000005E6 | 000A | MODULEHELPCONTEXT Record **- HelpContextRecord** | | +| 000005E6 | 0002 | unsigned integer **- Id** | 0x001E | +| 000005E8 | 0004 | unsigned integer **- Size** | 0x00000004 | +| 000005EC | 0004 | unsigned integer **- HelpContext** | 0x00000002 | +| 000005F0 | 0008 | [MODULECOOKIE Record](#modulecookie-record) **- CookieRecord** | | +| 000005F0 | 0002 | unsigned integer **- Id** | 0x002C | +| 000005F2 | 0004 | unsigned integer **- Size** | 0x00000002 | +| 000005F6 | 0002 | unsigned integer **- Cookie** | 0xFFFF | +| 000005F8 | 0006 | [MODULETYPE Record](#moduletype-record) **- TypeRecord** | | +| 000005F8 | 0002 | unsigned integer **- Id** | 0x0022 | +| 000005FA | 0004 | unsigned integer **- Reserved** | 0x00000000 | +| 000005FE | 0002 | unsigned integer **- Terminator** | 0x002B | +| 00000600 | 0004 | unsigned integer **- Reserved** | 0x00000000 | + +Figure 7: Sheet1 module record + +The preceding table illustrates a module record for a document module with a description and link to a Windows [**Help file**](#gt_3e1eb3ef-9be9-4638-b48f-f3c716d1a3aa) (.hlp). The description is described in the **DocStringRecord**. The link to the Help file is illustrated in the **HelpFilePathRecord** of the [**PROJECTINFORMATION**](#projectinformation-record) (section 2.3.4.2.1). The link to the Help topic for this example is illustrated in the **HelpContextRecord**. The decompressed code can be found in the corresponding Sheet3.1.2.3.2.2 Decompressed Module Stream Example (section [3.1.4](#Section_ca44af2896d54c6f9ec661e2cfe81d64)). + +**DocStringRecord.DocString:** "Example Module Description" specifies the description of the module in [**MBCS**](#gt_8249acae-6bac-450e-9f08-1cb90ce200bd) characters. + +**DocStringRecord.DocStringUnicode:** "Example Module Description" specifies the description of the module in [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) characters. This value is equivalent to the **DocString** field value. + +**HelpContextRecord.HelpContext:** 0x00000002 specifies the [**Help topic identifier**](#gt_bb52365c-d923-4f0a-ae73-707c31d99704) in the Help file specified by [**PROJECTHELPFILEPATH Record**](#projecthelpfilepath-record) (section 2.3.4.2.1.8). + +###### UserForm1 Designer Module Record Example + +The following example illustrates a [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92) record. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000604 | 0088 | [MODULE Record](#module-record) **- ModuleRecord** | | +| 00000604 | 000F | [MODULENAME Record](#modulename-record) **- NameRecord** | | +| 00000604 | 0002 | unsigned integer **- Id** | 0x0019 | +| 00000606 | 0004 | unsigned integer **- SizeOfModuleName** | 0x00000009 | +| 0000060A | 0009 | array of bytes **- ModuleName** | UserForm1 | +| 00000613 | 0018 | [MODULENAMEUNICODE Record](#modulenameunicode-record) **- NameUnicodeRecord** | | +| 00000613 | 0002 | unsigned integer **- Id** | 0x0047 | +| 00000615 | 0004 | unsigned integer **- SizeOfModuleNameUnicode** | 0x00000012 | +| 00000619 | 0012 | array of bytes **- ModuleNameUnicode** | UserForm1 | +| 0000062B | 0027 | [MODULESTREAMNAME Record](#modulestreamname-record) **- StreamNameRecord** | | +| 0000062B | 0002 | unsigned integer **- Id** | 0x001A | +| 0000062D | 0004 | unsigned integer **- SizeOfStreamName** | 0x00000009 | +| 00000631 | 0009 | array of bytes **- StreamName** | UserForm1 | +| 0000063A | 0002 | unsigned integer **- Reserved** | 0x0032 | +| 0000063C | 0004 | unsigned integer **- SizeOfStreamNameUnicode** | 0x00000012 | +| 00000640 | 0012 | array of bytes **- StreamNameUnicode** | UserForm1 | +| 00000652 | 000C | [MODULEDOCSTRING Record](#moduledocstring-record) **- DocStringRecord** | | +| 00000652 | 0002 | unsigned integer **- Id** | 0x001C | +| 00000654 | 0004 | unsigned integer **- SizeOfDocString** | 0x00000000 | +| 00000658 | 0000 | array of bytes **- DocString** | | +| 00000658 | 0002 | unsigned integer **- Reserved** | 0x0048 | +| 0000065A | 0004 | unsigned integer **- SizeOfDocStringUnicode** | 0x00000000 | +| 0000065E | 0000 | array of bytes **- DocStringUnicode** | | +| 0000065E | 000A | [MODULEOFFSET Record](#moduleoffset-record) **- OffsetRecord** | | +| 0000065E | 0002 | unsigned integer **- Id** | 0x0031 | +| 00000660 | 0004 | unsigned integer **- Size** | 0x00000004 | +| 00000664 | 0004 | unsigned integer **- TextOffset** | 0x00000000 | +| 00000668 | 000A | [MODULEHELPCONTEXT Record](#modulehelpcontext-record) **- HelpContextRecord** | | +| 00000668 | 0002 | unsigned integer **- Id** | 0x001E | +| 0000066A | 0004 | unsigned integer **- Size** | 0x00000004 | +| 0000066E | 0004 | unsigned integer **- HelpContext** | 0x00000000 | +| 00000672 | 0008 | [MODULECOOKIE Record](#modulecookie-record) **- CookieRecord** | | +| 00000672 | 0002 | unsigned integer **- Id** | 0x002C | +| 00000674 | 0004 | unsigned integer **- Size** | 0x00000002 | +| 00000678 | 0002 | unsigned integer **- Cookie** | 0xFFFF | +| 0000067A | 0006 | [MODULETYPE Record](#moduletype-record) **- TypeRecord** | | +| 0000067A | 0002 | unsigned integer **- Id** | 0x0022 | +| 0000067C | 0004 | unsigned integer **- Reserved** | 0x00000000 | +| 00000680 | 0006 | [MODULEPRIVATE Record](#moduleprivate-record) **- PrivateRecord** | | +| 00000680 | 0002 | unsigned integer **- Id** | 0x0028 | +| 00000682 | 0004 | unsigned integer **- Reserved** | 0x00000000 | +| 00000686 | 0002 | unsigned integer **- Terminator** | 0x002B | +| 00000688 | 0004 | unsigned integer **- Reserved** | 0x00000000 | + +Figure 8: UserForm1 module record + +The preceding table illustrates a Module record for a designer module. The fields for this example are omitted, with the exception of **PrivateRecord**. The decompressed data can be found in the corresponding UserForm3.1.2.3.2.3 Decompressed Module Stream Example (section [3.1.5](#Section_29d79feb50b44bd9b45644d26983c2ed)). + +**PrivateRecord:** The presence of this record with a value of 0x0028 for the identifier specifies that the module is only usable from within this [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e). Referencing VBA projects might not call this module. + +### ThisWorkbook Decompressed Module Stream Example + +The following example illustrates the decompressed module [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) for the "ThisWorkbook" module record. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 0163 | array of bytes **- TextDecompressedData** | Attribute VB_Name = "ThisWorkbook"\r\nAttribute VB_Base = "0{00020819-0000-0000-C000-000000000046}"\r\nAttribute VB_GlobalNameSpace = False\r\nAttribute VB_Creatable = False\r\nAttribute VB_PredeclaredId = True\r\nAttribute VB_Exposed = True\r\nAttribute VB_TemplateDerived = False\r\nAttribute VB_Customizable = True\r\nSub helloworld()\r\nMsgBox "Hello, World"\r\nEnd Sub\r\n | + +Figure 9: Decompressed module data + +The preceding table illustrates the decompressed module data for the "ThisWorkbook" module. + +**TextDecompressedData:** Specifies the attributes of the "ThisWorkbook" module and the code for the module, as described in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74). The following text is formatted for readability. + +1109. Attribute VB_Name = "ThisWorkbook" + + Attribute VB_Base = "0{00020819-0000-0000-C000-000000000046}" + + Attribute VB_GlobalNameSpace = False + + Attribute VB_Creatable = False + + Attribute VB_PredeclaredId = True + + Attribute VB_Exposed = True + + Attribute VB_TemplateDerived = False + + Attribute VB_Customizable = True + + Sub helloworld() + + MsgBox "Hello, World" + + End Sub + +### Sheet1 Decompressed Module Stream Example + +The following example illustrates the decompressed module [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) example for the "Sheet1" module record. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 01D5 | array of bytes **- TextDecompressedData** | Attribute VB_Name = "Sheet1"\r\nAttribute VB_Base = "0{00020820-0000-0000-C000-000000000046}"\r\nAttribute VB_GlobalNameSpace = False\r\nAttribute VB_Creatable = False\r\nAttribute VB_PredeclaredId = True\r\nAttribute VB_Exposed = True\r\nAttribute VB_TemplateDerived = False\r\nAttribute VB_Customizable = True\r\nAttribute VB_HelpID = 2\r\nAttribute VB_Description = "Example Module Description"\r\nSub CompiliationExample()\r\n\r\n#If abc Then\r\n MsgBox "abc=1"\r\n#End If\r\n \r\nEnd Sub\r\n\r\n | + +Figure 10: Decompressed module data + +**TextDecompressedData:** Specifies the attributes of the "Sheet1" module and the code for the module as described in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74). The following text is formatted for readability. + +1120. Attribute VB_Name = "Sheet1" + + Attribute VB_Base = "0{00020820-0000-0000-C000-000000000046}" + + Attribute VB_GlobalNameSpace = False + + Attribute VB_Creatable = False + + Attribute VB_PredeclaredId = True + + Attribute VB_Exposed = True + + Attribute VB_TemplateDerived = False + + Attribute VB_Customizable = True + + Attribute VB_HelpID = 2 + + Attribute VB_Description = "Example Module Description" + + Sub CompiliationExample() + + \#If abc Then + + MsgBox "abc=1" + + \#End If + + End Sub + +### UserForm1 Decompressed Module Stream Example + +The following example illustrates the decompressed module [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) example for the "UserForm1" module record. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 0156 | array of bytes **- TextDecompressedData** | Attribute VB_Name = "UserForm1"\r\nAttribute VB_Base = "0{842E9C5E-88B5-439A-912E-4C2D9AA0EC27}{2DC3C962-DA1C-47BA-AB63-E9D578FC2637}"\r\nAttribute VB_GlobalNameSpace = False\r\nAttribute VB_Creatable = False\r\nAttribute VB_PredeclaredId = True\r\nAttribute VB_Exposed = False\r\nAttribute VB_TemplateDerived = False\r\nAttribute VB_Customizable = False\r\n | + +Figure 11: Decompressed module data + +**TextDecompressedData:** Specifies the attributes of the "UserForm1" module. The following text is formatted for readability. + +1137. Attribute VB_Name = "UserForm1" + + Attribute VB_Base = "0{842E9C5E-88B5-439A-912E-4C2D9AA0EC27}{2DC3C962-DA1C-47BA-AB63-E9D578FC2637}" + + Attribute VB_GlobalNameSpace = False + + Attribute VB_Creatable = False + + Attribute VB_PredeclaredId = True + + Attribute VB_Exposed = False + + Attribute VB_TemplateDerived = False + + Attribute VB_Customizable = False + +### PROJECT Stream Example + +This example illustrates the properties of the [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) in the Project Stream. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 027F | array of bytes **- text** | ID="{917DED54-440B-4FD1-A5C1-74ACF261E600}"\r\nDocument=ThisWorkbook/&H00000000\r\nDocument=Sheet1/&H00000000\r\nPackage={AC9F2F90-E877-11CE-9F68-00AA00574A4F}\r\nBaseClass=UserForm1\r\nHelpFile="c:\example path\example.hlp"\r\nName="VBAProject"\r\nHelpContextID="1"\r\nDescription="Example VBA Project Description"\r\nVersionCompatible32="393222000"\r\nCMG="0705D8E3D8EDDBF1DBF1DBF1DBF1"\r\nDPB="0E0CD1ECDFF4E7F5E7F5E7"\r\nGC="1517CAF1D6F9D7F9D706"\r\n\r\n\[Host Extender Info\]\r\n&H00000001={3832D640-CF90-11CF-8E43-00A0C911005A};VBE;&H00000000\r\n\r\n\[Workspace\]\r\nThisWorkbook=23, 23, 911, 280, \r\nSheet1=69, 69, 724, 317, C\r\nUserForm1=0, 0, 0, 0, C, 46, 46, 701, 294, Z | + +Figure 12: Project stream + +The preceding table illustrates an array of bytes that contains the example [**VBAPROJECTText**](#Section_d88cb9d8a475423db370cc0caaf78628) (section 2.3.1). The **VBAPROJECTText** (section 2.3.1) conforms to the ABNF syntax. + +**text:** The example **VBAPROJECTText** (section 2.3.1) follows. The following text is formatted for readability: + +1145. ID="{917DED54-440B-4FD1-A5C1-74ACF261E600}" + + Document=ThisWorkbook/&H00000000 + + Document=Sheet1/&H00000000 + + Package={AC9F2F90-E877-11CE-9F68-00AA00574A4F} + + BaseClass=UserForm1 + + HelpFile="c:\example path\example.hlp" + + Name="VBAProject" + + HelpContextID="1" + + Description="Example VBA Project Description" + + VersionCompatible32="393222000" + + CMG="0705D8E3D8EDDBF1DBF1DBF1DBF1" + + DPB="0E0CD1ECDFF4E7F5E7F5E7" + + GC="1517CAF1D6F9D7F9D706" + + \[Host Extender Info\] + + &H00000001={3832D640-CF90-11CF-8E43-00A0C911005A};VBE;&H00000000 + + \[Workspace\] + + ThisWorkbook=23, 23, 911, 280, + + Sheet1=69, 69, 724, 317, C + + UserForm1=0, 0, 0, 0, C, 46, 46, 701, 294, Z + +[**ProjectID**](#Section_20f4aad3b646431183015948fb1c2ded) (section 2.3.1.2): "ID="{917DED54-440B-4FD1-A5C1-74ACF261E600}"" specifies the [**CLSID**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the VBA project’s [**Automation type library**](#gt_4057fc86-007f-496f-a966-01c762088a8e). + +[**ProjectDocModule**](#Section_f58d24a823504fab8d1e3861f112b786) (section 2.3.1.4): specifies the module names, "ThisWorkbook" and "Sheet1", of the [**document module**](#gt_d992176e-7031-4ae8-8c8e-6ea9f4085c71)s in the VBA project. "&H00000000" specifies the modules are document modules. This example contains no [**ProjectStdModule**](#Section_570bc7e44a30434cb1e120ccde0024ac) (section 2.3.1.5) or [**ProjectClassModule**](#Section_02e00ce3a9214dff9f8c56894d3bd12a) (section 2.3.1.6) properties as there are no [**procedural modules**](#gt_bb39b710-62e6-48cc-8c8e-992c6360e521) or [**class modules**](#gt_25ca6ee7-698a-45cc-9e3c-8be094d77324). + +[**ProjectPackage**](#Section_db81c7c092d6476cb6718cef969edcfe) (section 2.3.1.8): "Package={AC9F2F90-E877-11CE-9F68-00AA00574A4F}" specifies the CLSID for the [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92), "UserForm1", as specified in the [**ProjectDesignerModule**](#Section_eee17583018744d7a23504b0d144696f) (section 2.3.1.7) property. + +[**ProjectHelpFile**](#Section_db080517cf01434087514884a24cb91c) (section 2.3.1.9): "HelpFile="c:\example path\example.hlp"" is equivalent to the value specified in [**PROJECTHELPFILEPATH**](#projecthelpfilepath-record) (section 2.3.4.2.1.8) field in the [**PROJECTINFORMATION**](#projectinformation-record) record (section 2.3.4.2.1). + +[**ProjectName**](#Section_d8912a96773540838b00d9eb7112f195) (section 2.3.1.11): "Name="VBAProject"" is equivalent to the value specified in [**PROJECTNAME**](#projectname-record) (section 2.3.4.2.1.6). + +[**ProjectHelpId**](#Section_c766f0d96e2847caadf055cdd9c9d0a3) (section 2.3.1.12): "HelpContextID="1"" is equivalent to the value specified in [**PROJECTHELPCONTEXT**](#projecthelpcontext-record) (section 2.3.4.2.1.9). + +[**ProjectDescription**](#Section_febac5d4111a42c89ad54ddaf2ac93a7) (section 2.3.1.13): "Description="Example VBA Project Description"" is equivalent to the [**DocStringRecord**](#projectdocstring-record) (section 2.3.4.2.1.7) field in the **PROJECTINFORMATION** record (section 2.3.4.2.1). + +[**ProjectVersionCompat32**](#Section_4f2b5590e5334bc882a6a416eedbd4da) (section 2.3.1.14): "VersionCompatible32="393222000"" specifies the [**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f) version of the VBA project. + +[**ProjectProtectionState**](#Section_55e770e2e1a44d1ca8a4dcfca27d6663) (section 2.3.1.15): "CMG="0705D8E3D8EDDBF1DBF1DBF1DBF1"" specifies no sources are restricted access to the VBA project. The value is obfuscated by [Data Encryption](#Section_a02dfe4e3c9f45a48f14f2f2d44fa063) (section 2.4.3). The following is the decrypted value of the **ProjectProtectionState** (section 2.3.1.15) as specified by an [**Encrypted Data Structure**](#Section_a2ad3aa7e1804ccb85117e0eb49a0ad9) (section 2.4.3.1). The text is formatted for readability: + +1166. Seed: 0x07 + + Version: 0x02 + + ProjKey: 0xDF + + Ignored: 0x070707 + + DataLength: 0x00000004 + + Data: 0x00000000 + +[**ProjectPassword**](#Section_7968542630fe43cd9cbf7f161c3de7d8) (section 2.3.1.16): "DPB="0E0CD1ECDFF4E7F5E7F5E7"" specifies the VBA project has no password. The value is obfuscated by Data Encryption (section 2.4.3). The following is the decrypted value of the **ProjectProtectionState** (section 2.3.1.15) as specified by an **Encrypted Data Structure** (section 2.4.3.1). The text is formatted for readability: + +1172. Seed: 0x0E + + Version: 0x02 + + ProjKey: 0xDF + + Ignored: 0x070707 + + DataLength: 0x00000001 + + Data: 0x00 + +[**ProjectVisibilityState**](#Section_690c96e8e862497fbb7d5eacf4dc742a) (section 2.3.1.17): "GC="1517CAF1D6F9D7F9D706"" specifies the VBA project is visible. The value is obfuscated by Data Encryption (section 2.4.3). The following text is the decrypted value of **ProjectVisibilityState** (section 2.3.1.17) as specified by an **Encrypted Data Structure** (section 2.4.3.1). The text is formatted for readability: + +1178. Seed: 0x15 + + Version: 0x02 + + ProjKey: 0xDF + + Ignored: 0x0707 + + DataLength: 0x00000001 + + Data: 0xFF + +[**HostExtenderRef**](#Section_9b5165d1c585425c8d55605d11bdbca0) (section 2.3.1.18): "&H00000001={3832D640-CF90-11CF-8E43-00A0C911005A};VBE;&H00000000", specifies the list of [**host extenders**](#gt_ae4ac5b2-257c-4c60-88bf-616b75ca6f3c). There is only one host extender for the VBA project. + +**ExtenderIndex**: "&H00000001" specifies the host extender entry is "1". + +**ExtenderGuid**: "{3832D640-CF90-11CF-8E43-00A0C911005A}" specifies the [**GUID**](#gt_f49694cc-c350-462d-ab8e-816f0103c6c1) of the Automation type library to extend. + +**LibName:** "VBE" specifies a built in name for the VBA Automation type library. + +**CreationFlags**: "&H00000000" specifies that a new [**extended type library**](#gt_978a0d25-372e-494a-b189-654118c11be5) for the [**aggregatable server**](#gt_cb1c7858-f49b-4030-9311-479026cbe832) cannot be created if there is one available. + +[**ProjectWorkspace**](#Section_8be329b17b794485a3c88ad37e70df1e) record (section 2.3.1.19) specifies [**module**](#gt_3f7df968-a51b-4dea-9f2c-4cf6ce65ccc1) window states for the three modules in the VBA project. + +The first **ProjectWorkspace** record (section 2.3.1.19) specifies the module window state for the "ThisWorkbook" module. The **ModuleIdentifier** value, "ThisWorkbook" specifies the name of the module. The first **CodeWindow** value, "23, 23, 911, 280", specifies the coordinates of the window as follows: + +**WindowLeft** 23 + +**WindowTop** 23 + +**WindowRight** 911 + +**WindowBottom** 280 + +There is no value for **WindowState** for this module. + +The second **ProjectWorkspace** record (section 2.3.1.19) specifies the module window state for the "Sheet1" module. **ModuleIdentifier** "Sheet1" specifies the name of the module. The **CodeWindow** Value, "69, 69, 724, 317" specifies the coordinates of the window as follows: + +**WindowLeft** = 69 + +**WindowTop** = 69 + +**WindowRight** = 724 + +**WindowBottom** = 317 + +The **WindowState**, "C" specifies the code window for this module is closed. + +The third **ProjectWorkspace** record (section 2.3.1.19) specifies the module windows state for the "UserForm1" designer module. **ModuleIdentifier** "UserForm1" specifies the name of the module. The **CodeWindow** value, "0, 0, 0, 0", specifies no code window coordinates for this **ProjectWorkspace** record (section 2.3.1.19). The WindowState, "C", specifies the code window for this module is closed. The **DesignerWindow** value, "46, 46, 701, 294", specifies the coordinates of the window as follows: + +**WindowLeft** = 46 + +**WindowTop** = 46 + +**WindowRight** = 701 + +**WindowBottom** = 294 + +**WindowState:** "Z" specifies the **DesignerWindow** is zoomed to fill the available viewing area. + +### VBFrame Stream Example + +The following example illustrates the extended properties for a designer module. + +| **Offset** | **Size** | **Structure** | **Value** | +|----|----|----|----| +| 00000000 | 0123 | array of bytes **- text** | VERSION 5.00\r\nBegin {C62A69F0-16DC-11CE-9E98-00AA00574A4F} UserForm1 \r\n Caption = "UserForm1"\r\n ClientHeight = 3210\r\n ClientLeft = 45\r\n ClientTop = 345\r\n ClientWidth = 4710\r\n StartUpPosition = 1 'CenterOwner\r\n TypeInfoVer = 1\r\nEnd\r\n | + +Figure 13: VBFrame stream + +The preceding table illustrates the [**VBFrame Stream**](#Section_0c41936d7c184ec68229544fdd7408b3) (section 2.2.11). This [**stream**](#gt_f3529cd8-50da-4f36-aa0b-66af455edbb6) contains an Office Form [**ActiveX control library**](#gt_6c7b2a46-092b-4821-99ec-774cf7dd0692) as described in [\[MS-OFORMS\]](%5bMS-OFORMS%5d.pdf#Section_9c79701a8c3e4429a139b60ac3a1d50a). + +**text:** This **VBFrame Stream** (section 2.2.11) describes the extended properties for the "UserForm1" [**designer module**](#gt_026d14c3-c2cd-4a0d-9599-7391e30feb92). The following text is formatted for readability: + +1184. VERSION 5.00 + + Begin {C62A69F0-16DC-11CE-9E98-00AA00574A4F} UserForm1 + + Caption = "UserForm1" + + ClientHeight = 3210 + + ClientLeft = 45 + + ClientTop = 345 + + ClientWidth = 4710 + + StartUpPosition = 1 'CenterOwner + + TypeInfoVer = 2 + + End + +**DesignerCLSID**: "{C62A69F0-16DC-11CE-9E98-00AA00574A4F}" specifies the [**class identifier (CLSID)**](#gt_e433c806-6cb6-46a2-bb95-523df8818c99) of the Office Form [**ActiveX control**](#gt_f3dcc35f-8f80-474e-ac39-106a23f059c2) as described in \[MS-OFORMS\]. + +**DesignerName:** "UserForm1" specifies the name of the designer module. + +[**DesignerCaption**](#Section_86f5bd2de3854a9ea216fc2106be3304) (section 2.3.5.2): "UserForm1" specifies the title text of the [**designer**](#gt_6bb6285f-f5b8-45e5-8f32-2a23472532b8). + +[**DesignerHeight**](#Section_1a2414aa73c842a48c3b57699ea99d3e) (section 2.3.5.3): "ClientHeight = 3210" specifies the height of the designer is 3210 [**twips**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382). + +[**DesignerLeft**](#Section_df041ec4a8a84bc0b8aa7779b22c6e92) (section 2.3.5.4): "ClientLeft = 45" specifies the left edge of the designer is 45 twips from the [**DesignerStartupPosition**](#Section_845d0dbe55f34ffaafc4af4455198969) (section 2.3.5.11). + +[**DesignerTop**](#Section_5fd796902e094be0839d2955a9586bf7) (section 2.3.5.5): "ClientTop = 345" specifies the top edge of the designer is 345 twips from the **DesignerStartupPosition** (section 2.3.5.11). + +[**DesignerWidth**](#Section_3a131f23104e4e08941dc47fecfe70dc) (section 2.3.5.6): "ClientWidth = 4710" specifies the width of the designer is 4710 twips. + +**DesignerStartupPosition** (section 2.3.5.11): "StartUpPosition = 1" specifies the **RelativeParent** value of "1". This specifies the designer is centered relative to its [**parent window**](#gt_bbeda13b-cd86-49b8-bb10-d15488223bf8). The text "’CenterOwner" is a comment as described in [\[MS-VBAL\]](%5bMS-VBAL%5d.pdf#Section_d54181460bd245eb9c7afd9502722c74). + +[**DesignerTypeInfoVer**](#Section_92534334b0fd43a79447a83d5de52229) (section 2.3.5.13): "TypeInfoVer = 2" specifies the designer has been changed and saved 2 times. + +## Compression/Decompression Examples + +### No Compression Example + +The following string illustrates an ASCII text string with a set of characters that cannot be compressed by the compression algorithm specified in section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd). + +1194. abcdefghijklmnopqrstuv. + +This example is provided to demonstrate the results of compressing and decompressing the string using an interoperable implementation of the algorithm specified in section 2.4.1. + +The following hex array represents the compressed byte array of the example string as compressed by the compression algorithm. + +1195. 01 19 B0 00 61 62 63 64 65 66 67 68 00 69 6A 6B 6C + + 6D 6E 6F 70 00 71 72 73 74 75 76 2E + +The following hex array represents the decompressed byte array of the example string as decompressed by the decompression algorithm. + +1197. 61 62 63 64 65 66 67 68 69 6A 6B 6C 6D 6E 6F 70 71 + + 72 73 74 75 76 2E + +### Normal Compression Example + +The following string illustrates an ASCII text string with a typical set of characters that can be compressed by the compression algorithm. + +1199. \#aaabcdefaaaaghijaaaaaklaaamnopqaaaaaaaaaaaarstuvwxyzaaa + +This example is provided to demonstrate the results of compressing and decompressing the example string using an interoperable implementation of the algorithm specified in section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd). + +The following hex array represents the compressed byte array of the example string as compressed by the compression algorithm: + +1200. 01 2F B0 00 23 61 61 61 62 63 64 65 82 66 00 70 + + 61 67 68 69 6A 01 38 08 61 6B 6C 00 20 6D 6E 6F + + 70 06 71 02 70 04 00 72 73 74 75 76 10 77 78 79 + + 7A 00 2C + +The following hex array represents the decompressed byte array of the example string as decompressed by the decompression algorithm: + +1204. 23 61 61 61 62 63 64 65 66 61 61 61 61 67 68 69 + + 6a 61 61 61 61 61 6B 6C 61 61 61 6D 6E 6F 70 71 + + 61 61 61 61 61 61 61 61 61 61 61 61 72 73 74 75 + + 76 77 78 79 7A 61 61 61 + +### Maximum Compression Example + +The following illustrates a set of repeating characters that represent a string that can be maximally compressed using the compression algorithm. + +1208. aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa + +This example is provided to demonstrate the results of compressing and decompressing the example string using an interoperable implementation of the algorithm specified in section [2.4.1](#Section_4742b896b32b4eb08372fbf01e3c65fd). + +The following hex array represents the compressed byte array of the example string as compressed by the compression algorithm: + +1209. 01 03 B0 02 61 45 00 + +The following hex array represents the decompressed byte array of the example string as decompressed by the decompression algorithm: + +1210. 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 + + 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 + + 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 + + 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 + + 61 61 61 61 61 61 61 61 61 + +# Security Considerations + +## Project Integrity Verification + +The Visual Basic for Applications ([**VBA**](#gt_bc3968c6-4bd2-40a2-8619-5cd7695b3e4f)) cryptographic [**digest**](#gt_1c222b9e-7176-4840-9d19-e65895b9fc62) for a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e) – see [**Contents Hash**](#Section_73422f49565e47a3baf45742e2ba7dad) (section 2.4.2) – can be stored externally and used to verify the integrity of the VBA project. + +## Encryption Method + +When data in a [**VBA project**](#gt_980e3334-2874-4425-a73a-f2235cec1e1e), such as a password, is encrypted, the information necessary to decrypt the data is stored with the encrypted data. The design of this encryption is to obfuscate sensitive information, not to secure it. For more information, see [Data Encryption](#Section_a02dfe4e3c9f45a48f14f2f2d44fa063) (section 2.4.3). Following is a list of encrypted items: + +- Project password – see [**ProjectPassword**](#Section_7968542630fe43cd9cbf7f161c3de7d8) (section 2.3.1.16) + +- Project protection state – see [**ProjectProtectionState**](#Section_55e770e2e1a44d1ca8a4dcfca27d6663) (section 2.3.1.15) + +- Project visibility state – see [**ProjectVisibilityState**](#Section_690c96e8e862497fbb7d5eacf4dc742a) (section 2.3.1.17) + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- Microsoft Office 97 + +- Microsoft Office 2000 + +- Microsoft Office XP + +- Microsoft Office 2003 + +- the 2007 Microsoft Office system + +- Microsoft Office 2010 suites + +- Microsoft Office 2013 + +- Microsoft Office 2016 + +- Microsoft Office 2019 + +- Microsoft Office 2021 + +- Microsoft Office LTSC 2024 + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 1.5](#Appendix_A_Target_1): This persistence format provides interoperability with applications that create or read documents conforming to this structure, including Microsoft Word 97, Microsoft Word 2000, Microsoft Word 2002, Microsoft Office Word 2003, Microsoft Office Word 2007, Microsoft Word 2010 and later, Microsoft Excel 97, Microsoft Excel 2000, Microsoft Excel 2002, Microsoft Office Excel 2003, Microsoft Office Excel 2007, Microsoft Excel 2010 and later, Microsoft PowerPoint 97, Microsoft PowerPoint 2000, Microsoft PowerPoint 2002, Microsoft Office PowerPoint 2003, Microsoft Office PowerPoint 2007, and Microsoft PowerPoint 2010 and later. + +[\<2\> Section 2.1.1.9](#Appendix_A_Target_2): Microsoft Visual Basic for Applications 5.0 (VBA 5.0) does not require the name to be an identifier. + +[\<3\> Section 2.3.1.11](#Appendix_A_Target_3): VBA 5.0 uses the file name of the containing document. + +[\<4\> Section 2.3.1.14](#Appendix_A_Target_4): VBA 5.0 does not write this record. + +[\<5\> Section 2.3.1.15](#Appendix_A_Target_5): VBA 5.0 will save 0x00000000 regardless of protection state. + +[\<6\> Section 2.3.1.16](#Appendix_A_Target_6): VBA 5.0 will save the encrypted plain text password. + +[\<7\> Section 2.3.4.2.1.12](#Appendix_A_Target_7): Microsoft Visual Basic for Applications (VBA) will write user-specified values between −32768 and 32767. However, VBA will only read values between -9999 and 32767. + +[\<8\> Section 2.3.4.2.2.3](#Appendix_A_Target_8): VBA 5.0 uses **LibidTwiddled** to specify a [**twiddled type library**](#gt_ef574965-aae0-4087-af88-dbf82f83c0f2) + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [2.2.6](#Section_26f8053a61ed4c6aa5ef8b9933b67ef5) SRP Streams | Stream names allow hex digits | Major | + +# Index + +\_ + +[\_VBA_PROJECT example](#vba_project-example) 89 + +[\_VBA_PROJECT stream](#vba_project-stream) 20 + +A + +[ABNF rules](#abnf-rules) 15 + +Algorithms + +[compression](#compression-and-decompression) 54 + +[contents hash](#contents-hashes) 72 + +[data encryption](#data-encryption) 80 + +[decompression](#compression-and-decompression) 54 + +[encryption](#data-encryption) 80 + +[password hash](#password-hash) 85 + +[Applicability](#applicability-statement) 14 + +B + +[Byte ordering - overview](#byte-ordering) 13 + +C + +[Change tracking](#change-tracking) 114 + +[Compression algorithms](#compression-and-decompression) 54 + +[Contents hash algorithm](#contents-hashes) 72 + +[Conventions](#conventions) 15 + +D + +[Data encryption algorithm](#data-encryption) 80 + +[Decompressed module stream example – Sheet1](#sheet1-decompressed-module-stream-example) 104 + +[Decompressed module stream example - ThisWorkbook](#thisworkbook-decompressed-module-stream-example) 104 + +[Decompressed module stream example – UserForm1](#userform1-decompressed-module-stream-example) 105 + +[Decompression algorithms](#compression-and-decompression) 54 + +[Designer storage](#designer-storages) 20 + +Details + +[\_VBA_PROJECT stream](#vba_project-stream) 20 + +[ABNF rules](#abnf-rules) 15 + +[compression algorithms](#compression-and-decompression) 54 + +[contents hash algorithm](#contents-hashes) 72 + +[conventions](#conventions) 15 + +[data encryption algorithm](#data-encryption) 80 + +[decompression algorithms](#compression-and-decompression) 54 + +[designer storage](#designer-storages) 20 + +[dir stream](#dir-stream) 20 + +[file structure](#file-structure) 19 + +[module stream](#module-stream) 20 + +[password hash algorithm](#password-hash) 85 + +[project root storage](#project-root-storage) 19 + +[PROJECT stream](#project-stream) 20 + +[PROJECT stream project information](#project-stream-project-information) 21 + +[PROJECTlk stream](#projectlk-stream) 20 + +[PROJECTlk stream ActiveX control information](#projectlk-stream-activex-control-information) 28 + +[PROJECTwm stream](#projectwm-stream) 20 + +[PROJECTwm stream module name information](#projectwm-stream-module-name-information) 29 + +[pseudocode](#pseudocode) 18 + +[SRP stream](#srp-streams) 20 + +[VBA storage](#vba-storage) 19 + +[VBA storage project information](#vba-storage-visual-basic-for-applications-project-information) 29 + +[VBFrame stream](#vbframe-stream) 21 + +[VBFrame stream designer information](#vbframe-stream-designer-information) 51 + +[dir stream](#dir-stream) 20 + +[dir stream example](#dir-stream-example) 89 + +E + +[Encryption algorithm](#data-encryption) 80 + +[Examples](#structure-examples) 89 + +[\_VBA_PROJECT](#vba_project-example) 89 + +[decompressed module stream – Sheet1](#sheet1-decompressed-module-stream-example) 104 + +[decompressed module stream - ThisWorkbook](#thisworkbook-decompressed-module-stream-example) 104 + +[decompressed module stream – UserForm1](#userform1-decompressed-module-stream-example) 105 + +[dir stream](#dir-stream-example) 89 + +[maximum compression](#maximum-compression-example) 111 + +[no compression](#no-compression-example) 110 + +[normal compression](#normal-compression-example) 110 + +[PROJECT stream](#project-stream-example) 106 + +[Sheet1 decompressed module stream](#sheet1-decompressed-module-stream-example) 104 + +[ThisWorkbook decompressed module stream](#thisworkbook-decompressed-module-stream-example) 104 + +[UserForm1 decompressed module stream](#userform1-decompressed-module-stream-example) 105 + +[VBFrame stream](#vbframe-stream-example) 109 + +F + +[Fields - vendor-extensible](#vendor-extensible-fields) 14 + +[File structure](#file-structure) 19 + +G + +[Glossary](#glossary) 8 + +I + +[Informative references](#informative-references) 11 + +[Introduction](#introduction) 8 + +L + +[Localization](#versioning-and-localization) 14 + +M + +[Maximum compression example](#maximum-compression-example) 111 + +[Module stream](#module-stream) 20 + +N + +[No compression example](#no-compression-example) 110 + +[Normal compression example](#normal-compression-example) 110 + +[Normative references](#normative-references) 11 + +O + +[Overview (synopsis)](#overview) 12 + +P + +[Password hash algorithm](#password-hash) 85 + +[Product behavior](#appendix-a-product-behavior) 113 + +[Project information - overview](#project-information) 12 + +[Project items - overview](#project-items) 12 + +[Project references - overview](#project-references) 12 + +[Project root storage](#project-root-storage) 19 + +[PROJECT stream](#project-stream) 20 + +[PROJECT stream example](#project-stream-example) 106 + +[PROJECT stream project information](#project-stream-project-information) 21 + +[PROJECTlk stream](#projectlk-stream) 20 + +[PROJECTlk stream ActiveX control information](#projectlk-stream-activex-control-information) 28 + +[PROJECTwm stream](#projectwm-stream) 20 + +[PROJECTwm stream module name information](#projectwm-stream-module-name-information) 29 + +[Pseudocode](#pseudocode) 18 + +R + +[References](#references) 11 + +[informative](#informative-references) 11 + +[normative](#normative-references) 11 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 13 + +S + +Security + +[encryption method](#encryption-method) 112 + +[project integrity verification](#project-integrity-verification) 112 + +[Security – encryption method](#encryption-method) 112 + +[Security - project integrity verification](#project-integrity-verification) 112 + +[Sheet1 decompressed module stream example](#sheet1-decompressed-module-stream-example) 104 + +[SRP stream](#srp-streams) 20 + +Structures + +[\_VBA_PROJECT stream](#vba_project-stream) 20 + +[ABNF rules](#abnf-rules) 15 + +[compression algorithms](#compression-and-decompression) 54 + +[contents hash algorithm](#contents-hashes) 72 + +[conventions](#conventions) 15 + +[data encryption algorithm](#data-encryption) 80 + +[decompression algorithms](#compression-and-decompression) 54 + +[designer storage](#designer-storages) 20 + +[dir stream](#dir-stream) 20 + +[module stream](#module-stream) 20 + +[password hash algorithm](#password-hash) 85 + +[project root storage](#project-root-storage) 19 + +[PROJECT stream](#project-stream) 20 + +[PROJECT stream project information](#project-stream-project-information) 21 + +[PROJECTlk stream](#projectlk-stream) 20 + +[PROJECTlk stream ActiveX control information](#projectlk-stream-activex-control-information) 28 + +[PROJECTwm stream](#projectwm-stream) 20 + +[PROJECTwm stream module name information](#projectwm-stream-module-name-information) 29 + +[pseudocode](#pseudocode) 18 + +[SRP stream](#srp-streams) 20 + +[VBA storage](#vba-storage) 19 + +[VBA storage project information](#vba-storage-visual-basic-for-applications-project-information) 29 + +[VBFrame stream](#vbframe-stream) 21 + +[VBFrame stream designer information](#vbframe-stream-designer-information) 51 + +T + +[ThisWorkbook decompressed module stream example](#thisworkbook-decompressed-module-stream-example) 104 + +[Tracking changes](#change-tracking) 114 + +U + +[UserForm1 decompressed module stream example](#userform1-decompressed-module-stream-example) 105 + +V + +[VBA storage](#vba-storage) 19 + +[VBA storage project information](#vba-storage-visual-basic-for-applications-project-information) 29 + +[VBFrame stream](#vbframe-stream) 21 + +[VBFrame stream designer information](#vbframe-stream-designer-information) 51 + +[VBFrame stream example](#vbframe-stream-example) 109 + +[Vendor-extensible fields](#vendor-extensible-fields) 14 + +[Versioning](#versioning-and-localization) 14 diff --git a/docs/standards/doc/ms-wmf.md b/docs/standards/doc/ms-wmf.md new file mode 100644 index 0000000..91a2565 --- /dev/null +++ b/docs/standards/doc/ms-wmf.md @@ -0,0 +1,9329 @@ +**\[MS-WMF\]:** + +**Windows Metafile Format** + +Intellectual Property Rights Notice for Open Specifications Documentation + +- **Technical Documentation.** Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions. + +- **Copyrights**. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation. + +- **No Trade Secrets**. Microsoft does not claim any trade secret rights in this documentation. + +- **Patents**. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft [Open Specifications Promise](https://go.microsoft.com/fwlink/?LinkId=214445) or the [Microsoft Community Promise](https://go.microsoft.com/fwlink/?LinkId=214448). If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting . + +- **License Programs**. To see all of the protocols in scope under a specific license program and the associated patents, visit the [Patent Map](https://aka.ms/AA9ufj8). + +- **Trademarks**. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit [www.microsoft.com/trademarks](https://www.microsoft.com/trademarks). + +- **Fictitious Names**. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred. + +**Reservation of Rights**. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise. + +**Tools**. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it. + +**Support.** For questions and support, please contact . + +**Revision Summary** + +[TABLE] + +Table of Contents + +[1 Introduction [10](#introduction)](#introduction) + +[1.1 Glossary [10](#glossary)](#glossary) + +[1.2 References [15](#references)](#references) + +[1.2.1 Normative References [15](#normative-references)](#normative-references) + +[1.2.2 Informative References [16](#informative-references)](#informative-references) + +[1.3 Overview [16](#overview)](#overview) + +[1.3.1 Metafile Structure [16](#metafile-structure)](#metafile-structure) + +[1.3.2 Graphics Objects [18](#graphics-objects)](#graphics-objects) + +[1.3.3 Byte Ordering [18](#byte-ordering)](#byte-ordering) + +[1.4 Relationship to Protocols and Other Structures [18](#relationship-to-protocols-and-other-structures)](#relationship-to-protocols-and-other-structures) + +[1.5 Applicability Statement [19](#applicability-statement)](#applicability-statement) + +[1.6 Versioning and Localization [19](#versioning-and-localization)](#versioning-and-localization) + +[1.7 Vendor-Extensible Fields [19](#vendor-extensible-fields)](#vendor-extensible-fields) + +[2 Structures [20](#structures)](#structures) + +[2.1 WMF Constants [20](#wmf-constants)](#wmf-constants) + +[2.1.1 WMF Enumerations [20](#wmf-enumerations)](#wmf-enumerations) + +[2.1.1.1 RecordType Enumeration [20](#recordtype-enumeration)](#recordtype-enumeration) + +[2.1.1.2 BinaryRasterOperation Enumeration [25](#binaryrasteroperation-enumeration)](#binaryrasteroperation-enumeration) + +[2.1.1.3 BitCount Enumeration [28](#bitcount-enumeration)](#bitcount-enumeration) + +[2.1.1.4 BrushStyle Enumeration [29](#brushstyle-enumeration)](#brushstyle-enumeration) + +[2.1.1.5 CharacterSet Enumeration [30](#characterset-enumeration)](#characterset-enumeration) + +[2.1.1.6 ColorUsage Enumeration [31](#colorusage-enumeration)](#colorusage-enumeration) + +[2.1.1.7 Compression Enumeration [31](#compression-enumeration)](#compression-enumeration) + +[2.1.1.8 FamilyFont Enumeration [32](#familyfont-enumeration)](#familyfont-enumeration) + +[2.1.1.9 FloodFill Enumeration [33](#floodfill-enumeration)](#floodfill-enumeration) + +[2.1.1.10 FontQuality Enumeration [33](#fontquality-enumeration)](#fontquality-enumeration) + +[2.1.1.11 GamutMappingIntent Enumeration [34](#gamutmappingintent-enumeration)](#gamutmappingintent-enumeration) + +[2.1.1.12 HatchStyle Enumeration [35](#hatchstyle-enumeration)](#hatchstyle-enumeration) + +[2.1.1.13 Layout Enumeration [35](#layout-enumeration)](#layout-enumeration) + +[2.1.1.14 LogicalColorSpace Enumeration [36](#logicalcolorspace-enumeration)](#logicalcolorspace-enumeration) + +[2.1.1.15 LogicalColorSpaceV5 Enumeration [36](#logicalcolorspacev5-enumeration)](#logicalcolorspacev5-enumeration) + +[2.1.1.16 MapMode Enumeration [36](#mapmode-enumeration)](#mapmode-enumeration) + +[2.1.1.17 MetafileEscapes Enumeration [37](#metafileescapes-enumeration)](#metafileescapes-enumeration) + +[2.1.1.18 MetafileType Enumeration [40](#metafiletype-enumeration)](#metafiletype-enumeration) + +[2.1.1.19 MetafileVersion Enumeration [41](#metafileversion-enumeration)](#metafileversion-enumeration) + +[2.1.1.20 MixMode Enumeration [41](#mixmode-enumeration)](#mixmode-enumeration) + +[2.1.1.21 OutPrecision Enumeration [41](#outprecision-enumeration)](#outprecision-enumeration) + +[2.1.1.22 PaletteEntryFlag Enumeration [42](#paletteentryflag-enumeration)](#paletteentryflag-enumeration) + +[2.1.1.23 PenStyle Enumeration [42](#penstyle-enumeration)](#penstyle-enumeration) + +[2.1.1.24 PitchFont Enumeration [43](#pitchfont-enumeration)](#pitchfont-enumeration) + +[2.1.1.25 PolyFillMode Enumeration [44](#polyfillmode-enumeration)](#polyfillmode-enumeration) + +[2.1.1.26 PostScriptCap Enumeration [44](#postscriptcap-enumeration)](#postscriptcap-enumeration) + +[2.1.1.27 PostScriptClipping Enumeration [45](#postscriptclipping-enumeration)](#postscriptclipping-enumeration) + +[2.1.1.28 PostScriptFeatureSetting Enumeration [45](#postscriptfeaturesetting-enumeration)](#postscriptfeaturesetting-enumeration) + +[2.1.1.29 PostScriptJoin Enumeration [46](#postscriptjoin-enumeration)](#postscriptjoin-enumeration) + +[2.1.1.30 StretchMode Enumeration [46](#stretchmode-enumeration)](#stretchmode-enumeration) + +[2.1.1.31 TernaryRasterOperation Enumeration [46](#ternaryrasteroperation-enumeration)](#ternaryrasteroperation-enumeration) + +[2.1.2 WMF Flags [75](#wmf-flags)](#wmf-flags) + +[2.1.2.1 ClipPrecision Flags [76](#clipprecision-flags)](#clipprecision-flags) + +[2.1.2.2 ExtTextOutOptions Flags [76](#exttextoutoptions-flags)](#exttextoutoptions-flags) + +[2.1.2.3 TextAlignmentMode Flags [77](#textalignmentmode-flags)](#textalignmentmode-flags) + +[2.1.2.4 VerticalTextAlignmentMode Flags [78](#verticaltextalignmentmode-flags)](#verticaltextalignmentmode-flags) + +[2.2 WMF Objects [78](#wmf-objects)](#wmf-objects) + +[2.2.1 Graphics Objects [79](#graphics-objects-1)](#graphics-objects-1) + +[2.2.1.1 Brush Object [79](#brush-object)](#brush-object) + +[2.2.1.2 Font Object [80](#font-object)](#font-object) + +[2.2.1.3 Palette Object [82](#palette-object)](#palette-object) + +[2.2.1.4 Pen Object [83](#pen-object)](#pen-object) + +[2.2.1.5 Region Object [83](#region-object)](#region-object) + +[2.2.2 Structure Objects [84](#structure-objects)](#structure-objects) + +[2.2.2.1 Bitmap16 Object [84](#bitmap16-object)](#bitmap16-object) + +[2.2.2.2 BitmapCoreHeader Object [85](#bitmapcoreheader-object)](#bitmapcoreheader-object) + +[2.2.2.3 BitmapInfoHeader Object [85](#bitmapinfoheader-object)](#bitmapinfoheader-object) + +[2.2.2.4 BitmapV4Header Object [87](#bitmapv4header-object)](#bitmapv4header-object) + +[2.2.2.5 BitmapV5Header Object [88](#bitmapv5header-object)](#bitmapv5header-object) + +[2.2.2.6 CIEXYZ Object [89](#ciexyz-object)](#ciexyz-object) + +[2.2.2.7 CIEXYZTriple Object [90](#ciexyztriple-object)](#ciexyztriple-object) + +[2.2.2.8 ColorRef Object [90](#colorref-object)](#colorref-object) + +[2.2.2.9 DeviceIndependentBitmap Object [91](#deviceindependentbitmap-object)](#deviceindependentbitmap-object) + +[2.2.2.10 LogBrush Object [92](#logbrush-object)](#logbrush-object) + +[2.2.2.11 LogColorSpace Object [93](#logcolorspace-object)](#logcolorspace-object) + +[2.2.2.12 LogColorSpaceW Object [94](#logcolorspacew-object)](#logcolorspacew-object) + +[2.2.2.13 PaletteEntry Object [96](#paletteentry-object)](#paletteentry-object) + +[2.2.2.14 PitchAndFamily Object [96](#pitchandfamily-object)](#pitchandfamily-object) + +[2.2.2.15 PointL Object [96](#pointl-object)](#pointl-object) + +[2.2.2.16 PointS Object [97](#points-object)](#points-object) + +[2.2.2.17 PolyPolygon Object [97](#polypolygon-object)](#polypolygon-object) + +[2.2.2.18 Rect Object [97](#rect-object)](#rect-object) + +[2.2.2.19 RectL Object [98](#rectl-object)](#rectl-object) + +[2.2.2.20 RGBQuad Object [98](#rgbquad-object)](#rgbquad-object) + +[2.2.2.21 Scan Object [99](#scan-object)](#scan-object) + +[2.2.2.22 SizeL Object [99](#sizel-object)](#sizel-object) + +[2.3 WMF Records [100](#wmf-records)](#wmf-records) + +[2.3.1 Bitmap Record Types [101](#bitmap-record-types)](#bitmap-record-types) + +[2.3.1.1 META_BITBLT Record [101](#meta_bitblt-record)](#meta_bitblt-record) + +[2.3.1.1.1 With Bitmap [102](#with-bitmap)](#with-bitmap) + +[2.3.1.1.2 Without Bitmap [103](#without-bitmap)](#without-bitmap) + +[2.3.1.2 META_DIBBITBLT Record [103](#meta_dibbitblt-record)](#meta_dibbitblt-record) + +[2.3.1.2.1 With Bitmap [104](#with-bitmap-1)](#with-bitmap-1) + +[2.3.1.2.2 Without Bitmap [105](#without-bitmap-1)](#without-bitmap-1) + +[2.3.1.3 META_DIBSTRETCHBLT Record [105](#meta_dibstretchblt-record)](#meta_dibstretchblt-record) + +[2.3.1.3.1 With Bitmap [106](#with-bitmap-2)](#with-bitmap-2) + +[2.3.1.3.2 Without Bitmap [107](#without-bitmap-2)](#without-bitmap-2) + +[2.3.1.4 META_SETDIBTODEV Record [108](#meta_setdibtodev-record)](#meta_setdibtodev-record) + +[2.3.1.5 META_STRETCHBLT Record [109](#meta_stretchblt-record)](#meta_stretchblt-record) + +[2.3.1.5.1 With Bitmap [110](#with-bitmap-3)](#with-bitmap-3) + +[2.3.1.5.2 Without Bitmap [111](#without-bitmap-3)](#without-bitmap-3) + +[2.3.1.6 META_STRETCHDIB Record [112](#meta_stretchdib-record)](#meta_stretchdib-record) + +[2.3.2 Control Record Types [113](#control-record-types)](#control-record-types) + +[2.3.2.1 META_EOF Record [114](#meta_eof-record)](#meta_eof-record) + +[2.3.2.2 META_HEADER Record [114](#meta_header-record)](#meta_header-record) + +[2.3.2.3 META_PLACEABLE Record [115](#meta_placeable-record)](#meta_placeable-record) + +[2.3.3 Drawing Record Types [116](#drawing-record-types)](#drawing-record-types) + +[2.3.3.1 META_ARC Record [116](#meta_arc-record)](#meta_arc-record) + +[2.3.3.2 META_CHORD Record [117](#meta_chord-record)](#meta_chord-record) + +[2.3.3.3 META_ELLIPSE Record [118](#meta_ellipse-record)](#meta_ellipse-record) + +[2.3.3.4 META_EXTFLOODFILL Record [119](#meta_extfloodfill-record)](#meta_extfloodfill-record) + +[2.3.3.5 META_EXTTEXTOUT Record [120](#meta_exttextout-record)](#meta_exttextout-record) + +[2.3.3.6 META_FILLREGION Record [122](#meta_fillregion-record)](#meta_fillregion-record) + +[2.3.3.7 META_FLOODFILL Record [122](#meta_floodfill-record)](#meta_floodfill-record) + +[2.3.3.8 META_FRAMEREGION Record [123](#meta_frameregion-record)](#meta_frameregion-record) + +[2.3.3.9 META_INVERTREGION Record [124](#meta_invertregion-record)](#meta_invertregion-record) + +[2.3.3.10 META_LINETO Record [124](#meta_lineto-record)](#meta_lineto-record) + +[2.3.3.11 META_PAINTREGION Record [125](#meta_paintregion-record)](#meta_paintregion-record) + +[2.3.3.12 META_PATBLT Record [125](#meta_patblt-record)](#meta_patblt-record) + +[2.3.3.13 META_PIE Record [126](#meta_pie-record)](#meta_pie-record) + +[2.3.3.14 META_POLYLINE Record [127](#meta_polyline-record)](#meta_polyline-record) + +[2.3.3.15 META_POLYGON Record [127](#meta_polygon-record)](#meta_polygon-record) + +[2.3.3.16 META_POLYPOLYGON Record [128](#meta_polypolygon-record)](#meta_polypolygon-record) + +[2.3.3.17 META_RECTANGLE Record [129](#meta_rectangle-record)](#meta_rectangle-record) + +[2.3.3.18 META_ROUNDRECT Record [129](#meta_roundrect-record)](#meta_roundrect-record) + +[2.3.3.19 META_SETPIXEL Record [130](#meta_setpixel-record)](#meta_setpixel-record) + +[2.3.3.20 META_TEXTOUT Record [131](#meta_textout-record)](#meta_textout-record) + +[2.3.4 Object Record Types [131](#object-record-types)](#object-record-types) + +[2.3.4.1 META_CREATEBRUSHINDIRECT Record [132](#meta_createbrushindirect-record)](#meta_createbrushindirect-record) + +[2.3.4.2 META_CREATEFONTINDIRECT Record [133](#meta_createfontindirect-record)](#meta_createfontindirect-record) + +[2.3.4.3 META_CREATEPALETTE Record [133](#meta_createpalette-record)](#meta_createpalette-record) + +[2.3.4.4 META_CREATEPATTERNBRUSH Record [134](#meta_createpatternbrush-record)](#meta_createpatternbrush-record) + +[2.3.4.5 META_CREATEPENINDIRECT Record [135](#meta_createpenindirect-record)](#meta_createpenindirect-record) + +[2.3.4.6 META_CREATEREGION Record [136](#meta_createregion-record)](#meta_createregion-record) + +[2.3.4.7 META_DELETEOBJECT Record [136](#meta_deleteobject-record)](#meta_deleteobject-record) + +[2.3.4.8 META_DIBCREATEPATTERNBRUSH Record [137](#meta_dibcreatepatternbrush-record)](#meta_dibcreatepatternbrush-record) + +[2.3.4.9 META_SELECTCLIPREGION Record [138](#meta_selectclipregion-record)](#meta_selectclipregion-record) + +[2.3.4.10 META_SELECTOBJECT Record [138](#meta_selectobject-record)](#meta_selectobject-record) + +[2.3.4.11 META_SELECTPALETTE Record [139](#meta_selectpalette-record)](#meta_selectpalette-record) + +[2.3.5 State Record Types [139](#state-record-types)](#state-record-types) + +[2.3.5.1 META_ANIMATEPALETTE Record [141](#meta_animatepalette-record)](#meta_animatepalette-record) + +[2.3.5.2 META_EXCLUDECLIPRECT Record [141](#meta_excludecliprect-record)](#meta_excludecliprect-record) + +[2.3.5.3 META_INTERSECTCLIPRECT Record [142](#meta_intersectcliprect-record)](#meta_intersectcliprect-record) + +[2.3.5.4 META_MOVETO Record [143](#meta_moveto-record)](#meta_moveto-record) + +[2.3.5.5 META_OFFSETCLIPRGN Record [143](#meta_offsetcliprgn-record)](#meta_offsetcliprgn-record) + +[2.3.5.6 META_OFFSETVIEWPORTORG Record [144](#meta_offsetviewportorg-record)](#meta_offsetviewportorg-record) + +[2.3.5.7 META_OFFSETWINDOWORG Record [144](#meta_offsetwindoworg-record)](#meta_offsetwindoworg-record) + +[2.3.5.8 META_REALIZEPALETTE Record [145](#meta_realizepalette-record)](#meta_realizepalette-record) + +[2.3.5.9 META_RESIZEPALETTE Record [145](#meta_resizepalette-record)](#meta_resizepalette-record) + +[2.3.5.10 META_RESTOREDC Record [146](#meta_restoredc-record)](#meta_restoredc-record) + +[2.3.5.11 META_SAVEDC Record [146](#meta_savedc-record)](#meta_savedc-record) + +[2.3.5.12 META_SCALEVIEWPORTEXT Record [146](#meta_scaleviewportext-record)](#meta_scaleviewportext-record) + +[2.3.5.13 META_SCALEWINDOWEXT Record [147](#meta_scalewindowext-record)](#meta_scalewindowext-record) + +[2.3.5.14 META_SETBKCOLOR Record [148](#meta_setbkcolor-record)](#meta_setbkcolor-record) + +[2.3.5.15 META_SETBKMODE Record [148](#meta_setbkmode-record)](#meta_setbkmode-record) + +[2.3.5.16 META_SETLAYOUT Record [149](#meta_setlayout-record)](#meta_setlayout-record) + +[2.3.5.17 META_SETMAPMODE Record [149](#meta_setmapmode-record)](#meta_setmapmode-record) + +[2.3.5.18 META_SETMAPPERFLAGS Record [150](#meta_setmapperflags-record)](#meta_setmapperflags-record) + +[2.3.5.19 META_SETPALENTRIES Record [150](#meta_setpalentries-record)](#meta_setpalentries-record) + +[2.3.5.20 META_SETPOLYFILLMODE Record [151](#meta_setpolyfillmode-record)](#meta_setpolyfillmode-record) + +[2.3.5.21 META_SETRELABS Record [151](#meta_setrelabs-record)](#meta_setrelabs-record) + +[2.3.5.22 META_SETROP2 Record [152](#meta_setrop2-record)](#meta_setrop2-record) + +[2.3.5.23 META_SETSTRETCHBLTMODE Record [152](#meta_setstretchbltmode-record)](#meta_setstretchbltmode-record) + +[2.3.5.24 META_SETTEXTALIGN Record [153](#meta_settextalign-record)](#meta_settextalign-record) + +[2.3.5.25 META_SETTEXTCHAREXTRA Record [153](#meta_settextcharextra-record)](#meta_settextcharextra-record) + +[2.3.5.26 META_SETTEXTCOLOR Record [154](#meta_settextcolor-record)](#meta_settextcolor-record) + +[2.3.5.27 META_SETTEXTJUSTIFICATION Record [154](#meta_settextjustification-record)](#meta_settextjustification-record) + +[2.3.5.28 META_SETVIEWPORTEXT Record [155](#meta_setviewportext-record)](#meta_setviewportext-record) + +[2.3.5.29 META_SETVIEWPORTORG Record [155](#meta_setviewportorg-record)](#meta_setviewportorg-record) + +[2.3.5.30 META_SETWINDOWEXT Record [156](#meta_setwindowext-record)](#meta_setwindowext-record) + +[2.3.5.31 META_SETWINDOWORG Record [156](#meta_setwindoworg-record)](#meta_setwindoworg-record) + +[2.3.6 Escape Record Types [157](#escape-record-types)](#escape-record-types) + +[2.3.6.1 META_ESCAPE Record [158](#meta_escape-record)](#meta_escape-record) + +[2.3.6.2 ABORTDOC Record [159](#abortdoc-record)](#abortdoc-record) + +[2.3.6.3 BEGIN_PATH Record [160](#begin_path-record)](#begin_path-record) + +[2.3.6.4 CHECKJPEGFORMAT Record [160](#checkjpegformat-record)](#checkjpegformat-record) + +[2.3.6.5 CHECKPNGFORMAT Record [161](#checkpngformat-record)](#checkpngformat-record) + +[2.3.6.6 CLIP_TO_PATH Record [161](#clip_to_path-record)](#clip_to_path-record) + +[2.3.6.7 CLOSECHANNEL Record [162](#closechannel-record)](#closechannel-record) + +[2.3.6.8 DOWNLOADFACE Record [163](#downloadface-record)](#downloadface-record) + +[2.3.6.9 DOWNLOADHEADER Record [163](#downloadheader-record)](#downloadheader-record) + +[2.3.6.10 DRAWPATTERNRECT Record [164](#drawpatternrect-record)](#drawpatternrect-record) + +[2.3.6.11 ENCAPSULATED_POSTSCRIPT Record [164](#encapsulated_postscript-record)](#encapsulated_postscript-record) + +[2.3.6.12 END_PATH Record [165](#end_path-record)](#end_path-record) + +[2.3.6.13 ENDDOC Record [166](#enddoc-record)](#enddoc-record) + +[2.3.6.14 EPSPRINTING Record [166](#epsprinting-record)](#epsprinting-record) + +[2.3.6.15 EXTTEXTOUT Record [167](#exttextout-record)](#exttextout-record) + +[2.3.6.16 GETCOLORTABLE Record [168](#getcolortable-record)](#getcolortable-record) + +[2.3.6.17 GETDEVICEUNITS Record [169](#getdeviceunits-record)](#getdeviceunits-record) + +[2.3.6.18 GETEXTENDEDTEXTMETRICS Record [169](#getextendedtextmetrics-record)](#getextendedtextmetrics-record) + +[2.3.6.19 GETFACENAME Record [170](#getfacename-record)](#getfacename-record) + +[2.3.6.20 GETPAIRKERNTABLE Record [170](#getpairkerntable-record)](#getpairkerntable-record) + +[2.3.6.21 GETPHYSPAGESIZE Record [171](#getphyspagesize-record)](#getphyspagesize-record) + +[2.3.6.22 GETPRINTINGOFFSET Record [171](#getprintingoffset-record)](#getprintingoffset-record) + +[2.3.6.23 GET_PS_FEATURESETTING Record [172](#get_ps_featuresetting-record)](#get_ps_featuresetting-record) + +[2.3.6.24 GETSCALINGFACTOR Record [172](#getscalingfactor-record)](#getscalingfactor-record) + +[2.3.6.25 META_ESCAPE_ENHANCED_METAFILE Record [173](#meta_escape_enhanced_metafile-record)](#meta_escape_enhanced_metafile-record) + +[2.3.6.26 METAFILE_DRIVER Record [174](#metafile_driver-record)](#metafile_driver-record) + +[2.3.6.27 NEWFRAME Record [175](#newframe-record)](#newframe-record) + +[2.3.6.28 NEXTBAND Record [175](#nextband-record)](#nextband-record) + +[2.3.6.29 PASSTHROUGH Record [176](#passthrough-record)](#passthrough-record) + +[2.3.6.30 POSTSCRIPT_DATA Record [176](#postscript_data-record)](#postscript_data-record) + +[2.3.6.31 POSTSCRIPT_IDENTIFY Record [177](#postscript_identify-record)](#postscript_identify-record) + +[2.3.6.32 POSTSCRIPT_IGNORE Record [178](#postscript_ignore-record)](#postscript_ignore-record) + +[2.3.6.33 POSTSCRIPT_INJECTION Record [178](#postscript_injection-record)](#postscript_injection-record) + +[2.3.6.34 POSTSCRIPT_PASSTHROUGH Record [179](#postscript_passthrough-record)](#postscript_passthrough-record) + +[2.3.6.35 OPENCHANNEL Record [179](#openchannel-record)](#openchannel-record) + +[2.3.6.36 QUERYDIBSUPPORT Record [180](#querydibsupport-record)](#querydibsupport-record) + +[2.3.6.37 QUERYESCSUPPORT Record [180](#queryescsupport-record)](#queryescsupport-record) + +[2.3.6.38 SETCOLORTABLE Record [181](#setcolortable-record)](#setcolortable-record) + +[2.3.6.39 SETCOPYCOUNT Record [181](#setcopycount-record)](#setcopycount-record) + +[2.3.6.40 SETLINECAP Record [182](#setlinecap-record)](#setlinecap-record) + +[2.3.6.41 SETLINEJOIN Record [183](#setlinejoin-record)](#setlinejoin-record) + +[2.3.6.42 SETMITERLIMIT Record [183](#setmiterlimit-record)](#setmiterlimit-record) + +[2.3.6.43 SPCLPASSTHROUGH2 Record [184](#spclpassthrough2-record)](#spclpassthrough2-record) + +[2.3.6.44 STARTDOC Record [185](#startdoc-record)](#startdoc-record) + +[3 Structure Examples [186](#structure-examples)](#structure-examples) + +[3.1 Metafile Design [186](#metafile-design)](#metafile-design) + +[3.1.1 Device Independence [186](#device-independence)](#device-independence) + +[3.1.2 Byte Ordering Example [186](#byte-ordering-example)](#byte-ordering-example) + +[3.1.3 Mapping Modes [187](#mapping-modes)](#mapping-modes) + +[3.1.4 Managing Objects [188](#managing-objects)](#managing-objects) + +[3.1.4.1 WMF Object Table [188](#wmf-object-table)](#wmf-object-table) + +[3.1.4.2 Object Scaling [188](#object-scaling)](#object-scaling) + +[3.1.5 Playback Device Context [189](#playback-device-context)](#playback-device-context) + +[3.1.6 Run-Length Encoding (RLE) Compression [192](#run-length-encoding-rle-compression)](#run-length-encoding-rle-compression) + +[3.1.6.1 Bitmaps with 4 Bits per Pixel [192](#bitmaps-with-4-bits-per-pixel)](#bitmaps-with-4-bits-per-pixel) + +[3.1.6.2 Bitmaps with 8 Bits per Pixel [193](#bitmaps-with-8-bits-per-pixel)](#bitmaps-with-8-bits-per-pixel) + +[3.2 WMF Metafile Example [194](#wmf-metafile-example)](#wmf-metafile-example) + +[3.2.1 META_HEADER Example [195](#meta_header-example)](#meta_header-example) + +[3.2.2 META_CREATEPENINDIRECT Example [196](#meta_createpenindirect-example)](#meta_createpenindirect-example) + +[3.2.3 META_SELECTOBJECT Example 1 [197](#meta_selectobject-example-1)](#meta_selectobject-example-1) + +[3.2.4 META_CREATEBRUSHINDIRECT Example [197](#meta_createbrushindirect-example)](#meta_createbrushindirect-example) + +[3.2.5 META_SELECTOBJECT Example 2 [198](#meta_selectobject-example-2)](#meta_selectobject-example-2) + +[3.2.6 META_RECTANGLE Example [199](#meta_rectangle-example)](#meta_rectangle-example) + +[3.2.7 META_TEXTOUT Example [200](#meta_textout-example)](#meta_textout-example) + +[3.2.8 META_EOF Example [200](#meta_eof-example)](#meta_eof-example) + +[4 Security Considerations [202](#security-considerations)](#security-considerations) + +[5 Appendix A: Product Behavior [203](#appendix-a-product-behavior)](#appendix-a-product-behavior) + +[6 Change Tracking [208](#change-tracking)](#change-tracking) + +[7 Index [209](#index)](#index) + +# Introduction + +This is a specification of the [**Windows metafile format (WMF)**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) structure, which can store an image in portable form. The stored image can be rendered by parsing and processing the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +A WMF metafile is a series of variable-length records, called WMF records, that contain graphics drawing commands, object definitions and properties. The metafile begins with a header record, which includes the metafile version, its size, and the number of objects it defines. A WMF metafile is "played back" when its records are converted to a format understood by a specific graphics device. + +## Glossary + +This document uses the following terms: + +> **American National Standards Institute (ANSI) character set**: A character set defined by a code page approved by the American National Standards Institute (ANSI). The term "ANSI" as used to signify Windows code pages is a historical reference and a misnomer that persists in the Windows community. The source of this misnomer stems from the fact that the Windows code page 1252 was originally based on an ANSI draft, which became International Organization for Standardization (ISO) Standard 8859-1 [\[ISO/IEC-8859-1\]](https://go.microsoft.com/fwlink/?LinkId=90689). In Windows, the ANSI character set can be any of the following code pages: 1252, 1250, 1251, 1253, 1254, 1255, 1256, 1257, 1258, 874, 932, 936, 949, or 950. For example, "ANSI application" is usually a reference to a non-[**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) or code-page-based application. Therefore, "ANSI character set" is often misused to refer to one of the character sets defined by a Windows code page that can be used as an active system code page; for example, character sets defined by code page 1252 or character sets defined by code page 950. Windows is now based on [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8), so the use of ANSI character sets is strongly discouraged unless they are used to interoperate with legacy applications or legacy data. +> +> **anti-aliasing**: The smoothing of the jagged appearance of font characters and lines, which is an artifact of the limited resolution on an output device. The pixels that surround the edges of the character glyph or line are changed to varying shades of color in order to blend the sharp edge into the background. +> +> **ASCII**: The American Standard Code for Information Interchange (ASCII) is an 8-bit character-encoding scheme based on the English alphabet. ASCII codes represent text in computers, communications equipment, and other devices that work with text. ASCII refers to a single 8-bit ASCII character or an array of 8-bit ASCII characters with the high bit of each character set to zero. +> +> **aspect ratio**: The ratio that is computed by dividing the width of a pixel on a given output device by its height. +> +> **banding**: A printing technique in which an application prints an image by dividing it into a number of bands and sending each band to the printer separately. +> +> **baseline**: The imaginary line to which the bottom of the lowercase "x" character in a font [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) is aligned. +> +> **big-endian**: Multiple-byte values that are byte-ordered with the most significant byte stored in the memory location with the lowest address. +> +> **bitmap**: A collection of structures that contain a representation of a graphical image, a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3), dimensions and other information. +> +> **bottom-up bitmap**: A [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) with an origin at the bottom-left corner. +> +> **chromaticity**: The quality of a color as determined by the magnitudes and relative intensities of its [**red green blue (RGB)**](#gt_799800d5-de1e-41fa-804c-2bcdd2326825) components in the [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5). +> +> **CIEXYZ**: A widely used device-independent color standard developed by the [**Commission Internationale de l'Éclairage (CIE)**](#gt_1bd8584d-9cad-4882-970a-9403fa0bb988). The CIEXYZ standard is based on color-matching experiments on human observers. No actual device is expected to produce colors in this [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5). It is used as a means of converting colors from one [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) to another. The primary colors in this [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) are the abstract colors X, Y, and Z. +> +> **ClearType**: A font technology developed by Microsoft that can display fractions of pixels of character glyphs and which improves the readability of text on liquid crystal displays (LCDs) and flat-panel monitors. +> +> **clipboard**: A program provided by the operating system that enables local data transfer between applications by using the cut, copy, and paste operations. +> +> **clipboard format**: An unsigned integer that uniquely identifies the format of a data packet that is stored in a binary large object (BLOB) and can be shared between processes through the operating system clipboard or other means. +> +> **CMYK**: A [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) used for commercial printing and most color computer printers. In theory, cyan, magenta, and yellow (CMY) can print all colors, but inks are not pure and black comes out muddy. The black (K) ink is required for quality black-and-white printing. +> +> **color profile**: A file that contains information about how to convert colors in the color space and the color gamut of a specific device into a device-independent color space. A device-specific color profile is called a "device profile". For more information on using color and device profiles, see [\[MSDN-UDP\]](https://go.microsoft.com/fwlink/?LinkId=90151). +> +> **color space**: A system that describes color numerically by mapping color components to a multidimensional coordinate system. The number of dimensions is typically two, three, or four. For example, if colors are expressed as a combination of the three components red, green, and blue, a three-dimensional space can describe all possible colors. Grayscale colors can be mapped to a two-dimensional color space. If transparency is considered a component, four dimensions are appropriate. Also referred to as color model. +> +> **color table**: An array of data that maps pixel values into a [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5). +> +> **Commission Internationale de l'Eclairage (CIE)**: An international Commission on Illumination in Vienna, Austria (www.cie.co.at) that sets standards for all aspects of lighting and illumination, including colorimetry, photometry, and the measurement of visible and invisible radiation. +> +> **device context**: A collection of properties and objects that defines a dynamic environment for processes on a device. For graphics output, properties include brush style, line style, text layout, foreground and background colors, and [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae); and objects include a brush, pen, font, [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5), [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197), and transform matrix. Multiple device contexts can exist simultaneously, but a single device context specifies the environment for graphics output at a particular point in time. +> +> **device-independent bitmap (DIB)**: A container for bitmapped graphics, which specifies characteristics of the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) such that it can be created using one application and loaded and displayed in another application, while retaining an identical appearance. +> +> **dithering**: A form of digital halftoning. +> +> **encapsulated PostScript (EPS)**: A file of [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) raw data that describes the appearance of a single page. Although EPS data can describe text, graphics, and images; the primary purpose of an EPS file is to be encapsulated within another [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) page definition. +> +> **enhanced metafile format (EMF)**: A file format that supports the device-independent definitions of images. +> +> **font association**: The automatic pairing of a font that contains ideographs with a font that does not contain ideographs. Font association is used to maintain font attributes across changes in locale and allows the user to enter ideographic characters regardless of which font is selected. +> +> **font embedding**: The process of attaching a font to a document so that the font can be used wherever the document is used, regardless of whether the font is installed on the system. +> +> **font mapper**: An operating system component that maps specified font attributes to available, installed fonts on the system. +> +> **gamma**: A value that describes the way brightness is distributed across the intensity spectrum by a graphics device. Depending on the device, the gamma can have a significant effect on the way colors are perceived. Technically, gamma is an expression of the relationship between input voltage and resulting output intensity. A perfect linear device would have a gamma of 1.0; a monitor or printer typically has a gamma in the range of 1.8 to 2.6, which affects midrange tones. Gamma values are used to implement gamma correction. Typically, separate gamma values are used for each component of a [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5). +> +> **Graphics Device Interface (GDI)**: An API, supported on 16-bit and 32-bit versions of the operating system, that supports graphics operations and image manipulation on logical graphics objects. +> +> **International Color Consortium (ICC)**: A group established in 1993 by eight industry vendors for the purpose of creating, promoting, and encouraging the standardization and evolution of an open, vendor-neutral, cross-platform color management system architecture and components. The outcome of this cooperation was the development of the ICC profile specification. Version 4 of the specification is now widely used and has recently been approved as International Standard ISO 15076. +> +> **isotropic**: Refers to the properties of an image, such as the scaling of logical units to device units, which are the same regardless of the direction (x-axis versus y-axis) that is measured. Contrast with anisotropic. +> +> **Joint Photographic Experts Group (JPEG)**: A raster graphics file format for displaying high-resolution color graphics. JPEG graphics apply a user-specified compression scheme that can significantly reduce the file sizes of photo-realistic color graphics. A higher level of compression results in lower quality, whereas a lower level of compression results in higher quality. JPEG-format files have a .jpg or .jpeg file name extension. +> +> **little-endian**: Multiple-byte values that are byte-ordered with the least significant byte stored in the memory location with the lowest address. +> +> **logical object**: A graphics object that is defined with device-independent parameters, without assuming device specifics, such as color format or resolution. +> +> **logical palette**: A [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) that defines colors as device-independent values. Unlike the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe), which has predefined, device-specific color definitions, a logical palette contains color values that can be defined entirely by an application. A logical palette entry is mapped to the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe) entry in order for the custom colors to appear when the application is run. +> +> **mapping mode**: The way in which logical (device-independent) coordinates are mapped to device space (device-specific) coordinates. It also specifies the orientation of the axes and size of the units used for drawing operations. +> +> **metafile**: A sequence of record structures that store an image in an application-independent format. Metafile records contain drawing commands, object definitions, and configuration settings. When a metafile is processed, the stored image can be rendered on a display, output to a printer or plotter, stored in memory, or saved to a file or stream. +> +> **METAFILEPICT**: A structure that defines the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) picture format. [**METAFILEPICT**](#gt_3963540d-e32b-4271-a2d0-61a2d93139cc) is used for exchanging [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) data through the [**clipboard**](#gt_1d19723a-0cdb-4afc-b603-d3767e4dbcf4). See [\[MSDN-METAFILEPICT\]](https://go.microsoft.com/fwlink/?LinkId=156856) and [\[MSDN-CLIPFORM\]](https://go.microsoft.com/fwlink/?LinkId=89971) for further information. +> +> **n-up printing**: The act of arranging multiple logical pages on a physical sheet of paper. +> +> **OpenType**: A [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8)-based font technology that is an extension to [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) and [**Type 1 font**](#gt_8539bd4b-4321-40c3-b4d2-aefe3c846e4e) technologies. OpenType allows [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) and [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) glyph definitions to reside in a common container format. +> +> **outline font**: A font that is defined with mathematical equations, which makes it possible for a printer or other output device to generate the characters at any size. In addition to being arbitrarily scalable, the appearance of an outline font improves in proportion to the resolution of an output device. [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) and [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) are examples of outline font technology. +> +> **packed bitmap**: A [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) in which the bit array immediately follows a BitmapInfoHeader object. +> +> **page space**: A logical coordinate system used for graphics operations. It is determined by the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae). Page space is defined with device-independent units, such as pixels. +> +> **palette**: An array of values, each element of which contains the definition of a color. The color elements in a palette are often indexed so that clients can refer to the colors, each of which can occupy 24 bits or more, by a number that requires less storage space. +> +> **path**: A graphics object that is a container for a series of line and curve segments, and [**regions**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in an image. +> +> **pitch**: A property of a font that describes the horizontal density of characters in a font; that is, the number of characters that can fit in a given unit of space. When all the characters in a font have the same width, the font is called "fixed-pitch"; if characters can have various widths, the font is "variable-pitch". Times New Roman is a variable-pitch font; it is easy to see that the characters in the font have different widths. For example, the width of a lowercase "i" is visibly less than the width of an uppercase "W". +> +> **playback device context**: The [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388) that defines the current graphics state during playback of the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). Although the data in a [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) can be device-independent, playback is always associated with an output device with specific properties, such as resolution, color support, and so on. +> +> **Portable Network Graphics (PNG)**: A bitmap graphics file format that uses lossless data compression and supports variable transparency of images (alpha channels) and control of image brightness on different computers (gamma correction). PNG-format files have a .png file name extension. +> +> **PostScript**: A page description language developed by Adobe Systems that is primarily used for printing documents on laser printers. It is the standard for desktop publishing. +> +> **Predecessor Change List (PCL)**: A set of change numbers that specify the latest versions of a messaging object in all replicas that were integrated into the current version. It is used for conflict detection. +> +> **print job**: The rendered page description language (PDL) output data sent to a print device for a particular application or user request. +> +> **Printer Control Language (PCL)**: A page description language (PDL) developed by Hewlett Packard for its laser and ink-jet printers. +> +> **printer driver**: The interface component between the operating system and the printer device. It is responsible for processing the application data into a page description language (PDL) that can be interpreted by the printer device. +> +> **raster operation**: The process of combining the bits in a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) with the bits in a destination [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) and in a specified pattern, to achieve a particular graphical output. +> +> **rasterized font**: A font produced with rasterization. Such fonts are not scalable; they define glyph [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) at specific sizes. Because of this, the appearance of rasterized fonts does not improve in proportion to the resolution of an output device. When magnified, the visual quality of a rasterized font decreases significantly compared to a [**vector font**](#gt_4795d9b6-f3e9-4435-874e-bb6882ea1f0f). +> +> **raw mode**: Refers to a spool file format that requires no further processing; it is ready to be received by the printer for which the data was formatted. +> +> **red green blue (RGB)**: An additive color model in which red, green, and blue are combined in various ways to reproduce other colors. +> +> **red-green-blue (RGB)**: A color model that describes color information in terms of the red (R), green (G), and blue (B) intensities in a color. +> +> **region**: A graphics object that is nonrectilinear in shape and is defined by an array of scanlines. +> +> **Reverse Polish Notation (RPN)**: A mathematical notation wherein each operator follows all of its operands. Also known as postfix notation. +> +> **run-length encoding (RLE) compression**: A form of data compression in which repeated values are represented by a count and a single instance of the value. RLE compression can significantly reduce disk and memory space requirements. +> +> **scanline**: A row of pixels in a [**rasterized**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c) image or [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). Multiple scanlines can be used to define the boundaries and to fill any polygon or shape. +> +> **sRGB**: A standard, predefined [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) that is portable across all devices and allows accurate color matching with little overhead. sRGB was developed by Hewlett-Packard and Microsoft and is specified in [\[IEC-RGB\]](https://go.microsoft.com/fwlink/?LinkId=89893). It is available to users of Windows. Windows NT 3.1 operating system, Windows NT 3.5 operating system, Windows NT 3.51 operating system, Windows 95 operating system, and Windows NT 4.0 operating system: [**sRGB**](#gt_cac39c64-7550-4d2a-92c8-b3b54dc3c466) color management technology is not available. +> +> **stock object**: A predefined graphics object. Stock objects are standard, commonly used objects, such as a black brush and pen. The set of predefined stock objects is specified in \[MS-EMF\] section 2.1.31. Stock objects are neither created nor deleted. +> +> **system palette**: The [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) that is actually in use to reproduce colors on a device such as a computer screen. A system palette has predefined, device-specific colors that are used by default, so that individual applications do not have to set them up. +> +> **top-down bitmap**: A [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) with an origin at the upper-left corner. +> +> **tri-stimulus**: The generation of color using three color components. +> +> **TrueType**: A scalable font technology that renders fonts for both the printer and the screen. Each TrueType font contains its own algorithms for converting printer outlines into screen [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952), which means both the outline and [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) information is [**rasterized**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c) from the same font data. The lower-level language embedded within the TrueType font allows great flexibility in its design. Both TrueType and [**Type 1 font**](#gt_8539bd4b-4321-40c3-b4d2-aefe3c846e4e) technologies are part of the [**OpenType**](#gt_5e824598-05ae-44e2-99bd-78c347279ad9) format. +> +> **twip**: A unit of measurement that is used in typesetting and desktop publishing. It equals one-twentieth of a printer's point, or 1/1440 of an inch. +> +> **Type 1 font**: A public, standard type format originally developed for use with [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) printers. Type 1 fonts contain two components—the [**outline font**](#gt_b1b9e27d-9dbc-4dfe-8d65-176a6a660ff6), used for printing; and the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) font set, used for screen display. +> +> **typeface**: The primary design of a set of printed characters such as Courier, Helvetica, and Times Roman. The terms typeface and font are sometimes used interchangeably. A font is the particular implementation and variation of the typeface such as normal, bold, or italics. The distinguishing characteristic of a typeface is often the presence or absence of serifs. +> +> **Unicode**: A character encoding standard developed by the Unicode Consortium that represents almost all of the written languages of the world. The [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) standard [\[UNICODE5.0.0/2007\]](https://go.microsoft.com/fwlink/?LinkId=154659) provides three forms (UTF-8, UTF-16, and UTF-32) and seven schemes (UTF-8, UTF-16, UTF-16 BE, UTF-16 LE, UTF-32, UTF-32 LE, and UTF-32 BE). +> +> **UTF-16LE (Unicode Transformation Format, 16-bits, little-endian)**: The encoding scheme specified in \[UNICODE5.0.0/2007\] section 2.6 for encoding Unicode characters as a sequence of 16-bit codes, each encoded as two 8-bit bytes with the least-significant byte first. +> +> **vector font**: A font that is defined with geometrical primitives such as points, lines, curves, and polygons, which are all based on mathematical equations instead of collections of discrete pixel settings. Vector fonts can be rendered in high quality at arbitrary sizes. [**Outline fonts**](#gt_b1b9e27d-9dbc-4dfe-8d65-176a6a660ff6) are vector fonts. Contrast with [**rasterized fonts**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c). +> +> **white point**: A set of [**tri-stimulus**](#gt_94ecf034-38bc-4883-9f7c-255c4f957840) values that define the color "white" in graphics image rendering. Depending on the application, different definitions of white might be needed to produce acceptable results. For example, consider a photograph taken indoors using incandescent lights, which are relatively orange compared to daylight: Defining "white" as daylight will give unacceptable results when attempting to color-correct such a photograph. +> +> **Windows metafile format (WMF)**: A file format used by Windows that supports the definition of images, including a format for clip art in word-processing documents. +> +> **XML Paper Specification (XPS)**: An XML-based document format. [**XML Paper Specification (XPS)**](#gt_0b8be35a-bc52-4a6d-b711-3ee441b1bf60) specifies the set of conventions for the use of XML and other widely available technologies to describe the content and appearance of paginated documents. For more information, see [\[MSFT-XMLPAPER\]](https://go.microsoft.com/fwlink/?LinkId=90214). +> +> **MAY, SHOULD, MUST, SHOULD NOT, MUST NOT:** These terms (in all caps) are used as defined in [\[RFC2119\]](https://go.microsoft.com/fwlink/?LinkId=90317). All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT. + +## References + +Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the [Errata](https://go.microsoft.com/fwlink/?linkid=850906). + +### Normative References + +We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information. + +\[ISO/IEC-8859-1\] International Organization for Standardization, "Information Technology -- 8-Bit Single-Byte Coded Graphic Character Sets -- Part 1: Latin Alphabet No. 1", ISO/IEC 8859-1, 1998, [http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=28245](https://go.microsoft.com/fwlink/?LinkId=90689) + +**Note** There is a charge to download the specification. + +\[JFIF\] Hamilton, E., "JPEG File Interchange Format, Version 1.02", September 1992, [http://www.w3.org/Graphics/JPEG/jfif.txt](https://go.microsoft.com/fwlink/?LinkId=89925) + +\[MS-DTYP\] Microsoft Corporation, "[Windows Data Types](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2)". + +\[RFC2083\] Boutell, T., et al., "PNG (Portable Network Graphics) Specification Version 1.0", RFC 2083, March 1997, [https://www.rfc-editor.org/info/rfc2083](https://go.microsoft.com/fwlink/?LinkId=90313) + +\[RFC2119\] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997, [https://www.rfc-editor.org/info/rfc2119](https://go.microsoft.com/fwlink/?LinkId=90317) + +\[W3C-PNG\] World Wide Web Consortium, "Portable Network Graphics (PNG) Specification, Second Edition", November 2003, [http://www.w3.org/TR/PNG](https://go.microsoft.com/fwlink/?LinkId=90562) + +### Informative References + +\[MS-EMF\] Microsoft Corporation, "[Enhanced Metafile Format](%5bMS-EMF%5d.pdf#Section_91c257d7c39d4a369b1f63e3f73d30ca)". + +\[MSDN-CLIPFORM\] Microsoft Corporation, "Clipboard Formats", [http://msdn.microsoft.com/en-us/library/ms649013.aspx](https://go.microsoft.com/fwlink/?LinkId=89971) + +## Overview + +### Metafile Structure + +[**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) specifies structures for defining a graphical image. A WMF [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) contains drawing commands, property definitions, and graphics objects in a series of WMF records. In effect, a WMF metafile is a digital recording of an image, and the recording can be played back to reproduce that image. Because WMF metafiles are application-independent, they can be shared among applications and used for image storage. + +Original WMF metafiles were device-specific; that is, the graphical images they contained would only be rendered correctly if played back on the output device for which they were recorded. To overcome this limitation, "placeable" WMF metafiles were developed, which contain an extension to the standard header with information about the placement and scaling of the image. + +The following figure illustrates the high-level structures of the original and placeable forms of WMF metafile. + +![Structures of original and placeable Windows metafiles](media/image1.bin "Structures of original and placeable Windows metafiles") + +Figure 1: Structures of original and placeable Windows metafiles + +The **META_HEADER Record** (section [2.3.2.2](#Section_d169108ae3fe436abb44bea61a46ce56)) contains information that defines the characteristics of the metafile, including: + +- The type of the metafile + +- The version of the metafile + +- The size of the metafile + +- The number of objects defined in the metafile + +- The size of the largest single record in the metafile + +The **META_PLACEABLE Record** (section [2.3.2.3](#Section_828e18647fe742d8ab0a1de161b32f27)) contains extended information concerning the image, including: + +- A bounding rectangle + +- Logical unit size, for scaling + +- A checksum, for validation + +WMF records have a generic format, which is specified in section [2.3](#Section_33c95db8eff244d3b2ce23d0ebdca5c2). Every WMF record contains the following information: + +- The record size + +- The record function + +- Parameters, if any, for the record function + +All WMF metafiles are terminated by a **META_EOF Record** (section [2.3.2.1](#Section_3aa35974e8994acc892a47a2300948af)). + +### Graphics Objects + +Graphics objects include the brushes, fonts, palettes, pens, and regions, which are used in the drawing and painting operations specified in the records of a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). They can be defined in metafile records prior to the records that specify their use; that is, they are designed to have a lifetime outside the processing of a particular record and to be reusable during the course of playing back the metafile. The structure of WMF graphics objects is specified in section [2.2.1](#Section_aafd0883af3f43a69ccd201b725c370e). + +Throughout this specification, it is assumed that these reusable graphics objects are available when needed for the processing of particular metafile records. This implies that they are stored or managed in some fashion; the store of available objects is referred to in the text as the **WMF Object Table**, which is described in section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4). The exact characteristics of the object store are determined by the particular implementations that parse and write the metafiles. + +Records that specify drawing and painting operations can occur in a WMF metafile prior to the definition of any graphics objects. Thus, it is assumed that an initial state exists that specifies default graphics properties of the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45), including default graphics objects. Information concerning the playback device context is provided in section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b). + +### Byte Ordering + +Data in [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) records is stored in [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) format. + +Some computer architectures number bytes in a binary word from left to right, which is referred to as [**big-endian**](#gt_6f6f9e8e-5966-4727-8527-7e02fb864e7e). The byte numbering used for bitfields in this specification is big-endian. Other architectures number the bytes in a binary word from right to left, which is referred to as little-endian. The byte numbering used for enumerations, objects, and records in this specification is little-endian. + +Using big-endian and little-endian methods, the number 0x12345678 would be stored as shown in the following. + +| Byte order | Byte 0 | Byte 1 | Byte 2 | Byte 3 | +|---------------|--------|--------|--------|--------| +| Big-endian | 0x12 | 0x34 | 0x56 | 0x78 | +| Little-endian | 0x78 | 0x56 | 0x34 | 0x12 | + +## Relationship to Protocols and Other Structures + +[**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) is not dependent on any protocols or other structures. WMF defines a design and layout based on 16-bit operating systems.[\<1\>](#Appendix_A_1) + +On 32-bit systems and for print spooling, it has been replaced by [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36), described in [\[MS-EMF\]](%5bMS-EMF%5d.pdf#Section_91c257d7c39d4a369b1f63e3f73d30ca). + +## Applicability Statement + +Structures that are compliant with [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) are portable, application-independent containers for images. The graphics supported in WMF [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) are applicable to document content representation, including printing and plotting. + +## Versioning and Localization + +This specification covers versioning issues in the following areas: + +**Structure Versions**: There is only one version of the WMF structure. + +**Localization**: This structure defines no locale-specific processes or data. + +## Vendor-Extensible Fields + +The [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) defines a mechanism for the encapsulation of arbitrary, vendor-defined data. See section [2.3.6.1](#Section_a2f3ad96e6554f24a371d968aeb53852) for details. + +# Structures + +This section specifies the structures used to define the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b), including: + +- Enumerations of WMF graphics properties, styles and flags. + +- Definitions of WMF graphics and structure objects. + +- Specifications of WMF [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) records, by type. + +This protocol references commonly used data types as defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2). + +## WMF Constants + +### WMF Enumerations + +This section contains enumerations of constant values that are referenced in this specification. + +#### RecordType Enumeration + +The **RecordType Enumeration** defines the types of records that can be used in [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +1. typedef enum + + { + +   META_EOF = 0x0000, + +   META_REALIZEPALETTE = 0x0035, + +   META_SETPALENTRIES = 0x0037, + +   META_SETBKMODE = 0x0102, + +   META_SETMAPMODE = 0x0103, + +   META_SETROP2 = 0x0104, + +   META_SETRELABS = 0x0105, + +   META_SETPOLYFILLMODE = 0x0106, + +   META_SETSTRETCHBLTMODE = 0x0107, + +   META_SETTEXTCHAREXTRA = 0x0108, + +   META_RESTOREDC = 0x0127, + +   META_RESIZEPALETTE = 0x0139, + +   META_DIBCREATEPATTERNBRUSH = 0x0142, + +   META_SETLAYOUT = 0x0149, + +   META_SETBKCOLOR = 0x0201, + +   META_SETTEXTCOLOR = 0x0209, + +   META_OFFSETVIEWPORTORG = 0x0211, + +   META_LINETO = 0x0213, + +   META_MOVETO = 0x0214, + +   META_OFFSETCLIPRGN = 0x0220, + +   META_FILLREGION = 0x0228, + +   META_SETMAPPERFLAGS = 0x0231, + +   META_SELECTPALETTE = 0x0234, + +   META_POLYGON = 0x0324, + +   META_POLYLINE = 0x0325, + +   META_SETTEXTJUSTIFICATION = 0x020A, + +   META_SETWINDOWORG = 0x020B, + +   META_SETWINDOWEXT = 0x020C, + +   META_SETVIEWPORTORG = 0x020D, + +   META_SETVIEWPORTEXT = 0x020E, + +   META_OFFSETWINDOWORG = 0x020F, + +   META_SCALEWINDOWEXT = 0x0410, + +   META_SCALEVIEWPORTEXT = 0x0412, + +   META_EXCLUDECLIPRECT = 0x0415, + +   META_INTERSECTCLIPRECT = 0x0416, + +   META_ELLIPSE = 0x0418, + +   META_FLOODFILL = 0x0419, + +   META_FRAMEREGION = 0x0429, + +   META_ANIMATEPALETTE = 0x0436, + +   META_TEXTOUT = 0x0521, + +   META_POLYPOLYGON = 0x0538, + +   META_EXTFLOODFILL = 0x0548, + +   META_RECTANGLE = 0x041B, + +   META_SETPIXEL = 0x041F, + +   META_ROUNDRECT = 0x061C, + +   META_PATBLT = 0x061D, + +   META_SAVEDC = 0x001E, + +   META_PIE = 0x081A, + +   META_STRETCHBLT = 0x0B23, + +   META_ESCAPE = 0x0626, + +   META_INVERTREGION = 0x012A, + +   META_PAINTREGION = 0x012B, + +   META_SELECTCLIPREGION = 0x012C, + +   META_SELECTOBJECT = 0x012D, + +   META_SETTEXTALIGN = 0x012E, + +   META_ARC = 0x0817, + +   META_CHORD = 0x0830, + +   META_BITBLT = 0x0922, + +   META_EXTTEXTOUT = 0x0a32, + +   META_SETDIBTODEV = 0x0d33, + +   META_DIBBITBLT = 0x0940, + +   META_DIBSTRETCHBLT = 0x0b41, + +   META_STRETCHDIB = 0x0f43, + +   META_DELETEOBJECT = 0x01f0, + +   META_CREATEPALETTE = 0x00f7, + +   META_CREATEPATTERNBRUSH = 0x01F9, + +   META_CREATEPENINDIRECT = 0x02FA, + +   META_CREATEFONTINDIRECT = 0x02FB, + +   META_CREATEBRUSHINDIRECT = 0x02FC, + +   META_CREATEREGION = 0x06FF + + } RecordType; + +**META_EOF:** This record specifies the end of the file, the last record in the metafile. + +**META_REALIZEPALETTE:** This record maps entries from the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe). + +**META_SETPALENTRIES:** This record defines [**red green blue (RGB)**](#gt_799800d5-de1e-41fa-804c-2bcdd2326825) color values in a range of entries in the logical palette that is defined in the playback device context. + +**META_SETBKMODE:** This record defines the background [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) mix mode in the playback device context. The background mix mode is the mode for combining pens, text, hatched brushes, and interiors of filled objects with background colors on the output surface. + +**META_SETMAPMODE:** This record defines the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) in the playback device context. The mapping mode defines the unit of measure used to transform [**page-space**](#gt_f530f123-858a-4af7-b626-adea0aeaa75a) coordinates into coordinates of the output device, and also defines the orientation of the device's x and y axes. + +**META_SETROP2:** This record defines the foreground raster operation mix mode in the playback device context. The foreground mix mode is the mode for combining pens and interiors of filled objects with foreground colors on the output surface. + +**META_SETRELABS:** This record is undefined and MUST be ignored. + +**META_SETPOLYFILLMODE:** This record defines polygon fill mode in the playback device context for graphics operations that fill polygons. + +**META_SETSTRETCHBLTMODE:** This record defines the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) stretching mode in the playback device context. + +**META_SETTEXTCHAREXTRA:** This record defines inter-character spacing for text justification in the playback device context. Spacing is added to the white space between each character, including break characters, when a line of justified text is output. + +**META_RESTOREDC:** This record restores the playback device context from a previously saved [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388). + +**META_RESIZEPALETTE:** This record redefines the size of the logical palette that is defined in the playback device context. + +**META_DIBCREATEPATTERNBRUSH:** This record defines a brush with a pattern specified by a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +**META_SETLAYOUT:** This record defines the layout orientation in the playback device context.[\<2\>](#Appendix_A_2) + +**META_SETBKCOLOR:** This record sets the background color in the playback device context to a specified color, or to the nearest physical color if the device cannot represent the specified color. + +**META_SETTEXTCOLOR:** This record defines the text color in the playback device context. + +**META_OFFSETVIEWPORTORG:** This record moves the viewport origin in the playback device context by using specified horizontal and vertical offsets. + +**META_LINETO:** This record draws a line from the output position that is defined in the playback device context up to, but not including, a specified point. + +**META_MOVETO:** This record sets the output position in the playback device context to a specified point. + +**META_OFFSETCLIPRGN:** This record moves the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) that is defined in the playback device context by specified offsets. + +**META_FILLREGION:** This record fills a region by using a specified brush. + +**META_SETMAPPERFLAGS:** This record defines the algorithm that the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) uses when it maps logical fonts to physical fonts. + +**META_SELECTPALETTE:** This record specifies the logical palette in the playback device context. + +**META_POLYGON:** This record paints a polygon consisting of two or more vertices connected by straight lines. The polygon is outlined by using the pen and filled by using the brush and polygon fill mode; these are defined in the playback device context. + +**META_POLYLINE:** This record draws a series of line segments by connecting the points in a specified array. + +**META_SETTEXTJUSTIFICATION:** This record defines the amount of space to add to break characters in a string of justified text. + +**META_SETWINDOWORG:** This record defines the output window origin in the playback device context. + +**META_SETWINDOWEXT:** This record defines the horizontal and vertical extents of the output window in the playback device context. + +**META_SETVIEWPORTORG:** This record defines the viewport origin in the playback device context. + +**META_SETVIEWPORTEXT:** This record defines the horizontal and vertical extents of the viewport in the playback device context. + +**META_OFFSETWINDOWORG:** This record moves the output window origin in the playback device context by using specified horizontal and vertical offsets. + +**META_SCALEWINDOWEXT:** This record scales the horizontal and vertical extents of the output window that is defined in the playback device context by using the ratios formed by specified multiplicands and divisors. + +**META_SCALEVIEWPORTEXT:** This record scales the horizontal and vertical extents of the viewport that is defined in the playback device context by using the ratios formed by specified multiplicands and divisors. + +**META_EXCLUDECLIPRECT:** This record sets the clipping region that is defined in the playback device context to the existing clipping region minus a specified rectangle. + +**META_INTERSECTCLIPRECT:** This record sets the clipping region that is defined in the playback device context to the intersection of the existing clipping region and a specified rectangle. + +**META_ELLIPSE:** This record defines an ellipse. The center of the ellipse is the center of a specified bounding rectangle. The ellipse is outlined by using the pen and is filled by using the brush; these are defined in the playback device context. + +**META_FLOODFILL:** This record fills an area of the display surface with the brush that is defined in the playback device context. + +**META_FRAMEREGION:** This record defines a border around a specified region by using a specified brush. + +**META_ANIMATEPALETTE:** This record redefines entries in the logical palette that is defined in the playback device context. + +**META_TEXTOUT:** This record outputs a character string at a specified location using the font, background color, and text color; these are defined in the playback device context. + +**META_POLYPOLYGON:** This record paints a series of closed polygons. Each polygon is outlined by using the pen and filled by using the brush and polygon fill mode; these are defined in the playback device context. The polygons drawn in this operation can overlap. + +**META_EXTFLOODFILL:** This record fills an area with the brush that is defined in the playback device context. + +**META_RECTANGLE:** This record paints a rectangle. The rectangle is outlined by using the pen and filled by using the brush; these are defined in the playback device context. + +**META_SETPIXEL:** This record sets the pixel at specified coordinates to a specified color. + +**META_ROUNDRECT:** This record draws a rectangle with rounded corners. The rectangle is outlined by using the current pen and filled by using the current brush. + +**META_PATBLT:** This record paints the specified rectangle by using the brush that is currently selected into the playback device context. The brush color and the surface color or colors are combined using the specified raster operation. + +**META_SAVEDC:** This record saves the playback device context for later retrieval. + +**META_PIE:** This record draws a pie-shaped wedge bounded by the intersection of an ellipse and two radials. The pie is outlined by using the pen and filled by using the brush; these are defined in the playback device context. + +**META_STRETCHBLT:** This record specifies the transfer of a block of pixels according to a raster operation, with possible expansion or contraction. + +**META_ESCAPE:** This record makes it possible to access capabilities of a particular printing device that are not directly available through other WMF records. + +**META_INVERTREGION:** This record inverts the colors in a specified region. + +**META_PAINTREGION:** This record paints a specified region by using the brush that is defined in the playback device context. + +**META_SELECTCLIPREGION:** This record specifies the clipping region in the playback device context. + +**META_SELECTOBJECT:** This record specifies a graphics object in the playback device context. The new object replaces the previous object of the same type, if one is defined. + +**META_SETTEXTALIGN:** This record defines the text-alignment values in the playback device context. + +**META_ARC:** This record draws an elliptical arc. + +**META_CHORD:** This record draws a chord, which is a region bounded by the intersection of an ellipse and a line segment. The chord is outlined by using the pen and filled by using the brush; these are defined in the playback device context. + +**META_BITBLT:** This record specifies the transfer of a block of pixels according to a raster operation. + +**META_EXTTEXTOUT:** This record outputs a character string by using the font, background color, and text color; these are defined in the playback device context. Optionally, dimensions can be provided for clipping, opaquing, or both. + +**META_SETDIBTODEV:** This record sets a block of pixels using device-independent color data. + +**META_DIBBITBLT:** This record specifies the transfer of a block of pixels in device-independent format according to a raster operation. + +**META_DIBSTRETCHBLT:** This record specifies the transfer of a block of pixels in device-independent format according to a raster operation, with possible expansion or contraction. + +**META_STRETCHDIB:** This record specifies the transfer of color data from a block of pixels in device-independent format according to a raster operation, with possible expansion or contraction. + +**META_DELETEOBJECT:** This record deletes a graphics object, which can be a pen, brush, font, region, or [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). + +**META_CREATEPALETTE:** This record defines a logical palette. + +**META_CREATEPATTERNBRUSH:** This record defines a brush with a pattern specified by a DIB. + +**META_CREATEPENINDIRECT:** This record defines a pen with specified style, width, and color. + +**META_CREATEFONTINDIRECT:** This record defines a font with specified characteristics. + +**META_CREATEBRUSHINDIRECT:** This record defines a brush with specified style, color, and pattern. + +**META_CREATEREGION:** This record defines a region. + +The high-order byte of the WMF record type values SHOULD be ignored for all record types except the following:[\<3\>](#Appendix_A_3) + +- **META_BITBLT** + +- **META_DIBBITBLT** + +- **META_DIBSTRETCHBLT** + +- **META_POLYGON** + +- **META_POLYLINE** + +- **META_SETPALENTRIES** + +- **META_STRETCHBLT** + +The meanings of the high-order bytes of these record type fields are specified in the respective sections that define them. + +A record type is not defined for the WMF header record, because only one can be present as the first record in the metafile. + +#### BinaryRasterOperation Enumeration + +The **BinaryRasterOperation Enumeration** section lists the binary raster-operation codes. Raster-operation codes define how [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) processing combines the bits from the selected pen with the bits in the destination [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). + +Each raster-operation code represents a Boolean operation in which the values of the pixels in the selected pen and the destination bitmap are combined. Following are the two operands used in these operations. + +| Operand | Meaning | +|---------|--------------------| +| P | Selected pen | +| D | Destination bitmap | + +Following are the Boolean operators used in these operations. + +| Operator | Meaning | +|----------|----------------------------| +| a | Bitwise AND | +| n | Bitwise NOT (inverse) | +| o | Bitwise OR | +| x | Bitwise exclusive OR (XOR) | + +All Boolean operations are presented in [**reverse Polish notation**](#gt_0a595f18-03ac-4b23-b9f4-9924a0f1a4e6). For example, the following operation replaces the values of the pixels in the destination bitmap with a combination of the pixel values of the pen and the selected brush: DPo. + +Each raster-operation code is a 32-bit integer whose high-order word is a Boolean operation index and whose low-order word is the operation code. The 16-bit operation index is a zero-extended, 8-bit value that represents all possible outcomes resulting from the Boolean operation on two parameters (in this case, the pen and destination values). For example, the operation indexes for the DPo and DPan operations are shown in the following list. + +| P | D | DPo | DPan | +|-----|-----|-----|------| +| 0 | 0 | 0 | 1 | +| 0 | 1 | 1 | 1 | +| 1 | 0 | 1 | 1 | +| 1 | 1 | 1 | 0 | + +The following enumeration lists the drawing modes and the Boolean operations that they represent. + +74. typedef enum + + { + +   R2_BLACK = 0x0001, + +   R2_NOTMERGEPEN = 0x0002, + +   R2_MASKNOTPEN = 0x0003, + +   R2_NOTCOPYPEN = 0x0004, + +   R2_MASKPENNOT = 0x0005, + +   R2_NOT = 0x0006, + +   R2_XORPEN = 0x0007, + +   R2_NOTMASKPEN = 0x0008, + +   R2_MASKPEN = 0x0009, + +   R2_NOTXORPEN = 0x000A, + +   R2_NOP = 0x000B, + +   R2_MERGENOTPEN = 0x000C, + +   R2_COPYPEN = 0x000D, + +   R2_MERGEPENNOT = 0x000E, + +   R2_MERGEPEN = 0x000F, + +   R2_WHITE = 0x0010 + + } BinaryRasterOperation; + +**R2_BLACK:** 0, Pixel is always 0. + +**R2_NOTMERGEPEN:** DPon, Pixel is the inverse of the **R2_MERGEPEN** color. + +**R2_MASKNOTPEN:** DPna, Pixel is a combination of the screen color and the inverse of the pen color. + +**R2_NOTCOPYPEN:** Pn, Pixel is the inverse of the pen color. + +**R2_MASKPENNOT:** PDna, Pixel is a combination of the colors common to both the pen and the inverse of the screen. + +**R2_NOT:** Dn, Pixel is the inverse of the screen color. + +**R2_XORPEN:** DPx, Pixel is a combination of the colors in the pen or in the screen, but not in both. + +**R2_NOTMASKPEN:** DPan, Pixel is the inverse of the **R2_MASKPEN** color. + +**R2_MASKPEN:** DPa, Pixel is a combination of the colors common to both the pen and the screen. + +**R2_NOTXORPEN:** DPxn, Pixel is the inverse of the **R2_XORPEN** color. + +**R2_NOP:** D, Pixel remains unchanged. + +**R2_MERGENOTPEN:** DPno, Pixel is a combination of the colors common to both the screen and the inverse of the pen. + +**R2_COPYPEN:** P, Pixel is the pen color. + +**R2_MERGEPENNOT:** PDno, Pixel is a combination of the pen color and the inverse of the screen color. + +**R2_MERGEPEN:** DPo, Pixel is a combination of the pen color and the screen color. + +**R2_WHITE:** 1, Pixel is always 1 + +For a monochrome device, [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) format maps the value 0 to black and the value 1 to white. If an application attempts to draw with a black pen on a white destination by using the available binary [**raster operations**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc), the following results occur. + +| Raster operation | Result | +|--------------------|--------------------| +| **R2_BLACK** | Visible black line | +| **R2_COPYPEN** | Visible black line | +| **R2_MASKNOTPEN** | No visible line | +| **R2_MASKPEN** | Visible black line | +| **R2_MASKPENNOT** | Visible black line | +| **R2_MERGENOTPEN** | No visible line | +| **R2_MERGEPEN** | Visible black line | +| **R2_MERGEPENNOT** | Visible black line | +| **R2_NOP** | No visible line | +| **R2_NOT** | Visible black line | +| **R2_NOTCOPYPEN** | No visible line | +| **R2_NOTMASKPEN** | No visible line | +| **R2_NOTMERGEPEN** | Visible black line | +| **R2_NOTXORPEN** | Visible black line | +| **R2_WHITE** | No visible line | +| **R2_XORPEN** | No visible line | + +For a color device, WMF format uses [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values to represent the colors of the pen and the destination. An RGB color value is a long integer that contains a red, a green, and a blue color field, each specifying the intensity of the given color. Intensities range from 0 through 255. The values are packed in the three low-order bytes of the long integer. The color of a pen is always a solid color, but the color of the destination can be a mixture of any two or three colors. If an application attempts to draw with a white pen on a blue destination by using the available binary raster operations, the following results occur. + +| Raster operation | Result | +|--------------------|------------------------| +| **R2_BLACK** | Visible black line | +| **R2_COPYPEN** | Visible white line | +| **R2_MASKNOTPEN** | Visible black line | +| **R2_MASKPEN** | Invisible blue line | +| **R2_MASKPENNOT** | Visible red/green line | +| **R2_MERGENOTPEN** | Invisible blue line | +| **R2_MERGEPEN** | Visible white line | +| **R2_MERGEPENNOT** | Visible white line | +| **R2_NOP** | Invisible blue line | +| **R2_NOT** | Visible red/green line | +| **R2_NOTCOPYPEN** | Visible black line | +| **R2_NOTMASKPEN** | Visible red/green line | +| **R2_NOTMERGEPEN** | Visible black line | +| **R2_NOTXORPEN** | Invisible blue line | +| **R2_WHITE** | Visible white line | +| **R2_XORPEN** | Visible red/green line | + +#### BitCount Enumeration + +The **BitCount Enumeration** specifies the number of bits that define each pixel and the maximum number of colors in a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +A DIB is specified by a **DeviceIndependentBitmap (DIB) Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)), and its header is a **BitmapInfoHeader Object** (section [2.2.2.3](#Section_567172fab8a24d7986a25e21d6659ef3)). + +93. typedef enum + + { + +   BI_BITCOUNT_0 = 0x0000, + +   BI_BITCOUNT_1 = 0x0001, + +   BI_BITCOUNT_2 = 0x0004, + +   BI_BITCOUNT_3 = 0x0008, + +   BI_BITCOUNT_4 = 0x0010, + +   BI_BITCOUNT_5 = 0x0018, + +   BI_BITCOUNT_6 = 0x0020 + + } BitCount; + +**BI_BITCOUNT_0:** The number of bits per pixel is undefined. + +The image SHOULD be in either [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) or [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) format.[\<4\>](#Appendix_A_4) Neither of these formats includes a [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418), so this value specifies that no color table is present in the **Colors** field of the **DIB Object**. See [\[JFIF\]](https://go.microsoft.com/fwlink/?LinkId=89925) and [\[RFC2083\]](https://go.microsoft.com/fwlink/?LinkId=90313) for more information concerning JPEG and PNG compression formats. + +**BI_BITCOUNT_1:** The image is specified with two colors. + +Each pixel in the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) in the **BitmapBuffer** field of the **DIB Object** is represented by a single bit. If the bit is clear, the pixel is displayed with the color of the first entry in the color table in the **Colors** field; if the bit is set, the pixel has the color of the second entry in the table. + +**BI_BITCOUNT_2:** The image is specified with a maximum of 16 colors. + +Each pixel in the bitmap in the **BitmapBuffer** field of the **DIB Object** is represented by a 4-bit index into the color table in the **Colors** field, and each byte contains 2 pixels. + +**BI_BITCOUNT_3:** The image is specified with a maximum of 256 colors. + +Each pixel in the bitmap in the **BitmapBuffer** field of the **DIB Object** is represented by an 8-bit index into the color table in the **Colors** field, and each byte contains 1 pixel. + +**BI_BITCOUNT_4:** The image is specified with a maximum of 2^16 colors. + +Each pixel in the bitmap in the **BitmapBuffer** field of the **DIB Object** is represented by a 16-bit value. + +If the **Compression** field of the **BitmapInfoHeader Object** is BI_RGB, the **Colors** field of the **DIB Object** is NULL. Each **WORD** (defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61) in the bitmap represents a single pixel. The relative intensities of red, green, and blue are represented with 5 bits for each color component. The value for blue is in the least significant 5 bits, followed by 5 bits each for green and red. The most significant bit is not used. + +If the **Compression** field is set to BI_BITFIELDS, the color table in the **Colors** field contains three **DWORD** (defined in \[MS-DTYP\] section 2.2.9) color masks that specify the red, green, and blue components, respectively, of each pixel. Each **WORD** in the bitmap represents a single pixel. The color table is used for optimizing colors on palette-based devices, and contains the number of entries specified by the **ColorUsed** field of the **BitmapInfoHeader Object**. + +When the **Compression** field is set to BI_BITFIELDS, bits set in each **DWORD** mask MUST be contiguous and SHOULD NOT overlap the bits of another mask. + +BI_RGB and BI_BITFIELDS are defined in **Compression Enumeration**, section [2.1.1.7](#Section_4e588f70bd924a6fb77f35d0feaf7a57). + +**BI_BITCOUNT_5:** The bitmap in the **BitmapBuffer** field of the **DIB Object** has a maximum of 2^24 colors, and the **Colors** field is NULL. Each 3-byte triplet in the bitmap represents the relative intensities of blue, green, and red, respectively, for a pixel. + +**BI_BITCOUNT_6:** The bitmap in the **BitmapBuffer** field of the **DIB Object** has a maximum of 2^24 colors. + +If the **Compression** field of the **BitmapInfoHeader Object** is set to BI_RGB, the **Colors** field of the **DIB Object** is set to NULL. Each **DWORD** in the bitmap in the **BitmapBuffer** field represents the relative intensities of blue, green, and red, respectively, for a pixel. The high byte in each **DWORD** is not used. + +If the **Compression** field is set to BI_BITFIELDS, the color table in the **Colors** field contains three **DWORD** color masks that specify the red, green, and blue components, respectively, of each pixel. Each **DWORD** in the bitmap represents a single pixel. The color table is used for optimizing colors used on palette-based devices and contains the number of entries specified by the **ColorUsed** field of the **BitmapInfoHeader Object**. + +When the **Compression** field is set to BI_BITFIELDS, bits set in each **DWORD** mask MUST be contiguous and MUST NOT overlap the bits of another mask. All the bits in the pixel do not need to be used. + +BI_RGB and BI_BITFIELDS are specified in the **Compression Enumeration**. + +#### BrushStyle Enumeration + +The **BrushStyle Enumeration** specifies the different possible brush types that can be used in graphics operations. For more information, see the specification of the **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)). + +103. typedef enum + + { + +   BS_SOLID = 0x0000, + +   BS_NULL = 0x0001, + +   BS_HATCHED = 0x0002, + +   BS_PATTERN = 0x0003, + +   BS_INDEXED = 0x0004, + +   BS_DIBPATTERN = 0x0005, + +   BS_DIBPATTERNPT = 0x0006, + +   BS_PATTERN8X8 = 0x0007, + +   BS_DIBPATTERN8X8 = 0x0008, + +   BS_MONOPATTERN = 0x0009 + + } BrushStyle; + +**BS_SOLID:** A brush that paints a single, constant color, either solid or dithered. + +**BS_NULL:** A brush that does nothing. Using a BS_NULL brush in a graphics operation MUST have the same effect as using no brush at all.[\<5\>](#Appendix_A_5) + +**BS_HATCHED:** A brush that paints a predefined simple pattern, or "hatch", onto a solid background. + +**BS_PATTERN:** A brush that paints a pattern defined by a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952), which can be a **Bitmap16 Object** (section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c)) or a **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +**BS_INDEXED:** Not supported. + +**BS_DIBPATTERN:** A pattern brush specified by a [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +**BS_DIBPATTERNPT:** A pattern brush specified by a DIB. + +**BS_PATTERN8X8:** Not supported. + +**BS_DIBPATTERN8X8:** Not supported. + +**BS_MONOPATTERN:** Not supported. + +#### CharacterSet Enumeration + +The **CharacterSet Enumeration** defines the possible sets of character glyphs that are defined in fonts for graphics output. + +116. typedef enum + + { + +   ANSI_CHARSET = 0x00000000, + +   DEFAULT_CHARSET = 0x00000001, + +   SYMBOL_CHARSET = 0x00000002, + +   MAC_CHARSET = 0x0000004D, + +   SHIFTJIS_CHARSET = 0x00000080, + +   HANGUL_CHARSET = 0x00000081, + +   JOHAB_CHARSET = 0x00000082, + +   GB2312_CHARSET = 0x00000086, + +   CHINESEBIG5_CHARSET = 0x00000088, + +   GREEK_CHARSET = 0x000000A1, + +   TURKISH_CHARSET = 0x000000A2, + +   VIETNAMESE_CHARSET = 0x000000A3, + +   HEBREW_CHARSET = 0x000000B1, + +   ARABIC_CHARSET = 0x000000B2, + +   BALTIC_CHARSET = 0x000000BA, + +   RUSSIAN_CHARSET = 0x000000CC, + +   THAI_CHARSET = 0x000000DE, + +   EASTEUROPE_CHARSET = 0x000000EE, + +   OEM_CHARSET = 0x000000FF + + } CharacterSet; + +**ANSI_CHARSET:** Specifies the English character set. + +**DEFAULT_CHARSET:** Specifies a character set based on the current system locale; for example, when the system locale is United States English, the default character set is ANSI_CHARSET. + +**SYMBOL_CHARSET:** Specifies a character set of symbols. + +**MAC_CHARSET:** Specifies the Apple Macintosh character set.[\<6\>](#Appendix_A_6) + +**SHIFTJIS_CHARSET:** Specifies the Japanese character set. + +**HANGUL_CHARSET:** Also spelled "Hangeul". Specifies the Hangul Korean character set. + +**JOHAB_CHARSET:** Also spelled "Johap". Specifies the Johab Korean character set. + +**GB2312_CHARSET:** Specifies the "simplified" Chinese character set for People's Republic of China. + +**CHINESEBIG5_CHARSET:** Specifies the "traditional" Chinese character set, used mostly in Taiwan and in the Hong Kong and Macao Special Administrative Regions. + +**GREEK_CHARSET:** Specifies the Greek character set. + +**TURKISH_CHARSET:** Specifies the Turkish character set. + +**VIETNAMESE_CHARSET:** Specifies the Vietnamese character set. + +**HEBREW_CHARSET:** Specifies the Hebrew character set + +**ARABIC_CHARSET:** Specifies the Arabic character set + +**BALTIC_CHARSET:** Specifies the Baltic (Northeastern European) character set + +**RUSSIAN_CHARSET:** Specifies the Russian Cyrillic character set. + +**THAI_CHARSET:** Specifies the Thai character set. + +**EASTEUROPE_CHARSET:** Specifies a Eastern European character set. + +**OEM_CHARSET:** Specifies a mapping to one of the OEM code pages, according to the current system locale setting. + +#### ColorUsage Enumeration + +The **ColorUsage Enumeration** specifies whether a [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) exists in a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) and how to interpret its values. + +138. typedef enum + + { + +   DIB_RGB_COLORS = 0x0000, + +   DIB_PAL_COLORS = 0x0001, + +   DIB_PAL_INDICES = 0x0002 + + } ColorUsage; + +**DIB_RGB_COLORS:** The color table contains [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values specified by **RGBQuad Objects** (section [2.2.2.20](#Section_c7e787f4aefc4f998fddae8ab37eae96)). + +**DIB_PAL_COLORS:** The color table contains 16-bit indices into the current [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +**DIB_PAL_INDICES:** No color table exists. The pixels in the DIB are indices into the current logical palette in the playback device context. + +A DIB is specified by a **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +#### Compression Enumeration + +The **Compression Enumeration** specifies the type of compression for a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) image. + +144. typedef enum + + { + +   BI_RGB = 0x0000, + +   BI_RLE8 = 0x0001, + +   BI_RLE4 = 0x0002, + +   BI_BITFIELDS = 0x0003, + +   BI_JPEG = 0x0004, + +   BI_PNG = 0x0005, + +   BI_CMYK = 0x000B, + +   BI_CMYKRLE8 = 0x000C, + +   BI_CMYKRLE4 = 0x000D + + } Compression; + +**BI_RGB:** The bitmap is in uncompressed [**red green blue (RGB)**](#gt_799800d5-de1e-41fa-804c-2bcdd2326825) format that is not compressed and does not use color masks. + +**BI_RLE8:** An [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) format that uses [**run-length encoding (RLE) compression**](#gt_24a5d1b0-11f0-4e92-a985-b6fc1fa5a421) for bitmaps with 8 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by a byte containing a color index. + +**BI_RLE4:** An RGB format that uses RLE compression for bitmaps with 4 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by two word-length color indexes. + +**BI_BITFIELDS:** The bitmap is not compressed, and the color table consists of three **DWORD** (defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.9) color masks that specify the red, green, and blue components, respectively, of each pixel. This is valid when used with 16 and 32-bits per pixel bitmaps. + +**BI_JPEG:** The image is a [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image, as specified in [\[JFIF\]](https://go.microsoft.com/fwlink/?LinkId=89925). This value SHOULD only be used in certain bitmap operations, such as JPEG pass-through. The application MUST query for the pass-through support, since not all devices support JPEG pass-through. Using non-RGB bitmaps MAY limit the portability of the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) to other devices. For instance, display device contexts generally do not support this pass-through. + +**BI_PNG:** The image is a [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) image, as specified in [\[RFC2083\]](https://go.microsoft.com/fwlink/?LinkId=90313). This value SHOULD only be used certain bitmap operations, such as JPEG/PNG pass-through. The application MUST query for the pass-through support, because not all devices support JPEG/PNG pass-through. Using non-RGB bitmaps MAY limit the portability of the metafile to other devices. For instance, display device contexts generally do not support this pass-through. + +**BI_CMYK:** The image is an uncompressed [**CMYK**](#gt_7c5541e5-c01d-45c3-a2c6-a312a2a14d8f) format. + +**BI_CMYKRLE8:** A CMYK format that uses RLE compression for bitmaps with 8 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by a byte containing a color index. + +**BI_CMYKRLE4:** A CMYK format that uses RLE compression for bitmaps with 4 bits per pixel. The compression uses a 2-byte format consisting of a count byte followed by two word-length color indexes. + +**Note** A [**bottom-up bitmap**](#gt_66aba5b9-e950-48ea-84cd-e8fe2671dc8b) can be compressed, but a [**top-down bitmap**](#gt_6becd457-578e-44e2-be91-5c008d24b56d) cannot. + +See section [3.1.6](#Section_b05fc2f2ad7441f088ee55ed5c36aad2) for more information on RLE compression. + +#### FamilyFont Enumeration + +The **FamilyFont Enumeration** specifies the font family. Font families describe the look of a font in a general way. They are intended for specifying fonts when the exact [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) desired is not available. + +156. typedef enum + + { + +   FF_DONTCARE = 0x00, + +   FF_ROMAN = 0x01, + +   FF_SWISS = 0x02, + +   FF_MODERN = 0x03, + +   FF_SCRIPT = 0x04, + +   FF_DECORATIVE = 0x05 + + } FamilyFont; + +**FF_DONTCARE:** The default font is specified, which is implementation-dependent. + +**FF_ROMAN:** Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which have serifs. "MS Serif" is an example. + +**FF_SWISS:** Fonts with variable stroke widths, which are proportional to the actual widths of the glyphs, and which do not have serifs. "MS Sans Serif" is an example. + +**FF_MODERN:** Fonts with constant stroke width, with or without serifs. Fixed-width fonts are usually modern. "Pica", "Elite", and "Courier New" are examples. + +**FF_SCRIPT:** Fonts designed to look like handwriting. "Script" and "Cursive" are examples. + +**FF_DECORATIVE:** Novelty fonts. "Old English" is an example. + +In a **Font Object** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)), when a **FamilyFont** value is packed into a byte with a **PitchFont Enumeration** (section [2.1.1.24](#Section_22dbe377aec4466988e6b8fdd9351d76)) value, the result is a **PitchAndFamily Object** (section [2.2.2.14](#Section_b73da50d697d41bdbc51213fd1c68a2e)). + +#### FloodFill Enumeration + +The **FloodFill Enumeration** specifies the type of fill operation to be performed. + +165. typedef enum + + { + +   FLOODFILLBORDER = 0x0000, + +   FLOODFILLSURFACE = 0x0001 + + } FloodFill; + +**FLOODFILLBORDER:** The fill area is bounded by the color specified by the **Color** member. This style is identical to the filling performed by the **META_FLOODFILL Record** (section [2.3.3.7](#Section_79e6c98517e244b5a3923fbbe6557674)). + +**FLOODFILLSURFACE:** The fill area is bounded by the color that is specified by the **Color** member. Filling continues outward in all directions as long as the color is encountered. This style is useful for filling areas with multicolored boundaries. + +#### FontQuality Enumeration + +The **FontQuality Enumeration** specifies how closely the attributes of the logical font match those of the physical font when rendering text. + +170. typedef enum + + { + +   DEFAULT_QUALITY = 0x00, + +   DRAFT_QUALITY = 0x01, + +   PROOF_QUALITY = 0x02, + +   NONANTIALIASED_QUALITY = 0x03, + +   ANTIALIASED_QUALITY = 0x04, + +   CLEARTYPE_QUALITY = 0x05 + + } FontQuality; + +**DEFAULT_QUALITY:** Specifies that the character quality of the font does not matter, so **DRAFT_QUALITY** can be used. + +**DRAFT_QUALITY:** Specifies that the character quality of the font is less important than the matching of logical attribuetes. For [**rasterized fonts**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c), scaling SHOULD be enabled, which means that more font sizes are available. + +**PROOF_QUALITY:** Specifies that the character quality of the font is more important than the matching of logical attributes. For rasterized fonts, scaling SHOULD be disabled, and the font closest in size SHOULD be chosen. + +**NONANTIALIASED_QUALITY:** Specifies that [**anti-aliasing**](#gt_1c163159-5835-4f3b-b6bf-518ad8eba532) SHOULD NOT be used when rendering text.[\<7\>](#Appendix_A_7) + +**ANTIALIASED_QUALITY:** Specifies that anti-aliasing SHOULD be used when rendering text, if the font supports it.[\<8\>](#Appendix_A_8) + +**CLEARTYPE_QUALITY:** Specifies that [**ClearType**](#gt_aadfbf1f-8e96-4012-8208-7b9fe852f2e7) anti-aliasing SHOULD be used when rendering text, if the font supports it.[\<9\>](#Appendix_A_9) + +Fonts that do not support ClearType anti-aliasing include [**type 1 fonts**](#gt_8539bd4b-4321-40c3-b4d2-aefe3c846e4e), [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) fonts, [**OpenType**](#gt_5e824598-05ae-44e2-99bd-78c347279ad9) fonts without [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) outlines, rasterized fonts, [**vector fonts**](#gt_4795d9b6-f3e9-4435-874e-bb6882ea1f0f), and device fonts. + +#### GamutMappingIntent Enumeration + +The **GamutMappingIntent Enumeration** specifies the relationship between logical and physical colors.[\<10\>](#Appendix_A_10) + +179. typedef enum + + { + +   LCS_GM_ABS_COLORIMETRIC = 0x00000008, + +   LCS_GM_BUSINESS = 0x00000001, + +   LCS_GM_GRAPHICS = 0x00000002, + +   LCS_GM_IMAGES = 0x00000004 + + } GamutMappingIntent; + +**LCS_GM_ABS_COLORIMETRIC:** Specifies that the [**white point**](#gt_d2287556-8c49-4b96-86b2-9bdf91da1860) SHOULD be maintained. Typically used when logical colors MUST be matched to their nearest physical color in the destination **color gamut**. + +Intent: Match + +[**ICC**](#gt_c24ecf5b-fcc2-441c-a56c-497a2be829c6) name: Absolute Colorimetric + +**LCS_GM_BUSINESS:** Specifies that saturation SHOULD be maintained. Typically used for business charts and other situations in which [**dithering**](#gt_0540a76e-7353-4f83-a800-377d1fb00903) is not required. + +Intent: Graphic + +ICC name: Saturation + +**LCS_GM_GRAPHICS:** Specifies that a colorimetric match SHOULD be maintained. Typically used for graphic designs and named colors. + +Intent: Proof + +ICC name: Relative Colorimetric + +**LCS_GM_IMAGES:** Specifies that contrast SHOULD be maintained. Typically used for photographs and natural images. + +Intent: Picture + +ICC name: Perceptual + +#### HatchStyle Enumeration + +The **HatchStyle Enumeration** specifies the hatch pattern. + +186. typedef enum + + { + +   HS_HORIZONTAL = 0x0000, + +   HS_VERTICAL = 0x0001, + +   HS_FDIAGONAL = 0x0002, + +   HS_BDIAGONAL = 0x0003, + +   HS_CROSS = 0x0004, + +   HS_DIAGCROSS = 0x0005 + + } HatchStyle; + +**HS_HORIZONTAL:** A horizontal hatch. + +**HS_VERTICAL:** A vertical hatch. + +**HS_FDIAGONAL:** A 45-degree downward, left-to-right hatch. + +**HS_BDIAGONAL:** A 45-degree upward, left-to-right hatch. + +**HS_CROSS:** A horizontal and vertical cross-hatch. + +**HS_DIAGCROSS:** A 45-degree crosshatch. + +#### Layout Enumeration + +The **Layout Enumeration** defines options for controlling the direction in which text and graphics are drawn.[\<11\>](#Appendix_A_11) + +195. typedef enum + + { + +   LAYOUT_LTR = 0x0000, + +   LAYOUT_RTL = 0x0001, + +   LAYOUT_BITMAPORIENTATIONPRESERVED = 0x0008 + + } Layout; + +**LAYOUT_LTR:** Sets the default horizontal layout to be left-to-right. + +**LAYOUT_RTL:** Sets the default horizontal layout to be right-to-left. Switching to this layout SHOULD cause the mapping mode in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to become **MM_ISOTROPIC** (section [2.1.1.16](#Section_97b31821a0db4113a210fffbcedcec4a)). + +**LAYOUT_BITMAPORIENTATIONPRESERVED:** Disables mirroring of bitmaps that are drawn by **META_BITBLT Record** (section [2.3.1.1](#Section_1aa8c9f613f740c0be47b52ab3d3a649)) and **META_STRETCHBLT Record** (section [2.3.1.5](#Section_61370adbd37d48c4b5dd7f7a64e0a9ea)) operations, when the layout is right-to-left. + +#### LogicalColorSpace Enumeration + +The LogicalColorSpace Enumeration specifies the type of [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5).[\<12\>](#Appendix_A_12) + +201. typedef enum + + { + +   LCS_CALIBRATED_RGB = 0x00000000, + +   LCS_sRGB = 0x73524742, + +   LCS_WINDOWS_COLOR_SPACE = 0x57696E20 + + } LogicalColorSpace; + +**LCS_CALIBRATED_RGB:** Color values are calibrated [**red green blue (RGB)**](#gt_799800d5-de1e-41fa-804c-2bcdd2326825) values. + +**LCS_sRGB:** The value is an encoding of the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters "sRGB", and it indicates that the color values are [**sRGB**](#gt_cac39c64-7550-4d2a-92c8-b3b54dc3c466) values. + +**LCS_WINDOWS_COLOR_SPACE:** The value is an encoding of the ASCII characters "Win ", including the trailing space, and it indicates that the color values are Windows default color space values. + +#### LogicalColorSpaceV5 Enumeration + +The **LogicalColorSpaceV5 Enumeration** is used to specify where to find [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) information for a **DeviceIndependentBitmap (DIB) Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)) that has a header of type **BitmapV5Header Object** (section [2.2.2.5](#Section_8a37c67bdab0469398a9fe0499095da6)).[\<13\>](#Appendix_A_13) + +207. typedef enum + + { + +   LCS_PROFILE_LINKED = 0x4C494E4B, + +   LCS_PROFILE_EMBEDDED = 0x4D424544 + + } LogicalColorSpaceV5; + +**LCS_PROFILE_LINKED:** The value consists of the string "LINK" from the Windows character set (code page 1252). It indicates that the color profile MUST be linked with the **DIB Object**. + +**LCS_PROFILE_EMBEDDED:** The value consists of the string "MBED" from the Windows character set (code page 1252). It indicates that the color profile MUST be embedded in the **DIB Object**. + +#### MapMode Enumeration + +The **MapMode Enumeration** defines how logical units are mapped to physical units; that is, assuming that the origins in both the logical and physical coordinate systems are at the same point on the drawing surface, what is the physical coordinate (x',y') that corresponds to logical coordinate (x,y). + +For example, suppose the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) is **MM_TEXT**. Given the following definition of that mapping mode, and an origin (0,0) at the top left corner of the drawing surface, logical coordinate (4,5) would map to physical coordinate (4,5) in pixels. + +Now suppose the mapping mode is **MM_LOENGLISH**, with the same origin as the previous example. Given the following definition of that mapping mode, logical coordinate (4,-5) would map to physical coordinate (0.04,0.05) in inches. + +212. typedef enum + + { + +   MM_TEXT = 0x0001, + +   MM_LOMETRIC = 0x0002, + +   MM_HIMETRIC = 0x0003, + +   MM_LOENGLISH = 0x0004, + +   MM_HIENGLISH = 0x0005, + +   MM_TWIPS = 0x0006, + +   MM_ISOTROPIC = 0x0007, + +   MM_ANISOTROPIC = 0x0008 + + } MapMode; + +**MM_TEXT:** Each logical unit is mapped to one device pixel. Positive x is to the right; positive y is down. + +**MM_LOMETRIC:** Each logical unit is mapped to 0.1 millimeter. Positive x is to the right; positive y is up. + +**MM_HIMETRIC:** Each logical unit is mapped to 0.01 millimeter. Positive x is to the right; positive y is up. + +**MM_LOENGLISH:** Each logical unit is mapped to 0.01 inch. Positive x is to the right; positive y is up. + +**MM_HIENGLISH:** Each logical unit is mapped to 0.001 inch. Positive x is to the right; positive y is up. + +**MM_TWIPS:** Each logical unit is mapped to one twentieth (1/20) of a point. In printing, a point is 1/72 of an inch; therefore, 1/20 of a point is 1/1440 of an inch. This unit is also known as a "[**twip**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382)". + +Positive x is to the right; positive y is up. + +**MM_ISOTROPIC:** Logical units are mapped to arbitrary device units with equally scaled axes; that is, one unit along the x-axis is equal to one unit along the y-axis. The **META_SETWINDOWEXT** (section [2.3.5.30](#Section_28fbdde622ee4e49b162abf826f5bc00)) and **META_SETVIEWPORTEXT** (section [2.3.5.28](#Section_d558b1a426ba4ad6a9c8c3caecaf0b1a)) records specify the units and the orientation of the axes. + +The processing application SHOULD make adjustments as necessary to ensure the x and y units remain the same size. For example, when the window extent is set, the viewport SHOULD be adjusted to keep the units [**isotropic**](#gt_716e3252-cd28-451e-be10-bde8793f0534). + +**MM_ANISOTROPIC:** Logical units are mapped to arbitrary units with arbitrarily scaled axes. + +#### MetafileEscapes Enumeration + +The **MetafileEscapes Enumeration** specifies [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) functionality that might not be directly accessible through [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) records defined in the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)). + +These values are used by **Escape Record Types** (section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0)). + +223. typedef enum + + { + +   NEWFRAME = 0x0001, + +   ABORTDOC = 0x0002, + +   NEXTBAND = 0x0003, + +   SETCOLORTABLE = 0x0004, + +   GETCOLORTABLE = 0x0005, + +   FLUSHOUT = 0x0006, + +   DRAFTMODE = 0x0007, + +   QUERYESCSUPPORT = 0x0008, + +   SETABORTPROC = 0x0009, + +   STARTDOC = 0x000A, + +   ENDDOC = 0x000B, + +   GETPHYSPAGESIZE = 0x000C, + +   GETPRINTINGOFFSET = 0x000D, + +   GETSCALINGFACTOR = 0x000E, + +   META_ESCAPE_ENHANCED_METAFILE = 0x000F, + +   SETPENWIDTH = 0x0010, + +   SETCOPYCOUNT = 0x0011, + +   SETPAPERSOURCE = 0x0012, + +   PASSTHROUGH = 0x0013, + +   GETTECHNOLOGY = 0x0014, + +   SETLINECAP = 0x0015, + +   SETLINEJOIN = 0x0016, + +   SETMITERLIMIT = 0x0017, + +   BANDINFO = 0x0018, + +   DRAWPATTERNRECT = 0x0019, + +   GETVECTORPENSIZE = 0x001A, + +   GETVECTORBRUSHSIZE = 0x001B, + +   ENABLEDUPLEX = 0x001C, + +   GETSETPAPERBINS = 0x001D, + +   GETSETPRINTORIENT = 0x001E, + +   ENUMPAPERBINS = 0x001F, + +   SETDIBSCALING = 0x0020, + +   EPSPRINTING = 0x0021, + +   ENUMPAPERMETRICS = 0x0022, + +   GETSETPAPERMETRICS = 0x0023, + +   POSTSCRIPT_DATA = 0x0025, + +   POSTSCRIPT_IGNORE = 0x0026, + +   GETDEVICEUNITS = 0x002A, + +   GETEXTENDEDTEXTMETRICS = 0x0100, + +   GETPAIRKERNTABLE = 0x0102, + +   EXTTEXTOUT = 0x0200, + +   GETFACENAME = 0x0201, + +   DOWNLOADFACE = 0x0202, + +   METAFILE_DRIVER = 0x0801, + +   QUERYDIBSUPPORT = 0x0C01, + +   BEGIN_PATH = 0x1000, + +   CLIP_TO_PATH = 0x1001, + +   END_PATH = 0x1002, + +   OPENCHANNEL = 0x100E, + +   DOWNLOADHEADER = 0x100F, + +   CLOSECHANNEL = 0x1010, + +   POSTSCRIPT_PASSTHROUGH = 0x1013, + +   ENCAPSULATED_POSTSCRIPT = 0x1014, + +   POSTSCRIPT_IDENTIFY = 0x1015, + +   POSTSCRIPT_INJECTION = 0x1016, + +   CHECKJPEGFORMAT = 0x1017, + +   CHECKPNGFORMAT = 0x1018, + +   GET_PS_FEATURESETTING = 0x1019, + +   MXDC_ESCAPE = 0x101A, + +   SPCLPASSTHROUGH2 = 0x11D8 + + } MetafileEscapes; + +**NEWFRAME:** Notifies the printer driver that the application has finished writing to a page. + +**ABORTDOC:** Stops processing the current document. + +**NEXTBAND:** Notifies the printer driver that the application has finished writing to a band. + +**SETCOLORTABLE:** Sets color table values. + +**GETCOLORTABLE:** Gets color table values. + +**FLUSHOUT:** Causes all pending output to be flushed to the output device. + +**DRAFTMODE:** Indicates that the printer driver SHOULD print text only, and no graphics. + +**QUERYESCSUPPORT:** Queries a printer driver to determine whether a specific escape function is supported on the output device it drives. + +**SETABORTPROC:** Sets the application-defined function that allows a [**print job**](#gt_12a6e569-e97c-4761-92f0-e397f8d5125f) to be canceled during printing. + +**STARTDOC:** Notifies the printer driver that a new print job is starting. + +**ENDDOC:** Notifies the printer driver that the current print job is ending. + +**GETPHYSPAGESIZE:** Retrieves the physical page size currently selected on an output device. + +**GETPRINTINGOFFSET:** Retrieves the offset from the upper-left corner of the physical page where the actual printing or drawing begins. + +**GETSCALINGFACTOR:** Retrieves the scaling factors for the x-axis and the y-axis of a printer. + +**META_ESCAPE_ENHANCED_METAFILE:** Used to embed an [**enhanced metafile format (EMF)**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) metafile within a WMF [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +**SETPENWIDTH:** Sets the width of a pen in pixels. + +**SETCOPYCOUNT:** Sets the number of copies. + +**SETPAPERSOURCE:** Sets the source, such as a particular paper tray or bin on a printer, for output forms. + +**PASSTHROUGH:** This record passes through arbitrary data. + +**GETTECHNOLOGY:** Gets information concerning graphics technology that is supported on a device. + +**SETLINECAP:** Specifies the line-drawing mode to use in output to a device. + +**SETLINEJOIN:** Specifies the line-joining mode to use in output to a device. + +**SETMITERLIMIT:** Sets the limit for the length of miter joins to use in output to a device. + +**BANDINFO:** Retrieves or specifies settings concerning [**banding**](#gt_fb013c89-b7e1-48db-917c-4c967617219f) on a device, such as the number of bands. + +**DRAWPATTERNRECT:** Draws a rectangle with a defined pattern. + +**GETVECTORPENSIZE:** Retrieves the physical pen size currently defined on a device. + +**GETVECTORBRUSHSIZE:** Retrieves the physical brush size currently defined on a device. + +**ENABLEDUPLEX:** Enables or disables double-sided (duplex) printing on a device. + +**GETSETPAPERBINS:** Retrieves or specifies the source of output forms on a device. + +**GETSETPRINTORIENT:** Retrieves or specifies the paper orientation on a device. + +**ENUMPAPERBINS:** Retrieves information concerning the sources of different forms on an output device. + +**SETDIBSCALING:** Specifies the scaling of [**device-independent bitmaps (DIBs)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +**EPSPRINTING:** Indicates the start and end of an [**encapsulated PostScript (EPS)**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f) section. + +**ENUMPAPERMETRICS:** Queries a printer driver for paper dimensions and other forms data. + +**GETSETPAPERMETRICS:** Retrieves or specifies paper dimensions and other forms data on an output device. + +**POSTSCRIPT_DATA:** Sends arbitrary [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) data to an output device. + +**POSTSCRIPT_IGNORE:** Notifies an output device to ignore PostScript data. + +**GETDEVICEUNITS:** Gets the device units currently configured on an output device. + +**GETEXTENDEDTEXTMETRICS:** Gets extended text metrics currently configured on an output device. + +**GETPAIRKERNTABLE:** Gets the font kern table currently defined on an output device. + +**EXTTEXTOUT:** Draws text using the currently selected font, background color, and text color. + +**GETFACENAME:** Gets the font face name currently configured on a device. + +**DOWNLOADFACE:** Sets the font face name on a device. + +**METAFILE_DRIVER:** Queries a printer driver about the support for metafiles on an output device. + +**QUERYDIBSUPPORT:** Queries the printer driver about its support for DIBs on an output device. + +**BEGIN_PATH:** Opens a [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613). + +**CLIP_TO_PATH:** Defines a clip [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) that is bounded by a path. The input MUST be a 16-bit quantity that defines the action to take. + +**END_PATH:** Ends a path. + +**OPENCHANNEL:** The same as **STARTDOC** specified with a NULL document and output filename, data in [**raw mode**](#gt_4fe025f0-d6ae-4360-9998-125a5e33c39f), and a type of zero. + +**DOWNLOADHEADER:** Instructs the printer driver to download sets of PostScript procedures. + +**CLOSECHANNEL:** The same as ENDDOC. See OPENCHANNEL. + +**POSTSCRIPT_PASSTHROUGH:** Sends arbitrary data directly to a printer driver, which is expected to process this data only when in PostScript mode. See **POSTSCRIPT_IDENTIFY**.[\<14\>](#Appendix_A_14) + +**ENCAPSULATED_POSTSCRIPT:** Sends arbitrary data directly to the printer driver. + +**POSTSCRIPT_IDENTIFY:** Sets the printer driver to either PostScript or [**GDI**](#gt_6c550e84-9a9c-46ef-8716-7260fe29cae3) mode.[\<15\>](#Appendix_A_15) + +**POSTSCRIPT_INJECTION:** Inserts a block of raw data into a PostScript stream. The input MUST be a 32-bit quantity specifying the number of bytes to inject, a 16-bit quantity specifying the injection point, and a 16-bit quantity specifying the page number, followed by the bytes to inject.[\<16\>](#Appendix_A_16) + +**CHECKJPEGFORMAT:** Checks whether the printer supports a [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image.[\<17\>](#Appendix_A_17) + +**CHECKPNGFORMAT:** Checks whether the printer supports a [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) image.[\<18\>](#Appendix_A_18) + +**GET_PS_FEATURESETTING:** Gets information on a specified feature setting for a PostScript printer driver.[\<19\>](#Appendix_A_19) + +**MXDC_ESCAPE:** Enables applications to write documents to a file or to a printer in [**XML Paper Specification (XPS)**](#gt_0b8be35a-bc52-4a6d-b711-3ee441b1bf60) format.[\<20\>](#Appendix_A_20) + +**SPCLPASSTHROUGH2:** Enables applications to include private procedures and other arbitrary data in documents.[\<21\>](#Appendix_A_21) + +#### MetafileType Enumeration + +The **MetafileType Enumeration** specifies where the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) is stored. + +286. typedef enum + + { + +   MEMORYMETAFILE = 0x0001, + +   DISKMETAFILE = 0x0002 + + } MetafileType; + +**MEMORYMETAFILE:** Metafile is stored in memory. + +**DISKMETAFILE:** Metafile is stored on disk. + +#### MetafileVersion Enumeration + +The **MetafileVersion Enumeration** defines values that specify support for [**device-independent bitmaps (DIBs)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) in [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +291. typedef enum + + { + +   METAVERSION100 = 0x0100, + +   METAVERSION300 = 0x0300 + + } MetafileVersion; + +**METAVERSION100:** DIBs are not supported. + +**METAVERSION300:** DIBs are supported. + +#### MixMode Enumeration + +The **MixMode Enumeration** specifies the background mix mode for text, hatched brushes, and other nonsolid pen styles. + +296. typedef enum + + { + +   TRANSPARENT = 0x0001, + +   OPAQUE = 0x0002 + + } MixMode; + +**TRANSPARENT:** The background remains untouched. + +**OPAQUE:** The background is filled with the background color that is currently defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) before the text, hatched brush, or pen is drawn. + +#### OutPrecision Enumeration + +The **OutPrecision enumeration** defines values for output precision, which is the requirement for the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) to match specific font parameters, including height, width, character orientation, escapement, [**pitch**](#gt_0f2ba14a-c9b3-4cc8-8840-a24c0aed5eb9), and font type. + +301. typedef enum + + { + +   OUT_DEFAULT_PRECIS = 0x00000000, + +   OUT_STRING_PRECIS = 0x00000001, + +   OUT_STROKE_PRECIS = 0x00000003, + +   OUT_TT_PRECIS = 0x00000004, + +   OUT_DEVICE_PRECIS = 0x00000005, + +   OUT_RASTER_PRECIS = 0x00000006, + +   OUT_TT_ONLY_PRECIS = 0x00000007, + +   OUT_OUTLINE_PRECIS = 0x00000008, + +   OUT_SCREEN_OUTLINE_PRECIS = 0x00000009, + +   OUT_PS_ONLY_PRECIS = 0x0000000A + + } OutPrecision; + +**OUT_DEFAULT_PRECIS:** A value that specifies default behavior. + +**OUT_STRING_PRECIS:** A value that is returned when [**rasterized fonts**](#gt_e4616703-011e-4bcf-842a-fbd0f778d76c) are enumerated. + +**OUT_STROKE_PRECIS:** A value that is returned when [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) and other [**outline fonts**](#gt_b1b9e27d-9dbc-4dfe-8d65-176a6a660ff6), and [**vector fonts**](#gt_4795d9b6-f3e9-4435-874e-bb6882ea1f0f) are enumerated. + +**OUT_TT_PRECIS:** A value that specifies the choice of a TrueType font when the system contains multiple fonts with the same name. + +**OUT_DEVICE_PRECIS:** A value that specifies the choice of a device font when the system contains multiple fonts with the same name. + +**OUT_RASTER_PRECIS:** A value that specifies the choice of a rasterized font when the system contains multiple fonts with the same name. + +**OUT_TT_ONLY_PRECIS:** A value that specifies the requirement for only TrueType fonts. If there are no TrueType fonts installed in the system, default behavior is specified. + +**OUT_OUTLINE_PRECIS:** A value that specifies the requirement for TrueType and other outline fonts. + +**OUT_SCREEN_OUTLINE_PRECIS:** A value that specifies a preference for TrueType and other outline fonts. + +**OUT_PS_ONLY_PRECIS:** A value that specifies a requirement for only [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) fonts. If there are no PostScript fonts installed in the system, default behavior is specified. + +#### PaletteEntryFlag Enumeration + +The **PaletteEntryFlag Enumeration** specifies how the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) entry is used. + +314. typedef enum + + { + +   PC_RESERVED = 0x01, + +   PC_EXPLICIT = 0x02, + +   PC_NOCOLLAPSE = 0x04 + + } PaletteEntryFlag; + +**PC_RESERVED:** Specifies that the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) entry be used for palette animation. This value prevents other windows from matching colors to the palette entry because the color frequently changes. If an unused system-palette entry is available, the color is placed in that entry. Otherwise, the color is not available for animation. + +**PC_EXPLICIT:** Specifies that the low-order word of the logical palette entry designates a hardware palette index. This value allows the application to show the contents of the display device palette. + +**PC_NOCOLLAPSE:** Specifies that the color be placed in an unused entry in the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe) instead of being matched to an existing color in the system palette. If there are no unused entries in the system palette, the color is matched normally. Once this color is in the system palette, colors in other logical palettes can be matched to this color. + +#### PenStyle Enumeration + +The 16-bit **PenStyle Enumeration** is used to specify different types of pens that can be used in graphics operations. + +Various styles can be combined by using a logical OR statement, one from each subsection of Style, EndCap, Join, and Type (Cosmetic). + +320. typedef enum + + { + +   PS_COSMETIC = 0x0000, + +   PS_ENDCAP_ROUND = 0x0000, + +   PS_JOIN_ROUND = 0x0000, + +   PS_SOLID = 0x0000, + +   PS_DASH = 0x0001, + +   PS_DOT = 0x0002, + +   PS_DASHDOT = 0x0003, + +   PS_DASHDOTDOT = 0x0004, + +   PS_NULL = 0x0005, + +   PS_INSIDEFRAME = 0x0006, + +   PS_USERSTYLE = 0x0007, + +   PS_ALTERNATE = 0x0008, + +   PS_ENDCAP_SQUARE = 0x0100, + +   PS_ENDCAP_FLAT = 0x0200, + +   PS_JOIN_BEVEL = 0x1000, + +   PS_JOIN_MITER = 0x2000 + + } PenStyle; + +**PS_COSMETIC:** The pen is cosmetic. + +**PS_ENDCAP_ROUND:** Line end caps are round. + +**PS_JOIN_ROUND:** Line joins are round. + +**PS_SOLID:** The pen is solid. + +**PS_DASH:** The pen is dashed. + +**PS_DOT:** The pen is dotted. + +**PS_DASHDOT:** The pen has alternating dashes and dots. + +**PS_DASHDOTDOT:** The pen has dashes and double dots. + +**PS_NULL:** The pen is invisible. + +**PS_INSIDEFRAME:** The pen is solid. When this pen is used in any drawing record that takes a bounding rectangle, the dimensions of the figure are shrunk so that it fits entirely in the bounding rectangle, taking into account the width of the pen. + +**PS_USERSTYLE:** The pen uses a styling array supplied by the user. + +**PS_ALTERNATE:** The pen sets every other pixel (this style is applicable only for cosmetic pens). + +**PS_ENDCAP_SQUARE:** Line end caps are square. + +**PS_ENDCAP_FLAT:** Line end caps are flat. + +**PS_JOIN_BEVEL:** Line joins are beveled. + +**PS_JOIN_MITER:** Line joins are mitered when they are within the current limit set by the **SETMITERLIMIT Record** (section [2.3.6.42](#Section_d3e1016314c64e7c8315e125450944d8)). A join is beveled when it would exceed the limit. + +#### PitchFont Enumeration + +The **PitchFont Enumeration** defines values that are used for specifying characteristics of a font. The values are used to indicate whether the characters in a font have a fixed or variable width, or [**pitch**](#gt_0f2ba14a-c9b3-4cc8-8840-a24c0aed5eb9). + +339. typedef enum + + { + +   DEFAULT_PITCH = 0, + +   FIXED_PITCH = 1, + +   VARIABLE_PITCH = 2 + + } PitchFont; + +**DEFAULT_PITCH:** The default pitch, which is implementation-dependent. + +**FIXED_PITCH:** A fixed pitch, which means that all the characters in the font occupy the same width when output in a string. + +**VARIABLE_PITCH:** A variable pitch, which means that the characters in the font occupy widths that are proportional to the actual widths of the glyphs when output in a string. For example, the "i" and space characters usually have much smaller widths than a "W" or "O" character. + +In a **Font Object** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)), when a **FamilyFont Enumeration** (section [2.1.1.8](#Section_9a6327661f1c4e2bb1a4f5b1a45f99ad)) value is packed into a byte with a **PitchFont** value, the result is a **PitchAndFamily Object** (section [2.2.2.14](#Section_b73da50d697d41bdbc51213fd1c68a2e)). + +#### PolyFillMode Enumeration + +The **PolyFillMode Enumeration** specifies the method used for filling a polygon. + +345. typedef enum + + { + +   ALTERNATE = 0x0001, + +   WINDING = 0x0002 + + } PolyFillMode; + +**ALTERNATE:** Selects alternate mode (fills the area between odd-numbered and even-numbered polygon sides on each scan line). + +**WINDING:** Selects winding mode (fills any [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) with a nonzero winding value). + +#### PostScriptCap Enumeration + +The **PostScriptCap Enumeration** defines line-ending types for use with a [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +350. typedef enum + + { + +   PostScriptNotSet = -2, + +   PostScriptFlatCap = 0, + +   PostScriptRoundCap = 1, + +   PostScriptSquareCap = 2 + + } PostScriptCap; + +**PostScriptNotSet:** Specifies that the line-ending style has not been set and that a default style can be used.[\<22\>](#Appendix_A_22) + +**PostScriptFlatCap:** Specifies that the line ends at the last point. The end is squared off. + +**PostScriptRoundCap:** Specifies a circular cap. The center of the circle is the last point in the line. The diameter of the circle is the same as the line width; that is, the thickness of the line. + +**PostScriptSquareCap:** Specifies a square cap. The center of the square is the last point in the line. The height and width of the square are the same as the line width; that is, the thickness of the line. + +#### PostScriptClipping Enumeration + +The **PostScriptClipping Enumeration** defines functions that can be applied to the clipping [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613) used for [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) output. + +357. typedef enum + + { + +   CLIP_SAVE = 0x0000, + +   CLIP_RESTORE = 0x0001, + +   CLIP_INCLUSIVE = 0x0002 + + } PostScriptClipping; + +**CLIP_SAVE:** Saves the current PostScript clipping path. + +**CLIP_RESTORE:** Restores the PostScript clipping path to the last clipping path that was saved by a previous **CLIP_SAVE** function applied by a **CLIP_TO_PATH Record** (section [2.3.6.6](#Section_4f55db445e8542d7aa780529270d4631)). + +**CLIP_INCLUSIVE:** Intersects the current PostScript clipping path with the current clipping path and saves the result as the new PostScript clipping path. + +#### PostScriptFeatureSetting Enumeration + +The **PostScriptFeatureSetting Enumeration** defines values that are used to retrieve information about specific features in a [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65).[\<23\>](#Appendix_A_23) + +363. typedef enum + + { + +   FEATURESETTING_NUP = 0x00000000, + +   FEATURESETTING_OUTPUT = 0x00000001, + +   FEATURESETTING_PSLEVEL = 0x00000002, + +   FEATURESETTING_CUSTPAPER = 0x00000003, + +   FEATURESETTING_MIRROR = 0x00000004, + +   FEATURESETTING_NEGATIVE = 0x00000005, + +   FEATURESETTING_PROTOCOL = 0x00000006, + +   FEATURESETTING_PRIVATE_BEGIN = 0x00001000, + +   FEATURESETTING_PRIVATE_END = 0x00001FFF + + } PostScriptFeatureSetting; + +**FEATURESETTING_NUP:** Specifies the [**n-up printing**](#gt_a1da4916-9932-4274-a4db-dd3994a9ba1b) (page layout) setting. + +**FEATURESETTING_OUTPUT:** Specifies PostScript driver output options. + +**FEATURESETTING_PSLEVEL:** Specifies the language level. + +**FEATURESETTING_CUSTPAPER:** Specifies custom paper parameters. + +**FEATURESETTING_MIRROR:** Specifies the mirrored output setting. + +**FEATURESETTING_NEGATIVE:** Specifies the negative output setting. + +**FEATURESETTING_PROTOCOL:** Specifies the output protocol setting. + +**FEATURESETTING_PRIVATE_BEGIN:** Specifies the start of a range of values that a driver can use for retrieving data concerning proprietary features.[\<24\>](#Appendix_A_24) + +**FEATURESETTING_PRIVATE_END:** Specifies the end of a range of values that a driver can use for retrieving data concerning proprietary features.[\<25\>](#Appendix_A_25) + +#### PostScriptJoin Enumeration + +The **PostScriptJoin Enumeration** defines line-joining capabilities for use with a [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +375. typedef enum + + { + +   PostScriptNotSet = -2, + +   PostScriptMiterJoin = 0, + +   PostScriptRoundJoin = 1, + +   PostScriptBevelJoin = 2 + + } PostScriptJoin; + +**PostScriptNotSet:** Specifies that the line-joining style has not been set and that a default style can be used.[\<26\>](#Appendix_A_26) + +**PostScriptMiterJoin:** Specifies a mitered join, which produces a sharp or clipped corner. + +**PostScriptRoundJoin:** Specifies a circular join, which produces a smooth, circular arc between the lines. + +**PostScriptBevelJoin:** Specifies a beveled join, which produces a diagonal corner. + +#### StretchMode Enumeration + +The **StretchMode Enumeration** specifies the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) stretching mode, which defines how the system combines rows or columns of a bitmap with existing pixels. + +382. typedef enum + + { + +   BLACKONWHITE = 0x0001, + +   WHITEONBLACK = 0x0002, + +   COLORONCOLOR = 0x0003, + +   HALFTONE = 0x0004 + + } StretchMode; + +**BLACKONWHITE:** Performs a Boolean AND operation by using the color values for the eliminated and existing pixels. If the bitmap is a monochrome bitmap, this mode preserves black pixels at the expense of white pixels.[\<27\>](#Appendix_A_27) + +**WHITEONBLACK:** Performs a Boolean OR operation by using the color values for the eliminated and existing pixels. If the bitmap is a monochrome bitmap, this mode preserves white pixels at the expense of black pixels.[\<28\>](#Appendix_A_28) + +**COLORONCOLOR:** Deletes the pixels. This mode deletes all eliminated lines of pixels without trying to preserve their information.[\<29\>](#Appendix_A_29) + +**HALFTONE:** Maps pixels from the source rectangle into blocks of pixels in the destination rectangle. The average color over the destination block of pixels approximates the color of the source pixels.[\<30\>](#Appendix_A_30) + +After setting the **HALFTONE** stretching mode, the brush origin MUST be set to avoid misalignment artifacts. + +#### TernaryRasterOperation Enumeration + +The **TernaryRasterOperation Enumeration** specifies ternary [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) codes, which define how to combine the bits in a source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) with the bits in a destination bitmap. + +389. typedef enum + + { + +   BLACKNESS = 0x00, + +   DPSOON = 0x01, + +   DPSONA = 0x02, + +   PSON = 0x03, + +   SDPONA = 0x04, + +   DPON = 0x05, + +   PDSXNON = 0x06, + +   PDSAON = 0x07, + +   SDPNAA = 0x08, + +   PDSXON = 0x09, + +   DPNA = 0x0A, + +   PSDNAON = 0x0B, + +   SPNA = 0x0C, + +   PDSNAON = 0x0D, + +   PDSONON = 0x0E, + +   PN = 0x0F, + +   PDSONA = 0x10, + +   NOTSRCERASE = 0x11, + +   SDPXNON = 0x12, + +   SDPAON = 0x13, + +   DPSXNON = 0x14, + +   DPSAON = 0x15, + +   PSDPSANAXX = 0x16, + +   SSPXDSXAXN = 0x17, + +   SPXPDXA = 0x18, + +   SDPSANAXN = 0x19, + +   PDSPAOX = 0x1A, + +   SDPSXAXN = 0x1B, + +   PSDPAOX = 0x1C, + +   DSPDXAXN = 0x1D, + +   PDSOX = 0x1E, + +   PDSOAN = 0x1F, + +   DPSNAA = 0x20, + +   SDPXON = 0x21, + +   DSNA = 0x22, + +   SPDNAON = 0x23, + +   SPXDSXA = 0x24, + +   PDSPANAXN = 0x25, + +   SDPSAOX = 0x26, + +   SDPSXNOX = 0x27, + +   DPSXA = 0x28, + +   PSDPSAOXXN = 0x29, + +   DPSANA = 0x2A, + +   SSPXPDXAXN = 0x2B, + +   SPDSOAX = 0x2C, + +   PSDNOX = 0x2D, + +   PSDPXOX = 0x2E, + +   PSDNOAN = 0x2F, + +   PSNA = 0x30, + +   SDPNAON = 0x31, + +   SDPSOOX = 0x32, + +   NOTSRCCOPY = 0x33, + +   SPDSAOX = 0x34, + +   SPDSXNOX = 0x35, + +   SDPOX = 0x36, + +   SDPOAN = 0x37, + +   PSDPOAX = 0x38, + +   SPDNOX = 0x39, + +   SPDSXOX = 0x3A, + +   SPDNOAN = 0x3B, + +   PSX = 0x3C, + +   SPDSONOX = 0x3D, + +   SPDSNAOX = 0x3E, + +   PSAN = 0x3F, + +   PSDNAA = 0x40, + +   DPSXON = 0x41, + +   SDXPDXA = 0x42, + +   SPDSANAXN = 0x43, + +   SRCERASE = 0x44, + +   DPSNAON = 0x45, + +   DSPDAOX = 0x46, + +   PSDPXAXN = 0x47, + +   SDPXA = 0x48, + +   PDSPDAOXXN = 0x49, + +   DPSDOAX = 0x4A, + +   PDSNOX = 0x4B, + +   SDPANA = 0x4C, + +   SSPXDSXOXN = 0x4D, + +   PDSPXOX = 0x4E, + +   PDSNOAN = 0x4F, + +   PDNA = 0x50, + +   DSPNAON = 0x51, + +   DPSDAOX = 0x52, + +   SPDSXAXN = 0x53, + +   DPSONON = 0x54, + +   DSTINVERT = 0x55, + +   DPSOX = 0x56, + +   DPSOAN = 0x57, + +   PDSPOAX = 0x58, + +   DPSNOX = 0x59, + +   PATINVERT = 0x5A, + +   DPSDONOX = 0x5B, + +   DPSDXOX = 0x5C, + +   DPSNOAN = 0x5D, + +   DPSDNAOX = 0x5E, + +   DPAN = 0x5F, + +   PDSXA = 0x60, + +   DSPDSAOXXN = 0x61, + +   DSPDOAX = 0x62, + +   SDPNOX = 0x63, + +   SDPSOAX = 0x64, + +   DSPNOX = 0x65, + +   SRCINVERT = 0x66, + +   SDPSONOX = 0x67, + +   DSPDSONOXXN = 0x68, + +   PDSXXN = 0x69, + +   DPSAX = 0x6A, + +   PSDPSOAXXN = 0x6B, + +   SDPAX = 0x6C, + +   PDSPDOAXXN = 0x6D, + +   SDPSNOAX = 0x6E, + +   PDXNAN = 0x6F, + +   PDSANA = 0x70, + +   SSDXPDXAXN = 0x71, + +   SDPSXOX = 0x72, + +   SDPNOAN = 0x73, + +   DSPDXOX = 0x74, + +   DSPNOAN = 0x75, + +   SDPSNAOX = 0x76, + +   DSAN = 0x77, + +   PDSAX = 0x78, + +   DSPDSOAXXN = 0x79, + +   DPSDNOAX = 0x7A, + +   SDPXNAN = 0x7B, + +   SPDSNOAX = 0x7C, + +   DPSXNAN = 0x7D, + +   SPXDSXO = 0x7E, + +   DPSAAN = 0x7F, + +   DPSAA = 0x80, + +   SPXDSXON = 0x81, + +   DPSXNA = 0x82, + +   SPDSNOAXN = 0x83, + +   SDPXNA = 0x84, + +   PDSPNOAXN = 0x85, + +   DSPDSOAXX = 0x86, + +   PDSAXN = 0x87, + +   SRCAND = 0x88, + +   SDPSNAOXN = 0x89, + +   DSPNOA = 0x8A, + +   DSPDXOXN = 0x8B, + +   SDPNOA = 0x8C, + +   SDPSXOXN = 0x8D, + +   SSDXPDXAX = 0x8E, + +   PDSANAN = 0x8F, + +   PDSXNA = 0x90, + +   SDPSNOAXN = 0x91, + +   DPSDPOAXX = 0x92, + +   SPDAXN = 0x93, + +   PSDPSOAXX = 0x94, + +   DPSAXN = 0x95, + +   DPSXX = 0x96, + +   PSDPSONOXX = 0x97, + +   SDPSONOXN = 0x98, + +   DSXN = 0x99, + +   DPSNAX = 0x9A, + +   SDPSOAXN = 0x9B, + +   SPDNAX = 0x9C, + +   DSPDOAXN = 0x9D, + +   DSPDSAOXX = 0x9E, + +   PDSXAN = 0x9F, + +   DPA = 0xA0, + +   PDSPNAOXN = 0xA1, + +   DPSNOA = 0xA2, + +   DPSDXOXN = 0xA3, + +   PDSPONOXN = 0xA4, + +   PDXN = 0xA5, + +   DSPNAX = 0xA6, + +   PDSPOAXN = 0xA7, + +   DPSOA = 0xA8, + +   DPSOXN = 0xA9, + +   D = 0xAA, + +   DPSONO = 0xAB, + +   SPDSXAX = 0xAC, + +   DPSDAOXN = 0xAD, + +   DSPNAO = 0xAE, + +   DPNO = 0xAF, + +   PDSNOA = 0xB0, + +   PDSPXOXN = 0xB1, + +   SSPXDSXOX = 0xB2, + +   SDPANAN = 0xB3, + +   PSDNAX = 0xB4, + +   DPSDOAXN = 0xB5, + +   DPSDPAOXX = 0xB6, + +   SDPXAN = 0xB7, + +   PSDPXAX = 0xB8, + +   DSPDAOXN = 0xB9, + +   DPSNAO = 0xBA, + +   MERGEPAINT = 0xBB, + +   SPDSANAX = 0xBC, + +   SDXPDXAN = 0xBD, + +   DPSXO = 0xBE, + +   DPSANO = 0xBF, + +   MERGECOPY = 0xC0, + +   SPDSNAOXN = 0xC1, + +   SPDSONOXN = 0xC2, + +   PSXN = 0xC3, + +   SPDNOA = 0xC4, + +   SPDSXOXN = 0xC5, + +   SDPNAX = 0xC6, + +   PSDPOAXN = 0xC7, + +   SDPOA = 0xC8, + +   SPDOXN = 0xC9, + +   DPSDXAX = 0xCA, + +   SPDSAOXN = 0xCB, + +   SRCCOPY = 0xCC, + +   SDPONO = 0xCD, + +   SDPNAO = 0xCE, + +   SPNO = 0xCF, + +   PSDNOA = 0xD0, + +   PSDPXOXN = 0xD1, + +   PDSNAX = 0xD2, + +   SPDSOAXN = 0xD3, + +   SSPXPDXAX = 0xD4, + +   DPSANAN = 0xD5, + +   PSDPSAOXX = 0xD6, + +   DPSXAN = 0xD7, + +   PDSPXAX = 0xD8, + +   SDPSAOXN = 0xD9, + +   DPSDANAX = 0xDA, + +   SPXDSXAN = 0xDB, + +   SPDNAO = 0xDC, + +   SDNO = 0xDD, + +   SDPXO = 0xDE, + +   SDPANO = 0xDF, + +   PDSOA = 0xE0, + +   PDSOXN = 0xE1, + +   DSPDXAX = 0xE2, + +   PSDPAOXN = 0xE3, + +   SDPSXAX = 0xE4, + +   PDSPAOXN = 0xE5, + +   SDPSANAX = 0xE6, + +   SPXPDXAN = 0xE7, + +   SSPXDSXAX = 0xE8, + +   DSPDSANAXXN = 0xE9, + +   DPSAO = 0xEA, + +   DPSXNO = 0xEB, + +   SDPAO = 0xEC, + +   SDPXNO = 0xED, + +   SRCPAINT = 0xEE, + +   SDPNOO = 0xEF, + +   PATCOPY = 0xF0, + +   PDSONO = 0xF1, + +   PDSNAO = 0xF2, + +   PSNO = 0xF3, + +   PSDNAO = 0xF4, + +   PDNO = 0xF5, + +   PDSXO = 0xF6, + +   PDSANO = 0xF7, + +   PDSAO = 0xF8, + +   PDSXNO = 0xF9, + +   DPO = 0xFA, + +   PATPAINT = 0xFB, + +   PSO = 0xFC, + +   PSDNOO = 0xFD, + +   DPSOO = 0xFE, + +   WHITENESS = 0xFF + + } TernaryRasterOperation; + +**BLACKNESS:** + +> **Reverse Polish** = 00000042 +> +> **Common** = 0 + +**DPSOON:** + +> **Reverse Polish** = 00010289 +> +> **Common** = DPSoon + +**DPSONA:** + +> **Reverse Polish** = 00020C89 +> +> **Common** = DPSona + +**PSON:** + +> **Reverse Polish** = 000300AA +> +> **Common** = PSon + +**SDPONA:** + +> **Reverse Polish** = 00040C88 +> +> **Common** = SDPona + +**DPON:** + +> **Reverse Polish** = 000500A9 +> +> **Common** = DPon + +**PDSXNON:** + +> **Reverse Polish** = 00060865 +> +> **Common** = PDSxnon + +**PDSAON:** + +> **Reverse Polish** = 000702C5 +> +> **Common** = PDSaon + +**SDPNAA:** + +> **Reverse Polish** = 00080F08 +> +> **Common** = SDPnaa + +**PDSXON:** + +> **Reverse Polish** = 00090245 +> +> **Common** = PDSxon + +**DPNA:** + +> **Reverse Polish** = 000A0329 +> +> **Common** = DPna + +**PSDNAON:** + +> **Reverse Polish** = 000B0B2A +> +> **Common** = PSDnaon + +**SPNA:** + +> **Reverse Polish** = 000C0324 +> +> **Common** = SPna + +**PDSNAON:** + +> **Reverse Polish** = 000D0B25 +> +> **Common** = PDSnaon + +**PDSONON:** + +> **Reverse Polish** = 000E08A5 +> +> **Common** = PDSonon + +**PN:** + +> **Reverse Polish** = 000F0001 +> +> **Common** = Pn + +**PDSONA:** + +> **Reverse Polish** = 00100C85 +> +> **Common** = PDSona + +**NOTSRCERASE:** + +> **Reverse Polish** = 001100A6 +> +> **Common** = DSon + +**SDPXNON:** + +> **Reverse Polish** = 00120868 +> +> **Common** = SDPxnon + +**SDPAON:** + +> **Reverse Polish** = 001302C8 +> +> **Common** = SDPaon + +**DPSXNON:** + +> **Reverse Polish** = 00140869 +> +> **Common** = DPSxnon + +**DPSAON:** + +> **Reverse Polish** = 001502C9 +> +> **Common** = DPSaon + +**PSDPSANAXX:** + +> **Reverse Polish** = 00165CCA +> +> **Common** = PSDPSanaxx + +**SSPXDSXAXN:** + +> **Reverse Polish** = 00171D54 +> +> **Common** = SSPxDSxaxn + +**SPXPDXA:** + +> **Reverse Polish** = 00180D59 +> +> **Common** = SPxPDxa + +**SDPSANAXN:** + +> **Reverse Polish** = 00191CC8 +> +> **Common** = SDPSanaxn + +**PDSPAOX:** + +> **Reverse Polish** = 001A06C5 +> +> **Common** = PDSPaox + +**SDPSXAXN:** + +> **Reverse Polish** = 001B0768 +> +> **Common** = SDPSxaxn + +**PSDPAOX:** + +> **Reverse Polish** = 001C06CA +> +> **Common** = PSDPaox + +**DSPDXAXN:** + +> **Reverse Polish** = 001D0766 +> +> **Common** = DSPDxaxn + +**PDSOX:** + +> **Reverse Polish** = 001E01A5 +> +> **Common** = PDSox + +**PDSOAN:** + +> **Reverse Polish** = 001F0385 +> +> **Common** = PDSoan + +**DPSNAA:** + +> **Reverse Polish** = 00200F09 +> +> **Common** = DPSnaa + +**SDPXON:** + +> **Reverse Polish** = 00210248 +> +> **Common** = SDPxon + +**DSNA:** + +> **Reverse Polish** = 00220326 +> +> **Common** = DSna + +**SPDNAON:** + +> **Reverse Polish** = 00230B24 +> +> **Common** = SPDnaon + +**SPXDSXA:** + +> **Reverse Polish** = 00240D55 +> +> **Common** = SPxDSxa + +**PDSPANAXN:** + +> **Reverse Polish** = 00251CC5 +> +> **Common** = PDSPanaxn + +**SDPSAOX:** + +> **Reverse Polish** = 002606C8 +> +> **Common** = SDPSaox + +**SDPSXNOX:** + +> **Reverse Polish** = 00271868 +> +> **Common** = SDPSxnox + +**DPSXA:** + +> **Reverse Polish** = 00280369 +> +> **Common** = DPSxa + +**PSDPSAOXXN:** + +> **Reverse Polish** = 002916CA +> +> **Common** = PSDPSaoxxn + +**DPSANA:** + +> **Reverse Polish** = 002A0CC9 +> +> **Common** = DPSana + +**SSPXPDXAXN:** + +> **Reverse Polish** = 002B1D58 +> +> **Common** = SSPxPDxaxn + +**SPDSOAX:** + +> **Reverse Polish** = 002C0784 +> +> **Common** = SPDSoax + +**PSDNOX:** + +> **Reverse Polish** = 002D060A +> +> **Common** = PSDnox + +**PSDPXOX:** + +> **Reverse Polish** = 002E064A +> +> **Common** = PSDPxox + +**PSDNOAN:** + +> **Reverse Polish** = 002F0E2A +> +> **Common** = PSDnoan + +**PSNA:** + +> **Reverse Polish** = 0030032A +> +> **Common** = PSna + +**SDPNAON:** + +> **Reverse Polish** = 00310B28 +> +> **Common** = SDPnaon + +**SDPSOOX:** + +> **Reverse Polish** = 00320688 +> +> **Common** = SDPSoox + +**NOTSRCCOPY:** + +> **Reverse Polish** = 00330008 +> +> **Common** = Sn + +**SPDSAOX:** + +> **Reverse Polish** = 003406C4 +> +> **Common** = SPDSaox + +**SPDSXNOX:** + +> **Reverse Polish** = 00351864 +> +> **Common** = SPDSxnox + +**SDPOX:** + +> **Reverse Polish** = 003601A8 +> +> **Common** = SDPox + +**SDPOAN:** + +> **Reverse Polish** = 00370388 +> +> **Common** = SDPoan + +**PSDPOAX:** + +> **Reverse Polish** = 0038078A +> +> **Common** = PSDPoax + +**SPDNOX:** + +> **Reverse Polish** = 0390604 +> +> **Common** = SPDnox + +**SPDSXOX:** + +> **Reverse Polish** = 003A0644 +> +> **Common** = SPDSxox + +**SPDNOAN:** + +> **Reverse Polish** = 003B0E24 +> +> **Common** = SPDnoan + +**PSX:** + +> **Reverse Polish** = 003C004A +> +> **Common** = PSx + +**SPDSONOX:** + +> **Reverse Polish** = 003D18A4 +> +> **Common** = SPDSonox + +**SPDSNAOX:** + +> **Reverse Polish** = 003E1B24 +> +> **Common** = SPDSnaox + +**PSAN:** + +> **Reverse Polish** = 003F00EA +> +> **Common** = PSan + +**PSDNAA:** + +> **Reverse Polish** = 00400F0A +> +> **Common** = PSDnaa + +**DPSXON:** + +**Reverse Polish** = 00410249 + +> **Common** = DPSxon + +**SDXPDXA:** + +> **Reverse Polish** = 00420D5D +> +> **Common** = SDxPDxa + +**SPDSANAXN:** + +> **Reverse Polish** = 00431CC4 +> +> **Common** = SPDSanaxn + +**SRCERASE:** + +> **Reverse Polish** = 00440328 +> +> **Common** = SDna + +**DPSNAON:** + +> **Reverse Polish** = 00450B29 +> +> **Common** = DPSnaon + +**DSPDAOX:** + +> **Reverse Polish** = 004606C6 +> +> **Common** = DSPDaox + +**PSDPXAXN:** + +> **Reverse Polish** = 0047076A +> +> **Common** = PSDPxaxn + +**SDPXA:** + +> **Reverse Polish** = 00480368 +> +> **Common** = SDPxa + +**PDSPDAOXXN:** + +> **Reverse Polish** = 004916C5 +> +> **Common** = PDSPDaoxxn + +**DPSDOAX:** + +> **Reverse Polish** = 004A0789 +> +> **Common** = DPSDoax + +**PDSNOX:** + +> **Reverse Polish** = 004B0605 +> +> **Common** = PDSnox + +**SDPANA:** + +> **Reverse Polish** = 004C0CC8 +> +> **Common** = SDPana + +**SSPXDSXOXN:** + +> **Reverse Polish** = 004D1954 +> +> **Common** = SSPxDSxoxn + +**PDSPXOX:** + +> **Reverse Polish** = 004E0645 +> +> **Common** = PDSPxox + +**PDSNOAN:** + +> **Reverse Polish** = 004F0E25 +> +> **Common** = PDSnoan + +**PDNA:** + +> **Reverse Polish** = 00500325 +> +> **Common** = PDna + +**DSPNAON:** + +> **Reverse Polish** = 00510B26 +> +> **Common** = DSPnaon + +**DPSDAOX:** + +> **Reverse Polish** = 005206C9 +> +> **Common** = DPSDaox + +**SPDSXAXN:** + +> **Reverse Polish** = 00530764 +> +> **Common** = SPDSxaxn + +**DPSONON:** + +> **Reverse Polish** = 005408A9 +> +> **Common** = DPSonon + +**DSTINVERT:** + +> **Reverse Polish** = 00550009 +> +> **Common** = Dn + +**DPSOX:** + +> **Reverse Polish** = 005601A9 +> +> **Common** = DPSox + +**DPSOAN:** + +> **Reverse Polish** = 000570389 +> +> **Common** = DPSoan + +**PDSPOAX:** + +> **Reverse Polish** = 00580785 +> +> **Common** = PDSPoax + +**DPSNOX:** + +> **Reverse Polish** = 00590609 +> +> **Common** = DPSnox + +**PATINVERT:** + +> **Reverse Polish** = 005A0049 +> +> **Common** = DPx + +**DPSDONOX:** + +> **Reverse Polish** = 005B18A9 +> +> **Common** = DPSDonox + +**DPSDXOX:** + +> **Reverse Polish** = 005C0649 +> +> **Common** = DPSDxox + +**DPSNOAN:** + +> **Reverse Polish** = 005D0E29 +> +> **Common** = DPSnoan + +**DPSDNAOX:** + +> **Reverse Polish** = 005E1B29 +> +> **Common** = DPSDnaox + +**DPAN:** + +> **Reverse Polish** = 005F00E9 +> +> **Common** = DPan + +**PDSXA:** + +> **Reverse Polish** = 00600365 +> +> **Common** = PDSxa + +**DSPDSAOXXN:** + +> **Reverse Polish** = 006116C6 +> +> **Common** = DSPDSaoxxn + +**DSPDOAX:** + +> **Reverse Polish** = 00620786 +> +> **Common** = DSPDoax + +**SDPNOX:** + +> **Reverse Polish** = 00630608 +> +> **Common** = SDPnox + +**SDPSOAX:** + +> **Reverse Polish** = 00640788 +> +> **Common** = SDPSoax + +**DSPNOX:** + +> **Reverse Polish** = 00650606 +> +> **Common** = DSPnox + +**SRCINVERT:** + +> **Reverse Polish** = 00660046 +> +> **Common** = DSx + +**SDPSONOX:** + +> **Reverse Polish** = 006718A8 +> +> **Common** = SDPSonox + +**DSPDSONOXXN:** + +> **Reverse Polish** = 006858A6 +> +> **Common** = DSPDSonoxxn + +**PDSXXN:** + +> **Reverse Polish** = 00690145 +> +> **Common** = PDSxxn + +**DPSAX:** + +> **Reverse Polish** = 006A01E9 +> +> **Common** = DPSax + +**PSDPSOAXXN:** + +> **Reverse Polish** = 006B178A +> +> **Common** = PSDPSoaxxn + +**SDPAX:** + +> **Reverse Polish** = 006C01E8 +> +> **Common** = SDPax + +**PDSPDOAXXN:** + +> **Reverse Polish** = 006D1785 +> +> **Common** = PDSPDoaxxn + +**SDPSNOAX:** + +> **Reverse Polish** = 006E1E28 +> +> **Common** = SDPSnoax + +**PDXNAN:** + +> **Reverse Polish** = 006F0C65 +> +> **Common** = PDXnan + +**PDSANA:** + +> **Reverse Polish** = 00700CC5 +> +> **Common** = PDSana + +**SSDXPDXAXN:** + +> **Reverse Polish** = 00711D5C +> +> **Common** = SSDxPDxaxn + +**SDPSXOX:** + +> **Reverse Polish** = 00720648 +> +> **Common** = SDPSxox + +**SDPNOAN:** + +> **Reverse Polish** = 00730E28 +> +> **Common** = SDPnoan + +**DSPDXOX:** + +> **Reverse Polish** = 00740646 +> +> **Common** = DSPDxox + +**DSPNOAN:** + +> **Reverse Polish** = 00750E26 +> +> **Common** = DSPnoan + +**SDPSNAOX:** + +> **Reverse Polish** = 00761B28 +> +> **Common** = SDPSnaox + +**DSAN:** + +> **Reverse Polish** = 007700E6 +> +> **Common** = DSan + +**PDSAX:** + +> **Reverse Polish** = 007801E5 +> +> **Common** = PDSax + +**DSPDSOAXXN:** + +> **Reverse Polish** = 00791786 +> +> **Common** = DSPDSoaxxn + +**DPSDNOAX:** + +> **Reverse Polish** = 007A1E29 +> +> **Common** = DPSDnoax + +**SDPXNAN:** + +> **Reverse Polish** = 007B0C68 +> +> **Common** = SDPxnan + +**SPDSNOAX:** + +> **Reverse Polish** = 007C1E24 +> +> **Common** = SPDSnoax + +**DPSXNAN:** + +> **Reverse Polish** = 007D0C69 +> +> **Common** = DPSxnan + +**SPXDSXO:** + +> **Reverse Polish** = 007E0955 +> +> **Common** = SPxDSxo + +**DPSAAN:** + +> **Reverse Polish** = 007F03C9 +> +> **Common** = DPSaan + +**DPSAA:** + +> **Reverse Polish** = 008003E9 +> +> **Common** = DPSaa + +**SPXDSXON:** + +> **Reverse Polish** = 00810975 +> +> **Common** = SPxDSxon + +**DPSXNA:** + +> **Reverse Polish** = 00820C49 +> +> **Common** = DPSxna + +**SPDSNOAXN:** + +> **Reverse Polish** = 00831E04 +> +> **Common** = SPDSnoaxn + +**SDPXNA:** + +> **Reverse Polish** = 00840C48 +> +> **Common** = SDPxna + +**PDSPNOAXN:** + +> **Reverse Polish** = 00851E05 +> +> **Common** = PDSPnoaxn + +**DSPDSOAXX:** + +> **Reverse Polish** = 008617A6 +> +> **Common** = DSPDSoaxx + +**PDSAXN:** + +> **Reverse Polish** = 008701C5 +> +> **Common** = PDSaxn + +**SRCAND:** + +> **Reverse Polish** = 008800C6 +> +> **Common** = DSa + +**SDPSNAOXN:** + +> **Reverse Polish** = 00891B08 +> +> **Common** = SDPSnaoxn + +**DSPNOA:** + +> **Reverse Polish** = 008A0E06 +> +> **Common** = DSPnoa + +**DSPDXOXN:** + +> **Reverse Polish** = 008B0666 +> +> **Common** = DSPDxoxn + +**SDPNOA:** + +> **Reverse Polish** = 008C0E08 +> +> **Common** = SDPnoa + +**SDPSXOXN:** + +> **Reverse Polish** = 008D0668 +> +> **Common** = SDPSxoxn + +**SSDXPDXAX:** + +> **Reverse Polish** = 008E1D7C +> +> **Common** = SSDxPDxax + +**PDSANAN:** + +> **Reverse Polish** = 008F0CE5 +> +> **Common** = PDSanan + +**PDSXNA:** + +> **Reverse Polish** = 00900C45 +> +> **Common** = PDSxna + +**SDPSNOAXN:** + +> **Reverse Polish** = 00911E08 +> +> **Common** = SDPSnoaxn + +**DPSDPOAXX:** + +> **Reverse Polish** = 009217A9 +> +> **Common** = DPSDPoaxx + +**SPDAXN:** + +> **Reverse Polish** = 009301C4 +> +> **Common** = SPDaxn + +**PSDPSOAXX:** + +> **Reverse Polish** = 009417AA +> +> **Common** = PSDPSoaxx + +**DPSAXN:** + +> **Reverse Polish** = 009501C9 +> +> **Common** = DPSaxn + +**DPSXX:** + +> **Reverse Polish** = 00960169 +> +> **Common** = DPSxx + +**PSDPSONOXX:** + +> **Reverse Polish** = 0097588A +> +> **Common** = PSDPSonoxx + +**SDPSONOXN:** + +> **Reverse Polish** = 00981888 +> +> **Common** = SDPSonoxn + +**DSXN:** + +> **Reverse Polish** = 00990066 +> +> **Common** = DSxn + +**DPSNAX:** + +> **Reverse Polish** = 009A0709 +> +> **Common** = DPSnax + +**SDPSOAXN:** + +> **Reverse Polish** = 009B07A8 +> +> **Common** = SDPSoaxn + +**SPDNAX:** + +> **Reverse Polish** = 009C0704 +> +> **Common** = SPDnax + +**DSPDOAXN:** + +> **Reverse Polish** = 009D07A6 +> +> **Common** = DSPDoaxn + +**DSPDSAOXX:** + +> **Reverse Polish** = 009E16E6 +> +> **Common** = DSPDSaoxx + +**PDSXAN:** + +> **Reverse Polish** = 009F0345 +> +> **Common** = PDSxan + +**DPA:** + +> **Reverse Polish** = 00A000C9 +> +> **Common** = DPa + +**PDSPNAOXN:** + +> **Reverse Polish** = 00A11B05 +> +> **Common** = PDSPnaoxn + +**DPSNOA:** + +> **Reverse Polish** = 00A20E09 +> +> **Common** = DPSnoa + +**DPSDXOXN:** + +> **Reverse Polish** = 00A30669 +> +> **Common** = DPSDxoxn + +**PDSPONOXN:** + +> **Reverse Polish** = 00A41885 +> +> **Common** = PDSPonoxn + +**PDXN:** + +> **Reverse Polish** = 00A50065 +> +> **Common** = PDxn + +**DSPNAX:** + +> **Reverse Polish** = 00A60706 +> +> **Common** = DSPnax + +**PDSPOAXN:** + +> **Reverse Polish** = 00A707A5 +> +> **Common** = PDSPoaxn + +**DPSOA:** + +> **Reverse Polish** = 00A803A9 +> +> **Common** = DPSoa + +**DPSOXN:** + +> **Reverse Polish** = 00A90189 +> +> **Common** = DPSoxn + +**D:** + +> **Reverse Polish** = 00AA0029 +> +> **Common** = D + +**DPSONO:** + +> **Reverse Polish** = 00AB0889 +> +> **Common** = DPSono + +**SPDSXAX:** + +> **Reverse Polish** = 00AC0744 +> +> **Common** = SPDSxax + +**DPSDAOXN:** + +> **Reverse Polish** = 00AD06E9 +> +> **Common** = DPSDaoxn + +**DSPNAO:** + +> **Reverse Polish** = 00AE0B06 +> +> **Common** = DSPnao + +**DPNO:** + +> **Reverse Polish** = 00AF0229 +> +> **Common** = DPno + +**PDSNOA:** + +> **Reverse Polish** = 00B00E05 +> +> **Common** = PDSnoa + +**PDSPXOXN:** + +> **Reverse Polish** = 00B10665 +> +> **Common** = PDSPxoxn + +**SSPXDSXOX:** + +> **Reverse Polish** = 00B21974 +> +> **Common** = SSPxDSxox + +**SDPANAN:** + +> **Reverse Polish** = 00B30CE8 +> +> **Common** = SDPanan + +**PSDNAX:** + +> **Reverse Polish** = 00B4070A +> +> **Common** = PSDnax + +**DPSDOAXN:** + +> **Reverse Polish** = 00B507A9 +> +> **Common** = DPSDoaxn + +**DPSDPAOXX:** + +> **Reverse Polish** = 00B616E9 +> +> **Common** = DPSDPaoxx + +**SDPXAN:** + +> **Reverse Polish** = 00B70348 +> +> **Common** = SDPxan + +**PSDPXAX:** + +> **Reverse Polish** = 00B8074A +> +> **Common** = PSDPxax + +**DSPDAOXN:** + +> **Reverse Polish** = 00B906E6 +> +> **Common** = DSPDaoxn + +**DPSNAO:** + +> **Reverse Polish** = 00BA0B09 +> +> **Common** = DPSnao + +**MERGEPAINT:** + +> **Reverse Polish** = 00BB0226 +> +> **Common** = DSno + +**SPDSANAX:** + +> **Reverse Polish** = 00BC1CE4 +> +> **Common** = SPDSanax + +**SDXPDXAN:** + +> **Reverse Polish** = 00BD0D7D +> +> **Common** = SDxPDxan + +**DPSXO:** + +> **Reverse Polish** = 00BE0269 +> +> **Common** = DPSxo + +**DPSANO:** + +> **Reverse Polish** = 00BF08C9 +> +> **Common** = DPSano + +**MERGECOPY:** + +> **Reverse Polish** = 00C000CA +> +> **Common** = PSa + +**SPDSNAOXN:** + +> **Reverse Polish** = 00C11B04 +> +> **Common** = SPDSnaoxn + +**SPDSONOXN:** + +> **Reverse Polish** = 00C21884 +> +> **Common** = SPDSonoxn + +**PSXN:** + +> **Reverse Polish** = 00C3006A +> +> **Common** = PSxn + +**SPDNOA:** + +> **Reverse Polish** = 00C40E04 +> +> **Common** = SPDnoa + +**SPDSXOXN:** + +> **Reverse Polish** = 00C50664 +> +> **Common** = SPDSxoxn + +**SDPNAX:** + +> **Reverse Polish** = 00C60708 +> +> **Common** = SDPnax + +**PSDPOAXN:** + +> **Reverse Polish** = 00C707AA +> +> **Common** = PSDPoaxn + +**SDPOA:** + +> **Reverse Polish** = 00C803A8 +> +> **Common** = SDPoa + +**SPDOXN:** + +> **Reverse Polish** = 00C90184 +> +> **Common** = SPDoxn + +**DPSDXAX:** + +> **Reverse Polish** = 00CA0749 +> +> **Common** = DPSDxax + +**SPDSAOXN:** + +> **Reverse Polish** = 00CB06E4 +> +> **Common** = SPDSaoxn + +**SRCCOPY:** + +> **Reverse Polish** = 00CC0020 +> +> **Common** = S + +**SDPONO:** + +> **Reverse Polish** = 00CD0888 +> +> **Common** = SDPono + +**SDPNAO:** + +> **Reverse Polish** = 00CE0B08 +> +> **Common** = SDPnao + +**SPNO:** + +> **Reverse Polish** = 00CF0224 +> +> **Common** = SPno + +**PSDNOA:** + +> **Reverse Polish** =00D00E0A +> +> **Common** = PSDnoa + +**PSDPXOXN:** + +> **Reverse Polish** = 00D1066A +> +> **Common** = PSDPxoxn + +**PDSNAX:** + +> **Reverse Polish** = 00D20705 +> +> **Common** = PDSnax + +**SPDSOAXN:** + +> **Reverse Polish** = 00D307A4 +> +> **Common** = SPDSoaxn + +**SSPXPDXAX:** + +> **Reverse Polish** = 00D41D78 +> +> **Common** = SSPxPDxax + +**DPSANAN:** + +> **Reverse Polish** = 00D50CE9 +> +> **Common** = DPSanan + +**PSDPSAOXX:** + +> **Reverse Polish** = 00D616EA +> +> **Common** = PSDPSaoxx + +**DPSXAN:** + +> **Reverse Polish** = 00D70349 +> +> **Common** = DPSxan + +**PDSPXAX:** + +> **Reverse Polish** = 00D80745 +> +> **Common** = PDSPxax + +**SDPSAOXN:** + +> **Reverse Polish** = 00D906E8 +> +> **Common** = SDPSaoxn + +**DPSDANAX:** + +> **Reverse Polish** = 00DA1CE9 +> +> **Common** = DPSDanax + +**SPXDSXAN:** + +> **Reverse Polish** = 00DB0D75 +> +> **Common** = SPxDSxan + +**SPDNAO:** + +> **Reverse Polish** = 00DC0B04 +> +> **Common** = SPDnao + +**SDNO:** + +> **Reverse Polish** = 00DD0228 +> +> **Common** = SDno + +**SDPXO:** + +> **Reverse Polish** = 00DE0268 +> +> **Common** = SDPxo + +**SDPANO:** + +> **Reverse Polish** = 00DF08C8 +> +> **Common** = SDPano + +**PDSOA:** + +> **Reverse Polish** = 00E003A5 +> +> **Common** = PDSoa + +**PDSOXN:** + +> **Reverse Polish** = 00E10185 +> +> **Common** = PDSoxn + +**DSPDXAX:** + +> **Reverse Polish** = 00E20746 +> +> **Common** = DSPDxax + +**PSDPAOXN:** + +> **Reverse Polish** = 00E306EA +> +> **Common** = PSDPaoxn + +**SDPSXAX:** + +> **Reverse Polish** = 00E40748 +> +> **Common** = SDPSxax + +**PDSPAOXN:** + +> **Reverse Polish** = 00E506E5 +> +> **Common** = PDSPaoxn + +**SDPSANAX:** + +> **Reverse Polish** = 00E61CE8 +> +> **Common** = SDPSanax + +**SPXPDXAN:** + +> **Reverse Polish** = 00E70D79 +> +> **Common** = SPxPDxan + +**SSPXDSXAX:** + +> **Reverse Polish** = 00E81D74 +> +> **Common** = SSPxDSxax + +**DSPDSANAXXN:** + +> **Reverse Polish** = 00E95CE6 +> +> **Common** = DSPDSanaxxn + +**DPSAO:** + +> **Reverse Polish** = 00EA02E9 +> +> **Common** = DPSao + +**DPSXNO:** + +> **Reverse Polish** = 00EB0849 +> +> **Common** = DPSxno + +**SDPAO:** + +> **Reverse Polish** = 00EC02E8 +> +> **Common** = SDPao + +**SDPXNO:** + +> **Reverse Polish** = 00ED0848 +> +> **Common** = SDPxno + +**SRCPAINT:** + +> **Reverse Polish** = 00EE0086 +> +> **Common** = DSo + +**SDPNOO:** + +> **Reverse Polish** = 00EF0A08 +> +> **Common** = SDPnoo + +**PATCOPY:** + +> **Reverse Polish** = 00F00021 +> +> **Common** = P + +**PDSONO:** + +> **Reverse Polish** = 00F10885 +> +> **Common** = PDSono + +**PDSNAO:** + +> **Reverse Polish** = 00F20B05 +> +> **Common** = PDSnao + +**PSNO:** + +> **Reverse Polish** = 00F3022A +> +> **Common** = PSno + +**PSDNAO:** + +> **Reverse Polish** = 00F40B0A +> +> **Common** = PSDnao + +**PDNO:** + +> **Reverse Polish** = 00F50225 +> +> **Common** = PDno + +**PDSXO:** + +> **Reverse Polish** = 00F60265 +> +> **Common** = PDSxo + +**PDSANO:** + +> **Reverse Polish** = 00F708C5 +> +> **Common** = PDSano + +**PDSAO:** + +> **Reverse Polish** = 00F802E5 +> +> **Common** = PDSao + +**PDSXNO:** + +> **Reverse Polish** = 00F90845 +> +> **Common** = PDSxno + +**DPO:** + +> **Reverse Polish** = 00FA0089 +> +> **Common** = DPo + +**PATPAINT:** + +> **Reverse Polish** = 00FB0A09 +> +> **Common** = DPSnoo + +**PSO:** + +> **Reverse Polish** = 00FC008A +> +> **Common** = PSo + +**PSDNOO:** + +> **Reverse Polish** = 00FD0A0A +> +> **Common** = PSDnoo + +**DPSOO:** + +> **Reverse Polish** = 00FE02A9 +> +> **Common** = DPSoo + +**WHITENESS:** + +> **Reverse Polish** = 00FF0062 +> +> **Common** = 1 + +Each ternary raster operation code represents a Boolean operation in which the values of the pixels in the source, the selected brush, and the destination are combined. Following are the three operands used in these operations. + +| Operand | Meaning | +|---------|--------------------------------------| +| D | Destination bitmap | +| P | Selected brush (also called pattern) | +| S | Source bitmap | + +Following are the Boolean operators used in these operations. + +| Operator | Meaning | +|----------|----------------------------| +| a | Bitwise AND | +| n | Bitwise NOT (inverse) | +| o | Bitwise OR | +| x | Bitwise exclusive OR (XOR) | + +All Boolean operations are presented in [**reverse Polish notation**](#gt_0a595f18-03ac-4b23-b9f4-9924a0f1a4e6). For example, the following operation replaces the values of the pixels in the destination bitmap with a combination of the pixel values of the source and brush: PSo. For another example, the following operation combines the values of the pixels in the source and brush with the pixel values of the destination bitmap: DPSoo. + +Each raster operation code is a 32-bit integer whose high-order word is a Boolean operation index and whose low-order word is the operation code. The 16-bit operation index is a zero-extended, 8-bit value that represents the result of the Boolean operation on predefined brush, source, and destination values. For example, the operation indexes for the PSo and DPSoo operations are shown in the following list. + +| P | S | D | PSo | DPSoo | +|-----|-----|-----|-----|-------| +| 0 | 0 | 0 | 0 | 0 | +| 0 | 0 | 1 | 0 | 1 | +| 0 | 1 | 0 | 1 | 1 | +| 0 | 1 | 1 | 1 | 1 | +| 1 | 0 | 0 | 1 | 1 | +| 1 | 0 | 1 | 1 | 1 | +| 1 | 1 | 0 | 1 | 1 | +| 1 | 1 | 1 | 1 | 1 | + +The operation indexes are determined by reading the binary values in a column of the table from the bottom up. For example, in the PSo column, the binary value is 11111100, which is equivalent to 00FC (hexadecimal is implicit for these values), which is the operation index for PSo. + +Using this method, DPSoo can be seen to have the operation index 00FE. Operation indexes define the locations of corresponding raster operation codes in the preceding enumeration. The PSo operation is in line 252 (0x00FC) of the enumeration; DPSoo is in line 254 (0x00FE). + +The most commonly used raster operations have been given explicit enumeration names, which SHOULD be used; examples are **PATCOPY** and **WHITENESS**. + +When the source and destination bitmaps are monochrome, a bit value of 0 represents a black pixel and a bit value of 1 represents a white pixel. When the source and the destination bitmaps are color, those colors are represented with [**red green blue (RGB)**](#gt_799800d5-de1e-41fa-804c-2bcdd2326825) values. + +### WMF Flags + +This section contains constant flag values that are referenced in this specification. + +#### ClipPrecision Flags + +**ClipPrecision Flags** specify clipping precision, which defines how to clip characters that are partially outside a clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). These flags can be combined to specify multiple options. + +[TABLE] + +#### ExtTextOutOptions Flags + +**ExtTextOutOptions Flags** specify various characteristics of the output of text. These flags can be combined to specify multiple options. + +[TABLE] + +#### TextAlignmentMode Flags + +**TextAlignmentMode Flags** specify the relationship between a reference point and a bounding rectangle, for text alignment. These flags can be combined to specify multiple options, with the restriction that only one flag can be chosen that alters the drawing position in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +Horizontal text alignment is performed when the font has a horizontal default [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62). + +[TABLE] + +**TextAlignmentMode** flags specify three different components of text alignment: + +- The horizontal position of the reference point is determined by **TA_RIGHT** and **TA_CENTER**; if those bits are clear, the alignment MUST be **TA_LEFT**. + +- The vertical position of the reference point is determined by **TA_BOTTOM** and **TA_BASELINE**; if those bits are clear, the alignment MUST be **TA_TOP**. + +- Whether to update the output position in the playback device context after text output is determined by **TA_UPDATECP**; if that bit is clear, the position MUST NOT be updated. + +This is the reason for defining three different zero values in the enumeration; they represent the default states of the three components of text alignment. + +#### VerticalTextAlignmentMode Flags + +**VerticalTextAlignmentMode Flags** specify the relationship between a reference point and a bounding rectangle, for text alignment. These flags can be combined to specify multiple options, with the restriction that only one flag can be chosen that alters the drawing position in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +Vertical text alignment is performed when the font has a vertical default [**baseline**](#gt_81ddcdfb-c66c-4c83-b963-18da9456fa62), such as Kanji. + +[TABLE] + +When the font that is defined in the playback device context has a vertical default baseline, as with Kanji, **VerticalTextAlignmentMode** flags MUST be used instead of **TextAlignmentMode** flags (section [2.1.2.3](#Section_2cf0d8025db742f6bb7550ff195a6c7c)) where there exists an equivalent. + +Both horizontal and vertical flags are named relative to their respective baselines. Thus, **VTA_LEFT** is the same as **TA_BOTTOM**, because the bottom edge of the bounding rectangle in normal text orientation becomes the left edge of the bounding rectangle with orientation relative to the vertical baseline. + +## WMF Objects + +This section specifies **WMF Objects**, which are grouped into the following categories: + +| Name | Section | Description | +|----|----|----| +| Graphics object types | [2.2.1](#Section_aafd0883af3f43a69ccd201b725c370e) | Specify parameters for graphics output. They are part of the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) and can persistent over the span of multiple records during the playback of a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). | +| Structure object types | [2.2.2](#Section_4ac77df091164b6c9215ded079af0fd8) | Specify data structures that are embedded in WMF objects and records. Structure objects, unlike graphics objects, are not explicitly created or deleted; they are components of more complex structures. | + +### Graphics Objects + +The [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) **Graphics Objects** specify parameters for graphics output. They are explicitly created and deleted by records of the **Object Record Types** (section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da)) during the playback of an WMF [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). A particular graphics object becomes part of the **Playback Device Context** (section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b)) when it is selected by an appropriate **Object Record Type**, and it is reused in subsequent graphics operations until a different object is selected. + +The following types of **Graphics Objects** are defined: + +| Name | Section | Description | +|----|----|----| +| Brush | [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4) | Specifies a graphics brush for the filling of figures. | +| Font | [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f) | Specifies properties that determine the appearance of text, including [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789), size, and style. | +| Palette | [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5) | Specifies colors as device-independent values, which can be defined entirely by an application. | +| Pen | [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca) | Specifies a graphics pen for the drawing of lines. | +| Region | [2.2.1.5](#Section_28883669449d47239376e853cc067aed) | Specifies line and curve segments that define a shape. | + +An implementation is responsible for keeping track of graphics objects during playback of the metafile. An abstract model for managing WMF graphics objects is described in **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)). + +#### Brush Object + +The **Brush Object** defines the style, color, and pattern of a brush. **Brush Objects** are created by the **META_CREATEBRUSHINDIRECT** (section [2.3.4.1](#Section_8331e35d0f974ec3b3b0cfb3281c0642)), **META_CREATEPATTERNBRUSH** (section [2.3.4.4](#Section_6f1c6ba3771042c1b6e21b776c2f769b)) and **META_DIBCREATEPATTERNBRUSH** (section [2.3.4.8](#Section_8e83b6056a874fa6a1b782ba7efaa59f)) records. + +[TABLE] + +**BrushStyle (2 bytes):** A 16-bit unsigned integer that defines the brush style. The value MUST be an enumeration from the **BrushStyle Enumeration** table (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)). For the meanings of the different values, see the following table. + +**ColorRef (4 bytes):** A 32-bit field that specifies how to interpret color values in the object defined in the **BrushHatch** field. Its interpretation depends on the value of **BrushStyle**, as explained in the following table. + +**BrushHatch (variable):** A variable-size field that contains the brush hatch or pattern data. The content depends on the value of **BrushStyle**, as explained below. + +The **BrushStyle** field determines how the **ColorRef** and **BrushHatch** fields SHOULD be interpreted, as specified in the following table. + +The following table shows the relationship between the **BrushStyle**, **ColorRef**, and **BrushHatch** fields in a **Brush Object**. + +| BrushStyle | ColorRef | BrushHatch | +|----|----|----| +| BS_SOLID | SHOULD be a **ColorRef Object**, specified in section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86). | Not used, and SHOULD be ignored. | +| BS_NULL | SHOULD be ignored. | Not used, and SHOULD be ignored. | +| BS_PATTERN | SHOULD be ignored. | SHOULD be a **Bitmap16 Object**, specified in section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c), which defines the brush pattern. | +| BS_DIBPATTERNPT | SHOULD be a 32-bit **ColorUsage Enumeration** value, specified in section [2.1.1.6](#Section_30403797a40840cab024dd8a1acb39be); the low-order word specifies the meaning of color values in the [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). | SHOULD be a **DIB Object**, specified in section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1), which defines the brush pattern. | +| BS_HATCHED | SHOULD be a **ColorRef Object**, specified in section 2.2.2.8. | SHOULD be a 16-bit value from the **HatchStyle Enumeration** table, specified in section [2.1.1.12](#Section_3d08f11808e143f08d789005151b00fe), which defines the brush pattern. | + +#### Font Object + +The Font object specifies the attributes of a logical font. + +[TABLE] + +**Height (2 bytes):** A 16-bit signed integer that specifies the height, in logical units, of the font's character cell. The character height is computed as the character cell height minus the internal leading. The [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) SHOULD interpret the height as follows. + +| Value | Meaning | +|----|----| +| *value* \< 0x0000 | The font mapper SHOULD transform this value into device units and match its absolute value against the character height of available fonts. | +| 0x0000 | A default height value MUST be used when creating a physical font. | +| 0x0000 \< *value* | The font mapper SHOULD transform this value into device units and match it against the cell height of available fonts. | + +> For all height comparisons, the font mapper SHOULD find the largest physical font that does not exceed the requested size.[\<40\>](#Appendix_A_40) + +**Width (2 bytes):** A 16-bit signed integer that defines the average width, in logical units, of characters in the font. If **Width** is 0x0000, the [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5) of the device SHOULD be matched against the digitization aspect ratio of the available fonts to find the closest match, determined by the absolute value of the difference. + +**Escapement (2 bytes):** A 16-bit signed integer that defines the angle, in tenths of degrees, between the escapement vector and the x-axis of the device. The escapement vector is parallel to the base line of a row of text. + +**Orientation (2 bytes):** A 16-bit signed integer that defines the angle, in tenths of degrees, between each character's base line and the x-axis of the device. + +**Weight (2 bytes):** A 16-bit signed integer that defines the weight of the font in the range 0 through 1000. For example, 400 is normal and 700 is bold. If this value is 0x0000, a default weight SHOULD be used. + +**Italic (1 byte):** A 8-bit Boolean value that specifies the italic attribute of the font. + +[TABLE] + +**Underline (1 byte):** An 8-bit Boolean value that specifies the underline attribute of the font. + +[TABLE] + +**StrikeOut (1 byte):** An 8-bit Boolean value that specifies the strikeout attribute of the font. + +[TABLE] + +**CharSet (1 byte):** An 8-bit unsigned integer that defines the character set. It SHOULD be set to a value in the **CharacterSet Enumeration** (section [2.1.1.5](#Section_0d0b32aca8364bd2a112b6000a1b4fc9)). + +The DEFAULT_CHARSET value MAY be used to allow the name and size of a font to fully describe the logical font. If the specified font name does not exist, a font in another character set MAY be substituted. The DEFAULT_CHARSET value is set to a value based on the current system locale. For example, when the system locale is United States, it is set to ANSI_CHARSET. + +If a [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) name in the **FaceName** field is specified, the CharSet value MUST match the character set of that typeface. + +**OutPrecision (1 byte):** An 8-bit unsigned integer that defines the output precision. The output precision defines how closely the output matches the requested font height, width, character orientation, escapement, [**pitch**](#gt_0f2ba14a-c9b3-4cc8-8840-a24c0aed5eb9), and font type. It MUST be one of the values from the **OutPrecision Enumeration** (section [2.1.1.21](#Section_28ebf28863cf4b649113410a63cf792d)). + +Applications can use the OUT_DEVICE_PRECIS, OUT_RASTER_PRECIS, OUT_TT_PRECIS, and OUT_PS_ONLY_PRECIS values to control how the font mapper selects a font when the operating system contains more than one font with a specified name. For example, if an operating system contains a font named "Symbol" in raster and [**TrueType**](#gt_855615c9-5378-459f-8d58-20f640afed6e) forms, specifying OUT_TT_PRECIS forces the font mapper to select the TrueType version. Specifying OUT_TT_ONLY_PRECIS forces the font mapper to select a TrueType font, even if it substitutes a TrueType font of another name. + +**ClipPrecision (1 byte):** An 8-bit unsigned integer that defines the clipping precision. The clipping precision defines how to clip characters that are partially outside the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). It MUST be a combination of one or more of the bit settings in the **ClipPrecision Flags** (section [2.1.2.1](#Section_c85e4c50f5814d22826c854e7b50e75d)). + +**Quality (1 byte):** An 8-bit unsigned integer that defines the output quality. The output quality defines how carefully to attempt to match the logical font attributes to those of an actual physical font. It MUST be one of the values in the **FontQuality Enumeration** (section [2.1.1.10](#Section_9518feced2f247999df6ba3db1d73371)). + +**PitchAndFamily (1 byte):** A **PitchAndFamily Object** (section [2.2.2.14](#Section_b73da50d697d41bdbc51213fd1c68a2e)) that defines the pitch and the family of the font. Font families specify the look of fonts in a general way and are intended for specifying fonts when the exact typeface wanted is not available. + +**Facename (32 bytes):** A null-terminated string of up to 32 8-bit Latin-1 [\[ISO/IEC-8859-1\]](https://go.microsoft.com/fwlink/?LinkId=90689) ANSI characters that specifies the typeface name of the font.  Any characters following the terminating null are ignored. + +#### Palette Object + +The **Palette Object** specifies the colors in a [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3). + +[TABLE] + +**Start (2 bytes):** A 16-bit unsigned integer that defines the offset into the **Palette Object** when used with the META_SETPALENTRIES and META_ANIMATEPALETTE record types. When used with META_CREATEPALETTE record type, it MUST be 0x0300. + +**NumberOfEntries (2 bytes):** A 16-bit unsigned integer that defines the number of objects in **aPaletteEntries**. + +**aPaletteEntries (variable):** An array of **NumberOfEntries** 32-bit **PaletteEntry Objects** (section [2.2.2.13](#Section_1813d77e0c2b455cb1ae2a234a698449)). + +#### Pen Object + +The **Pen Object** specifies the style, width, and color of a pen. + +[TABLE] + +**PenStyle (2 bytes):** A 16-bit unsigned integer that specifies the pen style. The value MUST be defined from the **PenStyle Enumeration** (section [2.1.1.23](#Section_2af5f7e49abb4fb4b428d739c8b23829)) table. + +**Width (4 bytes):** A 32-bit **PointS Object** (section [2.2.2.16](#Section_3066aeb312f54ed9bf2518c73a6e7175)) that specifies a point for the object dimensions. The x-coordinate is the pen width. The y-coordinate is ignored. + +**ColorRef (4 bytes):** A 32-bit **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that specifies the pen color value. + +#### Region Object + +The **Region Object** defines a potentially non-rectilinear shape defined by an array of [**scanlines**](#gt_e4a9ec4c-78d8-41a6-a13e-ec42e6427547). + +[TABLE] + +**nextInChain (2 bytes):** A value that MUST be ignored.[\<41\>](#Appendix_A_41) + +**ObjectType (2 bytes):** A 16-bit signed integer that specifies the [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) identifier. It MUST be 0x0006. + +**ObjectCount (4 bytes):** A value that MUST be ignored.[\<42\>](#Appendix_A_42) + +**RegionSize (2 bytes):** A 16-bit signed integer that defines the size of the region in bytes plus the size of **aScans** in bytes. + +**ScanCount (2 bytes):** A 16-bit signed integer that defines the number of scanlines composing the region. + +**maxScan (2 bytes):** A 16-bit signed integer that defines the maximum number of points in any one scan in this region. + +**BoundingRectangle (8 bytes):** A **Rect Object** (section [2.2.2.18](#Section_3ccb757b5eaa460c92696b638484640f)) that defines the bounding rectangle. + +**aScans (variable):** An array of **Scan Objects** (section [2.2.2.21](#Section_ae8f7607b1dc4d58a95870f517c6d152)) that define the scanlines in the region. + +### Structure Objects + +The [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) **Structure Objects** specify data structures that are embedded in WMF objects and records. Structure objects, unlike graphics objects, are not explicitly created or deleted; they are components of more complex structures. + +#### Bitmap16 Object + +The **Bitmap16 Object** specifies information about the dimensions and color format of a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). + +[TABLE] + +**Type (2 bytes):** A 16-bit signed integer that defines the bitmap type. + +**Width (2 bytes):** A 16-bit signed integer that defines the width of the bitmap in pixels. + +**Height (2 bytes):** A 16-bit signed integer that defines the height of the bitmap in scan lines. + +**WidthBytes (2 bytes):** A 16-bit signed integer that defines the number of bytes per scan line. + +**Planes (1 byte):** An 8-bit unsigned integer that defines the number of color planes in the bitmap. The value of this field MUST be 0x01. + +**BitsPixel (1 byte):** An 8-bit unsigned integer that defines the number of adjacent color bits on each plane. + +**Bits (variable):** A variable length array of bytes that defines the bitmap pixel data. The length of this field in bytes can be computed as follows. + +648. (((Width \* BitsPixel + 15) \>\> 4) \<\< 1) \* Height + +#### BitmapCoreHeader Object + +The **BitmapCoreHeader Object** contains information about the dimensions and color format of a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091).[\<43\>](#Appendix_A_43) + +[TABLE] + +**HeaderSize (4 bytes):** A 32-bit unsigned integer that defines the size of this object, in bytes. + +**Width (2 bytes):** A 16-bit unsigned integer that defines the width of the DIB, in pixels. + +**Height (2 bytes):** A 16-bit unsigned integer that defines the height of the DIB, in pixels. + +**Planes (2 bytes):** A 16-bit unsigned integer that defines the number of planes for the target device. This value MUST be 0x0001. + +**BitCount (2 bytes):** A 16-bit unsigned integer that defines the format of each pixel, and the maximum number of colors in the DIB. This value MUST be in the **BitCount Enumeration** (section [2.1.1.3](#Section_792153f41e994ec893cfd171a5f33903)). + +A DIB is specified by a **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +#### BitmapInfoHeader Object + +The **BitmapInfoHeader Object** contains information about the dimensions and color format of a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +[TABLE] + +**HeaderSize (4 bytes):** A 32-bit unsigned integer that defines the size of this object, in bytes. + +**Width (4 bytes):** A 32-bit signed integer that defines the width of the DIB, in pixels. This value MUST be positive. + +This field SHOULD specify the width of the decompressed image file, if the Compression value specifies [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) or [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) format.[\<44\>](#Appendix_A_44) + +**Height (4 bytes):** A 32-bit signed integer that defines the height of the DIB, in pixels. This value MUST NOT be zero. + +[TABLE] + +**Planes (2 bytes):** A 16-bit unsigned integer that defines the number of planes for the target device. This value MUST be 0x0001. + +**BitCount (2 bytes):** A 16-bit unsigned integer that defines the number of bits that define each pixel and the maximum number of colors in the DIB. This value MUST be in the **BitCount Enumeration** (section [2.1.1.3](#Section_792153f41e994ec893cfd171a5f33903)). + +**Compression (4 bytes):** A 32-bit unsigned integer that defines the compression mode of the DIB. This value MUST be in the **Compression Enumeration** (section [2.1.1.7](#Section_4e588f70bd924a6fb77f35d0feaf7a57)). + +This value MUST NOT specify a compressed format if the DIB is a top-down bitmap, as indicated by the **Height** value. + +**ImageSize (4 bytes):** A 32-bit unsigned integer that defines the size, in bytes, of the image. + +If the Compression value is BI_RGB, this value SHOULD be zero and MUST be ignored.[\<45\>](#Appendix_A_45) + +If the Compression value is BI_JPEG or BI_PNG, this value MUST specify the size of the JPEG or PNG image buffer, respectively. + +**XPelsPerMeter (4 bytes):** A 32-bit signed integer that defines the horizontal resolution, in pixels-per-meter, of the target device for the DIB. + +**YPelsPerMeter (4 bytes):** A 32-bit signed integer that defines the vertical resolution, in pixels-per-meter, of the target device for the DIB. + +**ColorUsed (4 bytes):** A 32-bit unsigned integer that specifies the number of indexes in the [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) used by the DIB, as follows: + +- If this value is zero, the DIB uses the maximum number of colors that correspond to the **BitCount** value. + +- If this value is nonzero and the BitCount value is less than 16, this value specifies the number of colors used by the DIB. + +- If this value is nonzero and the BitCount value is 16 or greater, this value specifies the size of the color table used to optimize performance of the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe). + +> **Note**  If this value is nonzero and greater than the maximum possible size of the color table based on the **BitCount** value, the maximum color table size SHOULD be assumed. + +**ColorImportant (4 bytes):** A 32-bit unsigned integer that defines the number of color indexes that are required for displaying the DIB. If this value is zero, all color indexes are required. + +A DIB is specified by a **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +When the array of pixels in the DIB immediately follows the **BitmapInfoHeader**, the DIB is a [**packed bitmap**](#gt_dde28230-24dc-459a-8066-970b16c35288). In a packed bitmap, the ColorUsed value MUST be either 0x00000000 or the actual size of the color table. + +#### BitmapV4Header Object + +The **BitmapV4Header Object** contains information about the dimensions and color format of a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). It is an extension of the **BitmapInfoHeader Object** (section [2.2.2.3](#Section_567172fab8a24d7986a25e21d6659ef3)).[\<46\>](#Appendix_A_46) + +[TABLE] + +**BitmapInfoHeader (40 bytes):** A **BitmapInfoHeader** object, which defines properties of the DIB. + +**RedMask (4 bytes):** A 32-bit unsigned integer that defines the color mask that specifies the red component of each pixel. If the Compression value in the **BitmapInfoHeader** object is not BI_BITFIELDS, this value MUST be ignored. + +**GreenMask (4 bytes):** A 32-bit unsigned integer that defines the color mask that specifies the green component of each pixel. If the Compression value in the **BitmapInfoHeader** object is not BI_BITFIELDS, this value MUST be ignored. + +**BlueMask (4 bytes):** A 32-bit unsigned integer that defines the color mask that specifies the blue component of each pixel. If the Compression value in the **BitmapInfoHeader** object is not BI_BITFIELDS, this value MUST be ignored. + +**AlphaMask (4 bytes):** A 32-bit unsigned integer that defines the color mask that specifies the alpha component of each pixel. + +**ColorSpaceType (4 bytes):** A 32-bit unsigned integer that defines the [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) of the **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). If this value is LCS_CALIBRATED_RGB from the **LogicalColorSpace Enumeration** (section [2.1.1.14](#Section_eb4bbd50b3ce4917895cbe31f214797f)), the color values in the DIB are calibrated [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values, and the endpoints and [**gamma**](#gt_d3a77352-cad6-4a80-9eaf-fb3098699367) values in this structure SHOULD be used to translate the color values before they are passed to the device. + +See the **LogColorSpace** (section [2.2.2.11](#Section_0a8def2e0d6541749f6717c8f3341514)) and **LogColorSpace ObjectW** (section [2.2.2.12](#Section_877948774d8340fa98cb9ffa20eed863)) objects for details concerning a logical color space. + +**Endpoints (36 bytes):** A **CIEXYZTriple Object** (section [2.2.2.7](#Section_07b63c50c07b44bc9523be4e90d20a8e)) that defines the [**CIE**](#gt_1bd8584d-9cad-4882-970a-9403fa0bb988) chromaticity x, y, and z coordinates of the three colors that correspond to the red, green, and blue endpoints for the logical color space associated with the DIB. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaRed (4 bytes):** A 32-bit fixed point value that defines the toned response curve for red. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaGreen (4 bytes):** A 32-bit fixed point value that defines the toned response curve for green. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaBlue (4 bytes):** A 32-bit fixed point value that defines the toned response curve for blue. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +The gamma value format is an unsigned "8.8" fixed-point integer that is then left-shifted by 8 bits. "8.8" means "8 integer bits followed by 8 fraction bits": nnnnnnnnffffffff. Taking the shift into account, the required format of the 32-bit DWORD is: 00000000nnnnnnnnffffffff00000000. + +#### BitmapV5Header Object + +The **BitmapV5Header Object** contains information about the dimensions and color format of a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). It is an extension of the **BitmapV4Header Object** (section [2.2.2.4](#Section_071b0c0dc2df4f1c9828d03c26002c61)).[\<47\>](#Appendix_A_47) + +[TABLE] + +**BitmapV4Header (108 bytes):** A **BitmapV4Header Object**, which defines properties of the **DIB Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +When it is part of a **BitmapV5Header**, the **ColorSpaceType** field of a **BitmapV4Header** can be a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) value in the **LogicalColorSpaceV5 Enumeration** (section [2.1.1.15](#Section_3c289fe1c42e42f6b1254b5fc49a2b20)). + +**Intent (4 bytes):** A 32-bit unsigned integer that defines the rendering intent for the **DIB**. This MUST be a value defined in the **GamutMappingIntent Enumeration** (section [2.1.1.11](#Section_9fec0834607d427dabd5ab240fb0db38)). + +**ProfileData (4 bytes):** A 32-bit unsigned integer that defines the offset, in bytes, from the beginning of this structure to the start of the [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) data. + +If the color profile is embedded in the **DIB**, **ProfileData** is the offset to the actual color profile; if the color profile is linked, **ProfileData** is the offset to the null-terminated file name of the color profile. This MUST NOT be a Unicode string, but MUST be composed exclusively of characters from the Windows character set (code page 1252). + +If the **ColorSpaceType** field in the **BitmapV4Header** does not specify LCS_PROFILE_LINKED or LCS_PROFILE_EMBEDDED, the color profile data SHOULD be ignored. + +**ProfileSize (4 bytes):** A 32-bit unsigned integer that defines the size, in bytes, of embedded color profile data. + +**Reserved (4 bytes):** A 32-bit unsigned integer that is undefined and SHOULD be ignored. + +#### CIEXYZ Object + +The **CIEXYZ Object** defines information about the [**CIEXYZ**](#gt_420d8605-ec8a-4170-9e3d-1fe7d1aeab9c) chromaticity object. + +[TABLE] + +**ciexyzX (4 bytes):** A 32-bit 2.30 fixed point type that defines the x chromaticity value. + +**ciexyzY (4 bytes):** A 32-bit 2.30 fixed point type that defines the y chromaticity value. + +**ciexyzZ (4 bytes):** A 32-bit 2.30 fixed point type that defines the z chromaticity value. + +#### CIEXYZTriple Object + +The **CIEXYZTriple Object** defines information about the **CIEXYZTriple** color object. + +[TABLE] + +**ciexyzRed (12 bytes):** A 96-bit **CIEXYZ Object** (section [2.2.2.6](#Section_211648823cb349d6813374396704f14d)) that defines the red chromaticity values. + +**ciexyzGreen (12 bytes):** A 96-bit **CIEXYZ Object** that defines the green chromaticity values. + +**ciexyzBlue (12 bytes):** A 96-bit **CIEXYZ Object** that defines the blue chromaticity values. + +#### ColorRef Object + +The **ColorRef Object** defines the [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color. + +[TABLE] + +**Red (1 byte):** An 8-bit unsigned integer that defines the relative intensity of red. + +**Green (1 byte):** An 8-bit unsigned integer that defines the relative intensity of green. + +**Blue (1 byte):** An 8-bit unsigned integer that defines the relative intensity of blue. + +**Reserved (1 byte):** An 8-bit unsigned integer that MUST be 0x00. + +#### DeviceIndependentBitmap Object + +The **DeviceIndependentBitmap (DIB) Object** defines an image in [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) format. + +[TABLE] + +**DIBHeaderInfo (variable):** Either a **BitmapCoreHeader Object** (section [2.2.2.2](#Section_d3cd31d4b2e7493cafc0f1d777baf399)) or a **BitmapInfoHeader Object** (section [2.2.2.3](#Section_567172fab8a24d7986a25e21d6659ef3)) that specifies information about the image. + +The first 32 bits of this field is the **HeaderSize** value. If it is 0x0000000C, then this is a **BitmapCoreHeader**; otherwise, this is a **BitmapInfoHeader**. + +**Colors (variable):** An optional array of either [RGBQuad Objects (section 2.2.2.20)](#Section_c7e787f4aefc4f998fddae8ab37eae96) or 16-bit unsigned integers that define a [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418). + +The size and contents of this field SHOULD be determined from the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) record or object that contains this **DeviceIndependentBitmap Object** and from information in the **DIBHeaderInfo** field. See **ColorUsage Enumeration** (section [2.1.1.6](#Section_30403797a40840cab024dd8a1acb39be)) and **BitCount Enumeration** (section [2.1.1.3](#Section_792153f41e994ec893cfd171a5f33903)) for additional details. + +**BitmapBuffer (variable):** A buffer containing the image, which is not required to be contiguous with the DIB header, unless this is a [**packed bitmap**](#gt_dde28230-24dc-459a-8066-970b16c35288). + +[TABLE] + +> **UndefinedSpace (variable):** An optional field that MUST be ignored. If this DIB is a packed bitmap, this field MUST NOT be present. +> +> **aData (variable):** An array of bytes that define the image. +> +> The size and format of this data is determined by information in the **DIBHeaderInfo** field. If it is a **BitmapCoreHeader**, the size in bytes MUST be calculated as follows: + +649. (((Width \* Planes \* BitCount + 31) & ~31) / 8) \* abs(Height) + +> This formula SHOULD also be used to calculate the size of **aData** when **DIBHeaderInfo** is a **BitmapInfoHeader Object**, using values from that object, but only if its Compression value is BI_RGB, BI_BITFIELDS, or BI_CMYK. +> +> Otherwise, the size of **aData** MUST be the **BitmapInfoHeader Object** value ImageSize. + +#### LogBrush Object + +The **LogBrush Object** defines the style, color, and pattern of a brush. This object is used only in the **META_CREATEBRUSHINDIRECT Record** (section [2.3.4.1](#Section_8331e35d0f974ec3b3b0cfb3281c0642)) to create a **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)). + +[TABLE] + +**BrushStyle (2 bytes):** A 16-bit unsigned integer that defines the brush style. This MUST be a value from the **BrushStyle Enumeration** (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)). For the meanings of different values, see the following table. The BS_NULL style specifies a brush that has no effect.[\<48\>](#Appendix_A_48) + +**ColorRef (4 bytes):** A 32-bit **ColorRef Object** section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that specifies a color. Its interpretation depends on the value of **BrushStyle**, as explained in the following. + +**BrushHatch (2 bytes):** A 16-bit field that specifies the brush hatch type. Its interpretation depends on the value of **BrushStyle**, as explained in the following. + +The following table shows the relationship between values in the **BrushStyle**, **ColorRef** and **BrushHatch** fields in a **LogBrush Object**. Only supported brush styles are listed. + +| BrushStyle | ColorRef | BrushHatch | +|----|----|----| +| BS_SOLID | SHOULD be a **ColorRef Object**, which determines the color of the brush. | Not used, and SHOULD be ignored. | +| BS_NULL | Not used, and SHOULD be ignored. | Not used, and SHOULD be ignored. | +| BS_PATTERN | Not used, and SHOULD be ignored. | Not used. A solid-color black **Brush Object** SHOULD be created by default.[\<49\>](#Appendix_A_49) | +| BS_DIBPATTERN | Not used, and SHOULD be ignored. | Not used. A solid-color black **Brush Object** SHOULD be created by default. | +| BS_DIBPATTERNPT | Not used, and SHOULD be ignored. | Not used. A default object, such as a solid-color black **Brush Object**, MAY be created. | +| BS_HATCHED | SHOULD be a **ColorRef Object**, which determines the foreground color of the hatch pattern. | A value from the **HatchStyle Enumeration** (section [2.1.1.12](#Section_3d08f11808e143f08d789005151b00fe)) that specifies the orientation of lines used to create the hatch. | + +#### LogColorSpace Object + +The **LogColorSpace Objec**t specifies a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5) for the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45), which can be the name of a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) in [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) characters. + +[TABLE] + +**Signature (4 bytes):** A 32-bit unsigned integer that specifies the signature of color space objects; it MUST be set to the value 0x50534F43, which is the ASCII encoding of the string "PSOC". + +**Version (4 bytes):** A 32-bit unsigned integer that defines a version number; it MUST be 0x00000400. + +**Size (4 bytes):** A 32-bit unsigned integer that defines the size of this object, in bytes. + +**ColorSpaceType (4 bytes):** A 32-bit signed integer that specifies the color space type. It MUST be defined in the **LogicalColorSpace Enumeration** (section [2.1.1.14](#Section_eb4bbd50b3ce4917895cbe31f214797f)). If this value is LCS_sRGB or LCS_WINDOWS_COLOR_SPACE, the [**sRGB**](#gt_cac39c64-7550-4d2a-92c8-b3b54dc3c466) color space MUST be used. + +**Intent (4 bytes):** A 32-bit signed integer that defines the gamut mapping intent. It MUST be defined in the **GamutMappingIntent Enumeration** (section [2.1.1.11](#Section_9fec0834607d427dabd5ab240fb0db38)). + +**Endpoints (36 bytes):** A **CIEXYZTriple Object** (section [2.2.2.7](#Section_07b63c50c07b44bc9523be4e90d20a8e)) that defines the [**CIE**](#gt_1bd8584d-9cad-4882-970a-9403fa0bb988) [**chromaticity**](#gt_a9dee546-522c-4462-9cb9-62c29335dc45) x, y, and z coordinates of the three colors that correspond to the [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) endpoints for the logical color space associated with the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaRed (4 bytes):** A 32-bit fixed point value that defines the toned response curve for red. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaGreen (4 bytes):** A 32-bit fixed point value that defines the toned response curve for green. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaBlue (4 bytes):** A 32-bit fixed point value that defines the toned response curve for blue. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**Filename (260 bytes):** An optional, ASCII charactger string that specifies the name of a file that contains a color profile. If a file name is specified, and the **ColorSpaceType** field is set to LCS_CALIBRATED_RGB, the other fields of this structure SHOULD be ignored. + +The **Endpoints**, **GammaRed**, **GammaGreen**, and **GammaBlue** fields are used to specify a logical color space. The **Endpoints** field is a **CIEXYZTriple Object** that contains the x, y, and z values of the RGB endpoint of the color space. + +The relation between [**tri-stimulus**](#gt_94ecf034-38bc-4883-9f7c-255c4f957840) values X,Y,Z and chromaticity values x,y,z is expressed as follows. + +650. x = X/(X+Y+Z) + + y = Y/(X+Y+Z) + + z = Z/(X+Y+Z) + +The **GammaRed**, **GammaGreen**, and **GammaBlue** fields contain values in "8.8 fixed point" format, which is a technique for representing non-integer numbers. Each value consists of a zero-extended 8-bit magnitude followed by an 8-bit fraction, with the combined 16 bits left-shifted by 8 bits. Thus, in 32-bits, the real value N.F is 00000000nnnnnnnnffffffff00000000, where "nnnnnnnn" and "ffffffff" are binary representations of N and F, respectively. For example, for the real number 10.5, nnnnnnnn would be 00001010 (binary 10) and ffffffff would be 00000101 (binary 5), and the complete 32-bit binary value would be 00000000000010100000010100000000, which is the hexadecimal value 0x0A50. + +#### LogColorSpaceW Object + +The **LogColorSpaceW Object** specifies a logical [**color space**](#gt_5d3fb5ea-c686-4d3b-b0ff-aef33fe1aee5), which can be defined by a [**color profile**](#gt_cffe5dfa-5408-4302-8ab0-400cb94f5e32) file with a name consisting of [**Unicode**](#gt_c305d0ab-8b94-461a-bd76-13b40cb8c4d8) 16-bit characters. + +[TABLE] + +**Signature (4 bytes):** A 32-bit unsigned integer that specifies the signature of color space objects. This MUST be set to the value 0x50534F43, which is the [**ASCII**](#gt_79fa85ca-ac61-467c-b819-e97dc1a7a599) encoding of the string "PSOC". + +**Version (4 bytes):** A 32-bit unsigned integer that defines a version number; it MUST be 0x00000400. + +**Size (4 bytes):** A 32-bit unsigned integer that defines the size of this object, in bytes. + +**ColorSpaceType (4 bytes):** A 32-bit signed integer that specifies the color space type. It MUST be defined in the **LogicalColorSpace Enumeration** (section [2.1.1.14](#Section_eb4bbd50b3ce4917895cbe31f214797f)). If this value is LCS_sRGB or LCS_WINDOWS_COLOR_SPACE, the [**sRGB**](#gt_cac39c64-7550-4d2a-92c8-b3b54dc3c466) color space MUST be used. + +**Intent (4 bytes):** A 32-bit signed integer that defines the gamut mapping intent. It MUST be defined in the **GamutMappingIntent Enumeration** (section [2.1.1.11](#Section_9fec0834607d427dabd5ab240fb0db38)). + +**Endpoints (36 bytes):** A **CIEXYZTriple Object** (section [2.2.2.7](#Section_07b63c50c07b44bc9523be4e90d20a8e)) that defines the [**CIE**](#gt_1bd8584d-9cad-4882-970a-9403fa0bb988) [**chromaticity**](#gt_a9dee546-522c-4462-9cb9-62c29335dc45) x, y, and z coordinates of the three colors that correspond to the [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) endpoints for the logical color space associated with the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaRed (4 bytes):** A 32-bit fixed point value that defines the toned response curve for red. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaGreen (4 bytes):** A 32-bit fixed point value that defines the toned response curve for green. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**GammaBlue (4 bytes):** A 32-bit fixed point value that defines the toned response curve for blue. If the **ColorSpaceType** field does not specify LCS_CALIBRATED_RGB, this field MUST be ignored. + +**Filename (520 bytes):** An optional, null-terminated Unicode [**UTF16-LE**](#gt_f25550c9-f84f-4eb2-8156-14794a7e3059) character string, which specifies the name of a file that contains a color profile. If a file name is specified, and the **ColorSpaceType** field is set to LCS_CALIBRATED_RGB, the other fields of this structure SHOULD be ignored. + +See the **LogColorSpace Object** (section [2.2.2.11](#Section_0a8def2e0d6541749f6717c8f3341514)) for additional details concerning the interpretation of field values of this object. + +#### PaletteEntry Object + +The **PaletteEntry Object** defines the color and usage of an entry in a [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). + +[TABLE] + +**Red (1 byte):** An 8-bit unsigned integer that defines the red intensity value for the palette entry. + +**Green (1 byte):** An 8-bit unsigned integer that defines the green intensity value for the palette entry. + +**Blue (1 byte):** An 8-bit unsigned integer that defines the blue intensity value for the palette entry. + +**Values (1 byte):** An 8-bit unsigned integer that defines how the palette entry is to be used. The **Values** field MUST be 0x00 or one of the values in the **PaletteEntryFlag Enumeration** (section [2.1.1.22](#Section_45e5c32055b44f3aaf5540f9e0f6e3ac)) table. + +#### PitchAndFamily Object + +The **PitchAndFamily Object** specifies the pitch and family properties of a **Font Object** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)). Pitch refers to the width of the characters, and family refers to the general appearance of a font. + +[TABLE] + +**Family (4 bits):** A property of a font that describes its general appearance. This MUST be a value in the **FamilyFont Enumeration** (section [2.1.1.8](#Section_9a6327661f1c4e2bb1a4f5b1a45f99ad)). + +**Pitch (2 bits):** A property of a font that describes the [**pitch**](#gt_0f2ba14a-c9b3-4cc8-8840-a24c0aed5eb9), of the characters. This MUST be a value in the **PitchFont Enumeration** (section [2.1.1.24](#Section_22dbe377aec4466988e6b8fdd9351d76)). + +#### PointL Object + +The **PointL Object** defines the coordinates of a point. + +[TABLE] + +**x (4 bytes):** A 32-bit signed integer that defines the horizontal (x) coordinate of the point. + +**y (4 bytes):** A 32-bit signed integer that defines the vertical (y) coordinate of the point. + +#### PointS Object + +The **PointS Object** defines the x- and y-coordinates of a point. + +[TABLE] + +**x (2 bytes):** A 16-bit signed integer that defines the horizontal (x) coordinate of the point. + +**y (2 bytes):** A 16-bit signed integer that defines the vertical (y) coordinate of the point. + +#### PolyPolygon Object + +The **PolyPolygon Object** defines a series of closed polygons. + +[TABLE] + +**NumberOfPolygons (2 bytes):** A 16-bit unsigned integer that defines the number of polygons in the object. + +**aPointsPerPolygon (variable):** A **NumberOfPolygons** array of 16-bit unsigned integers that define the number of points for each polygon in the object. + +**aPoints (variable):** An array of **PointS** values that define the coordinates of the polygons. The length of the array is equal to the sum of all 16-bit integers in the **aPointsPerPolygon** array. + +#### Rect Object + +The **Rect Object** defines a rectangle. + +[TABLE] + +**Left (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical coordinates, of the upper-left corner of the rectangle + +**Top (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical coordinates, of the upper-left corner of the rectangle. + +**Right (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical coordinates, of the lower-right corner of the rectangle. + +**Bottom (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical coordinates, of the lower-right corner of the rectangle. + +#### RectL Object + +The RectL Object defines a rectangle. + +[TABLE] + +**Left (4 bytes):** A 32-bit signed integer that defines the x coordinate, in logical coordinates, of the upper-left corner of the rectangle. + +**Top (4 bytes):** A 32-bit signed integer that defines the y coordinate, in logical coordinates, of the upper-left corner of the rectangle. + +**Right (4 bytes):** A 32-bit signed integer that defines the x coordinate, in logical coordinates, of the lower-right corner of the rectangle. + +**Bottom (4 bytes):** A 32-bit signed integer that defines y coordinate, in logical coordinates, of the lower-right corner of the rectangle. + +A rectangle defined with a **RectL Object** is filled up to— but not including—the right column and bottom row of pixels. + +#### RGBQuad Object + +The **RGBQuad Object** defines the pixel color values in an uncompressed **DIB Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +[TABLE] + +**Blue (1 byte):** An 8-bit unsigned integer that defines the relative intensity of blue. + +**Green (1 byte):** An 8-bit unsigned integer that defines the relative intensity of green. + +**Red (1 byte):** An 8-bit unsigned integer that defines the relative intensity of red. + +**Reserved (1 byte):** An 8-bit unsigned integer that MUST be 0x00. + +#### Scan Object + +The **Scan Object** specifies a collection of [**scanlines**](#gt_e4a9ec4c-78d8-41a6-a13e-ec42e6427547). + +[TABLE] + +**Count (2 bytes):** A 16-bit unsigned integer that specifies the number of horizontal (x-axis) coordinates in the **ScanLines** array. This value MUST be a multiple of 2, since left and right endpoints are required to specify each scanline. + +**Top (2 bytes):** A 16-bit unsigned integer that defines the vertical (y-axis) coordinate, in logical units, of the top scanline. + +**Bottom (2 bytes):** A 16-bit unsigned integer that defines the vertical (y-axis) coordinate, in logical units, of the bottom scanline. + +**ScanLines (variable):** An array of scanlines, each specified by left and right horizontal (x-axis) coordinates of its endpoints. + +[TABLE] + +> **Left (2 bytes):** A 16-bit unsigned integer that defines the horizontal (x-axis) coordinate, in logical units, of the left endpoint of the scanline. +> +> **Right (2 bytes):** A 16-bit unsigned integer that defines the horizontal (x-axis) coordinate, in logical units, of the right endpoint of the scanline. + +**Count2 (2 bytes):** A 16-bit unsigned integer that MUST be the same as the value of the **Count** field; it is present to allow upward travel in the structure. + +#### SizeL Object + +The **SizeL Object** defines the x- and y-extents of a rectangle. + +[TABLE] + +**cx (4 bytes):** A 32-bit unsigned integer that defines the x-coordinate of the point. + +**cy (4 bytes):** A 32-bit unsigned integer that defines the y-coordinate of the point. + +## WMF Records + +This section specifies the **WMF Records**, which can be grouped into the following general categories. + +| Name | Section | Description | +|----|----|----| +| [**Bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) record types | [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) | Manage and output bitmaps. | +| Control record types | [2.3.2](#Section_9a40a3507fe842bea8fec2e28dac6970) | Define the start and end of a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). | +| Drawing record types | [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) | Perform graphics drawing orders. | +| Object record types | [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) | Create and manage graphics objects. | +| State record types | [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) | Specify and manage the graphics configuration. | +| Escape record types | [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) | Specify extensions to functionality that are not directly available through other records defined in the WMF **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)). | + +During the playback of a WMF metafile, a [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) exists that can be described as a processing state in which every graphics object and property is defined. In the descriptions of **WMF Records** that follow in this section, an element of the playback device context can be referred to as a "currently selected" graphics object or property. If a graphics object or property that is used in the output operation specified by a record has not been explicitly selected, a default value MUST be used. See **Playback Device Context** (section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b)) for more information. + +When a WMF metafile is processed, the order in which graphics output is performed MUST be the same as the order of drawing records in the metafile. Thus, a given drawing command is always rendered on top of the renderings of preceding commands. + +Implementations MUST ignore records with undocumented or unsupported record types and proceed to process the next valid record. + +The following packet definition specifies the generic structure of all **WMF Records** except **Control Record Types** (section 2.3.2). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines the type of this record. The low-order byte MUST match the low-order byte of one of the values in the **RecordType Enumeration** (section 2.1.1.1). + +**rdParam (variable):** An optional place holder that is provided for record-specific fields. + +### Bitmap Record Types + +This section defines the **Bitmap Record Types**, which specify records that manage and output [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). + +The following are the **Bitmap Record Types**. + +| Name | Section | Description | +|----|----|----| +| META_BITBLT | [2.3.1.1](#Section_1aa8c9f613f740c0be47b52ab3d3a649) | Specifies the transfer of a block of pixels according to a [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc). | +| META_DIBBITBLT | [2.3.1.2](#Section_524aa748f2744bd3a4c1f280bd6cac09) | Specifies the transfer of a block of pixels in device-independent format according to a raster operation. | +| META_DIBSTRETCHBLT | [2.3.1.3](#Section_e666a66fb29d4adb82dae00eaf032ea6) | Specifies the transfer of a block of pixels in device-independent format according to a raster operation, with possible expansion or contraction. | +| META_SETDIBTODEV | [2.3.1.4](#Section_d0e77d4d653f4535a4db1496af84acdc) | Sets a block of pixels in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) using device-independent color data. | +| META_STRETCHBLT | [2.3.1.5](#Section_61370adbd37d48c4b5dd7f7a64e0a9ea) | Specifies the transfer of a block of pixels according to a raster operation, with possible expansion or contraction. | +| META_STRETCHDIB | [2.3.1.6](#Section_7ebae08d61ee4d829aa59217ba2aa8c1) | Specifies the transfer of color data from a block of pixels in device-independent format according to a raster operation, with possible expansion or contraction. | + +#### META_BITBLT Record + +The **META_BITBLT Record** specifies the transfer of a block of pixels according to a [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc).The destination of the transfer is the current output [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +There are two forms of **META_BITBLT**, one which specifies a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) as the source, and the other which uses the playback device context as the source. The fields that are the same in the two forms of **META_BITBLT** are defined below. The subsections that follow specify the packet structures of the two forms of **META_BITBLT**. + +**RecordSize:** A 32-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction:** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_BITBLT. + +**RasterOperation:** A 32-bit unsigned integer that defines how the source pixels, the current brush in the playback device context, and the destination pixels are to be combined to form the new image. This code MUST be one of the values in the **Ternary Raster Operation Enumeration** (section [2.1.1.31](#Section_1605dd68a6354639ab8199ff3e3fc5a3)). + +**YSrc:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the source rectangle. + +**XSrc:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the source rectangle. + +**Height:** A 16-bit signed integer that defines the height, in logical units, of the source and destination rectangles. + +**Width:** A 16-bit signed integer that defines the width, in logical units, of the source and destination rectangles. + +**YDest:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**XDest:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +The **RecordSize** and **RecordFunction** fields SHOULD be used to differentiate between the two forms of **META_BITBLT**. If the following Boolean expression is TRUE, a source bitmap is not specified in the record. + +654. RecordSize == ((RecordFunction \>\> 8) + 3) + +See section [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) for the specification of additional bitmap records. + +##### With Bitmap + +This section specifies the structure of the **META_BITBLT Record** (section [2.3.1.1](#Section_1aa8c9f613f740c0be47b52ab3d3a649)) when it contains an embedded [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). + +Fields not specified in this section are specified in the **META_BITBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_BITBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **Target** fields. That is: + +655. RecordSize - (2 + (sizeof(Target)/2)) + +**Target (variable):** A variable-sized **Bitmap16 Object** (section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c)) that defines source image content. This object MUST be specified, even if the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) does not require a source. + +##### Without Bitmap + +This section specifies the structure of the **META_BITBLT Record** (section [2.3.1.1](#Section_1aa8c9f613f740c0be47b52ab3d3a649)) when it does not contain an embedded source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). The source for this operation is the current [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +Fields not specified in this section are specified in the **META_BITBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_BITBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **RecordFunction** fields. That is: + +658. RecordSize - 3 + +**Reserved (2 bytes):** This field MUST be ignored. + +If the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) specified in this record requires a source, the processing of this record fails. + +#### META_DIBBITBLT Record + +The **META_DIBBITBLT Record** specifies the transfer of a block of pixels in device-independent format according to a [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc). + +The destination of the transfer is the current output [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +There are two forms of **META_DIBBITBLT**, one which specifies a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) as the source, and the other which uses the playback device context as the source. Definitions follow for the fields that are the same in the two forms of **META_DIBBITBLT**. The subsections that follow specify the packet structures of the two forms of **META_DIBBITBLT**. + +**RecordSize:** A 32-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction:** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBBITBLT. + +**RasterOperation:** A 32-bit unsigned integer that defines how the source pixels, the current brush in the playback device context, and the destination pixels are to be combined to form the new image. This code MUST be one of the values in the **Ternary Raster Operation Enumeration** (section [2.1.1.31](#Section_1605dd68a6354639ab8199ff3e3fc5a3)). + +**YSrc:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the source rectangle. + +**XSrc:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the source rectangle. + +**Height:** A 16-bit signed integer that defines the height, in logical units, of the source and destination rectangles. + +**Width:** A 16-bit signed integer that defines the width, in logical units, of the source and destination rectangles. + +**YDest:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**XDest:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +The **RecordSize** and **RecordFunction** fields SHOULD be used to differentiate between the two forms of **META_DIBBITBLT**. If the following Boolean expression is TRUE, a source DIB is not specified in the record. + +661. RecordSize == ((RecordFunction \>\> 8) + 3) + +See section [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) for the specification of additional [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) records. + +##### With Bitmap + +This section specifies the structure of the **META_DIBBITBLT Record** (section [2.3.1.2](#Section_524aa748f2744bd3a4c1f280bd6cac09)) when it contains an embedded [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +Fields not specified in this section are specified in the **META_DIBBITBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBBITBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **Target** fields. That is: + +662. RecordSize - (2 + (sizeof(Target)/2)) + +**Target (variable):** A variable-sized **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)) that defines image content. This object MUST be specified, even if the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) does not require a source. + +##### Without Bitmap + +This section specifies the structure of the **META_DIBBITBLT Record** (section [2.3.1.2](#Section_524aa748f2744bd3a4c1f280bd6cac09)) when it does not contain an embedded source [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). The source for this operation is the current [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +Fields not specified in this section are specified in the **META_DIBBITBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBBITBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **RecordFunction** fields. That is: + +665. RecordSize - 3 + +**Reserved (2 bytes):** This field MUST be ignored. + +If the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) specified in this record requires a source, the processing of this record fails. + +#### META_DIBSTRETCHBLT Record + +The **META_DIBSTRETCHBLT Record** specifies the transfer of a block of pixels in device-independent format according to a [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc), with possible expansion or contraction. + +The destination of the transfer is the current output [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +There are two forms of **META_DIBSTRETCHBLT**, one which specifies a [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) as the source, and the other which uses the playback device context as the source. Definitions follow for the fields that are the same in the two forms of **META_DIBSTRETCHBLT**. The subsections that follow specify the packet structures of the two forms of **META_DIBSTRETCHBLT**. + +The expansion or contraction is performed according to the stretching mode currently set in the playback device context, which MUST be a value from the **StretchMode Enumeration** (section [2.1.1.30](#Section_b839b18aa47c4a44b365ef17d3c89e9a)). + +**RecordSize:** A 32-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction:** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBSTRETCHBLT. + +**RasterOperation:** A 32-bit unsigned integer that defines how the source pixels, the current brush in the playback device context, and the destination pixels are to be combined to form the new image. This code MUST be one of the values in the **Ternary Raster Operation Enumeration** (section [2.1.1.31](#Section_1605dd68a6354639ab8199ff3e3fc5a3)). + +**SrcHeight:** A 16-bit signed integer that defines the height, in logical units, of the source rectangle. + +**SrcWidth:** A 16-bit signed integer that defines the width, in logical units, of the source rectangle. + +**YSrc:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the source rectangle. + +**XSrc:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the source rectangle. + +**DestHeight:** A 16-bit signed integer that defines the height, in logical units, of the destination rectangle. + +**DestWidth:** A 16-bit signed integer that defines the width, in logical units, of the destination rectangle. + +**YDest:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**XDest:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +The **RecordSize** and **RecordFunction** fields SHOULD be used to differentiate between the two forms of **META_DIBSTRETCHBLT**. If the following Boolean expression is TRUE, a source DIB is not specified in the record. + +668. RecordSize == ((RecordFunction \>\> 8) + 3) + +See section [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) for the specification of additional [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) records. + +##### With Bitmap + +This section specifies the structure of the **META_DIBSTRETCHBLT Record** (section [2.3.1.3](#Section_e666a66fb29d4adb82dae00eaf032ea6)) when it contains an embedded [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +Fields not specified in this section are specified in the **META_DIBSTRETCHBLT Recor**d section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBSTRETCHBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **Target** fields. That is: + +669. RecordSize - (2 + (sizeof(Target)/2)) + +**Target (variable):** A variable-sized **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)) that defines image content. This object MUST be specified, even if the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) does not require a source. + +##### Without Bitmap + +This section specifies the structure of the **META_DIBSTRETCHBLT Record** (section [2.3.1.3](#Section_e666a66fb29d4adb82dae00eaf032ea6)) when it does not contain an embedded source [**device-independent bitmap (DIB)**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). The source for this operation is the current [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +Fields not specified in this section are specified in the **META_DIBSTRETCHBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBSTRETCHBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **RecordFunction** fields. That is: + +672. RecordSize - 3 + +**Reserved (2 bytes):** This field MUST be ignored. + +If the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) specified in this record requires a source, the processing of this record fails. + +#### META_SETDIBTODEV Record + +The **META_SETDIBTODEV Record** sets a block of pixels in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) using device-independent color data. + +The source of the color data is a [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETDIBTODEV. + +**ColorUsage (2 bytes):** A 16-bit unsigned integer that defines whether the **Colors** field of the DIB contains explicit [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values or indexes into a [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). This MUST be one of the values in the **ColorUsage Enumeration** (section [2.1.1.6](#Section_30403797a40840cab024dd8a1acb39be)). + +**ScanCount (2 bytes):** A 16-bit unsigned integer that defines the number of scan lines in the source. + +**StartScan (2 bytes):** A 16-bit unsigned integer that defines the starting scan line in the source. + +**yDib (2 bytes):** A 16-bit unsigned integer that defines the y-coordinate, in logical units, of the source rectangle. + +**xDib (2 bytes):** A 16-bit unsigned integer that defines the x-coordinate, in logical units, of the source rectangle. + +**Height (2 bytes):** A 16-bit unsigned integer that defines the height, in logical units, of the source and destination rectangles. + +**Width (2 bytes):** A 16-bit unsigned integer that defines the width, in logical units, of the source and destination rectangles. + +**yDest (2 bytes):** A 16-bit unsigned integer that defines the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**xDest (2 bytes):** A 16-bit unsigned integer that defines the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**DIB (variable):** A variable-sized **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)) that is the source of the color data. + +The source image in the DIB is specified in one of the following formats: + +- An array of pixels with a structure specified by the **ColorUsage** field and information in the **DeviceIndependentBitmap** header. + +- A [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image [\[JFIF\]](https://go.microsoft.com/fwlink/?LinkId=89925).[\<50\>](#Appendix_A_50) + +- A [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) image [\[W3C-PNG\]](https://go.microsoft.com/fwlink/?LinkId=90562).[\<51\>](#Appendix_A_51) + +See section [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) for the specification of additional [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) records. + +#### META_STRETCHBLT Record + +The **META_STRETCHBLT Record** specifies the transfer of a block of pixels according to a [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc), with possible expansion or contraction. + +The destination of the transfer is the current output [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +There are two forms of **META_STRETCHBLT**, one which specifies a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) as the source, and the other which uses the playback device context as the source. Definitions follow for the fields that are the same in the two forms of **META_STRETCHBLT** are defined below. The subsections that follow specify the packet structures of the two forms of **META_STRETCHBLT**. + +The expansion or contraction is performed according to the stretching mode currently set in the playback device context, which MUST be a value from the **StretchMode Enumeration** (section [2.1.1.30](#Section_b839b18aa47c4a44b365ef17d3c89e9a)). + +**RecordSize:** A 32-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction:** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_STRETCHBLT. + +**RasterOperation:** A 32-bit unsigned integer that defines how the source pixels, the current brush in the playback device context, and the destination pixels are to be combined to form the new image. This code MUST be one of the values in the **Ternary Raster Operation Enumeration** (section [2.1.1.31](#Section_1605dd68a6354639ab8199ff3e3fc5a3)). + +**SrcHeight:** A 16-bit signed integer that defines the height, in logical units, of the source rectangle. + +**SrcWidth:** A 16-bit signed integer that defines the width, in logical units, of the source rectangle. + +**YSrc:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the source rectangle. + +**XSrc:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the source rectangle. + +**DestHeight:** A 16-bit signed integer that defines the height, in logical units, of the destination rectangle. + +**DestWidth:** A 16-bit signed integer that defines the width, in logical units, of the destination rectangle. + +**YDest:** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**XDest:** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +The **RecordSize** and **RecordFunction** fields SHOULD be used to differentiate between the two forms of **META_STRETCHBLT**. If the following Boolean expression is TRUE, a source bitmap is not specified in the record. + +675. RecordSize == ((RecordFunction \>\> 8) + 3) + +See section [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) for the specification of additional bitmap records. + +##### With Bitmap + +This section specifies the structure of the **META_STRETCHBLT Record** (section [2.3.1.5](#Section_61370adbd37d48c4b5dd7f7a64e0a9ea)) when it contains an embedded [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). + +Fields not specified in this section are specified in the **META_STRETCHBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_STRETCHBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **Target** fields. That is: + +676. RecordSize - (2 + (sizeof(Target)/2)) + +**Target (variable):** A variable-sized **Bitmap16 Object** (section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c)) that defines source image content. This object MUST be specified, even if the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) does not require a source. + +##### Without Bitmap + +This section specifies the structure of the **META_STRETCHBLT Record** (section [2.3.1.5](#Section_61370adbd37d48c4b5dd7f7a64e0a9ea)) when it does not contain an embedded source [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). The source for this operation is the current [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +Fields not specified in this section are specified in the **META_STRETCHBLT Record** section. + +[TABLE] + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_STRETCHBLT. The high-order byte MUST contain a value equal to the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record minus the number of **WORDs** in the **RecordSize** and **RecordFunction** fields. That is: + +679. RecordSize - 3 + +**Reserved (2 bytes):** This field MUST be ignored. + +If the [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) specified in this record requires a source, the processing of this record fails. + +#### META_STRETCHDIB Record + +The **META_STRETCHDIB Record** specifies the transfer of color data from a block of pixels in device-independent format according to a [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc), with possible expansion or contraction. + +The source of the color data is a [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091), and the destination of the transfer is the current output [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_STRETCHDIB. + +**RasterOperation (4 bytes):** A 32-bit unsigned integer that defines how the source pixels, the current brush in the playback device context, and the destination pixels are to be combined to form the new image. This code MUST be one of the values in the **Ternary Raster Operation Enumeration** (section [2.1.1.31](#Section_1605dd68a6354639ab8199ff3e3fc5a3)). + +**ColorUsage (2 bytes):** A 16-bit unsigned integer that defines whether the **Colors** field of the DIB contains explicit [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values or indexes into a [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). This value MUST be in the **ColorUsage Enumeration** (section [2.1.1.6](#Section_30403797a40840cab024dd8a1acb39be)). + +**SrcHeight (2 bytes):** A 16-bit signed integer that defines the height, in logical units, of the source rectangle. + +**SrcWidth (2 bytes):** A 16-bit signed integer that defines the width, in logical units, of the source rectangle. + +**YSrc (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the source rectangle. + +**XSrc (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the source rectangle. + +**DestHeight (2 bytes):** A 16-bit signed integer that defines the height, in logical units, of the destination rectangle. + +**DestWidth (2 bytes):** A 16-bit signed integer that defines the width, in logical units, of the destination rectangle. + +**yDst (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**xDst (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the destination rectangle. + +**DIB (variable):** A variable-sized **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)) that is the source of the color data. + +The source image in the DIB is specified in one of the following formats: + +- An array of pixels with a structure specified by the **ColorUsage** field and information in the **DeviceIndependentBitmap** header. + +- A [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image [\[JFIF\]](https://go.microsoft.com/fwlink/?LinkId=89925).[\<52\>](#Appendix_A_52) + +- A [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) image [\[W3C-PNG\]](https://go.microsoft.com/fwlink/?LinkId=90562).[\<53\>](#Appendix_A_53) + +If the image format is JPEG or PNG, the **ColorUsage** field in this record MUST be set to **DIB_RGB_COLORS**, and the **RasterOperation** field MUST be set to **SRCCOPY**. + +See section [2.3.1](#Section_41ff061aabdd4db19b7b417983092d32) for the specification of additional [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) records. + +### Control Record Types + +This section defines the **Control Record Types**, which specify records that begin and end a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +The following are the **Control Record Types**. + +| Name | Section | Description | +|----|----|----| +| META_EOF | [2.3.2.1](#Section_3aa35974e8994acc892a47a2300948af) | Specifies the end of a WMF metafile. | +| META_HEADER | [2.3.2.2](#Section_d169108ae3fe436abb44bea61a46ce56) | Specifies the start of a WMF metafile. | +| META_PLACEABLE | [2.3.2.3](#Section_828e18647fe742d8ab0a1de161b32f27) | Specifies the start of a placeable WMF metafile. | + +#### META_EOF Record + +The **META_EOF Record** indicates the end of the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines the type of this record. For **META_EOF**, this value MUST be 0x0000, as specified in the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table. + +See section [2.3.2](#Section_9a40a3507fe842bea8fec2e28dac6970) for the specification of similar records. + +#### META_HEADER Record + +The **META_HEADER Record** is the first record in a standard (nonplaceable) [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +[TABLE] + +**Type (2 bytes):** A 16-bit unsigned integer that defines the type of metafile. It MUST be a value in the **MetafileType Enumeration** (section [2.1.1.18](#Section_2d09c51e062b4d9b94c46ffd0e12dfb6)). + +**HeaderSize (2 bytes):** A 16-bit unsigned integer that defines the number of 16-bit **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the header. + +**Version (2 bytes):** A 16-bit unsigned integer that defines the metafile version. It MUST be a value in the **MetafileVersion Enumeration** (section [2.1.1.19](#Section_a161bbdd3ca8477ca91613f3bdff881b)).[\<54\>](#Appendix_A_54) + +**SizeLow (2 bytes):** A 16-bit unsigned integer that defines the low-order word of the number of 16-bit **WORD** structures in the entire metafile. + +**SizeHigh (2 bytes):** A 16-bit unsigned integer that defines the high-order word of the number of 16-bit **WORD** structures in the entire metafile. + +**NumberOfObjects (2 bytes):** A 16-bit unsigned integer that specifies the number of graphics objects that are defined in the entire metafile. These objects include brushes, pens, and the other objects specified in section [2.2.1](#Section_aafd0883af3f43a69ccd201b725c370e). + +**MaxRecord (4 bytes):** A 32-bit unsigned integer that specifies the size of the largest record used in the metafile (in 16-bit elements). + +**NumberOfMembers (2 bytes):** A 16-bit unsigned integer that is not used. It SHOULD be 0x0000. + +See section [2.3.2](#Section_9a40a3507fe842bea8fec2e28dac6970) for the specification of similar records. + +#### META_PLACEABLE Record + +The **META_PLACEABLE Record** is the first record in a placeable [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7), which is an extension to the WMF metafile format.[\<55\>](#Appendix_A_55) The information in this extension allows the specification of the placement and size of the target image, which makes it adaptable to different output devices. + +The **META_PLACEABLE** MUST be the first record of the metafile, located immediately before the **META_HEADER Record** (section [2.3.2.2](#Section_d169108ae3fe436abb44bea61a46ce56)). + +[TABLE] + +**Key (4 bytes):** Identification value that indicates the presence of a placeable metafile header. This value MUST be 0x9AC6CDD7. + +**HWmf (2 bytes):** The resource handle to the metafile, when the metafile is in memory. When the metafile is on disk, this field MUST contain 0x0000. This attribute of the metafile is specified in the **Type** field of the **META_HEADER Record**. + +**BoundingBox (8 bytes):** The rectangle in the playback context (or simply the destination rectangle), measured in logical units, for displaying the metafile. The size of a logical unit is specified by the **Inch** field. See section [2.2.2.18](#Section_3ccb757b5eaa460c92696b638484640f) for details about the structure of the **BoundingBox** field. + +**Inch (2 bytes):** The number of logical units per inch used to represent the image. This value can be used to scale an image. + +By convention, an image is considered to be recorded at 1440 logical units ([**twips**](#gt_4b82472c-103d-4eff-a07e-6a0f784e3382)) per inch. Thus, a value of 720 specifies that the image SHOULD be rendered at twice its normal size, and a value of 2880 specifies that the image SHOULD be rendered at half its normal size. + +**Reserved (4 bytes):** A field that is not used and MUST be set to 0x00000000. + +**Checksum (2 bytes):** A checksum for the previous 10 16-bit values in the header. This value can be used to determine whether the metafile has become corrupted. The value is calculated by initializing the checksum to zero and then XORing it one at a time with the 10 16-bit values in the header. + +See section [2.3.2](#Section_9a40a3507fe842bea8fec2e28dac6970) for the specification of similar records. + +### Drawing Record Types + +This section defines the **Drawing Record Types**, which specify records that perform graphics output. These records use graphics objects and properties specified in the **Playback Device Context** (section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b)). + +The following are the **Drawing Record Types**. + +| Name | Section | Description | +|----|----|----| +| META_ARC | [2.3.3.1](#Section_742097b458794c36b57e77e7cc152253) | Draws an elliptical arc. | +| META_CHORD | [2.3.3.2](#Section_44aa3febab0147ca938662acf7df5263) | Draws a chord. | +| META_ELLIPSE | [2.3.3.3](#Section_fefd23472bb34865b752c4e80b6f2711) | Draws an ellipse. | +| META_EXTFLOODFILL | [2.3.3.4](#Section_37ee458f1479479cb508ba873dc96aa4) | Fills an area with the brush that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). | +| META_EXTTEXTOUT | [2.3.3.5](#Section_7d07c44aa8284b829af0e0a81cced5a8) | Outputs a character string with optional opaquing and clipping. | +| META_FILLREGION | [2.3.3.6](#Section_3a60aba5d14343838c757694b64f82ae) | Fills a [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) using a specified brush. | +| META_FLOODFILL | [2.3.3.7](#Section_79e6c98517e244b5a3923fbbe6557674) | Fills an area of the output surface with the brush that is defined in the playback device context. | +| META_FRAMEREGION | [2.3.3.8](#Section_30d629ef52ee49c2aab96160ee5a0745) | Draws a border around a specified region using a specified brush. | +| META_INVERTREGION | [2.3.3.9](#Section_7d994d5f1f1d48588e75d81870ac30e4) | Draws a region in which the colors are inverted. | +| META_LINETO | [2.3.3.10](#Section_bf92fda02d684ea28b316a0a22574d7f) | Draws a line from the drawing position that is defined in the playback device context up to, but not including, a specified position. | +| META_PAINTREGION | [2.3.3.11](#Section_92b05872d1fc408dafbaddfd6801e198) | Paints the specified region using the brush that is defined in the playback device context. | +| META_PATBLT | [2.3.3.12](#Section_00e25092a0d34b39a0cfab49be6dddcd) | Paints a specified rectangle by using the brush that is defined in the playback device context. | +| META_PIE | [2.3.3.13](#Section_b3f3e55f6f69467887eae6feb6af6eeb) | Draws a pie-shaped wedge bounded by the intersection of an ellipse and two radial lines. | +| META_POLYLINE | [2.3.3.14](#Section_ed4e99ac1c5642f0ae01e4979ceb934c) | Draws a series of line segments by connecting the points in the specified array. | +| META_POLYGON | [2.3.3.15](#Section_0982bbfcfeb74f06a8fbad03b465ffea) | Paints a polygon consisting of two or more vertices connected by straight lines. | +| META_POLYPOLYGON | [2.3.3.16](#Section_941630ee85e64a0fb02f1c534b3fa9f8) | Paints a series of closed polygons. | +| META_RECTANGLE | [2.3.3.17](#Section_a8da53a6f75649f7b835f6d145ede760) | Paints a rectangle. | +| META_ROUNDRECT | [2.3.3.18](#Section_9c262e3be63143438b900441872f1e9a) | Paints a rectangle with rounded corners. | +| META_SETPIXEL | [2.3.3.19](#Section_de9a67c42ddb4e5bb5dfeca1772af366) | Sets the pixel at specified coordinates to a specified color. | +| META_TEXTOUT | [2.3.3.20](#Section_96531e1a187549e5b797b4c4c50fa789) | Outputs a character string. | + +#### META_ARC Record + +The **META_ARC Record** draws an elliptical arc. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ARC. + +**YEndArc (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the ending point of the radial line defining the ending point of the arc. + +**XEndArc (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the ending point of the radial line defining the ending point of the arc. + +**YStartArc (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the ending point of the radial line defining the starting point of the arc. + +**XStartArc (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the ending point of the radial line defining the starting point of the arc. + +**BottomRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**RightRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**TopRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +**LeftRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_CHORD Record + +The **META_CHORD Record** draws a chord, which is defined by a [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) bounded by the intersection of an ellipse with a line segment. The chord is outlined using the pen and filled using the brush that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_CHORD. + +**YRadial2 (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical coordinates, of the endpoint of the second radial. + +**XRadial2 (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical coordinates, of the endpoint of the second radial. + +**YRadial1 (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical coordinates, of the endpoint of the first radial. + +**XRadial1 (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical coordinates, of the endpoint of the first radial. + +**BottomRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**RightRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**TopRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +**LeftRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_ELLIPSE Record + +The **META_ELLIPSE Record** draws an ellipse. The center of the ellipse is the center of the specified bounding rectangle. The ellipse is outlined by using the pen and is filled by using the brush; these are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ELLIPSE. + +**BottomRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**RightRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**TopRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +**LeftRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_EXTFLOODFILL Record + +The **META_EXTFLOODFILL Record** fills an area with the brush that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_EXTFLOODFILL. + +**Mode (2 bytes):** A 16-bit unsigned integer that defines the fill operation to be performed. This member MUST be one of the values in the **FloodFill Enumeration** (section [2.1.1.9](#Section_931f06ab2e8a41dd905fcf56db613f69)) table. + +**ColorRef (4 bytes):** A 32-bit **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that defines the color value. + +**Y (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the point to be set. + +**X (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the point to be set. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_EXTTEXTOUT Record + +The **META_EXTTEXTOUT Record** outputs text by using the font, background color, and text color that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). Optionally, dimensions can be provided for clipping, opaquing, or both. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)1) table value META_EXTTEXTOUT. + +**Y (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, where the text string is to be located. + +**X (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, where the text string is to be located. + +**StringLength (2 bytes):** A 16-bit signed integer that defines the length of the string. + +**fwOpts (2 bytes):** A 16-bit unsigned integer that defines the use of the application-defined rectangle. This member can be a combination of one or more values in the **ExtTextOutOptions Flags** (section [2.1.2.2](#Section_830cec142f3c46f38f2082b3da370573)). + +**Rectangle (8 bytes):** An optional 8-byte **Rect Object** (section [2.2.2.18](#Section_3ccb757b5eaa460c92696b638484640f)).) When either ETO_CLIPPED, ETO_OPAQUE, or both are specified, the rectangle defines the dimensions, in logical coordinates, used for clipping, opaquing, or both. When neither ETO_CLIPPED nor ETO_OPAQUE is specified, the coordinates in **Rectangle** are ignored. + +**String (variable):** A variable-length string that specifies the text to be drawn. The string does not need to be null-terminated, because **StringLength** specifies the length of the string. If the length is odd, an extra byte is placed after it so that the following member (optional **Dx**) is aligned on a 16-bit boundary. The string will be decoded based on the font object currently selected into the playback device context. If a font matching the font object’s specification is not found, the decoding is undefined. If a matching font is found that matches the charset specified in the font object, the string should be decoded with the codepages in the following table. + +| CharSet | CodePage ID | +|---------------------|-------------| +| ANSI_CHARSET | 1252 | +| OEM_CHARSET | 437 | +| SHIFTJIS_CHARSET | 932 | +| HANGEUL_CHARSET | 949 | +| JOHAB_CHARSET | 1361 | +| GB2312_CHARSET | 936 | +| CHINESEBIG5_CHARSET | 950 | +| HEBREW_CHARSET | 1255 | +| ARABIC_CHARSET | 1256 | +| GREEK_CHARSET | 1253 | +| TURKISH_CHARSET | 1254 | +| BALTIC_CHARSET | 1257 | +| EASTEUROPE_CHARSET | 1250 | +| RUSSIAN_CHARSET | 1251 | +| THAI_CHARSET | 874 | +| VIETNAMESE_CHARSET | 1258 | +| SYMBOL_CHARSET | 42 | + +**Dx (variable):** An optional array of 16-bit signed integers that indicate the distance between origins of adjacent character cells. For example, **Dx**\[i\] logical units separate the origins of character cell i and character cell i + 1. If this field is present, there MUST be the same number of values as there are characters in the string. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_FILLREGION Record + +The **META_FILLREGION Record** fills a [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) using a specified brush. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_FILLREGION. + +**Region (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the region to be filled. + +**Brush (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** to get the brush to use for filling the region. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_FLOODFILL Record + +The **META_FLOODFILL Record** fills an area of the output surface with the brush that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_FLOODFILL. + +**ColorRef (4 bytes):** A 32-bit **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that defines the color value. + +**YStart (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the point where filling is to start. + +**XStart (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the point where filling is to start. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_FRAMEREGION Record + +The **META_FRAMEREGION Record** draws a border around a specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) using a specified brush. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_FRAMEREGION. + +**Region (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the region to be framed. + +**Brush (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** to get the Brush to use for filling the region. + +**Height (2 bytes):** A 16-bit signed integer that defines the height, in logical units, of the region frame. + +**Width (2 bytes):** A 16-bit signed integer that defines the width, in logical units, of the region frame. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_INVERTREGION Record + +The **META_INVERTREGION Record** draws a [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in which the colors are inverted. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_INVERTREGION. + +**Region (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the region to be inverted. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_LINETO Record + +The **META_LINETO Record** draws a line from the drawing position that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) up to, but not including, the specified point. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_LINETO. + +**Y (2 bytes):** A 16-bit signed integer that defines the vertical component of the drawing destination position, in logical units. + +**X (2 bytes):** A 16-bit signed integer that defines the horizontal component of the drawing destination position, in logical units. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_PAINTREGION Record + +The **META_PAINTREGION Record** paints the specified [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) by using the brush that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_PAINTREGION. + +**Region (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the region to be painted. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_PATBLT Record + +The **META_PATBLT Record** paints a specified rectangle using the brush that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The brush color and the surface color or colors are combined using the specified [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_PATBLT. + +**RasterOperation (4 bytes):** A 32-bit unsigned integer that defines the raster operation code. This code MUST be one of the values in the **TernaryRasterOperation Enumeration** (section [2.1.1.31](#Section_1605dd68a6354639ab8199ff3e3fc5a3)) table. + +**Height (2 bytes):** A 16-bit signed integer that defines the height, in logical units, of the rectangle. + +**Width (2 bytes):** A 16-bit signed integer that defines the width, in logical units, of the rectangle. + +**YLeft (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the rectangle to be filled. + +**XLeft (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the rectangle to be filled. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_PIE Record + +The **META_PIE Record** draws a pie-shaped wedge bounded by the intersection of an ellipse and two radials. The pie is outlined by using the pen and filled by using the brush that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_PIE. + +**YRadial2 (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical coordinates, of the endpoint of the second radial. + +**XRadial2 (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical coordinates, of the endpoint of the second radial. + +**YRadial1 (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical coordinates, of the endpoint of the first radial. + +**XRadial1 (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical coordinates, of the endpoint of the first radial. + +**BottomRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**RightRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the bounding rectangle. + +**TopRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +**LeftRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the bounding rectangle. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_POLYLINE Record + +The **META_POLYLINE Record** draws a series of line segments by connecting the points in the specified array. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_POLYLINE. + +**NumberOfPoints (2 bytes):** A 16-bit signed integer that defines the number of points in the array. + +**aPoints (variable):** A **NumberOfPoints** array of 32-bit **PointS Object**s (section [2.2.2.16](#Section_3066aeb312f54ed9bf2518c73a6e7175)), in logical units. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_POLYGON Record + +The **META_POLYGON Record** paints a polygon consisting of two or more vertices connected by straight lines. The polygon is outlined by using the pen and filled by using the brush and polygon fill mode that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_POLYGON. + +**NumberOfPoints (2 bytes):** A 16-bit signed integer that defines the number of points in the array. This value must be greater than or equal to 2. + +**aPoints (variable):** A **NumberOfPoints** array of 32-bit **PointS Objects** (section [2.2.2.16](#Section_3066aeb312f54ed9bf2518c73a6e7175)), in logical units. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_POLYPOLYGON Record + +The **META_POLYPOLYGON Record** paints a series of closed polygons. Each polygon is outlined by using the pen and filled by using the brush and polygon fill mode; these are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The polygons drawn by this function can overlap. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_POLYPOLYGON. + +**PolyPolygon (variable):** A variable-sized **PolyPolygon Object** (section [2.2.2.17](#Section_cf1ac7c0749d4678b32c6f68d2a5f268)) that defines the point information. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_RECTANGLE Record + +The **META_RECTANGLE Record** paints a rectangle. The rectangle is outlined by using the pen and filled by using the brush that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_RECTANGLE. + +**BottomRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the rectangle. + +**RightRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the rectangle. + +**TopRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the rectangle. + +**LeftRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the rectangle. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_ROUNDRECT Record + +The **META_ROUNDRECT Record** paints a rectangle with rounded corners. The rectangle is outlined using the pen and filled using the brush, as defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ROUNDRECT. + +**Height (2 bytes):** A 16-bit signed integer that defines the height, in logical coordinates, of the ellipse used to draw the rounded corners. + +**Width (2 bytes):** A 16-bit signed integer that defines the width, in logical coordinates, of the ellipse used to draw the rounded corners. + +**BottomRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the rectangle. + +**RightRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the rectangle. + +**TopRect (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the rectangle. + +**LeftRect (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the rectangle. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_SETPIXEL Record + +The **META_SETPIXEL Record** sets the pixel at the specified coordinates to the specified color. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETPIXEL. + +**ColorRef (4 bytes):** A **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that defines the color value. + +**Y (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the point to be set. + +**X (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the point to be set. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +#### META_TEXTOUT Record + +The **META_TEXTOUT Record** outputs a character string at the specified location by using the font, background color, and text color that are defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_TEXTOUT. + +**StringLength (2 bytes):** A 16-bit signed integer that defines the length of the string, in bytes, pointed to by **String**. + +**String (variable):** The size of this field MUST be a multiple of two. If StringLength is an odd number, then this field MUST be of a size greater than or equal to StringLength + 1. A variable-length string that specifies the text to be drawn. The string does not need to be null-terminated, because **StringLength** specifies the length of the string. The string is written at the location specified by the **XStart** and **YStart** fields. See section [2.3.3.5](#Section_7d07c44aa8284b829af0e0a81cced5a8) for information about the encoding of the field. + +**YStart (2 bytes):** A 16-bit signed integer that defines the vertical (y-axis) coordinate, in logical units, of the point where drawing is to start. + +**XStart (2 bytes):** A 16-bit signed integer that defines the horizontal (x-axis) coordinate, in logical units, of the point where drawing is to start. + +See section [2.3.3](#Section_cb1d4bfebfeb43489e51ba7f06096808) for the specification of other **Drawing Records**. + +### Object Record Types + +This section defines the **Object Record Types**, which create and manage the graphics objects specified in the **Playback Device Context** (section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b)). + +The following are the **Object Record Types**. + +| Name | Section | Description | +|----|----|----| +| META_CREATEBRUSHINDIRECT | [2.3.4.1](#Section_8331e35d0f974ec3b3b0cfb3281c0642) | Creates a **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)1) from a **LogBrush Object** (section [2.2.2.10](#Section_e764d08bdd0e4040ba317a557310c0d6)). | +| META_CREATEFONTINDIRECT | [2.3.4.2](#Section_6040492f7b5849bdbfefef1126bdffe3) | Creates a **Font Object** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)). | +| META_CREATEPALETTE | [2.3.4.3](#Section_919f7f04248445babb275c59701cd846) | Creates a **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)). | +| META_CREATEPATTERNBRUSH | [2.3.4.4](#Section_6f1c6ba3771042c1b6e21b776c2f769b) | Creates a **Brush Object** with a pattern specified by a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). | +| META_CREATEPENINDIRECT | [2.3.4.5](#Section_bdb95c1fc3e741cf8b56879c6f3441c3) | Creates a **Pen Object** (section [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca)). | +| META_CREATEREGION | [2.3.4.6](#Section_c9f5f9452efd4154a9ea3f4dfa59b917) | Creates a **Region Object** (section [2.2.1.5](#Section_28883669449d47239376e853cc067aed)). | +| META_DELETEOBJECT | [2.3.4.7](#Section_2a507b8c6cbc449db95cfaa3fdb6cc15) | Deletes an existing object. | +| META_DIBCREATEPATTERNBRUSH | [2.3.4.8](#Section_8e83b6056a874fa6a1b782ba7efaa59f) | Creates a **Brush Object** with a pattern specified by a [**DIB**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). | +| META_SELECTCLIPREGION | [2.3.4.9](#Section_e6d85905dc154d799788f3e007332071) | Specifies the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) with a specified **Region Object**. | +| META_SELECTOBJECT | [2.3.4.10](#Section_59b4b6f340db46858eda3be3e4196fb2) | Specifies a graphics object in the playback device context. | +| META_SELECTPALETTE | [2.3.4.11](#Section_4fe7a7fcbe504093a74a2c4b006006e2) | Specifies the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) in the playback device context with a specified **Palette Object**. | + +Whenever a graphics object is created by one of the preceding [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) records, the following actions are implied: + +- The object MUST always be assigned the lowest-numbered available index in the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)). + +- Subsequent [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) records MUST refer to the object by its assigned **WMF Object Table** index. + +- The object MUST NOT be used in drawing operations until a **META_SELECTOBJECT Record** (section 2.3.4.10) is received that specifies the object's index. + +- The object MUST remain available for selection until a **META_DELETEOBJECT Record** (section 2.3.4.7) is received that specifies the object's index. + +For further information concerning object indexes and the **WMF Object Table**, see **Managing Objects** (section [3.1.4](#Section_5ffe77a7c215411da3d97740b66c8a08)). + +#### META_CREATEBRUSHINDIRECT Record + +The **META_CREATEBRUSHINDIRECT Record** creates a **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)1) from a **LogBrush Object** (section [2.2.2.10](#Section_e764d08bdd0e4040ba317a557310c0d6)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1)](#Section_77db815896df4656a36c3066de3d5f59) table value META_CREATEBRUSHINDIRECT. + +**LogBrush (8 bytes):** **LogBrush Object** data that defines the brush to create. The **BrushStyle** field specified in the **LogBrush Object** SHOULD be BS_SOLID, BS_NULL, or BS_HATCHED; otherwise, a default **Brush Object** MAY be created. See the following table for details. + +The following table shows the types of **Brush Objects** created by the **META_CREATEBRUSHINDIRECT**, according to the **BrushStyle Enumeration** (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)) table value in the **LogBrush Object** specified by the **LogBrush** field. + +| BrushStyle | Brush Object created | +|----|----| +| BS_SOLID | A solid-color **Brush Object**. | +| BS_NULL | An empty **Brush Object**. | +| BS_PATTERN | A default object, such as a solid-color black **Brush Object**, SHOULD be created.[\<56\>](#Appendix_A_56) | +| BS_DIBPATTERNPT | Same as preceding BS_PATTERN. | +| BS_HATCHED | A hatched Brush Object. | + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_CREATEFONTINDIRECT Record + +The **META_CREATEFONTINDIRECT Record** creates a **Font Object** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_CREATEFONTINDIRECT. + +**Font (variable):** **Font Object** data that defines the font to create. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_CREATEPALETTE Record + +The **META_CREATEPALETTE Record** creates a **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_CREATEPALETTE. + +**Palette (variable):** **Palette Object** data that defines the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) to create. The **Start** field in the **Palette Object** MUST be set to 0x0300. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_CREATEPATTERNBRUSH Record + +The **META_CREATEPATTERNBRUSH Record** creates a brush object with a pattern specified by a [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952).[\<57\>](#Appendix_A_57) + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_CREATEPATTERNBRUSH. + +**Bitmap16 (14 bytes):** A partial **Bitmap16 Object** (section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c)), which defines parameters for the bitmap that specifies the pattern for the brush. Fields not described below are specified in section 2.2.2.1. + +[TABLE] + +> **Bits (4 bytes):** This field MUST be ignored. + +**Reserved (18 bytes):** This field MUST be ignored. + +**Pattern (variable):** A variable-length array of bytes that defines the bitmap pixel data that composes the brush pattern. The length of this field, in bytes, can be computed from bitmap parameters as follows. + +682. (((Width \* BitsPixel + 15) \>\> 4) \<\< 1) \* Height + +The **Width**, **BitsPixel**, and **Height** values are specified in the **Bitmap16** field of this record. + +The **BrushStyle Enumeration** (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)) table value for the brush object created by this record MUST be BS_PATTERN. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_CREATEPENINDIRECT Record + +The **META_CREATEPENINDIRECT Record** creates a **Pen Object** (section [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_CREATEPENINDIRECT. + +**Pen (10 bytes):** **Pen Objec**t data that defines the pen to create. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_CREATEREGION Record + +The **META_CREATEREGION Record** creates a **Region Object** (section [2.2.1.5](#Section_28883669449d47239376e853cc067aed)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_CREATEREGION. + +**Region (variable):** **Region Object** data that defines the [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) to create. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **object records**. + +#### META_DELETEOBJECT Record + +The **META_DELETEOBJECT Record** deletes an object, including the **Bitmap16 Object** (section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c)), **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)), **DeviceIndependentBitmap Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)), **Font Object** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)), **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)), **Pen Object** (section [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca)), and **Region Object** (section [2.2.1.5](#Section_28883669449d47239376e853cc067aed)). After the object is deleted, its index in the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) is no longer valid but is available to be reused. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DELETEOBJECT. + +**ObjectIndex (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** to get the object to be deleted. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_DIBCREATEPATTERNBRUSH Record + +The **META_DIBCREATEPATTERNBRUSH Record** creates a **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)) with a pattern specified by a **DeviceIndependentBitmap (DIB) Object** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_DIBCREATEPATTERNBRUSH. + +**Style (2 bytes):** A 16-bit unsigned integer that defines the brush style. The legal values for this field are defined as follows: if the value is not BS_PATTERN, BS_DIBPATTERNPT MUST be assumed. These values are specified in the **BrushStyle Enumeration** (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)). + +**ColorUsage (2 bytes):** A 16-bit unsigned integer that defines whether the **Colors** field of a **DIB Object** contains explicit [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) values, or indexes into a [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5). + +If the **Style** field specifies BS_PATTERN, a **ColorUsage** value of DIB_RGB_COLORS MUST be used regardless of the contents of this field. + +If the **Style** field specified anything but BS_PATTERN, this field MUST be one of the values in the **ColorUsage Enumeration** (section [2.1.1.6](#Section_30403797a40840cab024dd8a1acb39be)). + +**Target (variable):** Variable-bit **DIB Object** data that defines the pattern to use in the brush. + +The following table shows the types of **Brush Objects** created by the **META_DIBCREATEPATTERNBRUSH Record** (section 2.3.4.8), according to **BrushStyle Enumeration** values. + +| BrushStyle | ColorUsage | Brush Object created | +|----|----|----| +| BS_SOLID | Same as the following BS_DIBPATTERNPT. | Same as the following BS_DIBPATTERNPT. | +| BS_NULL | Same as the following BS_DIBPATTERNPT. | Same as the following BS_DIBPATTERNPT. | +| BS_PATTERN | A **ColorUsage Enumeration** value, which SHOULD define how to interpret the logical color values in the brush pattern. | A BS_PATTERN **Brush Object** that SHOULD contain a pattern defined by a **Bitmap16 Object** (section [2.2.2.1](#Section_dc4873153bb940c89f4955ffc6152d8c)). | +| BS_DIBPATTERNPT | A **ColorUsage Enumeration** value, which SHOULD define how to interpret the logical color values in the brush pattern. | A BS_DIBPATTERNPT **Brush Object** that SHOULD contain a pattern defined by a **DIB Object**. | +| BS_HATCHED | Same as the preceding BS_DIBPATTERNPT. | Same as preceding BS_DIBPATTERNPT. | + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_SELECTCLIPREGION Record + +The **META_SELECTCLIPREGION Record** specifies a **Region Object** (section [2.2.1.5](#Section_28883669449d47239376e853cc067aed)) to be the current clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SELECTCLIPREGION. + +**Region (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the region to be inverted. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_SELECTOBJECT Record + +The **META_SELECTOBJECT Record** specifies a graphics object for the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The new object replaces the previous object of the same type, unless if the previous object is a palette object. If the previous object is a **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)), then the **META_SELECTPALETTE Record** (section [2.3.4.11](#Section_4fe7a7fcbe504093a74a2c4b006006e2)) MUST be used instead of the **META_SELECTOBJECT Record** (section 2.3.4.10), because the **META_SELECTOBJECT Record** does not support replacing the **Palette Object** type. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SELECTOBJECT. + +**ObjectIndex (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the object to be selected. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +#### META_SELECTPALETTE Record + +The **META_SELECTPALETTE Record** defines the current [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) with a specified **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SELECTPALETTE. + +**Palette (2 bytes):** A 16-bit unsigned integer used to index into the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) to get the **Palette Object** to be selected. + +The **WMF Object Table** refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). See section 3.1.4.1 for more information. + +See section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da) for the specification of other **Object Records**. + +### State Record Types + +This section defines the **State Record Types**, which define and manage the graphics properties specified in the **Playback Device Context** (section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b)). + +The following are the **State Record Types**. + +| Name | Section | Description | +|----|----|----| +| META_ANIMATEPALETTE | [2.3.5.1](#Section_abac3df4c19a41029344b5bf68fcfa99) | Redefines entries in the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) with a specified **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)). | +| META_EXCLUDECLIPRECT | [2.3.5.2](#Section_d230f6dc19df4c32aa0c3c39763679e4) | Sets the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) that is defined in the playback device context to the existing clipping region minus a specified rectangle. | +| META_INTERSECTCLIPRECT | [2.3.5.3](#Section_7334bf67dd004786b43d777a733c5adc) | Sets the clipping region that is defined in the playback device context to the intersection of the existing clipping region and a specified rectangle. | +| META_MOVETO | [2.3.5.4](#Section_b92db99d2adc4823955575fd0b7c26cd) | Sets the output position in the playback device context to a specified point. | +| META_OFFSETCLIPRGN | [2.3.5.5](#Section_63e5f3cc7b0548b8b602fdd983eb3bd0) | Moves the clipping region that is defined in the playback device context by specified offsets. | +| META_OFFSETVIEWPORTORG | [2.3.5.6](#Section_9d9ea10a16ea4967b9514aa4efd0354f) | Moves the viewport origin in the playback device context by specified horizontal and vertical offsets. | +| META_OFFSETWINDOWORG | [2.3.5.7](#Section_6a411d75d9224f6a8fc24360766499de) | Moves the output window origin in the playback device context by specified horizontal and vertical offsets. | +| META_REALIZEPALETTE | [2.3.5.8](#Section_d110e35e157846f2a6541528d31e9e7c) | Maps entries from the logical palette that is defined in the playback device context to the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe). | +| META_RESIZEPALETTE | [2.3.5.9](#Section_60422f8cbc414f96a3282f4d2ddaa49e) | Redefines the size of the logical palette that is defined in the playback device context. | +| META_RESTOREDC | [2.3.5.10](#Section_0ba2dee6e4eb4a84ac3729c0ef1e2cb8) | Restores the playback device context from a previously saved [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388). | +| META_SAVEDC | [2.3.5.11](#Section_a5c76d62817b40ca86612bc835246c8d) | Saves the playback device context for later retrieval. | +| META_SCALEVIEWPORTEXT | [2.3.5.12](#Section_3742ef9128b94a5497d835959662b8c1) | Scales the horizontal and vertical extents of the viewport that is defined in the playback device context using the ratios formed by specified multiplicands and divisors. | +| META_SCALEWINDOWEXT | [2.3.5.13](#Section_8e5dfa2b2107472686c381ec3380016a) | Scales the horizontal and vertical extents of the output window that is defined in the playback device context using the ratios formed by specified multiplicands and divisors. | +| META_SETBKCOLOR | [2.3.5.14](#Section_477d3e0536e64feea5e360149ee71fd5) | Sets the background color in the playback device context to a specified color. | +| META_SETBKMODE | [2.3.5.15](#Section_4703ae2921234ab18b8570ba241549b4) | Sets the background mix mode in the playback device context. | +| META_SETLAYOUT | [2.3.5.16](#Section_ff018bbe75db47568f7b9177e84c3b02) | Defines the layout orientation in the playback device context. | +| META_SETMAPMODE | [2.3.5.17](#Section_c70612fb5beb4adfb9198f55deba943a) | Defines the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) in the playback device context. | +| META_SETMAPPERFLAGS | [2.3.5.18](#Section_d8a0fd62ac5246ba8e0eca65ea094092) | Defines the algorithm that the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) uses when it maps logical fonts to physical fonts. | +| META_SETPALENTRIES | [2.3.5.19](#Section_ae4f351a073a47378741441d2e4a5381) | Defines [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color values in a range of entries in the logical palette that is defined in the playback device context. | +| META_SETPOLYFILLMODE | [2.3.5.20](#Section_51c4e270c9e44ed2b538e5df407eb477) | Defines polygon fill mode in the playback device context for graphics operations that fill polygons. | +| META_SETRELABS | [2.3.5.21](#Section_b29768d217f24053a3f02f65917f046b) | Undefined and MUST be ignored. | +| META_SETROP2 | [2.3.5.22](#Section_8e632416efc740bab6925376cbcd4aad) | Defines the foreground [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) mixing mode in the playback device context. | +| META_SETSTRETCHBLTMODE | [2.3.5.23](#Section_eba242eabc6b4cc0b326256ca8d27fde) | Defines the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) stretching mode in the playback device context. | +| META_SETTEXTALIGN | [2.3.5.24](#Section_562b5f06dc3e4446bb2f9ada932a8f9d) | Defines text-alignment values in the playback device context. | +| META_SETTEXTCHAREXTRA | [2.3.5.25](#Section_e9ac157acb53406dbe53f249cd5b2dff) | Defines inter-character spacing for text justification in the playback device context. | +| META_SETTEXTCOLOR | [2.3.5.26](#Section_2bdfee2b30164a6ab4cdc725ce9cb2a0) | Defines the text foreground color in the playback device context. | +| META_SETTEXTJUSTIFICATION | [2.3.5.27](#Section_d215fe8fd5004b8caac5129a7f7af88c) | Defines the amount of space to add to break characters in a string of justified text. | +| META_SETVIEWPORTEXT | [2.3.5.28](#Section_d558b1a426ba4ad6a9c8c3caecaf0b1a) | Defines the horizontal and vertical extents of the viewport in the playback device context. | +| META_SETVIEWPORTORG | [2.3.5.29](#Section_a508f8e18c3d499ba8009dc8e1199d0b) | Defines the viewport origin in the playback device context. | +| META_SETWINDOWEXT | [2.3.5.30](#Section_28fbdde622ee4e49b162abf826f5bc00) | Defines the horizontal and vertical extents of the output window in the playback device context. | +| META_SETWINDOWORG | [2.3.5.31](#Section_6e6195bf6e89467bbabc2681eb290357) | Defines the output window origin in the playback device context. | + +#### META_ANIMATEPALETTE Record + +The **META_ANIMATEPALETTE Record** redefines entries in the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) with the specified **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ANIMATEPALETTE. + +**Palette (variable):** A variable-sized **Palette Objec**t that specifies a logical palette. + +The logical palette that is specified by the **Palette Object** in this record is the source of the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) changes, and the logical palette that is currently selected into the playback device context is the destination. Entries in the destination palette with the **PC_RESERVED** **PaletteEntryFlag Enumeration** (section [2.1.1.22](#Section_45e5c32055b44f3aaf5540f9e0f6e3ac)) set SHOULD be modified by this record, and entries with that flag clear SHOULD NOT be modified. If none of the entries in the destination palette have the **PC_RESERVED** flag set, then this record SHOULD have no effect. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_EXCLUDECLIPRECT Record + +The **META_EXCLUDECLIPRECT Record** sets the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to the existing clipping region minus the specified rectangle. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_EXCLUDECLIPRECT. + +**Bottom (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the rectangle. + +**Right (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the rectangle. + +**Top (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the rectangle. + +**Left (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the rectangle. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_INTERSECTCLIPRECT Record + +The **META_INTERSECTCLIPRECT Record** sets the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to the intersection of the existing clipping region and the specified rectangle. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_INTERSECTCLIPRECT. + +**Bottom (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the lower-right corner of the rectangle. + +**Right (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the lower-right corner of the rectangle. + +**Top (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units, of the upper-left corner of the rectangle. + +**Left (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units, of the upper-left corner of the rectangle. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_MOVETO Record + +The **META_MOVETO Record** sets the output position in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to a specified point. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_MOVETO. + +**Y (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units. + +**X (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_OFFSETCLIPRGN Record + +The **META_OFFSETCLIPRGN Record** moves the clipping [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by the specified offsets. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_OFFSETCLIPRGN. + +**YOffset (2 bytes):** A 16-bit signed integer that defines the number of logical units to move up or down. + +**XOffset (2 bytes):** A 16-bit signed integer that defines the number of logical units to move left or right. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_OFFSETVIEWPORTORG Record + +The **META_OFFSETVIEWPORTORG Record** moves the viewport origin in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by specified horizontal and vertical offsets. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_OFFSETVIEWPORTORG. + +**YOffset (2 bytes):** A 16-bit signed integer that defines the vertical offset, in device units. + +**XOffset (2 bytes):** A 16-bit signed integer that defines the horizontal offset, in device units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_OFFSETWINDOWORG Record + +The **META_OFFSETWINDOWORG Record** moves the output window origin in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by specified horizontal and vertical offsets. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_OFFSETWINDOWORG. + +**YOffset (2 bytes):** A 16-bit signed integer that defines the vertical offset, in device units. + +**XOffset (2 bytes):** A 16-bit signed integer that defines the horizontal offset, in device units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_REALIZEPALETTE Record + +The **META_REALIZEPALETTE Record** maps entries from the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to the [**system palette**](#gt_874d5ba8-6fd5-4c63-97f3-f35cfeda95fe). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_REALIZEPALETTE. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_RESIZEPALETTE Record + +The **META_RESIZEPALETTE Record** redefines the size of the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_RESIZEPALETTE. + +**NumberOfEntries (2 bytes):** A 16-bit unsigned integer that defines the number of entries in the logical palette. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_RESTOREDC Record + +The **META_RESTOREDC Record** restores the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) from a previously saved [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_RESTOREDC. + +**nSavedDC (2 bytes):** A 16-bit signed integer that defines the saved state to be restored. If this member is positive, **nSavedDC** represents a specific instance of the state to be restored. If this member is negative, **nSavedDC** represents an instance relative to the current state. + +See section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b) for a description of the state defined by the playback device context. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SAVEDC Record + +The **META_SAVEDC Record** saves the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) for later retrieval. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SAVEDC. + +See section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b) for a description of the state defined by the playback device context. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SCALEVIEWPORTEXT Record + +The **META_SCALEVIEWPORTEXT Record** scales the horizontal and vertical extents of the viewport that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by using the ratios formed by the specified multiplicands and divisors. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SCALEVIEWPORTEXT. + +**yDenom (2 bytes):** A 16-bit signed integer that defines the amount by which to divide the result of multiplying the current y-extent by the value of the **yNum** member. + +**yNum (2 bytes):** A 16-bit signed integer that defines the amount by which to multiply the current y-extent. + +**xDenom (2 bytes):** A 16-bit signed integer that defines the amount by which to divide the result of multiplying the current x-extent by the value of the **xNum** member. + +**xNum (2 bytes):** A 16-bit signed integer that defines the amount by which to multiply the current x-extent. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SCALEWINDOWEXT Record + +The **META_SCALEWINDOWEXT Record** scales the horizontal and vertical extents of the output window that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) by using the ratios formed by specified multiplicands and divisors. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SCALEWINDOWEXT. + +**yDenom (2 bytes):** A 16-bit signed integer that defines the amount by which to divide the result of multiplying the current y-extent by the value of the **yNum** member. + +**yNum (2 bytes):** A 16-bit signed integer that defines the amount by which to multiply the current y-extent. + +**xDenom (2 bytes):** A 16-bit signed integer that defines the amount by which to divide the result of multiplying the current x-extent by the value of the **xNum** member. + +**xNum (2 bytes):** A 16-bit signed integer that defines the amount by which to multiply the current x-extent. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETBKCOLOR Record + +The **META_SETBKCOLOR Record** sets the background color in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) to a specified color, or to the nearest physical color if the device cannot represent the specified color. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETBKCOLOR. + +**ColorRef (4 bytes):** A 32-bit **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that defines the color value. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETBKMODE Record + +The **META_SETBKMODE Record** defines the background [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) mix mode in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The background mix mode is the mode for combining pens, text, hatched brushes, and interiors of filled objects with background colors on the output surface. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETBKMODE. + +**BkMode (2 bytes):** A 16-bit unsigned integer that defines background mix mode. This MUST be one of the values in the **MixMode Enumeration** (section [2.1.1.20](#Section_9433d37eaa7044388f0b47c25e8723a9)). + +**Reserved (2 bytes):** An optional 16-bit field that MUST be ignored.[\<58\>](#Appendix_A_58) + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETLAYOUT Record + +The **META_SETLAYOUT Record** defines the layout orientation in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45).[\<59\>](#Appendix_A_59) The layout orientation determines the direction in which text and graphics are drawn + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETLAYOUT. + +**Layout (2 bytes):** A 16-bit unsigned integer that defines the layout of text and graphics. This MUST be one of the values in the **Layout Enumeration** (section [2.1.1.13](#Section_523c8784561f4b25bdb9630e0f71be0d)). + +**Reserved (2 bytes):** A 16-bit field that MUST be ignored. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETMAPMODE Record + +The **META_SETMAPMODE Record** defines the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The mapping mode defines the unit of measure used to transform page-space units into device-space units, and also defines the orientation of the device's x and y axes. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETMAPMODE. + +**MapMode (2 bytes):** A 16-bit unsigned integer that defines the mapping mode. This MUST be one of the values enumerated in the **MapMode Enumeration** (section [2.1.1.16](#Section_97b31821a0db4113a210fffbcedcec4a)) table. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETMAPPERFLAGS Record + +The **META_SETMAPPERFLAGS Record** defines the algorithm that the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) uses when it maps logical fonts to physical fonts. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETMAPPERFLAGS. + +**MapperValues (4 bytes):** A 32-bit unsigned integer that defines whether the font mapper attempts to match a font [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5) to the current device aspect ratio. If bit zero is set, the mapper selects only matching fonts. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETPALENTRIES Record + +The **META_SETPALENTRIES Record** defines [**RGB**](#gt_2c716d3a-e60b-4e52-bbb0-2fdeb298003b) color values in a range of entries in the [**logical palette**](#gt_43e451cc-1df4-4abc-bb24-aac32f5ab6f3) that is defined in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETPALENTRIES. + +**Palette (variable):** A **Palette Object** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)), which defines the [**palette**](#gt_dca5cd91-8d01-424b-9722-c9e818562ee5) information. + +The **META_SETPALENTRIES** modifies the logical palette that is currently selected in the playback device context. A **META_SELECTPALETTE Record** (section [2.3.4.11](#Section_4fe7a7fcbe504093a74a2c4b006006e2)) MUST have been used to specify that logical palette in the form of a **Palette Object** prior to the occurrence of the **META_SETPALENTRIES** in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). A **Palette object** is one of the graphics objects that is maintained in the playback device context during playback of the metafile. See Graphics Objects (section [1.3.2](#Section_7397185a8061487c84a637646cab92cc)) for more information. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETPOLYFILLMODE Record + +The **META_SETPOLYFILLMODE Record** sets polygon fill mode in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) for graphics operations that fill polygons. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETPOLYFILLMODE. + +**PolyFillMode (2 bytes):** A 16-bit unsigned integer that defines polygon fill mode. This MUST be one of the values in the **PolyFillMode Enumeration** (section [2.1.1.25](#Section_926ff7dc197b427a8d4e122f7e3505f1)). + +**Reserved (2 bytes):** An optional 16-bit field that MUST be ignored.[\<60\>](#Appendix_A_60) + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETRELABS Record + +The **META_SETRELABS Record** is reserved and not supported. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETRELABS. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETROP2 Record + +The **META_SETROP2 Record** defines the foreground [**raster operation**](#gt_772681cd-b9a5-440c-8021-b6219c70f6fc) mix mode in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). The foreground mix mode is the mode for combining pens and interiors of filled objects with foreground colors on the output surface. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETROP2. + +**DrawMode (2 bytes):** A 16-bit unsigned integer that defines the foreground binary raster operation mixing mode. This MUST be one of the values in the **BinaryRasterOperation Enumeration** (section [2.1.1.2](#Section_781a06bdaf9b48b78e7dd922de0f9c26)). + +**Reserved (2 bytes):** An optional 16-bit field that MUST be ignored.[\<61\>](#Appendix_A_61) + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETSTRETCHBLTMODE Record + +The **META_SETSTRETCHBLTMODE Record** defines the [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) stretching mode in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETSTRETCHBLTMODE. + +**StretchMode (2 bytes):** A 16-bit unsigned integer that defines bitmap stretching mode. This MUST be one of the values in the **StretchMode Enumeration** (section [2.1.1.30](#Section_b839b18aa47c4a44b365ef17d3c89e9a)). + +**Reserved (2 bytes):** An optional 16-bit field that MUST be ignored.[\<62\>](#Appendix_A_62) + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETTEXTALIGN Record + +The **META_SETTEXTALIGN Record** defines text-alignment values in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETTEXTALIGN. + +**TextAlignmentMode (2 bytes):** A 16-bit unsigned integer that defines text alignment. This value MUST be a combination of one or more **TextAlignmentMode Flags** (section [2.1.2.3](#Section_2cf0d8025db742f6bb7550ff195a6c7c)) for text with a horizontal baseline, and **VerticalTextAlignmentMode Flags** (section [2.1.2.4](#Section_2475d008f5ff4c93b28b3953818b8827)) for text with a vertical baseline. + +**Reserved (2 bytes):** An optional 16-bit field that MUST be ignored.[\<63\>](#Appendix_A_63) + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETTEXTCHAREXTRA Record + +The **META_SETTEXTCHAREXTRA Record** defines inter-character spacing for text justification in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). Spacing is added to the white space between each character, including break characters, when a line of justified text is output. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETTEXTCHAREXTRA. + +**CharExtra (2 bytes):** A 16-bit unsigned integer that defines the amount of extra space, in logical units, to be added to each character. If the current [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) is not MM_TEXT, this value is transformed and rounded to the nearest pixel. For details about setting the mapping mode, see **META_SETMAPMODE Record** (section [2.3.5.17](#Section_c70612fb5beb4adfb9198f55deba943a)). + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETTEXTCOLOR Record + +The **META_SETTEXTCOLOR Record** defines the text foreground color in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETTEXTCOLOR. + +**ColorRef (4 bytes):** A 32-bit **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that defines the color value. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETTEXTJUSTIFICATION Record + +The **META_SETTEXTJUSTIFICATION Record** defines the amount of space to add to break characters in a string of justified text. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETTEXTJUSTIFICATION. + +**BreakCount (2 bytes):** A 16-bit unsigned integer that specifies the number of space characters in the line. + +**BreakExtra (2 bytes):** A 16-bit unsigned integer that specifies the total extra space, in logical units, to be added to the line of text. If the current [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) is not MM_TEXT, the value identified by the **BreakExtra** member is transformed and rounded to the nearest pixel. For details about setting the mapping mode, see **META_SETMAPMODE Record** (section [2.3.5.17](#Section_c70612fb5beb4adfb9198f55deba943a)). + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETVIEWPORTEXT Record + +The **META_SETVIEWPORTEXT Record** sets the horizontal and vertical extents of the viewport in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETVIEWPORTEXT. + +**Y (2 bytes):** A 16-bit signed integer that defines the vertical extent of the viewport in device units. + +**X (2 bytes):** A 16-bit signed integer that defines the horizontal extent of the viewport in device units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETVIEWPORTORG Record + +The **META_SETVIEWPORTORG Record** defines the viewport origin in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETVIEWPORTORG. + +**Y (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units. + +**X (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETWINDOWEXT Record + +The **META_SETWINDOWEXT Record** defines the horizontal and vertical extents of the output window in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETWINDOWEXT. + +**Y (2 bytes):** A 16-bit signed integer that defines the vertical extent of the window in logical units. + +**X (2 bytes):** A 16-bit signed integer that defines the horizontal extent of the window in logical units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +#### META_SETWINDOWORG Record + +The **META_SETWINDOWORG Record** defines the output window origin in the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this WMF record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_SETWINDOWORG. + +**Y (2 bytes):** A 16-bit signed integer that defines the y-coordinate, in logical units. + +**X (2 bytes):** A 16-bit signed integer that defines the x-coordinate, in logical units. + +See section [2.3.5](#Section_54e4a2e05ca94c69b6a8dc8f938c68ae) for the specification of other **State Record Types**. + +### Escape Record Types + +This section defines the **Escape Record Types**, which specify extensions to [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) functionality. The generic format of all escape records is specified by the **META_ESCAPE Record** (section [2.3.6.1](#Section_a2f3ad96e6554f24a371d968aeb53852)). + +The following are the **Escape Record Types**. + +| Name | Section | Description | +|----|----|----| +| ABORTDOC | [2.3.6.2](#Section_b49a160bae4b49e9944bb11cf5d6cf20) | Stops processing the current document. | +| BEGIN_PATH | [2.3.6.3](#Section_ac6c557adb0743e78054bbcac49be22c) | Opens a [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613). | +| CHECKJPEGFORMAT | [2.3.6.4](#Section_e400a122a1ce4d21a3178562cdbebcdb) | Determines whether it can handle the given [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image. | +| CHECKPNGFORMAT | [2.3.6.5](#Section_81d4f4684a8a4565a556c795d2404551) | Determines whether it can handle the given [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) image. | +| CLIP_TO_PATH | [2.3.6.6](#Section_4f55db445e8542d7aa780529270d4631) | Applies a function to the current [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) clipping path. | +| CLOSECHANNEL | [2.3.6.7](#Section_e45db47cd6b34830a89c40ba385dbbc7) | Same as **ENDDOC**. | +| DOWNLOADFACE | [2.3.6.8](#Section_5c6d7a7c51a842219491f2e9c9303333) | Sets the font face name on the output device. | +| DOWNLOADHEADER | [2.3.6.9](#Section_b9d0b1fd90f34e7abd339c2f13f76f5a) | Downloads sets of PostScript procedures. | +| DRAWPATTERNRECT | [2.3.6.10](#Section_f8294b86f8f84d32a1b78f35f4890341) | Draws a rectangle with a defined pattern. | +| ENCAPSULATED_POSTSCRIPT | [2.3.6.11](#Section_a7ee8fe3f4c74a89ba740d73651fa5a0) | Sends arbitrary [**encapsulated PostScript (EPS)**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f) data directly to the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). | +| END_PATH | [2.3.6.12](#Section_403d5b60970d41fc835dda9cbcc35ab0) | Ends a path. | +| ENDDOC | [2.3.6.13](#Section_2ec225373a154aa7aa4b39b62a12452c) | Notifies the printer driver that a new [**print job**](#gt_12a6e569-e97c-4761-92f0-e397f8d5125f) is ending. | +| EPSPRINTING | [2.3.6.14](#Section_91e797efc4084bb18b3ff0ffa46c1923) | Indicates the start and end of EPS printing. | +| EXTTEXTOUT | [2.3.6.15](#Section_3479aa6a49ee4f7f883bf9bf50affa0d) | Draws text using the currently selected font, background color, and text color. | +| GETCOLORTABLE | [2.3.6.16](#Section_7b11d0070c8c4bc7af80721e0bb7990f) | Gets [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) values from the printer driver. | +| GETDEVICEUNITS | [2.3.6.17](#Section_98a00c4bc2d242b8acb4f72ce38b0dae) | Gets the device units currently configured on the output device. | +| GETEXTENDEDTEXTMETRICS | [2.3.6.18](#Section_3c8fb8c3050b4cffafb100661fd89faf) | Gets the extended text metrics that are currently configured on the printer driver. | +| GETFACENAME | [2.3.6.19](#Section_3204f004374340d3ad336ee450bc4316) | Gets the font face name currently configured on the output device. | +| GETPAIRKERNTABLE | [2.3.6.20](#Section_e0cb14e3f5894d4d824b08ede3d48735) | Gets the font kern table currently defined on the output device. | +| GETPHYSPAGESIZE | [2.3.6.21](#Section_73800abad2e64b8186aa0a99eb020a31) | Retrieves the physical page size currently selected on the output device. | +| GETPRINTINGOFFSET | [2.3.6.22](#Section_dbc16e9507a64a8680e60f287c222d0f) | Retrieves the offset from the upper-left corner of the physical page where the actual printing or drawing begins. | +| GET_PS_FEATURESETTING | [2.3.6.23](#Section_476ccc2552094090811c2f5a0f2cc188) | Queries the printer driver for information about PostScript features supported on the output device. | +| GETSCALINGFACTOR | [2.3.6.24](#Section_c6974c10c442449383f33ba9d1f42ea1) | Retrieves the scaling factors for the x-axis and the y-axis of a printer. | +| META_ESCAPE_ENHANCED_METAFILE | [2.3.6.25](#Section_cfc88064d86d4b5293743ce27d456179) | Used to embed an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) metafile within a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) metafile. | +| METAFILE_DRIVER | [2.3.6.26](#Section_965669efe3c14516951f624ff396ecaa) | Queries the printer driver about its support for metafiles on the output device. | +| NEWFRAME | [2.3.6.27](#Section_4810f00f110d4d9ab81120c65d7f8e56) | Notifies the printer driver that the application has finished writing to a page. | +| NEXTBAND | [2.3.6.28](#Section_a9034be01c9a4f4d8c7539d21bc13b2c) | Notifies the printer driver that the application has finished writing to a band. | +| PASSTHROUGH | [2.3.6.29](#Section_08743c1d590b468eae4d7791ed174612) | Passes through arbitrary data to the printer driver. | +| POSTSCRIPT_DATA | [2.3.6.30](#Section_76ba4ab1cdde4ad886d090479d8688a0) | Sends arbitrary PostScript data to the output device. | +| POSTSCRIPT_IDENTIFY | [2.3.6.31](#Section_722be3feefff42af8622f5cee7b6deb0) | Sets the printer driver to either PostScript-centric or [**GDI**](#gt_6c550e84-9a9c-46ef-8716-7260fe29cae3)-centric mode. | +| POSTSCRIPT_IGNORE | [2.3.6.32](#Section_d92455001fbd460d92d5ea5b06805863) | Notifies the output device to ignore PostScript data. | +| POSTSCRIPT_INJECTION | [2.3.6.33](#Section_02eac78c7a9c49fc91e3471181b0a0e6) | Inserts a block of raw data into a PostScript stream. | +| POSTSCRIPT_PASSTHROUGH | [2.3.6.34](#Section_3b4c46f8def64604b0789be340c29508) | Sends arbitrary data directly to a printer driver, which is expected to process this data only when in PostScript mode. | +| OPENCHANNEL | [2.3.6.35](#Section_d09608dcb16948c2896a968cdbfb8223) | Acts the same as **STARTDOC**, with a NULL document and output filename, and data in [**raw mode**](#gt_4fe025f0-d6ae-4360-9998-125a5e33c39f). | +| QUERYDIBSUPPORT | [2.3.6.36](#Section_61e48729e5ba40d1a2cc683365016972) | Queries the printer driver about its support for [**DIBs**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091) on the output device. | +| QUERYESCSUPPORT | [2.3.6.37](#Section_2dfcdfe7c2c345e6acf0806cf83b78c8) | Queries the printer driver to determine whether a specific WMF escape function is supported on the output device. | +| SETCOLORTABLE | [2.3.6.38](#Section_7a1bd9de34104b12aa4b7e86c3566d7a) | Sets color table values. | +| SETCOPYCOUNT | [2.3.6.39](#Section_0f85aa756d0f4fd7b552c823e2acbacb) | Sets the number of copies. | +| SETLINECAP | [2.3.6.40](#Section_7253743653ba41bebdf853af06c26a4a) | Specifies the line-ending mode to use in drawing to the output device. | +| SETLINEJOIN | [2.3.6.41](#Section_cdcf06320ed4478396587f5bb3aea3da) | Specifies the line-joining mode to use in drawing to the output device. | +| SETMITERLIMIT | [2.3.6.42](#Section_d3e1016314c64e7c8315e125450944d8) | Sets the limit for the length of miter joins to use in drawing to the output device. | +| SPCLPASSTHROUGH2 | [2.3.6.43](#Section_052e24a7a584447e8413281a15a687cc) | Enables documents to include private procedures and other arbitrary data in documents. | +| STARTDOC | [2.3.6.44](#Section_38dcdad930d8463384f0472903c06fa9) | Notifies the printer driver that a new print job is starting. | + +#### META_ESCAPE Record + +The **META_ESCAPE Record** specifies extensions to [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) functionality that are not directly available through other records defined in the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)). The **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) lists these extensions. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be from the **MetafileEscapes Enumeration**. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **EscapeData** field. + +**EscapeData (variable):** An array of bytes of size **ByteCount**. + +Every **META_ESCAPE** MUST include a **MetafileEscapes** function specifier, followed by arbitrary data. The data SHOULD NOT contain position-specific data that assumes the location of a particular record within the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7), because one metafile might be embedded within another. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### ABORTDOC Record + +The **ABORTDOC Record** stops processing the current document and erases everything drawn since the last **STARTDOC Record** (section [2.3.6.44](#Section_38dcdad930d8463384f0472903c06fa9)) was processed. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0002 (ABORTDOC) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### BEGIN_PATH Record + +The **BEGIN_PATH Record** opens a [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1000 (BEGIN_PATH) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### CHECKJPEGFORMAT Record + +The **CHECKJPEGFORMAT Record** specifies whether the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) supports [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) image output. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1017 (CHECKJPEGFORMAT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **JPEGBuffer** field. + +**JPEGBuffer (variable):** A buffer of JPEG image data. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### CHECKPNGFORMAT Record + +The **CHECKPNGFORMAT Record** queries the driver to see if it can handle the given [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) image and parses the PNG image to determine whether the driver can support it. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1018 (CHECKPNGFORMAT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **PNGBuffer** field. + +**PNGBuffer (variable):** A buffer of PNG image data. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### CLIP_TO_PATH Record + +The **CLIP_TO_PATH Record** applies a function to the current [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) clipping [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record. This value MUST be 0x0000000E. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines the record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1001 (CLIP_TO_PATH) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the record data that follows. This value MUST be 0x0004. + +**ClipFunction (2 bytes):** A 16-bit unsigned integer that defines the function to apply to the PostScript clipping path. This value MUST be a **PostScriptClipping Enumeration** (section [2.1.1.27](#Section_9024b733d84b49ca8b9f4f64476d1b7e)) table value. + +| Name | Value | +|----------------|--------| +| CLIP_SAVE | 0x0000 | +| CLIP_RESTORE | 0x0001 | +| CLIP_INCLUSIVE | 0x0002 | + +**Reserved1 (2 bytes):** This value SHOULD be zero and SHOULD be ignored by the client.[\<64\>](#Appendix_A_64) + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### CLOSECHANNEL Record + +The **CLOSECHANNEL Record** notifies the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) that the current [**print job**](#gt_12a6e569-e97c-4761-92f0-e397f8d5125f) is ending. This is the same function as the **ENDDOC Record** (section [2.3.6.13](#Section_2ec225373a154aa7aa4b39b62a12452c)). A **CLOSECHANNEL** MUST be preceded by an **OPENCHANNEL Record** (section [2.3.6.35](#Section_d09608dcb16948c2896a968cdbfb8223)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1010 ( CLOSECHANNEL) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### DOWNLOADFACE Record + +The **DOWNLOADFACE Record** sends the font face. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0202 (DOWNLOADFACE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### DOWNLOADHEADER Record + +The **DOWNLOADHEADER Record** instructs the driver to download all sets of [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) procedures. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be set to 0x100F (DOWNLOADHEADER) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### DRAWPATTERNRECT Record + +The **DRAWPATTERNRECT Record** draws a rectangle with a defined pattern. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0019 (DRAWPATTERNRECT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the record data that follows. This MUST be 0x0014. + +**Position (8 bytes):** A **PointL Object** (section [2.2.2.15](#Section_4eeaf09ee41a491c93a17aec0afd4f96)) that defines the position of the rectangle. + +**Size (8 bytes):** A **PointL Object** that defines the dimensions of the rectangle. + +**Style (2 bytes):** A 16-bit unsigned integer that defines the style. + +**Pattern (2 bytes):** A 16-bit unsigned integer that defines the pattern. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### ENCAPSULATED_POSTSCRIPT Record + +The **ENCAPSULATED_POSTSCRIPT Record** sends arbitrary [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) data directly to a [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1014 (ENCAPSULATED_POSTSCRIPT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the record data that follows. This value SHOULD be greater than or equal to the value of the **Size** field.[\<65\>](#Appendix_A_65) + +**Size (4 bytes):** A 32-bit unsigned integer that specifies the total size, in bytes, of the **Size**, **Version**, **Points**, and **Data** fields. + +**Version (4 bytes):** A 32-bit unsigned integer that defines the PostScript language level. + +**Points (24 bytes):** An array of three **PointL Objects** (section [2.2.2.15](#Section_4eeaf09ee41a491c93a17aec0afd4f96)) that define the output parallelogram in **28.4 FIX** device coordinates. + +**Data (variable):** The PostScript data. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### END_PATH Record + +The **END_PATH Record** specifies the end of a [**path**](#gt_2cd71385-2d9c-4ab8-bf4a-7b258816d613). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1002 (END_PATH) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### ENDDOC Record + +The **ENDDOC Record** notifies the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) that the current [**print job**](#gt_12a6e569-e97c-4761-92f0-e397f8d5125f) is ending. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x000B (ENDDOC) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### EPSPRINTING Record + +The **EPSPRINTING Recor**d indicates the start or end of [**Encapsulated PostScript (EPS)**](#gt_ba716063-a4a2-4e6e-a657-7ba9fde7b93f) printing. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0021 (EPSPRINTING) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **SetEpsPrinting** field. This MUST be 0x0002. + +**SetEpsPrinting (2 bytes):** A 16-bit unsigned integer that indicates the start or end of EPS printing. If the value is nonzero, the start of EPS printing is indicated; otherwise, the end is indicated. + +[TABLE] + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### EXTTEXTOUT Record + +The **EXTTEXTOUT Record** draws text using the currently selected font, background color, and text color. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0200 (EXTTEXTOUT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETCOLORTABLE Record + +The **GETCOLORTABLE Record** gets [**color table**](#gt_4737483c-820c-41e2-a7be-0ffed2eb4418) values from the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines the record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0005 (GETCOLORTABLE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the record data that follows. + +**Start (2 bytes):** A 16-bit unsigned integer that defines the offset from the beginning of the record to the start of the color table data in the **ColorTable** field. + +**ColorTableBuffer (variable):** A buffer containing the color table that is obtained from the printer driver, which is not required to be contiguous with the static part of the record. + +[TABLE] + +> **UndefinedSpace (variable):** An optional field that MUST be ignored. +> +> **ColorTable (variable):** An array of bytes that define the color table. The location of this field within the record is specified by the **Start** field. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETDEVICEUNITS Record + +The **GETDEVICEUNITS Record** gets the current device units. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x002A (GETDEVICEUNITS) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETEXTENDEDTEXTMETRICS Record + +The **GETEXTENDEDTEXTMETRICS Record** gets the extended text metrics that are currently configured on the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) and applies them to the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines the record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0100 (GETEXTENDEDTEXTMETRICS) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETFACENAME Record + +The **GETFACENAME Record** gets the font face name. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0201 (GETFACENAME) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETPAIRKERNTABLE Record + +The **GETPAIRKERNTABLE Record** gets the font kern table. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0102 (GETPAIRKERNTABLE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETPHYSPAGESIZE Record + +The **GETPHYSPAGESIZE Record** retrieves the physical page size and copies it to a specified location. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x000C (GETPHYSPAGESIZE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETPRINTINGOFFSET Record + +The **GETPRINTINGOFFSET Record** retrieves the offset from the upper-left corner of the physical page where the actual printing or drawing begins. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x000D (GETPRINTINGOFFSET) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GET_PS_FEATURESETTING Record + +The **GET_PS_FEATURESETTING Record** is used to query the driver concerning [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) features. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1019 (GET_PS_FEATURESETTING) from the **MetafileEscapes Enumeratio**n (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Feature** field. This MUST be 0x0004. + +**Feature (4 bytes):** A 32-bit signed integer that identifies the feature setting being queried. Possible values are defined in the **PostScriptFeatureSetting Enumeration** (section [2.1.1.28](#Section_a2f3152ed8f64a8b944304bca27bed1e)). + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### GETSCALINGFACTOR Record + +The **GETSCALINGFACTOR Record** retrieves the scaling factors for the x-axis and the y-axis of a printer. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x000E (GETSCALINGFACTOR) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### META_ESCAPE_ENHANCED_METAFILE Record + +The **META_ESCAPE_ENHANCED_METAFILE Record** is used to embed an [**EMF**](#gt_d9d0bff9-d270-4528-9081-fe51db809c36) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) within a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) metafile. The EMF metafile is broken up into sections, each represented by one **META_ESCAPE_ENHANCED_METAFILE**. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x000F (META_ESCAPE_ENHANCED_METAFILE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the record data that follows. This value MUST be 34 plus the value of the **EnhancedMetafileDataSize** field. + +**CommentIdentifier (4 bytes):** A 32-bit unsigned integer that defines this record as a WMF Comment record. This value MUST be 0x43464D57. + +**CommentType (4 bytes):** A 32-bit unsigned integer that identifies the type of comment in this record. This value MUST be 0x00000001. + +**Version (4 bytes):** A 32-bit unsigned integer that specifies EMF metafile interoperability. This SHOULD be 0x00010000.[\<66\>](#Appendix_A_66) + +**Checksum (2 bytes):** A 16-bit unsigned integer used to validate the correctness of the embedded EMF stream. This value MUST be the one's-complement of the result of applying an XOR operation to all **WORD** structures, defined in \[MS-DTYP\] section 2.2.61, in the EMF stream. + +**Flags (4 bytes):** This 32-bit unsigned integer is unused and MUST be set to zero. + +**CommentRecordCount (4 bytes):** A 32-bit unsigned integer that specifies the total number of consecutive **META_ESCAPE_ENHANCED_METAFILE** records that contain the embedded EMF metafile. + +**CurrentRecordSize (4 bytes):** A 32-bit unsigned integer that specifies the size, in bytes, of the **EnhancedMetafileData** field. This value MUST be less than or equal to 8,192. + +**RemainingBytes (4 bytes):** A 32-bit unsigned integer that specifies the number of bytes in the EMF stream that remain to be processed after this record. Those additional EMF bytes MUST follow in the **EnhancedMetafileData** fields of subsequent **META_ESCAPE_ENHANDED_METAFILE** escape records. + +**EnhancedMetafileDataSize (4 bytes):** A 32-bit unsigned integer that specifies the total size of the EMF stream embedded in this sequence of **META_ESCAPE_ENHANCED_METAFILE** records. + +**EnhancedMetafileData (variable):** A segment of an EMF file. The bytes in consecutive **META_ESCAPE_ENHANCED_METAFILE** records MUST be concatenated to represent the entire embedded EMF file. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### METAFILE_DRIVER Record + +The **METAFILE_DRIVER Record** queries the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) about its support for [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) on the output device. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines the record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0801 (METAFILE_DRIVER) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### NEWFRAME Record + +The **NEWFRAME Record** informs the printer that the application has finished writing to a page. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0001 (NEWFRAME) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### NEXTBAND Record + +The **NEXTBAND Record** informs the printer that the application has finished writing to a band. + +Band information is no longer used. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0003 (NEXTBAND) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### PASSTHROUGH Record + +The **PASSTHROUGH Record** passes through arbitrary data to the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0013 (PASSTHROUGH) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Data** field. + +**Data (variable):** An array of bytes of size **ByteCount**. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### POSTSCRIPT_DATA Record + +The **POSTSCRIPT_DATA Record** sends arbitrary [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) data to the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0025 (POSTSCRIPT_DATA) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Data** field. + +**Data (variable):** An array of bytes of size **ByteCount**. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### POSTSCRIPT_IDENTIFY Record + +The **POSTSCRIPT_IDENTIFY Recor**d sets the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) to either [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d)-centric or [**GDI**](#gt_6c550e84-9a9c-46ef-8716-7260fe29cae3)-centric mode. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1005 (POSTSCRIPT_IDENTIFY) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Data** field. + +**Data (variable):** An array of bytes of size **ByteCount**. + +**Note** This record MUST be processed before the **STARTDOC Record** (section [2.3.6.44](#Section_38dcdad930d8463384f0472903c06fa9)). + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### POSTSCRIPT_IGNORE Record + +The **POSTSCRIPT_IGNORE Record** informs the device to ignore the [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) data. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0026 (POSTSCRIPT_IGNORE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### POSTSCRIPT_INJECTION Record + +The **POSTSCRIPT_INJECTION Record** inserts a block of raw data into a [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) stream. The input MUST be a 32-bit quantity specifying the number of bytes to inject, a 16-bit quantity specifying the injection point, and a 16-bit quantity specifying the page number, followed by the bytes to inject. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1006 (POSTSCRIPT_INJECTION) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Data** field. + +**Data (variable):** An array of bytes of size **ByteCount**. + +**Note** This record MUST be processed before a **STARTDOC Record** (section [2.3.6.44](#Section_38dcdad930d8463384f0472903c06fa9)). + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### POSTSCRIPT_PASSTHROUGH Record + +The **POSTSCRIPT_PASSTHROUGH Record** sends arbitrary data directly to the driver. The driver is expected to only process this data when in [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) mode. For more information, see the **POSTSCRIPT_IDENTIFY** (section [2.3.6.31](#Section_722be3feefff42af8622f5cee7b6deb0)) escape record. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x1013 (POSTSCRIPT_PASSTHROUGH) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Data** field. + +**Data (variable):** An array of bytes of size **ByteCount**. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### OPENCHANNEL Record + +The **OPENCHANNEL RECORD** notifies the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) that a new [**print job**](#gt_12a6e569-e97c-4761-92f0-e397f8d5125f) is starting. This is the same function as a **STARTDOC Record** (section [2.3.6.44](#Section_38dcdad930d8463384f0472903c06fa9)) specified with a NULL document and output file name, data in [**raw mode**](#gt_4fe025f0-d6ae-4360-9998-125a5e33c39f), and a type of zero. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x100E (OPENCHANNEL) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### QUERYDIBSUPPORT Record + +The **QUERYDIBSUPPORT Record** queries the driver about its support for **DIB Objects** (section [2.2.2.9](#Section_7376542acce946258ead585e9538f9f1)). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0C01 (QUERYDIBSUPPORT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) table. + +**ByteCount (2 bytes):** A 16-bit unsigned integer that MUST be 0x0000. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### QUERYESCSUPPORT Record + +The **QUERYESCSUPPORT Record** queries the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) to determine whether a specific [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) escape function is supported on the output device. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0008 (QUERYESCSUPPORT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Query** field. This MUST be 0x0002. + +**Query (2 bytes):** A 16-bit unsigned integer that MUST be a value from the **MetafileEscapes Enumeraton**. This record specifies a query of whether this escape is supported. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### SETCOLORTABLE Record + +The **SETCOLORTABLE Record** sets the color table. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0004 (SETCOLORTABLE) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **ColorTable** field. + +**ColorTable (variable):** A **ByteCount** length byte array containing the color table. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### SETCOPYCOUNT Record + +The **SETCOPYCOUNT Record** sets the number of copies. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0011 (SETCOPYCOUNT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **CopyCount** field. This MUST be 0x0002. + +**CopyCount (2 bytes):** A 16-bit unsigned integer that specifies the number of copies to print. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### SETLINECAP Record + +The **SETLINECAP Record** specifies the type of line-ending to use in subsequent graphics operations. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The low-order byte MUST match the low-order byte of the **RecordType Enumeratio**n (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0015 (SETLINECAP) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Cap** field. This MUST be 0x0004. + +**Cap (4 bytes):** A 32-bit signed integer that defines the type of line cap. Possible values are specified in the **PostScriptCap Enumeration** (section [2.1.1.26](#Section_7d524125be2b4546adf8f49272a5e589)) table. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### SETLINEJOIN Record + +The **SETLINEJOIN Record** specifies the type of line-joining to use in subsequent graphics operations. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0016 (SETLINEJOIN) from the **MetafileEscapes Enumeratio**n (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **Join** field. This MUST be 0x0004. + +**Join (4 bytes):** A 32-bit signed integer that specifies the type of line join. Possible values are specified in **PostScriptJoin Enumeration** (section [2.1.1.29](#Section_62b0b36da0c04cd0bde069a1c8c7d8f1)) table. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### SETMITERLIMIT Record + +The **SETMITERLIMIT Record** sets the limit for the length of miter joins to use in subsequent graphics operations. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x0017 (SETMITERLIMIT) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)) + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **MiterLimit** field. This MUST be 0x0004. + +**MiterLimit (4 bytes):** A 32-bit signed integer that specifies the miter limit. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### SPCLPASSTHROUGH2 Record + +The **SPCLPASSTHROUGH2 Record** enables documents to include private procedures and other resources to send to the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65). + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x11D8 (SPCLPASSTHROUGH2) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the record data that follows. + +**Reserved (4 bytes):** A 32-bit unsigned integer that is not used and MUST be ignored. + +**Size (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **RawData** field. + +**RawData (variable):** The **Size**-length byte array of unprocessed private data to send to the printer driver. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +#### STARTDOC Record + +The **STARTDOC Record** informs the [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) that a new [**print job**](#gt_12a6e569-e97c-4761-92f0-e397f8d5125f) is starting. + +[TABLE] + +**RecordSize (4 bytes):** A 32-bit unsigned integer that defines the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in the record. + +**RecordFunction (2 bytes):** A 16-bit unsigned integer that defines this record type. The lower byte MUST match the lower byte of the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) table value META_ESCAPE. + +**EscapeFunction (2 bytes):** A 16-bit unsigned integer that defines the escape function. The value MUST be 0x000A (STARTDOC) from the **MetafileEscapes Enumeration** (section [2.1.1.17](#Section_55961a7bf6f64f0ba76bb4cf652bc86b)). + +**ByteCount (2 bytes):** A 16-bit unsigned integer that specifies the size, in bytes, of the **DocName** field. This size MUST be less than 260. + +**DocName (variable):** A string of **ByteCount** 8-bit characters that contains the name of the document. + +See section [2.3.6](#Section_2a1786c2dd0f40b48da0a84c0f0d18a0) for the specification of other **Escape Record Types**. + +# Structure Examples + +## Metafile Design + +### Device Independence + +[**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) are useful for transferring images between applications. Most applications support the [**clipboard format**](#gt_8f3c1316-2599-4b4f-918a-fa1898835c15) associated with metafiles, called [**METAFILEPICT**](#gt_3963540d-e32b-4271-a2d0-61a2d93139cc) (for more information, see [\[MSDN-CLIPFORM\]](https://go.microsoft.com/fwlink/?LinkId=89971)). When treated as a single graphics primitive, a metafile is easy to paste into an application without that application needing to know the specific content of the image. An application can store a metafile in global memory or to disk. + +The [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae) of a metafile can be altered during playback. Thus, the image can be scaled arbitrarily, with every component scaling separately, which minimizes the loss of information for the image as a whole, which is not characteristic of [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). + +To ensure that metafiles can be transported between different computers and applications, any application that creates a metafile needs to ensure that the metafile is device independent and sizable. The following guidelines help ensure that every metafile can be accepted and manipulated by other applications: + +- Set the mapping mode as one of the first records. Some applications only accept metafiles that are in MM_ANISOTROPIC mode. + +- Set the **META_SETWINDOWORG** (section [2.3.5.31](#Section_6e6195bf6e89467bbabc2681eb290357)) and **META_SETWINDOWEXT** (section [2.3.5.30](#Section_28fbdde622ee4e49b162abf826f5bc00)) records. Do not use the **META_SETVIEWPORTEXT** (section [2.3.5.28](#Section_d558b1a426ba4ad6a9c8c3caecaf0b1a)) or **META_SETVIEWPORTORG** (section [2.3.5.29](#Section_a508f8e18c3d499ba8009dc8e1199d0b)) record if the user will be able to resize or change the dimensions of the object. + +- Do not use any of the [**region**](#gt_6f13fe5f-8747-4ae0-9375-814bf0528197) records, because they are device dependent. + +- Use **META_STRETCHBLT** (section [2.3.1.5](#Section_61370adbd37d48c4b5dd7f7a64e0a9ea)) or **META_STRETCHDIB** (section [2.3.1.6](#Section_7ebae08d61ee4d829aa59217ba2aa8c1)) instead of **META_BITBLT** (section [2.3.1.1](#Section_1aa8c9f613f740c0be47b52ab3d3a649)). + +- Terminate the metafile with a **META_EOF** **Record** (section [2.3.2.1](#Section_3aa35974e8994acc892a47a2300948af)) (0x0000). + +### Byte Ordering Example + +The following code snippet illustrates how the use of the [**big-endian**](#gt_6f6f9e8e-5966-4727-8527-7e02fb864e7e) and [**little-endian**](#gt_079478cb-f4c5-4ce5-b72b-2144da5d2ce7) methods can affect the compatibility of applications. + +683. \#include \ + + \#include \ + + \#include \ + + int main() + + { + + int buf; + + int in; + + int nread; + + in = open("file.in", O_RDONLY); + + nread = read(in, (int \*) &buf, sizeof(buf)); + + printf("First Integer in file.in = %x\n", buf); + + exit(0); + + } + +In the preceding code, if the first integer word stored in the file.in file on a big-endian computer was the hexadecimal number 0x12345678, the resulting output on that computer would be as follows. + +697. % ./test + + First Integer in file.in = 12345678 + + % + +If the file.in file were read by the same program running on a little-endian computer, the resulting output would be as follows. + +701. % ./test + + First Integer in file.in = 78563412 + + % + +Because of the difference in output, [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) record processing can be implemented so that it can read integers from a file based on the endian method that the output computer uses. + +Because metafiles were developed and written with little-endian computers, computers that are big-endian based will have to perform this necessary compensation. + +### Mapping Modes + +When an application pastes a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) from a [**clipboard**](#gt_1d19723a-0cdb-4afc-b603-d3767e4dbcf4), the application can determine the size of metafile output. For this to work cleanly between applications, be aware of the following: + +- The metafile is responsible for specifying the window part of the [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae). + +- The player of the metafile is responsible for the viewport part of the mapping mode. + +To perform a simple playback of the metafile, an application can perform the following initialization before processing records. + +1. Set the mapping mode to the mode specified in the [**METAFILEPICT**](#gt_3963540d-e32b-4271-a2d0-61a2d93139cc) structure (for more information, see [\[MSDN-CLIPFORM\]](https://go.microsoft.com/fwlink/?LinkId=89971)). + +2. Convert the horizontal and vertical extents of the viewport to logical units, if necessary (see the following). + +3. Perform scaling computations, if required (see below). + +4. Set the viewport origin according to the desired placement of the metafile. + +If the mapping mode in a metafile is **MM_ANISOTROPIC** or **MM_ISOTROPIC**, coordinate conversion might be required, as mentioned earlier. If the horizontal and vertical extents of the image are given in **MM_HIMETRIC** coordinates, they are converted to pixel values. Before playback, the application sets the viewport origin to the desired location, sets the mapping mode to the specified mode, and computes the viewport extents. If no extents are specified in the METAFILEPICT structure, the application performing the playback can arbitrarily choose a size. + +Thus, scaling a metafile that uses the **MM_ANISOTROPIC** or **MM_ISOTROPIC** mapping modes can be performed by changing the viewport extents to the appropriate dimensions before playback. The viewport defines the size of the metafile image. + +To scale metafiles that use any other mapping mode, first convert the metafile to use **MM_ANISOTROPIC** mapping mode. The metafile itself does not need to change, but the mapping mode setup does need to be correct before beginning the playback. + +### Managing Objects + +#### WMF Object Table + +The **WMF Object Table** is a conceptual element of [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) graphics objects management. **Graphics Objects** (section [2.2.1](#Section_aafd0883af3f43a69ccd201b725c370e)) include **Brush Objects** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)), **Font Objects** (section [2.2.1.2](#Section_dabb1ed6e5e8424380ede63443e5484f)), **Palette Objects** (section [2.2.1.3](#Section_3ff2d783b9344049bba367fe157fb3d5)), **Pen Objects** (section [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca)), and **Region Objects** (section [2.2.1.5](#Section_28883669449d47239376e853cc067aed)); they can be defined, used, reused, and deleted by records in a WMF [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). This section describes a hypothetical **WMF Object Table** to keep track of graphics objects during the processing of a WMF metafile. + +The **WMF Object Table** is simply an array of indexes assigned to graphics object structures defined during the processing of a WMF metafile. The maximum number of indexes needed in a **WMF Object Table** for a given metafile can be computed from the total number of objects defined in the metafile, which is specified by the **NumberOfObjects** field in the WMF **META_HEADER Record** (section [2.3.2.2](#Section_d169108ae3fe436abb44bea61a46ce56)). An implementation of the **WMF Object Table** will store and manage that number of objects. + +Whenever a graphics object is created by one of the **Object Record Types** listed in section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da), the following actions are implied: + +- Every object is assigned the lowest available index—that is, the smallest numerical value—in the **WMF Object Table**. This binding happens at object creation, not when the object is used. Moreover, each object table index uniquely refers to an object. Indexes in the **WMF Object Table** always start at 0. + +- Subsequent WMF records refer to an object by its assigned **WMF Object Table** index. However, there is no requirement that every object defined in the metafile will be used. + +- An object is not used in drawing operations until a **META_SELECTOBJECT Record** (section [2.3.4.10](#Section_59b4b6f340db46858eda3be3e4196fb2)) is received that specifies its **WMF Object Table** index. This record activates the object and makes it current in the **Playback Device Context** section [3.1.5](#Section_6af060b607dd4b1aad1d972a9ce1603b)). + +- Later in the processing of the metafile, another **META_SELECTOBJECT Record** might be encountered that selects a different object of the same object type into the [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45). When that happens, the previously defined object is not deleted, and its index is not returned to the pool of available indexes. + +- When a **META_DELETEOBJECT Record** (section [2.3.4.7](#Section_2a507b8c6cbc449db95cfaa3fdb6cc15)) is received that specifies this object's particular index, the object's resources are released, the binding to its **WMF Object Table** index is ended, and the index value is returned to the pool of available indexes. The index will be reused, if needed, by a subsequent object created by another **Object Record Type** (section 2.3.4) record. + +Thus, graphics object creation, use, and deletion depend on the correct order of records during playback to achieve the expected results. + +**Note**  This specification does not mandate that implementations adhere to the implementation of the **WMF Object Table** presented in this section, as long as the implementation of external behavior is compatible with the behavior described in this specification. + +#### Object Scaling + +A [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) that is created by an application and then passed to another application is likely to be scaled. Scaling can alter the desired image in a way that was not anticipated by the originating application, which does not scale the image. Every logical measure defined in a [**logical object**](#gt_9e6749e7-d04d-484c-a8ac-f9a57d0d7307) is scaled before the object is realized into physical form. + +For a logical object such as pens, the width is transformed from logical to physical as an x-scalar value. If the metafile is scaled in y but not in x, the pen width is unchanged. If the metafile is scaled in x but not in y, the pen width does scale. Thus, using a pen of width 1 in a metafile results in a pen that is wider (thick and slow) when the metafile is scaled. If a nominal width pen (width of 1 at all times) is wanted, use 0 as the width because it is not affected by [**mapping modes**](#gt_6e998e8d-4394-4263-8632-503730f0abae). A 0-width pen is drawn as having a width of 1. + +Font sizing is more complicated. The two values that scale in a logical font are the height and the width. Most applications use a width of 0 to define a font, which results in a physical font with a width that was designed for the given height. As the metafile is stretched in x, the font remains the same size. As the metafile is stretched in y, however, the physical font grows bigger and probably wider. In and of itself, this is not bad, but problems arise when the metafile makes assumptions about the width of the font by placing the characters of a text string individually, using **META_EXTTEXTOUT Record** (section [2.3.3.5](#Section_7d07c44aa8284b829af0e0a81cced5a8)) with a width array, or using a **META_TEXTOUT Record** (section [2.3.3.20](#Section_96531e1a187549e5b797b4c4c50fa789)) for each character. In either case, the x-placement of each character scales with the metafile, but the font's width does not necessarily scale accordingly, which causes characters to overlap or be widely spaced. + +The simplest way to overcome this problem is not to place the characters individually but to use **META_TEXTOUT** (or **META_EXTTEXTOUT** with no width array) to output the whole string. The text string remains intact, but its size can change in relation to the rest of the image when x and y are not scaled identically. Another possibility is to define the font with a nonzero width so that it scales in x as well as in y. However, doing so is problematic, because its [**bitmapped**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) fonts might not scale independently in x and y. Scaling a font's width is also possible; unfortunately, any time a font's width is scaled, the look of the [**typeface**](#gt_2fff9b0b-4bc1-4d05-81ef-8dde59fd9789) changes in ways not necessarily intended by the designers, and a typographically "incorrect" typeface results. + +### Playback Device Context + +The [**playback device context**](#gt_32591a2b-a9d0-4ccf-a5b8-7177e1ea8d45) is an abstract data structure that defines the state of graphics at any point in time during playback of a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). The graphics state includes: + +- A complete set of **Graphics Objects** (section [2.2.1](#Section_aafd0883af3f43a69ccd201b725c370e)), including a brush, font, palette, pen, and region, which are created and managed by WMF **Object Record Types** (section [2.3.4](#Section_aeab62b803ab48c0817609c392f3c9da)). + +- A set of selected **Structure Objects** (section [2.2.2](#Section_4ac77df091164b6c9215ded079af0fd8)), which define parameters of the output surface. These elements of the playback device context are not explicitly created by any record, but they can be modified. + +- A vector of graphics properties, which are numerical values that specify modes and parameters for graphics operations. + +Although the state defined by the playback device context can be modified by WMF records, there is no guarantee that every graphics object and property will be explicitly initialized by records in a given metafile before any output takes place. Thus, whenever a metafile is played back, it is necessary to define initial conditions consisting of a set of default values for the playback device context. These initial conditions are dependent on multiple factors, including the operating system and the device that is the destination for output.[\<67\>](#Appendix_A_67) + +The following table lists the graphics objects that are defined in the playback device context. + +[TABLE] + +The following table lists the structure objects that are defined in the playback device context. + +[TABLE] + +The following table lists the graphics properties that are defined in the playback device context. + +| Property | Description | Modified by record(s) | +|----|----|----| +| Background mix mode | The mode for combining pens, text, hatched brushes, and interiors of filled objects with background colors on the output surface. | **META_SETBKMODE Record** (section [2.3.5.15](#Section_4703ae2921234ab18b8570ba241549b4)) | +| Break extra space | The total extra space to be added to a line of text for justification. | **META_SETTEXTJUSTIFICATION Record** (section [2.3.5.27](#Section_d215fe8fd5004b8caac5129a7f7af88c)) | +| Font matching mode | A Boolean value that specifies whether the [**font mapper**](#gt_3c6f410b-e1f3-4841-8254-6f45433425f1) attempts to match a font [**aspect ratio**](#gt_091ff8ed-6ac1-4015-9d91-93020f13f6b5) to the current device aspect ratio. | **META_SETMAPPERFLAGS Record** (section [2.3.5.18](#Section_d8a0fd62ac5246ba8e0eca65ea094092)) | +| Foreground mix mode | The mode for combining pens and interiors of filled objects with foreground colors on the output surface. | **META_SETROP2 Record** (section [2.3.5.22](#Section_8e632416efc740bab6925376cbcd4aad)) | +| Layout mode | The direction in which text and graphics are drawn. | **META_SETLAYOUT Record** (section [2.3.5.16](#Section_ff018bbe75db47568f7b9177e84c3b02)) | +| Mapping mode | How logical units are mapped to physical units. | **META_SETMAPMODE Record** (section [2.3.5.17](#Section_c70612fb5beb4adfb9198f55deba943a)) | +| Polygon fill mode | The method used for filling a polygon. | **META_SETPOLYFILLMODE Record** (section [2.3.5.20](#Section_51c4e270c9e44ed2b538e5df407eb477)) | +| Stretchblt mode | How the system combines rows or columns of pixels when shrinking a bitmap. | **META_SETSTRETCHBLTMODE Record** (section [2.3.5.23](#Section_eba242eabc6b4cc0b326256ca8d27fde)) | +| Text alignment mode | The relationship between a reference point and a bounding rectangle, for text alignment. | **META_SETTEXTALIGN Record** (section [2.3.5.24](#Section_562b5f06dc3e4446bb2f9ada932a8f9d)) | +| Text extra space | The amount of extra space to add to each character when writing a line of text. | **META_SETTEXTCHAREXTRA Record** (section [2.3.5.25](#Section_e9ac157acb53406dbe53f249cd5b2dff)) | + +**Note**  This specification does not mandate that implementations adhere to the implementation of the playback device context presented in this section, as long as the implementation of external behavior is compatible with the behavior described in this specification. + +### Run-Length Encoding (RLE) Compression + +In general, [**run-length encoding (RLE) compression**](#gt_24a5d1b0-11f0-4e92-a985-b6fc1fa5a421) makes it possible to specify an arbitrary number of identical values without a proportional increase in storage requirements. The compressed format usually defines a run count and a value, and expansion amounts to replicating that value a number of times equal to the run count. + +Metafile records can contain [**bitmaps**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952) that are compressed with an enhanced RLE compression algorithm. Compression of bitmaps that are defined with 4 and 8 bits per pixel are described in the sections which follow. + +#### Bitmaps with 4 Bits per Pixel + +When the **Compression** field of a **BitmapInfoHeader Object** (section [2.2.2.3](#Section_567172fab8a24d7986a25e21d6659ef3)) is **BI_RLE4**, an [**RLE compression**](#gt_24a5d1b0-11f0-4e92-a985-b6fc1fa5a421) algorithm is used to compress a 4-bit [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). This format specifies encoded and absolute modes, and either mode can occur anywhere in a given bitmap. + +Encoded mode involves two bytes. If the first byte of a pair is greater than zero, it specifies the number of consecutive pixels to be drawn using the two color indexes that are contained in the high-order and low-order bits of the second byte. + +The first pixel is drawn using the color specified by the high-order 4 bits, the second is drawn using the color in the low-order 4 bits, the third is drawn using the color in the high-order 4 bits, and so on, until all the pixels specified by the first byte have been drawn. + +If the first byte of a pair is zero and the second byte is 0x02 or less, the second byte is an escape value that can denote the end of a line, the end of the bitmap, or a relative pixel position, as follows. + +| Second byte value | Meaning | +|-------------------|---------------| +| 0x00 | End of line | +| 0x01 | End of bitmap | +| 0x02 | Delta | + +When a delta is specified, the 2 bytes following the escape value contain unsigned values indicating the horizontal and vertical offsets of the next pixel relative to the current position. + +In absolute mode, the first byte is zero, and the second byte is a value in the range 0x03 through 0xFF. The second byte contains the number of 4-bit color indexes that follow. Subsequent bytes contain color indexes in their high- and low-order 4 bits, one color index for each pixel. In absolute mode, each run is aligned on a word boundary. + +The following example shows the hexadecimal contents of a 4-bit compressed bitmap: + +705. 03 04 05 06 00 06 45 56 67 00 04 78 00 02 05 01 + + 04 78 00 00 09 1E 00 01 + +This bitmap is interpreted as follows: + +- 03 04: Encoded mode, specifying 3 pixels with the values 0x0, 0x4, and 0x0. + +- 05 06: Encoded mode, specifying 5 pixels with the values 0x0, 0x6, 0x0, 0x6, and 0x0. + +- 00 06 45 56 67 00: Absolute mode, specifying 6 pixels with the values 0x4, 0x5, 0x5, 0x6, 0x6, and 0x7, padded to a word boundary. + +- 04 78: Encoded mode, specifying 4 pixels with the values 0x7, 0x8, 0x7, and 0x8. + +- 00 02 05 01: Encoded mode, specifying a new relative position 5 pixels to the right and one line down. + +- 04 78: Encoded mode, specifying 4 pixels with the values 0x7, 0x8, 0x7, and 0x8. + +- 00 00: Encoded mode, specifying the end of a line. + +- 09 1E: Encoded mode, specifying 9 pixels with the values 0x1, 0xE, 0x1, 0xE, 0x1, 0xE, 0x1, 0xE, and 0x1. + +- 00 01: Encoded mode, specifying the end of the bitmap. + +Now, suppose the bitmap has a width of 32 pixels and a height of 4 lines, and pixel values that are not specified are 0x00 by default. The resulting expended bitmap would be as follows. + +708. 04 00 60 60 45 56 67 78 78 00 00 00 00 00 00 00 + + 00 00 00 00 00 00 00 00 00 00 00 07 87 80 00 00 + + 1E 1E 1E 1E 10 00 00 00 00 00 00 00 00 00 00 00 + + 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + +#### Bitmaps with 8 Bits per Pixel + +When the **Compression** field of a **BitmapInfoHeader Object** (section [2.2.2.3](#Section_567172fab8a24d7986a25e21d6659ef3)) is **BI_RLE8**, an [**RLE compression**](#gt_24a5d1b0-11f0-4e92-a985-b6fc1fa5a421) algorithm is used to compress an 8-bit [**bitmap**](#gt_26a17e58-eeba-4210-81b9-8bbadf7ee952). This format specifies encoded and absolute modes, and either mode can occur anywhere in a given bitmap. + +Encoded mode involves two bytes. If the first byte of a pair is greater than zero, it specifies the number of consecutive pixels to be drawn using the color index that is contained in the second byte. + +If the first byte of a pair is zero and the second byte is 0x02 or less, the second byte is an escape value that can denote the end of a line, the end of the bitmap, or a relative pixel position, as follows. + +| Second byte value | Meaning | +|-------------------|---------------| +| 0x00 | End of line | +| 0x01 | End of bitmap | +| 0x02 | Delta | + +When a delta is specified, the 2 bytes following the escape value contain unsigned values indicating the horizontal and vertical offsets of the next pixel relative to the current position. + +In absolute mode, the first byte is zero, and the second byte is a value in the range 0x03 through 0xFF. The second byte represents the number of bytes that follow, each of which contains the color index of a single pixel. In absolute mode, each run is aligned on a word boundary. + +The following example shows the hexadecimal contents of an 8-bit compressed bitmap. + +713. 03 04 05 06 00 03 45 56 67 00 02 78 00 02 05 01 + + 02 78 00 00 09 1E 00 01 + +This bitmap is interpreted as follows: + +- 03 04: Encoded mode, specifying 3 pixels with the value 0x04. + +- 05 06: Encoded mode, specifying 5 pixels with the value 0x06. + +- 00 03 45 56 67 00: Absolute mode, specifying 3 pixels with the values 0x45, 0x56, and 0x67, padded to a word boundary. + +- 02 78: Encoded mode, specifying 2 pixels with the value 0x78. + +- 00 02 05 01: Encoded mode, specifying a new relative position 5 pixels to the right and 1 line down. + +- 02 78: Encoded mode, specifying 2 pixels with the value 0x78. + +- 00 00: Encoded mode, specifying the end of a line. + +- 09 1E: Encoded mode, specifying 9 pixels with the value 1E. + +- 00 01: Encoded mode, specifying the end of the bitmap. + +Now, suppose the bitmap has a width of 32 pixels and a height of 4 lines, and pixel values that are not specified are 0x00 by default. The resulting expended bitmap would be as follows. + +716. 04 04 04 06 06 06 06 06 45 56 67 78 78 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 78 78 00 00 00 00 00 00 00 00 00 00 00 00 + + 1E 1E 1E 1E 1E 1E 1E 1E 1E 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + + 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 00 + +## WMF Metafile Example + +This section provides an example of a [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) which, when processed, renders the following image. + +![WMF metafile example](media/image2.bin "WMF metafile example") + +Figure 2: WMF metafile example + +The contents of this metafile example are shown in the following in hexadecimal bytes. The far-left column is the byte count; the far-right characters are the interpretation of the bytes in the Latin-1 [**ANSI Character Set**](#gt_100cd8a6-5cb1-4895-9de6-e4a3c224a583), as specified in [\[ISO/IEC-8859-1\]](https://go.microsoft.com/fwlink/?LinkId=90689). The sections that follow describe the packets that convey this series of bytes. + +721. 00000000: 01 00 09 00 00 03 36 00 00 00 02 00 0C 00 00 00 …...6......... + + 00000010: 00 00 08 00 00 00 FA 02 04 00 00 00 00 00 00 00 ......ú......... + + 00000020: FF 00 04 00 00 00 2D 01 00 00 07 00 00 00 FC 02 ÿ.....-.......ü. + + 00000030: 02 00 00 FF 00 FF 04 00 04 00 00 00 2C 01 01 00 ...ÿ.ÿ......,... + + 00000040: 07 00 00 00 1B 04 46 00 96 00 00 00 00 00 0C 00 ......F.–....... + + 00000050: 00 00 21 05 0C 00 48 65 6C 6C 6F 20 50 65 6F 70 ..!...Hello Peop + + 00000060: 6C 65 0A 00 0A 00 03 00 00 00 00 00 le.......... + +**Note**  When a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) metafile is processed, the order in which graphics are rendered corresponds to the order of records in the metafile. This can create challenges for devices that have layers. For example, [**Printer Command Language (PCL)**](#gt_ffc25745-85c9-40bc-b2d3-f19ab7b48570) defines a graphics layer and a text layer. The text layer in [**PCL**](#gt_9afb8a20-a5a2-487a-962b-0ca96d0082d8) is always drawn on top of the graphics layer. Thus, when converting from metafile format to PCL, the converter, to generate the correct output, either detects text/graphic overlaps and sends the text down as graphics, or always sends the text as graphics. + +The sections that follow provide definitions of the WMF header and records that correspond to this metafile. The **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) refers to an indexed table of **WMF Objects** (section [2.2](#Section_61870a5fb2b14e1a9fa7af9d3664604d)) that are defined in the metafile. + +### META_HEADER Example + +This section provides an example of a **META_HEADER Record** (section [2.3.2.2](#Section_d169108ae3fe436abb44bea61a46ce56)), which is always the first record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +729. 00000000: 01 00 09 00 00 03 36 00 00 00 02 00 0C 00 00 00 + + 00000010: 00 00 + +[TABLE] + +**Type (2 bytes):** 0x0001 specifies the type of metafile from the **MetafileType Enumeration** (section [2.1.1.18](#Section_2d09c51e062b4d9b94c46ffd0e12dfb6)) to be a metafile stored in memory. + +**HeaderSize (2 bytes):** 0x0009 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 18 (0x0012) bytes. + +**Version (2 bytes):** 0x0300 specifies the metafile version from the **MetafileVersion Enumeration** (section [2.1.1.19](#Section_a161bbdd3ca8477ca91613f3bdff881b)) to be a [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) metafile that supports [**DIBs**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091). + +**Size (4 bytes):** 0x00000036 specifies the number of **WORDs** in the entire metafile, which is equivalent to 108 (0x0000006C) bytes. + +**NumberOfObjects (2 bytes):** 0x0002 specifies the number of graphics objects that are defined in the metafile. + +**MaxRecord (4 bytes):** 0x0000000C specifies the size in **WORDs** of the largest record in the metafile, which is equivalent to 24 (0x00000018) bytes. + +**NumberOfMembers (2 bytes):** 0x0000 is not used. + +**Note** Based on the value of the **NumberOfObjects** field, a **WMF Object Table** (section [3.1.4.1)](#Section_ea7c8077111a451e8b99181705f97cf4) can be created that is large enough for 2 objects. + +### META_CREATEPENINDIRECT Example + +This section provides an example of a **META_CREATEPENDIRECT Record** (section [2.3.4.5](#Section_bdb95c1fc3e741cf8b56879c6f3441c3)). + +731. 00000010: 08 00 00 00 FA 02 04 00 00 00 00 00 00 00 + + 00000020: FF 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x00000008 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 16 (0x00000010) bytes. + +**RecordFunction (2 bytes):** 0x02FA specifies a **META_CREATEPENINDIRECT** record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)). + +**Pen Object (10 bytes):** A **Pen Object** (section [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca)) that defines the pen to create. + +[TABLE] + +**PenStyle (2 bytes):** 0x0004 specifies the PS_DASHDOTDOT style from the **PenStyle Enumeration** (section [2.1.1.23](#Section_2af5f7e49abb4fb4b428d739c8b23829)). + +**PointS Object (4 bytes):** A **PointS Object** (section [2.2.2.16](#Section_3066aeb312f54ed9bf2518c73a6e7175)) that specifies the width of the pen. + +[TABLE] + +**x (2 bytes):** 0x0000 specifies the width of the pen to be the default, which is 1 pixel. + +**y (2 bytes):** 0x0000 is not used. + +**ColorRef Object (4 bytes):** A **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that specifies a green pen color. + +[TABLE] + +**Reserved (1 byte):** 0x00 is not used. + +**Blue (1 byte):** 0x00 specifies no blue. + +**Green (1 byte):** 0xFF specifies full intensity of green. + +**Red (1 byte):** 0x00 specifies no red. + +**Note** The **Pen Object** created by processing this record is assigned index 0 in the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)). + +### META_SELECTOBJECT Example 1 + +This section provides an example of a **META_SELECTOBJECT Record** (section [2.3.4.10](#Section_59b4b6f340db46858eda3be3e4196fb2)). + +733. 00000020: 04 00 00 00 2D 01 00 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x00000004 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 8 (0x00000008) bytes. + +**RecordFunction (2 bytes):** 0x012D specifies the type of this record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) to be **META_SELECTOBJECT**. + +**ObjectIndex (2 bytes):** 0x0000 specifies the index in the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) of the object being selected, which is the **Pen Object** (section [2.2.1.4](#Section_6e43c74e2d194d4097abb5933caa80ca)) created in the previous record. + +### META_CREATEBRUSHINDIRECT Example + +This section provides an example of a **META_CREATEBRUSHINDIRECT Record** (section [2.3.4.1](#Section_8331e35d0f974ec3b3b0cfb3281c0642)). + +734. 00000020: 07 00 00 00 FC 02 + + 00000030: 02 00 00 FF 00 FF 04 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x00000007 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 14 (0x0000000E) bytes. + +**RecordFunction (2 bytes):** 0x02FC specifies a **META_CREATEBRUSHINDIRECT** record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)). + +**LogBrush Object (8 bytes):** A **LogBrush Object** (section [2.2.2.10](#Section_e764d08bdd0e4040ba317a557310c0d6)) that defines the brush to create. + +[TABLE] + +**BrushStyle (2 bytes):** 0x0002 specifies the BS_HATCHED style from the **BrushStyle Enumeration** (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)). + +**ColorRef Object (4 bytes):** A **ColorRef Object** (section [2.2.2.8](#Section_0fdf54fc63574cddb27f795dee14cf86)) that specifies a magenta brush color. + +[TABLE] + +**Reserved (1 byte):** 0x00 is not used. + +**Blue (1 byte):** 0xFF specifies full intensity blue. + +**Green (1 byte):** 0x00 specifies no green. + +**Red (1 byte):** 0xFF specifies full intensity red. + +**BrushHatch (2 bytes):** 0x0004 specifies the hatch style from the **HatchStyle Enumeration** (section [2.1.1.12](#Section_3d08f11808e143f08d789005151b00fe)), a horizontal and vertical cross-hatch. + +**Note** The **Brush Object** created by processing this record is assigned index 1 in the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)). + +### META_SELECTOBJECT Example 2 + +This section provides an example of a **META_SELECTOBJECT Record** (section [2.3.4.10](#Section_59b4b6f340db46858eda3be3e4196fb2)). + +736. 00000030: 04 00 00 00 2D 01 01 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x00000004 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 8 (0x00000008) bytes. + +**RecordFunction (2 bytes):** 0x012D specifies the type of this record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) to be **META_SELECTOBJECT**. + +**ObjectIndex (2 bytes):** 0x0001 specifies the index in the **WMF Object Table** (section [3.1.4.1](#Section_ea7c8077111a451e8b99181705f97cf4)) of the object being selected, which is the **Brush Object** (section [2.2.1.1](#Section_91892dd87d73415a848cdb10eccfdea4)) created in the previous record. + +### META_RECTANGLE Example + +This section provides an example of a **META_RECTANGLE Record** (section [2.3.3.17](#Section_a8da53a6f75649f7b835f6d145ede760)). + +737. 00000040: 07 00 00 00 1B 04 46 00 96 00 00 00 00 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x0000007 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 14 (0x0000000E) bytes. + +**RecordFunction (2 bytes):** 0x041B defines the type of this record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) to be **META_RECTANGLE**. + +**BottomRect (2 bytes):** 0x0046 defines the y-coordinate, in logical units, of the lower-right corner of the rectangle. + +**RightRect (2 bytes):** 0x0096 defines the x-coordinate, in logical units, of the lower-right corner of the rectangle. + +**TopRect (2 bytes):** 0x0000 defines the y-coordinate, in logical units, of the upper-left corner of the rectangle. + +**LeftRect (2 bytes):** 0x0000 defines the x-coordinate, in logical units, of the upper-left corner of the rectangle. + +### META_TEXTOUT Example + +This section provides an example of a **META_TEXTOUT Record** (section [2.3.3.20](#Section_96531e1a187549e5b797b4c4c50fa789)). + +738. 0000004E: 0C 00 + + 00000050: 00 00 21 05 0C 00 48 65 6C 6C 6F 20 50 65 6F 70 + + 00000060: 6C 65 0A 00 0A 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x0000000C specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 24 (0x00000018) bytes. + +**RecordFunction (2 bytes):** 0x0521 specifies the type of this record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) to be **META_TEXTOUT**. + +**StringLength (2 bytes):** 0x000C specifies the length of the string in bytes. + +**String (12 bytes):** "Hello People" specifies the text to be drawn. + +**YStart (2 bytes):** 0x000A specifies the vertical (y-axis) coordinate, in logical units, of the point where drawing is to start. + +**XStart (2 bytes):** 0x000A specifies the horizontal (x-axis) coordinate, in logical units, of the point where drawing is to start. + +### META_EOF Example + +This section provides an example of a **META_EOF Record** (section [2.3.2.1](#Section_3aa35974e8994acc892a47a2300948af)), which is always the last record in the [**metafile**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7). + +741. 00000060: 03 00 00 00 00 00 + +[TABLE] + +**RecordSize (4 bytes):** 0x00000003 specifies the number of **WORD** structures, defined in [\[MS-DTYP\]](%5bMS-DTYP%5d.pdf#Section_cca2742956894a16b2b49325d93e4ba2) section 2.2.61, in this record, which is equivalent to 6 (0x00000006) bytes. + +**RecordFunction (**2 bytes): 0x0000 specifies the type of this record from the **RecordType Enumeration** (section [2.1.1.1](#Section_77db815896df4656a36c3066de3d5f59)) to be **META_EOF**. + +# Security Considerations + +This file format enables third parties to send payloads (such as [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d)) to pass through as executable code. + +# Appendix A: Product Behavior + +The information in this specification is applicable to the following Microsoft products or supplemental software. References to product versions include updates to those products. + +- Windows NT 3.1 operating system + +- Windows NT 3.5 operating system + +- Windows NT 3.51 operating system + +- Windows 95 operating system + +- Windows NT 4.0 operating system + +- Windows 98 operating system + +- Windows Millennium Edition operating system + +- Windows 2000 operating system + +- Windows XP operating system + +- Windows Server 2003 operating system + +- Windows Vista operating system + +- Windows Server 2008 operating system + +- Windows 7 operating system + +- Windows Server 2008 R2 operating system + +- Windows 8 operating system + +- Windows Server 2012 operating system + +- Windows 8.1 operating system + +- Windows Server 2012 R2 operating system + +- Windows 10 operating system + +- Windows Server 2016 operating system + +- Windows Server operating system + +- Windows Server 2019 operating system + +- Windows Server 2022 operating system + +- Windows 11 operating system + +- Windows Server 2025 operating system + +Exceptions, if any, are noted in this section. If an update version, service pack or Knowledge Base (KB) number appears with a product name, the behavior changed in that update. The new behavior also applies to subsequent updates unless otherwise specified. If a product edition appears with the product version, behavior is different in that product edition. + +Unless otherwise specified, any statement of optional behavior in this specification that is prescribed using the terms "SHOULD" or "SHOULD NOT" implies product behavior in accordance with the SHOULD or SHOULD NOT prescription. Unless otherwise specified, the term "MAY" implies that the product does not follow the prescription. + +[\<1\> Section 1.4](#Appendix_A_Target_1): Windows NT 3.1, Windows NT 3.51, Windows NT Server 4.0 operating system, and Windows 95: [**WMF**](#gt_48849cf6-d55c-47e5-b041-13b65854de2b) is used primarily with the **Win16** and **Win32s** APIs. + +[\<2\> Section 2.1.1.1](#Appendix_A_Target_2): Windows NT 3.1, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This record type is not supported. + +[\<3\> Section 2.1.1.1](#Appendix_A_Target_3): For most WMF record types, the high-order byte of the **RecordFunction** field signifies the minimum number of 16-bit parameters, ideally specified in the WMF record; however, the value is not reliable for that purpose. + +[\<4\> Section 2.1.1.3](#Appendix_A_Target_4): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: Neither [**JPEG**](#gt_5eda1f18-8071-4b27-ab0f-07f1fb79199d) nor [**PNG**](#gt_212c87ce-40ba-4311-be2a-494f1a116604) format is supported. + +[\<5\> Section 2.1.1.4](#Appendix_A_Target_5): In Windows implementations, **BS_HOLLOW** was added as a duplicate symbolic name for **BS_NULL**, because **BS_NULL** was too easily mistaken for a NULL pointer. + +**BS_HOLLOW** is used by an application when [**GDI**](#gt_6c550e84-9a9c-46ef-8716-7260fe29cae3) requires a non-NULL brush parameter, but the application requires that no brush be used. + +[\<6\> Section 2.1.1.5](#Appendix_A_Target_6): Windows NT 3.1 and Windows NT 3.51: This value is not supported. + +[\<7\> Section 2.1.1.10](#Appendix_A_Target_7): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: [**Anti-aliasing**](#gt_1c163159-5835-4f3b-b6bf-518ad8eba532) is not supported. + +[\<8\> Section 2.1.1.10](#Appendix_A_Target_8): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: Anti-aliasing is not supported. + +[\<9\> Section 2.1.1.10](#Appendix_A_Target_9): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, Windows Millennium Edition, and Windows 2000: [**ClearType**](#gt_aadfbf1f-8e96-4012-8208-7b9fe852f2e7) is not supported. + +[\<10\> Section 2.1.1.11](#Appendix_A_Target_10): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This functionality is not supported. + +[\<11\> Section 2.1.1.13](#Appendix_A_Target_11): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<12\> Section 2.1.1.14](#Appendix_A_Target_12): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This functionality is not supported. + +[\<13\> Section 2.1.1.15](#Appendix_A_Target_13): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: This functionality is not supported. + +[\<14\> Section 2.1.1.17](#Appendix_A_Target_14): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<15\> Section 2.1.1.17](#Appendix_A_Target_15): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<16\> Section 2.1.1.17](#Appendix_A_Target_16): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<17\> Section 2.1.1.17](#Appendix_A_Target_17): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<18\> Section 2.1.1.17](#Appendix_A_Target_18): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<19\> Section 2.1.1.17](#Appendix_A_Target_19): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<20\> Section 2.1.1.17](#Appendix_A_Target_20): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, Windows Millennium Edition, Windows 2000, Windows XP, and Windows Server 2003: This functionality is not supported. + +[\<21\> Section 2.1.1.17](#Appendix_A_Target_21): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<22\> Section 2.1.1.26](#Appendix_A_Target_22): In Windows implementations, the [**PostScript**](#gt_31971c63-f974-47de-8de9-6b76d093890d) [**printer driver**](#gt_1a48eebd-e72c-494d-b8cb-84dfb7bc3b65) uses a default line join style of **PostScriptFlatCap**. + +[\<23\> Section 2.1.1.28](#Appendix_A_Target_23): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows 98, and Windows Millennium Edition: This functionality is not supported. + +[\<24\> Section 2.1.1.28](#Appendix_A_Target_24): Windows NT 4.0 and Windows 2000: This functionality is not supported. + +[\<25\> Section 2.1.1.28](#Appendix_A_Target_25): Windows NT 4.0 and Windows 2000: This functionality is not supported. + +[\<26\> Section 2.1.1.29](#Appendix_A_Target_26): In Windows implementations, the PostScript printer driver uses a default line join style of **PostScriptMiterJoin**. + +[\<27\> Section 2.1.1.30](#Appendix_A_Target_27): Windows 95 and Windows 98: The symbolic name "STRETCH_ANDSCANS" is synonymous with this value. + +[\<28\> Section 2.1.1.30](#Appendix_A_Target_28): Windows 95 and Windows 98: The symbolic name "STRETCH_ORSCANS" is synonymous with this value. + +[\<29\> Section 2.1.1.30](#Appendix_A_Target_29): Windows 95 and Windows 98: The symbolic name "STRETCH_DELETESCANS" is synonymous with this value. + +[\<30\> Section 2.1.1.30](#Appendix_A_Target_30): Windows 95 and Windows 98: The symbolic name "STRETCH_HALFTONE" is synonymous with this value. + +[\<31\> Section 2.1.2.1](#Appendix_A_Target_31): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows NT 4.0, Windows 2000, and Windows XP: This value is always returned when enumerating fonts. + +[\<32\> Section 2.1.2.1](#Appendix_A_Target_32): This value is supported in the following Windows versions: Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, Windows Millennium Edition, Windows 2000, Windows XP, and Windows Server 2003. + +[\<33\> Section 2.1.2.1](#Appendix_A_Target_33): This value is supported in the following Windows versions: Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0. + +[**Font association**](#gt_bdac8aac-4f02-48eb-ab1f-a68c63def4e6) is turned off in Windows 2000, Windows XP, and Windows Server 2003. + +[\<34\> Section 2.1.2.2](#Appendix_A_Target_34): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This function is not supported. + +[\<35\> Section 2.1.2.2](#Appendix_A_Target_35): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This function is not supported. + +[\<36\> Section 2.1.2.2](#Appendix_A_Target_36): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This function is not supported. + +[\<37\> Section 2.1.2.2](#Appendix_A_Target_37): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This function is not supported. + +[\<38\> Section 2.1.2.2](#Appendix_A_Target_38): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, and Windows Millennium Edition: This function is not supported. + +[\<39\> Section 2.1.2.3](#Appendix_A_Target_39): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This function is not supported. + +[\<40\> Section 2.2.1.2](#Appendix_A_Target_40): All Windows versions: mapping the logical font size to the available physical fonts occurs the first time the logical font needs to be used in a drawing operation. + +For the MM_TEXT [**mapping mode**](#gt_6e998e8d-4394-4263-8632-503730f0abae), the following formula can be used to compute the height of a font with a specified point size. + +742. Height = -MulDiv(PointSize, GetDeviceCaps(hDC, LOGPIXELSY), 72); + +[\<41\> Section 2.2.1.5](#Appendix_A_Target_41): Windows sets this field to 0x0000. + +[\<42\> Section 2.2.1.5](#Appendix_A_Target_42): Windows sets this field to an arbitrary value. + +[\<43\> Section 2.2.2.2](#Appendix_A_Target_43): Although Windows processes **BitmapCoreHeader objects** in [**DIBs**](#gt_3a6934d5-cc59-4ab9-a54e-e062a09a4091), it does not write them to WMF [**metafiles**](#gt_ae5f028e-7e28-4a0b-bec6-2c87913f7db7) + +[\<44\> Section 2.2.2.3](#Appendix_A_Target_44): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: Neither JPEG nor PNG format is supported. + +[\<45\> Section 2.2.2.3](#Appendix_A_Target_45): Windows implementations might write a nonzero value to this field, but it is ignored when the metafile is parsed. + +[\<46\> Section 2.2.2.4](#Appendix_A_Target_46): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51: This structure is not supported. + +[\<47\> Section 2.2.2.5](#Appendix_A_Target_47): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: This structure is not supported. + +[\<48\> Section 2.2.2.10](#Appendix_A_Target_48): In Windows implementations, **BS_HOLLOW** was added as a duplicate symbolic name for **BS_NULL**, because **BS_NULL** was too easily mistaken for a NULL pointer. + +**BS_HOLLOW** is used by an application when GDI requires a non-NULL brush parameter, but the application requires that no brush be used. + +[\<49\> Section 2.2.2.10](#Appendix_A_Target_49): In the following Windows versions, a solid-color black brush is not created by default when a **BrushStyle Enumeration** (section [2.1.1.4](#Section_38e6de432cfe428e874e391dbf74570c)) table value of BS_PATTERN or BS_DIBPATTERNPT is present: Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, Windows Millennium Edition, Windows 2000, Windows XP, and Windows Server 2003. + +The default brush creation behavior on these versions of Windows is undefined. + +[\<50\> Section 2.3.1.4](#Appendix_A_Target_50): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: This format is not supported. + +[\<51\> Section 2.3.1.4](#Appendix_A_Target_51): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: This format is not supported. + +[\<52\> Section 2.3.1.6](#Appendix_A_Target_52): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: This format is not supported. + +[\<53\> Section 2.3.1.6](#Appendix_A_Target_53): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, and Windows NT 4.0: This format is not supported. + +[\<54\> Section 2.3.2.2](#Appendix_A_Target_54): Metafiles created by Windows contain the value METAVERSION300. + +[\<55\> Section 2.3.2.3](#Appendix_A_Target_55): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows 95: This feature is not supported. + +[\<56\> Section 2.3.4.1](#Appendix_A_Target_56): In the following Windows versions, a solid-color black brush is not created by default when a **BrushStyle Enumeration** (section 2.1.1.4) table value of BS_PATTERN or BS_DIBPATTERNPT is present: Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, Windows 95, Windows NT 4.0, Windows 98, Windows Millennium Edition, Windows 2000, Windows XP, and Windows Server 2003. + +The default brush creation behavior on these versions of Windows is undefined. + +[\<57\> Section 2.3.4.4](#Appendix_A_Target_57): The META_CREATEPATTERNBRUSH record type is deprecated. No version of Windows emits this record. Playback implementation of this record in Windows is intended solely for compatibility purposes so that Windows metafiles containing this record can be rendered. + +[\<58\> Section 2.3.5.15](#Appendix_A_Target_58): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 implementations do not write this field to WMF metafiles. + +[\<59\> Section 2.3.5.16](#Appendix_A_Target_59): Windows NT 3.1, Windows NT 3.5, Windows NT 3.51, and Windows NT 4.0 implementations do not support this record type. + +[\<60\> Section 2.3.5.20](#Appendix_A_Target_60): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 implementations do not write this field to WMF metafiles. + +[\<61\> Section 2.3.5.22](#Appendix_A_Target_61): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 implementations do not write this field to WMF metafiles. + +[\<62\> Section 2.3.5.23](#Appendix_A_Target_62): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 implementations do not write this field to WMF metafiles. + +[\<63\> Section 2.3.5.24](#Appendix_A_Target_63): Windows NT 3.1, Windows NT 3.5, and Windows NT 3.51 implementations do not write this field to WMF metafiles. + +[\<64\> Section 2.3.6.6](#Appendix_A_Target_64): Windows 95, Windows 98, and Windows Millennium Edition implementations set this field to the fill mode value (section [2.1.1.25](#Section_926ff7dc197b427a8d4e122f7e3505f1)). + +[\<65\> Section 2.3.6.11](#Appendix_A_Target_65): Any bytes that exceed the **ByteCount** field are ignored by the client. + +[\<66\> Section 2.3.6.25](#Appendix_A_Target_66): Windows does not check this value. + +[\<67\> Section 3.1.5](#Appendix_A_Target_67): Windows applications use the Graphics Device Interface (GDI) to obtain a [**device context**](#gt_92e112c6-791f-48dd-8345-e65a35eef388) for performing output to a device. When the device context is created, the default values for graphics objects and properties are set up by the system and the driver for the device. + +# Change Tracking + +This section identifies changes that were made to this document since the last release. Changes are classified as Major, Minor, or None. + +The revision class **Major** means that the technical content in the document was significantly revised. Major changes affect protocol interoperability or implementation. Examples of major changes are: + +- A document revision that incorporates changes to interoperability requirements. + +- A document revision that captures changes to protocol functionality. + +The revision class **Minor** means that the meaning of the technical content was clarified. Minor changes do not affect protocol interoperability or implementation. Examples of minor changes are updates to clarify ambiguity at the sentence, paragraph, or table level. + +The revision class **None** means that no new technical changes were introduced. Minor editorial and formatting changes may have been made, but the relevant technical content is identical to the last released version. + +The changes made to this document are listed in the following table. For more information, please contact . + +| Section | Description | Revision class | +|----|----|----| +| [5](#Section_6a1bdbf7791d4115af9c23a9171fbc8d) Appendix A: Product Behavior | Added Windows Server 2025 to the list of applicable products. | Major | + +# Index + +A + +[ABORTDOC packet](#abortdoc-record) 159 + +[ABORTDOC Record](#abortdoc-record) 159 + +[Applicability](#applicability-statement) 19 + +B + +[BEGIN_PATH packet](#begin_path-record) 160 + +[BEGIN_PATH Record](#begin_path-record) 160 + +[BinaryRasterOperation enumeration](#binaryrasteroperation-enumeration) 25 + +[BitCount enumeration](#bitcount-enumeration) 28 + +[Bitmap Record Types](#bitmap-record-types) 101 + +[Bitmap16 Object](#bitmap16-object) 84 + +[Bitmap16 packet](#bitmap16-object) 84 + +[BitmapCoreHeader Object](#bitmapcoreheader-object) 85 + +[BitmapCoreHeader packet](#bitmapcoreheader-object) 85 + +[BitmapInfoHeader Object](#bitmapinfoheader-object) 85 + +[BitmapInfoHeader packet](#bitmapinfoheader-object) 85 + +[BitmapV4Header Object](#bitmapv4header-object) 87 + +[BitmapV4Header packet](#bitmapv4header-object) 87 + +[BitmapV5Header Object](#bitmapv5header-object) 88 + +[BitmapV5Header packet](#bitmapv5header-object) 88 + +[Brush Object](#brush-object) 79 + +[Brush packet](#brush-object) 79 + +[BrushStyle enumeration](#brushstyle-enumeration) 29 + +[Byte ordering](#byte-ordering) 18 + +C + +[Change tracking](#change-tracking) 208 + +[CharacterSet enumeration](#characterset-enumeration) 30 + +[CHECK_JPEGFORMAT packet](#checkjpegformat-record) 160 + +[CHECK_JPEGFORMAT Record](#checkjpegformat-record) 160 + +[CHECK_PNGFORMAT packet](#checkpngformat-record) 161 + +[CHECK_PNGFORMAT Record](#checkpngformat-record) 161 + +[CIEXYZ Object](#ciexyz-object) 89 + +[CIEXYZ packet](#ciexyz-object) 89 + +[CIEXYZTriple Object](#ciexyztriple-object) 90 + +[CIEXYZTriple packet](#ciexyztriple-object) 90 + +[CLIP_CHARACTER_PRECIS](#clipprecision-flags) 76 + +[CLIP_DEFAULT_PRECIS](#clipprecision-flags) 76 + +[CLIP_DFA_DISABLE](#clipprecision-flags) 76 + +[CLIP_EMBEDDED](#clipprecision-flags) 76 + +[CLIP_LH_ANGLES](#clipprecision-flags) 76 + +[CLIP_STROKE_PRECIS](#clipprecision-flags) 76 + +[CLIP_TO_PATH packet](#clip_to_path-record) 161 + +[CLIP_TO_PATH Record](#clip_to_path-record) 161 + +[CLIP_TT_ALWAYS](#clipprecision-flags) 76 + +[CLOSECHANNEL packet](#closechannel-record) 162 + +[CLOSECHANNEL Record](#closechannel-record) 162 + +[ColorRef Object](#colorref-object) 90 + +[ColorRef packet](#colorref-object) 90 + +[ColorUsage enumeration](#colorusage-enumeration) 31 + +[Common data types and fields](#structures) 20 + +[Compression enumeration](#compression-enumeration) 31 + +[Control Record Types](#control-record-types) 113 + +D + +[Data types and fields - common](#structures) 20 + +Details + +[common data types and fields](#structures) 20 + +[DeviceIndependentBitmap Object](#deviceindependentbitmap-object) 91 + +[DeviceIndependentBitmap packet](#deviceindependentbitmap-object) 91 + +[DOWNLOAD_FACE packet](#downloadface-record) 163 + +[DOWNLOAD_FACE Record](#downloadface-record) 163 + +[DOWNLOAD_HEADER packet](#downloadheader-record) 163 + +[DOWNLOAD_HEADER Record](#downloadheader-record) 163 + +[DRAW_PATTERNRECT packet](#drawpatternrect-record) 164 + +[DRAW_PATTERNRECT Record](#drawpatternrect-record) 164 + +[Drawing Record Types](#drawing-record-types) 116 + +E + +[ENCAPSULATED_POSTSCRIPT packet](#encapsulated_postscript-record) 164 + +[ENCAPSULATED_POSTSCRIPT Record](#encapsulated_postscript-record) 164 + +[END_PATH packet](#end_path-record) 165 + +[END_PATH Record](#end_path-record) 165 + +[ENDDOC packet](#enddoc-record) 166 + +[ENDDOC Record](#enddoc-record) 166 + +[Enumerations](#wmf-enumerations) 20 + +[EPS_PRINTING packet](#epsprinting-record) 166 + +[EPS_PRINTING Record](#epsprinting-record) 166 + +[Escape Record Types](#escape-record-types) 157 + +[ETO_CLIPPED](#exttextoutoptions-flags) 76 + +[ETO_GLYPH_INDEX](#exttextoutoptions-flags) 76 + +[ETO_NUMERICSLATIN](#exttextoutoptions-flags) 76 + +[ETO_NUMERICSLOCAL](#exttextoutoptions-flags) 76 + +[ETO_OPAQUE](#exttextoutoptions-flags) 76 + +[ETO_PDY](#exttextoutoptions-flags) 76 + +[ETO_RTLREADING](#exttextoutoptions-flags) 76 + +Examples + +[metafile design example](#metafile-design) 186 + +[metafile example](#wmf-metafile-example) 194 + +[WMF Metafile Example](#wmf-metafile-example) 194 + +[EXTTEXTOUT packet](#exttextout-record) 167 + +[EXTTEXTOUT Record](#exttextout-record) 167 + +F + +[FamilyFont enumeration](#familyfont-enumeration) 32 + +[Fields - vendor-extensible](#vendor-extensible-fields) 19 + +[Fixed-length record objects](#graphics-objects-1) 79 + +[FloodFill enumeration](#floodfill-enumeration) 33 + +[Font Object](#font-object) 80 + +[Font packet](#font-object) 80 + +[FontQuality enumeration](#fontquality-enumeration) 33 + +G + +[GamutMappingIntent enumeration](#gamutmappingintent-enumeration) 34 + +[GET_COLORTABLE packet](#getcolortable-record) 168 + +[GET_COLORTABLE Record](#getcolortable-record) 168 + +[GET_DEVICEUNITS packet](#getdeviceunits-record) 169 + +[GET_DEVICEUNITS Record](#getdeviceunits-record) 169 + +[GET_EXTENDED_TEXTMETRICS packet](#getextendedtextmetrics-record) 169 + +[GET_EXTENDED_TEXTMETRICS Record](#getextendedtextmetrics-record) 169 + +[GET_FACENAME packet](#getfacename-record) 170 + +[GET_FACENAME Record](#getfacename-record) 170 + +[GET_PAIRKERNTABLE packet](#getpairkerntable-record) 170 + +[GET_PAIRKERNTABLE Record](#getpairkerntable-record) 170 + +[GET_PHYSPAGESIZE packet](#getphyspagesize-record) 171 + +[GET_PHYSPAGESIZE Record](#getphyspagesize-record) 171 + +[GET_PRINTINGOFFSET packet](#getprintingoffset-record) 171 + +[GET_PRINTINGOFFSET Record](#getprintingoffset-record) 171 + +[GET_PS_FEATURESETTING packet](#get_ps_featuresetting-record) 172 + +[GET_PS_FEATURESETTING Record](#get_ps_featuresetting-record) 172 + +[GET_SCALINGFACTOR packet](#getscalingfactor-record) 172 + +[GET_SCALINGFACTOR Record](#getscalingfactor-record) 172 + +[Glossary](#glossary) 10 + +[Graphics objects](#graphics-objects) 18 + +H + +[HatchStyle enumeration](#hatchstyle-enumeration) 35 + +I + +[Implementer - security considerations](#security-considerations) 202 + +[Informative references](#informative-references) 16 + +[Introduction](#introduction) 10 + +L + +[Layout enumeration](#layout-enumeration) 35 + +[Localization](#versioning-and-localization) 19 + +[LogBrush Object](#logbrush-object) 92 + +[LogBrush packet](#logbrush-object) 92 + +[LogColorSpace Object](#logcolorspace-object) 93 + +[LogColorSpace packet](#logcolorspace-object) 93 + +[LogColorSpaceW Object](#logcolorspacew-object) 94 + +[LogColorSpaceW packet](#logcolorspacew-object) 94 + +[LogicalColorSpace enumeration](#logicalcolorspace-enumeration) 36 + +[LogicalColorSpaceV5 enumeration](#logicalcolorspacev5-enumeration) 36 + +M + +Managing objects + +[object scaling](#object-scaling) 188 + +[object table](#wmf-object-table) 188 + +[MapMode enumeration](#mapmode-enumeration) 36 + +[META_ANIMATEPALETTE packet](#meta_animatepalette-record) 141 + +[META_ANIMATEPALETTE Record](#meta_animatepalette-record) 141 + +[META_ARC packet](#meta_arc-record) 116 + +[META_ARC Record](#meta_arc-record) 116 + +[META_BITBLT packet](#without-bitmap) 103 + +[META_BITBLT Record](#meta_bitblt-record) 101 + +[META_BITBLT_Bitmap packet](#with-bitmap) 102 + +[META_CHORD packet](#meta_chord-record) 117 + +[META_CHORD Record](#meta_chord-record) 117 + +[META_CREATEBRUSHINDIRECT packet](#meta_createbrushindirect-record) 132 + +[META_CREATEBRUSHINDIRECT Record](#meta_createbrushindirect-record) 132 + +[META_CREATEFONTINDIRECT packet](#meta_createfontindirect-record) 133 + +[META_CREATEFONTINDIRECT Record](#meta_createfontindirect-record) 133 + +[META_CREATEPALETTE packet](#meta_createpalette-record) 133 + +[META_CREATEPALETTE Record](#meta_createpalette-record) 133 + +[META_CREATEPATTERNBRUSH packet](#meta_createpatternbrush-record) 134 + +[META_CREATEPATTERNBRUSH Record](#meta_createpatternbrush-record) 134 + +[META_CREATEPENINDIRECT packet](#meta_createpenindirect-record) 135 + +[META_CREATEPENINDIRECT Record](#meta_createpenindirect-record) 135 + +[META_CREATEREGION packet](#meta_createregion-record) 136 + +[META_CREATEREGION Record](#meta_createregion-record) 136 + +[META_DELETEOBJECT packet](#meta_deleteobject-record) 136 + +[META_DELETEOBJECT Record](#meta_deleteobject-record) 136 + +[META_DIBBITBLT packet](#without-bitmap-1) 105 + +[META_DIBBITBLT Record](#meta_dibbitblt-record) 103 + +[META_DIBBITBLT_Bitmap packet](#with-bitmap-1) 104 + +[META_DIBCREATEPATTERNBRUSH packet](#meta_dibcreatepatternbrush-record) 137 + +[META_DIBCREATEPATTERNBRUSH Record](#meta_dibcreatepatternbrush-record) 137 + +[META_DIBSTRETCHBLT packet](#without-bitmap-2) 107 + +[META_DIBSTRETCHBLT Record](#meta_dibstretchblt-record) 105 + +[META_DIBSTRETCHBLT_Bitmap packet](#with-bitmap-2) 106 + +[META_ELLIPSE packet](#meta_ellipse-record) 118 + +[META_ELLIPSE Record](#meta_ellipse-record) 118 + +[META_EOF Record](#meta_eof-record) 114 + +[META_EOF_Record packet](#meta_eof-record) 114 + +[META_ESCAPE packet](#meta_escape-record) 158 + +[META_ESCAPE Record](#meta_escape-record) 158 + +[META_ESCAPE_ENHANCED_METAFILE packet](#meta_escape_enhanced_metafile-record) 173 + +[META_ESCAPE_ENHANCED_METAFILE Record](#meta_escape_enhanced_metafile-record) 173 + +[META_EXCLUDECLIPRECT packet](#meta_excludecliprect-record) 141 + +[META_EXCLUDECLIPRECT Record](#meta_excludecliprect-record) 141 + +[META_EXTFLOODFILL packet](#meta_extfloodfill-record) 119 + +[META_EXTFLOODFILL Record](#meta_extfloodfill-record) 119 + +[META_EXTTEXTOUT packet](#meta_exttextout-record) 120 + +[META_EXTTEXTOUT Record](#meta_exttextout-record) 120 + +[META_FILLREGION packet](#meta_fillregion-record) 122 + +[META_FILLREGION Record](#meta_fillregion-record) 122 + +[META_FLOODFILL packet](#meta_floodfill-record) 122 + +[META_FLOODFILL Record](#meta_floodfill-record) 122 + +[META_FRAMEREGION packet](#meta_frameregion-record) 123 + +[META_FRAMEREGION Record](#meta_frameregion-record) 123 + +[META_HEADER packet](#meta_header-record) 114 + +[META_HEADER Record](#meta_header-record) 114 + +[META_INTERSECTCLIPRECT packet](#meta_intersectcliprect-record) 142 + +[META_INTERSECTCLIPRECT Record](#meta_intersectcliprect-record) 142 + +[META_INVERTREGION packet](#meta_invertregion-record) 124 + +[META_INVERTREGION Record](#meta_invertregion-record) 124 + +[META_LINETO packet](#meta_lineto-record) 124 + +[META_LINETO Record](#meta_lineto-record) 124 + +[META_MOVETO packet](#meta_moveto-record) 143 + +[META_MOVETO Record](#meta_moveto-record) 143 + +[META_OFFSETCLIPRGN packet](#meta_offsetcliprgn-record) 143 + +[META_OFFSETCLIPRGN Record](#meta_offsetcliprgn-record) 143 + +[META_OFFSETVIEWPORTORG packet](#meta_offsetviewportorg-record) 144 + +[META_OFFSETVIEWPORTORG Record](#meta_offsetviewportorg-record) 144 + +[META_OFFSETWINDOWORG packet](#meta_offsetwindoworg-record) 144 + +[META_OFFSETWINDOWORG Record](#meta_offsetwindoworg-record) 144 + +[META_PAINTREGION packet](#meta_paintregion-record) 125 + +[META_PAINTREGION Record](#meta_paintregion-record) 125 + +[META_PATBLT packet](#meta_patblt-record) 125 + +[META_PATBLT Record](#meta_patblt-record) 125 + +[META_PIE packet](#meta_pie-record) 126 + +[META_PIE Record](#meta_pie-record) 126 + +[META_PLACEABLE packet](#meta_placeable-record) 115 + +[META_PLACEABLE Record](#meta_placeable-record) 115 + +[META_POLYGON packet](#meta_polygon-record) 127 + +[META_POLYGON Record](#meta_polygon-record) 127 + +[META_POLYLINE packet](#meta_polyline-record) 127 + +[META_POLYLINE Record](#meta_polyline-record) 127 + +[META_POLYPOLYGON packet](#meta_polypolygon-record) 128 + +[META_POLYPOLYGON Record](#meta_polypolygon-record) 128 + +[META_REALIZEPALETTE packet](#meta_realizepalette-record) 145 + +[META_REALIZEPALETTE Record](#meta_realizepalette-record) 145 + +[META_RECTANGLE packet](#meta_rectangle-record) 129 + +[META_RECTANGLE Record](#meta_rectangle-record) 129 + +[META_RESIZEPALETTE packet](#meta_resizepalette-record) 145 + +[META_RESIZEPALETTE Record](#meta_resizepalette-record) 145 + +[META_RESTOREDC packet](#meta_restoredc-record) 146 + +[META_RESTOREDC Record](#meta_restoredc-record) 146 + +[META_ROUNDRECT packet](#meta_roundrect-record) 129 + +[META_ROUNDRECT Record](#meta_roundrect-record) 129 + +[META_SAVEDC packet](#meta_savedc-record) 146 + +[META_SAVEDC Record](#meta_savedc-record) 146 + +[META_SCALEVIEWPORTEXT packet](#meta_scaleviewportext-record) 146 + +[META_SCALEVIEWPORTEXT Record](#meta_scaleviewportext-record) 146 + +[META_SCALEWINDOWEXT packet](#meta_scalewindowext-record) 147 + +[META_SCALEWINDOWEXT Record](#meta_scalewindowext-record) 147 + +[META_SELECTCLIPREGION packet](#meta_selectclipregion-record) 138 + +[META_SELECTCLIPREGION Record](#meta_selectclipregion-record) 138 + +[META_SELECTOBJECT packet](#meta_selectobject-record) 138 + +[META_SELECTOBJECT Record](#meta_selectobject-record) 138 + +[META_SELECTPALETTE packet](#meta_selectpalette-record) 139 + +[META_SELECTPALETTE Record](#meta_selectpalette-record) 139 + +[META_SETBKCOLOR packet](#meta_setbkcolor-record) 148 + +[META_SETBKCOLOR Record](#meta_setbkcolor-record) 148 + +[META_SETBKMODE packet](#meta_setbkmode-record) 148 + +[META_SETBKMODE Record](#meta_setbkmode-record) 148 + +[META_SETDIBTODEV packet](#meta_setdibtodev-record) 108 + +[META_SETDIBTODEV Record](#meta_setdibtodev-record) 108 + +[META_SETLAYOUT packet](#meta_setlayout-record) 149 + +[META_SETLAYOUT Record](#meta_setlayout-record) 149 + +[META_SETMAPMODE packet](#meta_setmapmode-record) 149 + +[META_SETMAPMODE Record](#meta_setmapmode-record) 149 + +[META_SETMAPPERFLAGS packet](#meta_setmapperflags-record) 150 + +[META_SETMAPPERFLAGS Record](#meta_setmapperflags-record) 150 + +[META_SETPALENTRIES packet](#meta_setpalentries-record) 150 + +[META_SETPALENTRIES Record](#meta_setpalentries-record) 150 + +[META_SETPIXEL packet](#meta_setpixel-record) 130 + +[META_SETPIXEL Record](#meta_setpixel-record) 130 + +[META_SETPOLYFILLMODE packet](#meta_setpolyfillmode-record) 151 + +[META_SETPOLYFILLMODE Record](#meta_setpolyfillmode-record) 151 + +[META_SETRELABS packet](#meta_setrelabs-record) 151 + +[META_SETRELABS Record](#meta_setrelabs-record) 151 + +[META_SETROP2 packet](#meta_setrop2-record) 152 + +[META_SETROP2 Record](#meta_setrop2-record) 152 + +[META_SETSTRETCHBLTMODE packet](#meta_setstretchbltmode-record) 152 + +[META_SETSTRETCHBLTMODE Record](#meta_setstretchbltmode-record) 152 + +[META_SETTEXTALIGN packet](#meta_settextalign-record) 153 + +[META_SETTEXTALIGN Record](#meta_settextalign-record) 153 + +[META_SETTEXTCHAREXTRA packet](#meta_settextcharextra-record) 153 + +[META_SETTEXTCHAREXTRA Record](#meta_settextcharextra-record) 153 + +[META_SETTEXTCOLOR packet](#meta_settextcolor-record) 154 + +[META_SETTEXTCOLOR Record](#meta_settextcolor-record) 154 + +[META_SETTEXTJUSTIFICATION packet](#meta_settextjustification-record) 154 + +[META_SETTEXTJUSTIFICATION Record](#meta_settextjustification-record) 154 + +[META_SETVIEWPORTEXT packet](#meta_setviewportext-record) 155 + +[META_SETVIEWPORTEXT Record](#meta_setviewportext-record) 155 + +[META_SETVIEWPORTORG packet](#meta_setviewportorg-record) 155 + +[META_SETVIEWPORTORG Record](#meta_setviewportorg-record) 155 + +[META_SETWINDOWEXT packet](#meta_setwindowext-record) 156 + +[META_SETWINDOWEXT Record](#meta_setwindowext-record) 156 + +[META_SETWINDOWORG packet](#meta_setwindoworg-record) 156 + +[META_SETWINDOWORG Record](#meta_setwindoworg-record) 156 + +[META_STRETCHBLT packet](#without-bitmap-3) 111 + +[META_STRETCHBLT Record](#meta_stretchblt-record) 109 + +[META_STRETCHBLT_Bitmap packet](#with-bitmap-3) 110 + +[META_STRETCHDIB packet](#meta_stretchdib-record) 112 + +[META_STRETCHDIB Record](#meta_stretchdib-record) 112 + +[META_TEXTOUT packet](#meta_textout-record) 131 + +[META_TEXTOUT Record](#meta_textout-record) 131 + +[Metafile design example](#metafile-design) 186 + +Metafile example + +[header](#meta_header-example) 195 + +[META_CREATEBRUSHINDIRECT](#meta_createbrushindirect-example) 197 + +[META_CREATEPENINDIRECT](#meta_createpenindirect-example) 196 + +[META_EOF Example](#meta_eof-example) 200 + +[META_RECTANGLE](#meta_rectangle-example) 199 + +META_SELECTOBJECT ([section 3.2.3](#meta_selectobject-example-1) 197, [section 3.2.5](#meta_selectobject-example-2) 198) + +[META_TEXTOUT](#meta_textout-example) 200 + +[overview](#wmf-metafile-example) 194 + +[Metafile structure](#metafile-structure) 16 + +[METAFILE_DRIVER packet](#metafile_driver-record) 174 + +[METAFILE_DRIVER Record](#metafile_driver-record) 174 + +[MetafileEscapes enumeration](#metafileescapes-enumeration) 37 + +[MetafileType enumeration](#metafiletype-enumeration) 40 + +[MetafileVersion enumeration](#metafileversion-enumeration) 41 + +[MixMode enumeration](#mixmode-enumeration) 41 + +N + +[NEWFRAME packet](#newframe-record) 175 + +[NEWFRAME Record](#newframe-record) 175 + +[NEXTBAND packet](#nextband-record) 175 + +[NEXTBAND Record](#nextband-record) 175 + +[Normative references](#normative-references) 15 + +O + +[Object Record Types](#object-record-types) 131 + +[Objects](#wmf-objects) 78 + +[OPEN_CHANNEL packet](#openchannel-record) 179 + +[OPEN_CHANNEL Record](#openchannel-record) 179 + +[OutPrecision enumeration](#outprecision-enumeration) 41 + +[Overview (synopsis)](#overview) 16 + +P + +[Palette Object](#palette-object) 82 + +[Palette packet](#palette-object) 82 + +[PaletteEntry Object](#paletteentry-object) 96 + +[PaletteEntry_Object packet](#paletteentry-object) 96 + +[PaletteEntryFlag enumeration](#paletteentryflag-enumeration) 42 + +[PASSTHROUGH packet](#passthrough-record) 176 + +[PASSTHROUGH Record](#passthrough-record) 176 + +[Pen Object](#pen-object) 83 + +[Pen packet](#pen-object) 83 + +[PenStyle enumeration](#penstyle-enumeration) 42 + +[PitchAndFamily Object](#pitchandfamily-object) 96 + +[PitchAndFamily packet](#pitchandfamily-object) 96 + +[PitchFont enumeration](#pitchfont-enumeration) 43 + +[PointL Object](#pointl-object) 96 + +[PointL packet](#pointl-object) 96 + +[PointS Object](#points-object) 97 + +[PointS packet](#points-object) 97 + +[PolyFillMode enumeration](#polyfillmode-enumeration) 44 + +[PolyPolygon Object](#polypolygon-object) 97 + +[PolyPolygon packet](#polypolygon-object) 97 + +[POSTSCRIPT_DATA packet](#postscript_data-record) 176 + +[POSTSCRIPT_DATA Record](#postscript_data-record) 176 + +[POSTSCRIPT_IDENTIFY packet](#postscript_identify-record) 177 + +[POSTSCRIPT_IDENTIFY Record](#postscript_identify-record) 177 + +[POSTSCRIPT_IGNORE packet](#postscript_ignore-record) 178 + +[POSTSCRIPT_IGNORE Record](#postscript_ignore-record) 178 + +[POSTSCRIPT_INJECTION packet](#postscript_injection-record) 178 + +[POSTSCRIPT_INJECTION Record](#postscript_injection-record) 178 + +[POSTSCRIPT_PASSTHROUGH packet](#postscript_passthrough-record) 179 + +[POSTSCRIPT_PASSTHROUGH Record](#postscript_passthrough-record) 179 + +[PostScriptCap enumeration](#postscriptcap-enumeration) 44 + +[PostScriptClipping enumeration](#postscriptclipping-enumeration) 45 + +[PostScriptFeatureSetting enumeration](#postscriptfeaturesetting-enumeration) 45 + +[PostScriptJoin enumeration](#postscriptjoin-enumeration) 46 + +[Product behavior](#appendix-a-product-behavior) 203 + +Q + +[QUERY_DIBSUPPORT packet](#querydibsupport-record) 180 + +[QUERY_DIBSUPPORT Record](#querydibsupport-record) 180 + +[QUERY_ESCSUPPORT packet](#queryescsupport-record) 180 + +[QUERY_ESCSUPPORT Record](#queryescsupport-record) 180 + +R + +[Record objects - fixed-length](#graphics-objects-1) 79 + +[Record objects - variable-length](#structure-objects) 84 + +[Records](#wmf-records) 100 + +[enumerations](#wmf-enumerations) 20 + +[fixed-length record objects](#graphics-objects-1) 79 + +types ([section 2.3.1.1](#meta_bitblt-record) 101, [section 2.3.1.2](#meta_dibbitblt-record) 103, [section 2.3.1.3](#meta_dibstretchblt-record) 105, [section 2.3.1.5](#meta_stretchblt-record) 109) + +[variable-length record objects](#structure-objects) 84 + +[RecordType enumeration](#recordtype-enumeration) 20 + +[Rect Object](#rect-object) 97 + +[Rect packet](#rect-object) 97 + +[RectL Object](#rectl-object) 98 + +[RectL packet](#rectl-object) 98 + +[References](#references) 15 + +[informative](#informative-references) 16 + +[normative](#normative-references) 15 + +[Region Object](#region-object) 83 + +[Region packet](#region-object) 83 + +[Relationship to protocols and other structures](#relationship-to-protocols-and-other-structures) 18 + +[RGBQuad Object](#rgbquad-object) 98 + +[RGBQuad packet](#rgbquad-object) 98 + +S + +[Scan Object](#scan-object) 99 + +[Scan packet](#scan-object) 99 + +[Security](#security-considerations) 202 + +[Security - implementer considerations](#security-considerations) 202 + +[SET_COLORTABLE packet](#setcolortable-record) 181 + +[SET_COLORTABLE Record](#setcolortable-record) 181 + +[SET_COPYCOUNT packet](#setcopycount-record) 181 + +[SET_COPYCOUNT Record](#setcopycount-record) 181 + +[SET_LINECAP packet](#setlinecap-record) 182 + +[SET_LINECAP Record](#setlinecap-record) 182 + +[SET_LINEJOIN packet](#setlinejoin-record) 183 + +[SET_LINEJOIN Record](#setlinejoin-record) 183 + +[SET_MITERLIMIT packet](#setmiterlimit-record) 183 + +[SET_MITERLIMIT Record](#setmiterlimit-record) 183 + +[SizeL Object](#sizel-object) 99 + +[SizeL packet](#sizel-object) 99 + +[SPCLPASSTHROUGH2 packet](#spclpassthrough2-record) 184 + +[SPCLPASSTHROUGH2 Record](#spclpassthrough2-record) 184 + +[STARTDOC packet](#startdoc-record) 185 + +[STARTDOC Record](#startdoc-record) 185 + +[State record types](#state-record-types) 139 + +[StretchMode enumeration](#stretchmode-enumeration) 46 + +Structures + +[examples](#structure-examples) 186 + +[overview](#structures) 20 + +T + +[TA_BASELINE](#textalignmentmode-flags) 77 + +[TA_BOTTOM](#textalignmentmode-flags) 77 + +[TA_CENTER](#textalignmentmode-flags) 77 + +[TA_LEFT](#textalignmentmode-flags) 77 + +[TA_NOUPDATECP](#textalignmentmode-flags) 77 + +[TA_RIGHT](#textalignmentmode-flags) 77 + +[TA_RTLREADING](#textalignmentmode-flags) 77 + +[TA_TOP](#textalignmentmode-flags) 77 + +[TA_UPDATECP](#textalignmentmode-flags) 77 + +[TernaryRasterOperation enumeration](#ternaryrasteroperation-enumeration) 46 + +[Tracking changes](#change-tracking) 208 + +V + +[Variable-length record objects](#structure-objects) 84 + +[Vendor-extensible fields](#vendor-extensible-fields) 19 + +[Versioning](#versioning-and-localization) 19 + +[VTA_BASELINE](#verticaltextalignmentmode-flags) 78 + +[VTA_BOTTOM](#verticaltextalignmentmode-flags) 78 + +[VTA_CENTER](#verticaltextalignmentmode-flags) 78 + +[VTA_LEFT](#verticaltextalignmentmode-flags) 78 + +[VTA_RIGHT](#verticaltextalignmentmode-flags) 78 + +[VTA_TOP](#verticaltextalignmentmode-flags) 78 + +W + +[WMF Metafile Example example](#wmf-metafile-example) 194 + +[WMF_Records packet](#wmf-records) 100 diff --git a/docs/standards/README.md b/docs/standards/docx/README.md similarity index 78% rename from docs/standards/README.md rename to docs/standards/docx/README.md index 1b6c8ec..3e4d9a5 100644 --- a/docs/standards/README.md +++ b/docs/standards/docx/README.md @@ -1,11 +1,9 @@ # Нормативная документация форматов Word -Источник истины для chart-движка (`wordpdf-core/.../internal/chart/`) и нормализаторов: любые правки диаграмм/SmartArt/представления docx — по документам ниже, а не по догадкам. Правило закреплено в `AGENTS.md` (секция «Chart-движок»). Материалы разделены по категориям форматов: `docx/` — OOXML (Word 2007+), `doc/` — бинарный .doc (Word 97–2003). +Источник истины для chart-движка (`wordpdf-core/.../internal/chart/`) и нормализаторов: любые правки диаграмм/SmartArt/представления docx — по документам ниже, а не по догадкам. Правило закреплено в `AGENTS.md` (секция «Chart-движок»). Документация бинарного .doc — `../doc/README.md`. SHA-256 `.md`-файлов — справочные: они производные от инструментов извлечения (poppler/pandoc), при регенерации другим инструментом могут измениться; первичен PDF/docx в таблице «Источники». -## docx (OOXML) - ### Источники |Файл|Документ|Редакция/дата|URL|SHA-256| @@ -67,24 +65,3 @@ python3 docs/standards/docx/validate-fixtures.py wordpdf-core/src/test/resources ignorable-namespace'ов снимаются. Не маппятся (вне ECMA, осознанно): `word/charts/style*.xml`/`colors*.xml` (c14/chartStyle, MS-расширение), `word/diagrams/drawing*.xml` (`dsp:`, [MS-ODRAWXML]). - -## doc (бинарный, Word 97–2003) - -### Источники - -|Файл|Документ|Редакция/дата|URL|SHA-256| -|---|---|---|---|---| -|`ms-doc.md`|[MS-DOC] «Word (.doc) Binary File Format» — бинарный формат .doc Word 97–2003 (WordDocument/1Table-потоки, FIB, CHPX/PAPX, Clx/PlcPcd/Pcd — «piece table»)|12.5 (260217, февраль 2026)|https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-DOC/%5bMS-DOC%5d-260217.docx|`c2886120e92aa2790a5603156fb0ca8b23151d58476592fef3ede7fb6841ee7d`| - -### Что где искать - -- **Бинарный .doc (Word 97–2003)** — `ms-doc.md`: §2.1 File Structure (WordDocument-, 1Table/0Table-, Data-потоки), §2.5 FIB (FibBase, флага), §2.8–2.9 структуры данных (Chpx §2.9.32, PapxFkp, Grpprl, Clx §2.9.38, PlcPcd §2.8.35, Pcd), §3 Structure Examples, §6 Change Tracking; поиск по номерам секций — по строкам оглавления вида `[2.9.38 Clx …]` (заголовки в теле без номеров — автонумерация Word потерялась при извлечении). Конвертер принимает только .docx — документ справочный. - -### Регенерация - -```bash -# ms-doc.md — свежий dated-.docx [MS-DOC] с лендинга -# https://learn.microsoft.com/en-us/openspecs/office_file_formats/ms-doc/ccd7b486-7881-484c-a137-51170af7cc22 -curl -sSL -o /tmp/msdoc.docx "https://officeprotocoldocs-f5hpbjgea6b8gneq.b02.azurefd.net/files/MS-DOC/%5bMS-DOC%5d-260217.docx" -pandoc /tmp/msdoc.docx -t gfm-raw_html --wrap=none -o docs/standards/doc/ms-doc.md -```