Infragistics2.Win.UltraWinGrid.DocumentExport.v9.2.XML 112 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395
  1. <?xml version="1.0"?>
  2. <doc>
  3. <assembly>
  4. <name>Infragistics2.Win.UltraWinGrid.DocumentExport.v9.2</name>
  5. </assembly>
  6. <members>
  7. <member name="M:Infragistics.Shared.LocalizedCategoryAttribute.GetLocalizedString(System.String)">
  8. <summary>
  9. Returns the localized category name
  10. </summary>
  11. <param name="value">Name of the category to retreive</param>
  12. <returns>The localized string value</returns>
  13. </member>
  14. <member name="M:Infragistics.Shared.UltraLicenseAttribute.GetLicensedWithProducts">
  15. <summary>
  16. Return the list of products that this control can be licensed with
  17. </summary>
  18. </member>
  19. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderTypes">
  20. <summary>
  21. An enumerator for different header types used in header export related events.
  22. </summary>
  23. </member>
  24. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderTypes.BandHeader">
  25. <summary>
  26. Indicates that the header being exported is a band header.
  27. </summary>
  28. </member>
  29. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderTypes.GroupHeader">
  30. <summary>
  31. Indicates that the header being exported is a group header.
  32. </summary>
  33. </member>
  34. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderTypes.ColumnHeader">
  35. <summary>
  36. Indicates that the header being exported is a column header.
  37. </summary>
  38. </member>
  39. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.GridExportFileFormat">
  40. <summary>
  41. Defines the file formats to which the grid can be exported.
  42. </summary>
  43. </member>
  44. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.GridExportFileFormat.PDF">
  45. <summary>
  46. Specifies the Portable Document Format.
  47. </summary>
  48. </member>
  49. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.GridExportFileFormat.XPS">
  50. <summary>
  51. Specifies the XML Paper Specification format.
  52. </summary>
  53. </member>
  54. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.AutoSize">
  55. <summary>
  56. Options for automatically sizing the columns and rows of the grid before exporting.
  57. </summary>
  58. </member>
  59. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.AutoSize.None">
  60. <summary>
  61. No automatic sizing will be performed on either columns or rows.
  62. </summary>
  63. </member>
  64. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.AutoSize.SizeColumnsToContent">
  65. <summary>
  66. Size the columns to their contents before exporting.
  67. </summary>
  68. </member>
  69. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.AutoSize.SizeRowsToContent">
  70. <summary>
  71. Size the rows to their contents before exporting.
  72. </summary>
  73. </member>
  74. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.AutoSize.SizeColumnsAndRowsToContent">
  75. <summary>
  76. Size the columns and the rows to their contents before exporting.
  77. </summary>
  78. </member>
  79. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.ImageCompressorType">
  80. <summary>
  81. Determines which compressor to use for exported images.
  82. </summary>
  83. </member>
  84. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.ImageCompressorType.Flate">
  85. <summary>
  86. Not as good for compression as JPEG, but can handle transparency in images.
  87. </summary>
  88. </member>
  89. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.ImageCompressorType.JPEG">
  90. <summary>
  91. Better image compression for photos and complex images, but cannot support transparency.
  92. </summary>
  93. </member>
  94. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs">
  95. <summary>
  96. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.BeginExport"/> event.
  97. </summary>
  98. </member>
  99. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridLayout,Infragistics.Win.UltraWinGrid.RowsCollection,Infragistics.Documents.Report.Section.ISection)">
  100. <summary>
  101. Creates a new BeginExportEventArgs instance.
  102. </summary>
  103. <param name="layout">A cloned <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridLayout"/> of the grid being exported.</param>
  104. <param name="rows">The root <see cref="T:Infragistics.Win.UltraWinGrid.RowsCollection"/> of the grid being exported.</param>
  105. <param name="section">The <see cref="T:Infragistics.Documents.Report.Section.ISection"/> in the report to which the grid will be exported.</param>
  106. </member>
  107. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.Layout">
  108. <summary>
  109. A cloned <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridLayout"/> of the grid being exported.
  110. </summary>
  111. <remarks>
  112. <para class="body">Since this layout is a clone of the grid layout, it can be safely modified to affect the export without affecting the on-screen grid.</para>
  113. </remarks>
  114. </member>
  115. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.Rows">
  116. <summary>
  117. The root <see cref="T:Infragistics.Win.UltraWinGrid.RowsCollection"/> of the grid being exported.
  118. </summary>
  119. </member>
  120. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.Section">
  121. <summary>
  122. The <see cref="T:Infragistics.Documents.Report.Section.ISection"/> in the report to which the grid will be exported.
  123. </summary>
  124. </member>
  125. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs">
  126. <summary>
  127. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.InitializeRow"/> event.
  128. </summary>
  129. </member>
  130. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.Row">
  131. <summary>
  132. The grid row being initialized.
  133. </summary>
  134. <remarks>
  135. <para class="body">This row is not the same as the row in the On-screen grid. It is a new row that belongs to the export layout. As such, properties of the row can safely be modified and will affect the export, but will not affect the on-screen grid.</para>
  136. <para class="note"><b>Note:</b> The Value property of a cell is not stored by the row. It is stored by the underlying data source. So setting the Value of a cell in this row will affect the same data source as the on-screen grid.</para>
  137. <para class="note"><b>Note:</b> Since this row is part of the export layout, it will not share state information (such as the selected or expanded state) with the on-screen row. To get a reference to the corresponding on-screen grid row, use the <see cref="M:Infragistics.Win.UltraWinGrid.UltraGrid.GetRowFromPrintRow(Infragistics.Win.UltraWinGrid.UltraGridRow)"/> method of the grid.</para>
  138. </remarks>
  139. </member>
  140. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.SkipRow">
  141. <summary>
  142. Specifies whether to skip the current row.
  143. </summary>
  144. </member>
  145. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.SkipDescendants">
  146. <summary>
  147. Specifies whether to skip the descendats of the current row.
  148. </summary>
  149. </member>
  150. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.SkipSiblings">
  151. <summary>
  152. Specifies whether to skip sibling rows of the current row.
  153. </summary>
  154. </member>
  155. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.TerminateExport">
  156. <summary>
  157. Specifies whether to terminate the export process. If the export is terminated, the current row will not be processed.
  158. </summary>
  159. </member>
  160. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.EndExportEventArgs">
  161. <summary>
  162. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.EndExport"/> event.
  163. </summary>
  164. </member>
  165. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.EndExportEventArgs.#ctor(System.Boolean)">
  166. <summary>
  167. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.EndExportEventArgs"/> instance.
  168. </summary>
  169. <param name="canceled">True if exporting process was canceled.</param>
  170. </member>
  171. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.EndExportEventArgs.Canceled">
  172. <summary>
  173. True if the exporting process was canceled.
  174. </summary>
  175. </member>
  176. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs">
  177. <summary>
  178. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExporting"/> event.
  179. </summary>
  180. </member>
  181. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridBand,System.Boolean,Infragistics.Documents.Report.Tree.INode,Infragistics.Documents.Report.Table.ITableHeader)">
  182. <summary>
  183. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs"/> instance.
  184. </summary>
  185. <param name="band">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridBand"/> whose headers are being exported.</param>
  186. <param name="isFixedHeader">Returns whether the header being exported is a fixed header. </param>
  187. <param name="fixedHeaderContainer">Returns an INode into which the header will be exported if this is a fixed header.</param>
  188. <param name="headerContainer">Returns an ITableHeader into which the header will be exported if it is not a fixed header.</param>
  189. </member>
  190. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.Band">
  191. <summary>
  192. The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridBand"/> whose headers are being exported.
  193. </summary>
  194. </member>
  195. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.IsFixedHeader">
  196. <summary>
  197. Returns whether the header being exported is a fixed header.
  198. </summary>
  199. <remarks>
  200. <para class="body">A set of headers for a band may be exported to one of two places.</para>
  201. <para class="body">If the header is fixed, it will be exported into an INode which is contained within the report band header. This type of header will repeat at the top of each page of the report. In this case, the container is returned by the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.FixedHeaderContainer"/> property and <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.HeaderContainer"/> will be null.</para>
  202. <para class="body">If the header is not fixed, it will be exported into the header of the ITable representing the rows collection being exported. In this case, the container is returned by the HeaderContainer property and FixedHeaderContainer will be null.</para>
  203. </remarks>
  204. </member>
  205. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.FixedHeaderContainer">
  206. <summary>
  207. Returns an INode into which the header will be exported.
  208. </summary>
  209. <remarks>
  210. <para class="body">The FixedHeaderContainer is only available when <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.IsFixedHeader"/> is True. Otherwise, it will return null.</para>
  211. <para class="body">If the event is not cancelled, the header will be exported into the <see cref="P:Infragistics.Documents.Report.Tree.INode.Caption"/> of the INode specified by this property.</para>
  212. </remarks>
  213. </member>
  214. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.HeaderContainer">
  215. <summary>
  216. Returns an ITableHeader into which the header will be exported.
  217. </summary>
  218. <remarks>
  219. <para class="body">The HeaderContainer is only available when <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.IsFixedHeader"/> is False. Otherwise, it will return null.</para>
  220. <para class="body">If the event is not cancelled, the header will be exported into the <see cref="T:Infragistics.Documents.Report.Table.ITableHeader"/> specified by this property.</para>
  221. </remarks>
  222. </member>
  223. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs">
  224. <summary>
  225. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExporting"/> event.
  226. </summary>
  227. </member>
  228. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridRow,Infragistics.Documents.Report.Table.ITable)">
  229. <summary>
  230. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs"/> instance.
  231. </summary>
  232. <param name="gridRow">The grid row being exported.</param>
  233. <param name="containingTable">The ITable in the report to which the new row will be added.</param>
  234. </member>
  235. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs.GridRow">
  236. <summary>
  237. The grid row being exported.
  238. </summary>
  239. </member>
  240. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs.ContainingTable">
  241. <summary>
  242. The ITable in the report to which the new row will be added.
  243. </summary>
  244. </member>
  245. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs">
  246. <summary>
  247. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExporting"/> event.
  248. </summary>
  249. </member>
  250. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridSummaryRow,Infragistics.Documents.Report.Table.ITable)">
  251. <summary>
  252. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs"/> instance.
  253. </summary>
  254. <param name="gridSummaryRow">The UltraGridSummaryRow representing the summaries to be exported.</param>
  255. <param name="containingTable">The ITable in the report to which the summary row will be appended.</param>
  256. </member>
  257. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs.GridSummaryRow">
  258. <summary>
  259. The UltraGridSummaryRow representing the summaries to be exported.
  260. </summary>
  261. </member>
  262. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs.ContainingTable">
  263. <summary>
  264. The ITable in the report to which the summary row will be appended.
  265. </summary>
  266. <remarks>
  267. <para class="body">The table into which the summaries are exported will usually be a table representing a rows collection. But it may also be a table representing a GroupByRow (in the case where summaries are displayed as cells inside a GroupByRow).</para>
  268. </remarks>
  269. </member>
  270. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs">
  271. <summary>
  272. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExported"/> event.
  273. </summary>
  274. </member>
  275. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridBand,System.Boolean,Infragistics.Documents.Report.Tree.INode,Infragistics.Documents.Report.Table.ITableHeader,Infragistics.Documents.Report.Table.ITable)">
  276. <summary>
  277. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs"/> instance.
  278. </summary>
  279. <param name="band">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridBand"/> whose headers are being exported.</param>
  280. <param name="isFixedHeader">Returns whether the header being exported is a fixed header. </param>
  281. <param name="fixedHeaderContainer">Returns an INode into which the header will be exported.</param>
  282. <param name="headerContainer">Returns an ITableHeader into which the header will be exported.</param>
  283. <param name="reportHeaderRow">Return the ITable in the report into which the header row was exported.</param>
  284. </member>
  285. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.Band">
  286. <summary>
  287. The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridBand"/> whose headers are being exported.
  288. </summary>
  289. </member>
  290. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.IsFixedHeader">
  291. <summary>
  292. Returns whether the header being exported is a fixed header.
  293. </summary>
  294. <remarks>
  295. <para class="body">A set of headers for a band may be exported to one of two places.</para>
  296. <para class="body">If the header is fixed, it will be exported into an INode which is contained within the report band header. This type of header will repeat at the top of each page of the report. In this case, the container is returned by the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.FixedHeaderContainer"/> property and <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.HeaderContainer"/> will be null.</para>
  297. <para class="body">If the header is not fixed, it will be exported into the header of the ITable representing the rows collection being exported. In this case, the container is returned by the HeaderContainer property and FixedHeaderContainer will be null.</para>
  298. </remarks>
  299. </member>
  300. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.FixedHeaderContainer">
  301. <summary>
  302. Returns an INode into which the header will be exported.
  303. </summary>
  304. <remarks>
  305. <para class="body">The FixedHeaderContainer is only available when <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.IsFixedHeader"/> is True. Otherwise, it will return null.</para>
  306. <para class="body">If the event is not cancelled, the header will be exported into the <see cref="P:Infragistics.Documents.Report.Tree.INode.Caption"/> of the INode specified by this property.</para>
  307. </remarks>
  308. </member>
  309. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.HeaderContainer">
  310. <summary>
  311. Returns an ITableHeader into which the header will be exported.
  312. </summary>
  313. <remarks>
  314. <para class="body">The HeaderContainer is only available when <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.IsFixedHeader"/> is False. Otherwise, it will return null.</para>
  315. <para class="body">If the event is not cancelled, the header will be exported into the <see cref="T:Infragistics.Documents.Report.Table.ITableHeader"/> specified by this property.</para>
  316. </remarks>
  317. </member>
  318. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.ReportHeaderRow">
  319. <summary>
  320. Returns an ITable representing the header in the report.
  321. </summary>
  322. </member>
  323. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs">
  324. <summary>
  325. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExported"/> event.
  326. </summary>
  327. </member>
  328. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridRow,Infragistics.Documents.Report.Table.ITable,Infragistics.Documents.Report.Table.ITable)">
  329. <summary>
  330. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs"/> instance.
  331. </summary>
  332. <param name="gridRow">The grid row being exported.</param>
  333. <param name="containingTable">The ITable in the report to which the new row will be added.</param>
  334. <param name="reportRow">The ITable in the report which represents the row.</param>
  335. </member>
  336. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.GridRow">
  337. <summary>
  338. The grid row being exported.
  339. </summary>
  340. </member>
  341. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.ContainingTable">
  342. <summary>
  343. The <see cref="T:Infragistics.Documents.Report.Table.ITable"/> in the report to which the new row will be added.
  344. </summary>
  345. </member>
  346. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.ReportRow">
  347. <summary>
  348. The <see cref="T:Infragistics.Documents.Report.Table.ITable"/> in the report which represents the row.
  349. </summary>
  350. <remarks>
  351. <para class="body">The grid row is represented in the report by an ITable.</para>
  352. <para class="body">If the grid row is a normal row (as opposed to a GroupByRow), then the table will have 1 or 2 rows. The first row will contain an <see cref="T:Infragistics.Documents.Report.Grid.IGrid"/> rerepsenting the main part of the row, including all of the cells. The second row in the table contains the RowAutoPreviewArea, if any.</para>
  353. <para class="body">If the grid row is a GroupByRow, then the table will have 1 or 2 rows. The first row will contain the Description of the row. The second row in the table will contain the summaries, if they are displayed within the GroupByRow as cells.</para>
  354. </remarks>
  355. </member>
  356. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs">
  357. <summary>
  358. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExported"/> event.
  359. </summary>
  360. </member>
  361. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridSummaryRow,Infragistics.Documents.Report.Table.ITable,Infragistics.Documents.Report.Table.ITable)">
  362. <summary>
  363. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs"/> instance.
  364. </summary>
  365. <param name="gridSummaryRow">The UltraGridSummaryRow representing the summaries to be exported.</param>
  366. <param name="containingTable">The ITable in the report to which the summary row will be appended.</param>
  367. <param name="reportSummaryRow">Te ITable that represents the summary row in the report.</param>
  368. </member>
  369. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.GridSummaryRow">
  370. <summary>
  371. The UltraGridSummaryRow representing the summaries that were exported.
  372. </summary>
  373. </member>
  374. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.ContainingTable">
  375. <summary>
  376. The ITable in the report to which the summary row was appended.
  377. </summary>
  378. <remarks>
  379. <para class="body">The table into which the summaries are exported will usually be a table representing a rows collection. But it may also be a table representing a GroupByRow, in the case where summaries are displayed as cells inside a GroupByRow.</para>
  380. </remarks>
  381. </member>
  382. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.ReportSummaryRow">
  383. <summary>
  384. The ITable in the report which represents the row.
  385. </summary>
  386. <remarks>
  387. <para class="body">The summary row is represented in the report by an <see cref="T:Infragistics.Documents.Report.Table.ITable"/>.</para>
  388. <para class="body">The table may have one to three rows. The first row represents the SummaryFooterCaption. The second row represents summaries that are aligned to a particular grid column. The third row contains summaries that are aligned to the Left, Center, or Right.</para>
  389. </remarks>
  390. </member>
  391. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs">
  392. <summary>
  393. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExporting"/> event.
  394. </summary>
  395. </member>
  396. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridRow,Infragistics.Win.UltraWinGrid.UltraGridColumn,Infragistics.Documents.Report.Grid.IGridCell)">
  397. <summary>
  398. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs"/> instance.
  399. </summary>
  400. <param name="gridRow">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridRow"/> containing the cell.</param>
  401. <param name="gridColumn">The associated <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridColumn"/> containing the cell.</param>
  402. <param name="reportCell">The <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the cell will be exported.</param>
  403. </member>
  404. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.GridRow">
  405. <summary>
  406. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridRow"/> containing the cell.
  407. </summary>
  408. </member>
  409. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.GridColumn">
  410. <summary>
  411. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridColumn"/> which contains the cell being exported.
  412. </summary>
  413. </member>
  414. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.CellValue">
  415. <summary>
  416. Returns the grid cell value.
  417. </summary>
  418. </member>
  419. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.ExportValue">
  420. <summary>
  421. Gets or sets the value that will be exported to the report.
  422. </summary>
  423. <remarks>
  424. <p class="body">This property allows you to change the value being exported without affecting the on-screen grid or the data source.</p>
  425. </remarks>
  426. </member>
  427. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.ReportCell">
  428. <summary>
  429. Returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the cell will be exported.
  430. </summary>
  431. </member>
  432. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs">
  433. <summary>
  434. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExporting"/> event.
  435. </summary>
  436. </member>
  437. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.#ctor(Infragistics.Win.UltraWinGrid.HeaderBase,Infragistics.Win.UltraWinGrid.DocumentExport.HeaderTypes,Infragistics.Documents.Report.Grid.IGridCell,Infragistics.Documents.Report.Table.ITableCell,Infragistics.Documents.Report.Table.ITableCell)">
  438. <summary>
  439. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs"/> instance.
  440. </summary>
  441. <param name="gridHeader">The <see cref="T:Infragistics.Win.UltraWinGrid.HeaderBase"/> being exported.</param>
  442. <param name="headerType">The type of header is being exported: a band header, group, or column header.</param>
  443. <param name="columnHeaderContainer">An <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> which will contain the column header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.HeaderType"/> is not a column header, this should be null.</param>
  444. <param name="groupHeaderContainer">An <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which will contain the group header being exported. If HeaderType is not a group header, this should be null.</param>
  445. <param name="bandHeaderContainer">An ITableCell which will contain the band header being exported. If HeaderType is not a band header, this should be null.</param>
  446. </member>
  447. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.GridHeader">
  448. <summary>
  449. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.HeaderBase"/> being exported.
  450. </summary>
  451. </member>
  452. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.HeaderType">
  453. <summary>
  454. Indicates what type of header is being exported: a band header, group, or column header.
  455. </summary>
  456. </member>
  457. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.ColumnHeaderContainer">
  458. <summary>
  459. Returns an <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> which will contain the column header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.HeaderType"/> is not a column header, this will be null.
  460. </summary>
  461. </member>
  462. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.GroupHeaderContainer">
  463. <summary>
  464. Returns an <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which will contain the group header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.HeaderType"/> is not a group header, this will be null.
  465. </summary>
  466. </member>
  467. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.BandHeaderContainer">
  468. <summary>
  469. Returns an <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which will contain the band header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.HeaderType"/> is not a band header, this will be null.
  470. </summary>
  471. </member>
  472. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs">
  473. <summary>
  474. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExporting"/> event.
  475. </summary>
  476. </member>
  477. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.#ctor(Infragistics.Win.UltraWinGrid.SummaryValue,System.Int32,Infragistics.Documents.Report.Grid.IGridCell)">
  478. <summary>
  479. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs"/> instance.
  480. </summary>
  481. <param name="summary">The <see cref="T:Infragistics.Win.UltraWinGrid.SummaryValue"/> being exported.</param>
  482. <param name="summaryLevel">The level of the Summary. Summaries are exporting into multiple rows (levels). The summary level indicates on which level this summary is displayed.</param>
  483. <param name="reportCell">The <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the summary value will be exported.</param>
  484. </member>
  485. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.Summary">
  486. <summary>
  487. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.SummaryValue"/> being exported.
  488. </summary>
  489. </member>
  490. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.SummaryLevel">
  491. <summary>
  492. Returns the level of the Summary. Summaries are exporting into multiple rows (levels). The summary level indicates on which level this summary is displayed.
  493. </summary>
  494. </member>
  495. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.ReportCell">
  496. <summary>
  497. Returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the summary value will be exported.
  498. </summary>
  499. </member>
  500. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs">
  501. <summary>
  502. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExported"/> event.
  503. </summary>
  504. </member>
  505. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.#ctor(Infragistics.Win.UltraWinGrid.UltraGridRow,Infragistics.Win.UltraWinGrid.UltraGridColumn,Infragistics.Documents.Report.Grid.IGridCell)">
  506. <summary>
  507. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs"/> instance.
  508. </summary>
  509. <param name="gridRow">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridRow"/> containing the cell.</param>
  510. <param name="gridColumn">The associated <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridColumn"/> containing the cell.</param>
  511. <param name="reportCell">The <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the cell were exported.</param>
  512. </member>
  513. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.GridRow">
  514. <summary>
  515. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridRow"/> containing the cell.
  516. </summary>
  517. </member>
  518. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.GridColumn">
  519. <summary>
  520. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridColumn"/> which contains the cell being exported.
  521. </summary>
  522. </member>
  523. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.Value">
  524. <summary>
  525. Returns the grid cell value.
  526. </summary>
  527. </member>
  528. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.ReportCell">
  529. <summary>
  530. Returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the cell were exported.
  531. </summary>
  532. </member>
  533. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs">
  534. <summary>
  535. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExported"/> event.
  536. </summary>
  537. </member>
  538. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.#ctor(Infragistics.Win.UltraWinGrid.HeaderBase,Infragistics.Win.UltraWinGrid.DocumentExport.HeaderTypes,Infragistics.Documents.Report.Grid.IGridCell,Infragistics.Documents.Report.Table.ITableCell,Infragistics.Documents.Report.Table.ITableCell)">
  539. <summary>
  540. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs"/> instance.
  541. </summary>
  542. <param name="gridHeader">The <see cref="T:Infragistics.Win.UltraWinGrid.HeaderBase"/> being exported.</param>
  543. <param name="headerType">Indicates what type of header is being exported: a band header, group, or column header.</param>
  544. <param name="columnHeaderContainer">An <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> which contains the column header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.HeaderType"/> is not a column header, this will be null.</param>
  545. <param name="groupHeaderContainer">An <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which contains the group header being exported. If HeaderType is not a group header, this will be null.</param>
  546. <param name="bandHeaderContainer">An ITableCell which contains the band header being exported. If HeaderType is not a band header, this will be null.</param>
  547. </member>
  548. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.GridHeader">
  549. <summary>
  550. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.HeaderBase"/> being exported.
  551. </summary>
  552. </member>
  553. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.HeaderType">
  554. <summary>
  555. Indicates what type of header is being exported: a band header, group, or column header.
  556. </summary>
  557. </member>
  558. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.ColumnHeaderContainer">
  559. <summary>
  560. Returns an <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> which contains the column header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.HeaderType"/> is not a column header, this will be null.
  561. </summary>
  562. </member>
  563. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.GroupHeaderContainer">
  564. <summary>
  565. Returns an <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which contains the group header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.HeaderType"/> is not a group header, this will be null.
  566. </summary>
  567. </member>
  568. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.BandHeaderContainer">
  569. <summary>
  570. Returns an <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which contains the band header being exported. If <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.HeaderType"/> is not a band header, this will be null.
  571. </summary>
  572. </member>
  573. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs">
  574. <summary>
  575. Event parameters used for the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExported"/> event.
  576. </summary>
  577. </member>
  578. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.#ctor(Infragistics.Win.UltraWinGrid.SummaryValue,System.Int32,Infragistics.Documents.Report.Grid.IGridCell)">
  579. <summary>
  580. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs"/> instance.
  581. </summary>
  582. <param name="summary">The <see cref="T:Infragistics.Win.UltraWinGrid.SummaryValue"/> being exported.</param>
  583. <param name="summaryLevel">The level of the Summary. Summaries are exporting into multiple rows (levels). The summary level indicates on which level this summary is displayed.</param>
  584. <param name="reportCell">The <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the summary value were exported.</param>
  585. </member>
  586. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.Summary">
  587. <summary>
  588. Returns the <see cref="T:Infragistics.Win.UltraWinGrid.SummaryValue"/> being exported.
  589. </summary>
  590. </member>
  591. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.SummaryLevel">
  592. <summary>
  593. Returns the level of the Summary. Summaries are exporting into multiple rows (levels). The summary level indicates on which level this summary is displayed.
  594. </summary>
  595. </member>
  596. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.ReportCell">
  597. <summary>
  598. Returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the summary value were exported.
  599. </summary>
  600. </member>
  601. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.GraphicsCache.Dispose">
  602. <summary>
  603. Cleans up (disposes) the cached resources
  604. </summary>
  605. </member>
  606. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds">
  607. <summary>
  608. Values that uniquely identify each control property.
  609. </summary>
  610. </member>
  611. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.AutoSize">
  612. <summary>
  613. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.AutoSize"/> property.
  614. </summary>
  615. </member>
  616. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.FileBuffer">
  617. <summary>
  618. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.FileBuffer"/> property.
  619. </summary>
  620. </member>
  621. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.ImageCompressorType">
  622. <summary>
  623. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ImageCompressorType"/> property.
  624. </summary>
  625. </member>
  626. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.ImageTransparentMapColor">
  627. <summary>
  628. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ImageTransparentMapColor"/> property.
  629. </summary>
  630. </member>
  631. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.Margins">
  632. <summary>
  633. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Margins"/> property.
  634. </summary>
  635. </member>
  636. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.TargetPaperOrientation">
  637. <summary>
  638. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperOrientation"/> property.
  639. </summary>
  640. </member>
  641. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.TargetPaperSize">
  642. <summary>
  643. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperSize"/> property.
  644. </summary>
  645. </member>
  646. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.PropertyIds.UseFileBuffer">
  647. <summary>
  648. The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.UseFileBuffer"/> property.
  649. </summary>
  650. </member>
  651. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.Resources">
  652. <summary>
  653. Exposes a <see cref="T:Infragistics.Shared.ResourceCustomizer"/> instance for this assembly.
  654. </summary>
  655. <seealso cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.Resources.Customizer"/>
  656. <seealso cref="T:Infragistics.Shared.ResourceCustomizer"/>
  657. </member>
  658. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Resources.GetString(System.String,System.Object[])">
  659. <summary>
  660. Returns the resource string using the specified name and default culture.
  661. </summary>
  662. <param name="name">Name of the string resource to return.</param>
  663. <param name="args">Arguments supplied to the string.Format method when formatting the string.</param>
  664. <returns>The resource string using the specified resource name and default culture.</returns>
  665. </member>
  666. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Resources.GetString(System.String)">
  667. <summary>
  668. Returns the resource string using the specified resource name and default culture. The string is then formatted using the arguments specified.
  669. </summary>
  670. <param name="name">Name of the string resource to return.</param>
  671. <returns>The resource string using the specified resource name and default culture.</returns>
  672. </member>
  673. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Resources.GetObject(System.String)">
  674. <summary>
  675. Returns the resource object using the specified name.
  676. </summary>
  677. <param name="name">Name of the resource item.</param>
  678. <returns>An object containing the specified resource.</returns>
  679. </member>
  680. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.Resources.Customizer">
  681. <summary>
  682. Returns the <see cref="T:Infragistics.Shared.ResourceCustomizer"/> for this assembly.
  683. </summary>
  684. <seealso cref="T:Infragistics.Shared.ResourceCustomizer"/>
  685. </member>
  686. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter">
  687. <summary>
  688. UltraGridDocumentExporter component provides document (PDF or XPS) exporting functionality to UltraGrid.
  689. </summary>
  690. </member>
  691. <member name="F:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ReportRelevantPropFlags">
  692. <summary>
  693. Relevant appearance properties used in reports. All other
  694. properties are ignored in exporting process.
  695. </summary>
  696. </member>
  697. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.#ctor">
  698. <summary>
  699. UltraGridDocumentExporter constructor.
  700. </summary>
  701. </member>
  702. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.#ctor(System.ComponentModel.IContainer)">
  703. <summary>
  704. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter"/> instance.
  705. </summary>
  706. <param name="container">The <see cref="T:System.ComponentModel.IContainer"/> implementor which will contain the component.</param>
  707. </member>
  708. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Dispose(System.Boolean)">
  709. <summary>
  710. Releases the unmanaged resources used by the System.ComponentModel.Component and optionally releases the managed resources.
  711. </summary>
  712. <param name="disposing">True to release both managed and unmanaged resources; False to release only unmanaged resources.</param>
  713. </member>
  714. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ShouldSerializeImageTransparentMapColor">
  715. <summary>
  716. Returns True if the value is not the default.
  717. </summary>
  718. <returns>True if the value is not the default.</returns>
  719. </member>
  720. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ResetImageTransparentMapColor">
  721. <summary>
  722. Resets the property back to its default value.
  723. </summary>
  724. </member>
  725. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ShouldSerializeMargins">
  726. <summary>
  727. Returns True if the value is not the default.
  728. </summary>
  729. <returns>True if the value is not the default.</returns>
  730. </member>
  731. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ResetMargins">
  732. <summary>
  733. Resets the property back to its default value.
  734. </summary>
  735. </member>
  736. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ShouldSerializeTargetPaperSize">
  737. <summary>
  738. Returns True if the value is not the default.
  739. </summary>
  740. <returns>True if the value is not the default.</returns>
  741. </member>
  742. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ResetTargetPaperSize">
  743. <summary>
  744. Resets the property back to its default value.
  745. </summary>
  746. </member>
  747. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.GetCellExportValue(Infragistics.Win.UltraWinGrid.UltraGridRow,Infragistics.Win.UltraWinGrid.UltraGridColumn,Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs)">
  748. <summary>
  749. Get the value of a cell to export.
  750. </summary>
  751. <param name="gridRow"></param>
  752. <param name="gridColumn"></param>
  753. <param name="args"></param>
  754. <returns></returns>
  755. </member>
  756. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.PrepareLayoutBeforeBeginExport(Infragistics.Win.UltraWinGrid.UltraGridLayout)">
  757. <summary>
  758. Prepares the layout for exporting by modifying any properties that don't make sense in an export, such as ExclusiveColScrollRegions or a Horizontal ViewStyle.
  759. This method fires before the BeginExport event, so changes made here can be overriden by the programmer.
  760. </summary>
  761. <param name="exportLayout"></param>
  762. </member>
  763. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.PrepareLayoutAfterBeginExport(Infragistics.Win.UltraWinGrid.UltraGridLayout)">
  764. <summary>
  765. Prepares the layout for exporting by modifying any properties that don't make sense in an export, such as ExclusiveColScrollRegions or a Horizontal ViewStyle.
  766. This method is called After the BeginExport event fires, so changes made in BeforeExport
  767. will be overriden here.
  768. </summary>
  769. <param name="exportLayout"></param>
  770. </member>
  771. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Export(Infragistics.Win.UltraWinGrid.UltraGrid,System.String,Infragistics.Win.UltraWinGrid.DocumentExport.GridExportFileFormat)">
  772. <summary>
  773. Exports the specified grid to the specified file.
  774. </summary>
  775. <param name="grid">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGrid"/> control to export.</param>
  776. <param name="fileName">Name and path of resulting file.</param>
  777. <param name="fileFormat">The file format of the report.</param>
  778. <exception cref="T:System.ArgumentNullException"><paramref name="grid"/> is null.</exception>
  779. <exception cref="T:System.ArgumentNullException"><paramref name="fileName"/> is null.</exception>
  780. <returns>The newly created <see cref="T:Infragistics.Documents.Report.Report"/> into which the grid was exported..</returns>
  781. </member>
  782. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Export(Infragistics.Win.UltraWinGrid.UltraGrid,System.IO.Stream,Infragistics.Win.UltraWinGrid.DocumentExport.GridExportFileFormat)">
  783. <summary>
  784. Exports the specified grid to the specified file.
  785. </summary>
  786. <param name="grid">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGrid"/> control to export.</param>
  787. <param name="stream">The stream into which the grid will be exported.</param>
  788. <param name="fileFormat">The file format of the report.</param>
  789. <exception cref="T:System.ArgumentNullException"><paramref name="grid"/> is null.</exception>
  790. <exception cref="T:System.ArgumentNullException"><paramref name="stream"/> is null.</exception>
  791. <returns>The newly-created <see cref="T:Infragistics.Documents.Report.Report"/> into which the grid was exported.</returns>
  792. </member>
  793. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Export(Infragistics.Win.UltraWinGrid.UltraGrid)">
  794. <summary>
  795. Creates a new <see cref="T:Infragistics.Documents.Report.Report"/> and exports the specified grid into the report in a new <see cref="T:Infragistics.Documents.Report.Section.ISection"/>.
  796. </summary>
  797. <param name="grid">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGrid"/> control to export.</param>
  798. <exception cref="T:System.ArgumentNullException"><paramref name="grid"/> is null.</exception>
  799. <returns>The newly-created report section in the newly-created report into which the grid was exported.</returns>
  800. </member>
  801. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Export(Infragistics.Win.UltraWinGrid.UltraGrid,Infragistics.Documents.Report.Report)">
  802. <summary>
  803. Exports the specified ultragrid to the specified report in a new section.
  804. </summary>
  805. <param name="grid">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGrid"/> control to export.</param>
  806. <param name="report">The <see cref="T:Infragistics.Documents.Report.Report"/> into which to export the grid.</param>
  807. <exception cref="T:System.ArgumentNullException"><paramref name="grid"/> is null.</exception>
  808. <exception cref="T:System.ArgumentNullException"><paramref name="report"/> is null.</exception>
  809. <returns>The newly-created <see cref="T:Infragistics.Documents.Report.Section.ISection"/> in the report into which the grid was exported.</returns>
  810. </member>
  811. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Export(Infragistics.Win.UltraWinGrid.UltraGrid,Infragistics.Documents.Report.Section.ISection)">
  812. <summary>
  813. Exports the specified ultragrid to the specified section of a report.
  814. </summary>
  815. <param name="grid">The <see cref="T:Infragistics.Win.UltraWinGrid.UltraGrid"/> control to export.</param>
  816. <param name="section">The destination <see cref="T:Infragistics.Documents.Report.Section.ISection"/> into which the grid will be exported.</param>
  817. <exception cref="T:System.ArgumentNullException"><paramref name="grid"/> is null.</exception>
  818. <exception cref="T:System.ArgumentNullException"><paramref name="section"/> is null.</exception>
  819. </member>
  820. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnBeginExport(Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs)">
  821. <summary>
  822. Called before grid export starts.
  823. </summary>
  824. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  825. </member>
  826. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnInitializeRow(Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs)">
  827. <summary>
  828. Called when a row is initialized.
  829. </summary>
  830. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  831. </member>
  832. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnEndExport(Infragistics.Win.UltraWinGrid.DocumentExport.EndExportEventArgs)">
  833. <summary>
  834. Called after grid export is finished.
  835. </summary>
  836. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  837. </member>
  838. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnHeaderRowExporting(Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs)">
  839. <summary>
  840. Called before a header row is exported to a report.
  841. </summary>
  842. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  843. </member>
  844. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnRowExporting(Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs)">
  845. <summary>
  846. Called before a grid row is exported to a report.
  847. </summary>
  848. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  849. </member>
  850. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnSummaryRowExporting(Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs)">
  851. <summary>
  852. Called before a summary row is exported to a report.
  853. </summary>
  854. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  855. </member>
  856. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnHeaderRowExported(Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs)">
  857. <summary>
  858. Called after a header row is exported to a report.
  859. </summary>
  860. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  861. </member>
  862. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnRowExported(Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs)">
  863. <summary>
  864. Called after a grid row is exported to a report.
  865. </summary>
  866. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  867. </member>
  868. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnSummaryRowExported(Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs)">
  869. <summary>
  870. Called after a summary row is exported to a report.
  871. </summary>
  872. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  873. </member>
  874. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnCellExporting(Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs)">
  875. <summary>
  876. Called before a grid cell is exported to a report.
  877. </summary>
  878. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  879. </member>
  880. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnHeaderCellExporting(Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs)">
  881. <summary>
  882. Called before a header cell is exported to a report.
  883. </summary>
  884. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  885. </member>
  886. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnSummaryCellExporting(Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs)">
  887. <summary>
  888. Called before a summary cell is exported to a report.
  889. </summary>
  890. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  891. </member>
  892. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnCellExported(Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs)">
  893. <summary>
  894. Called after a grid cell is exported to a report.
  895. </summary>
  896. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  897. </member>
  898. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnHeaderCellExported(Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs)">
  899. <summary>
  900. Called after a header cell is exported to a report.
  901. </summary>
  902. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  903. </member>
  904. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.OnSummaryCellExported(Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs)">
  905. <summary>
  906. Called after summary cell is exported to a report.
  907. </summary>
  908. <param name="e">An <see cref="T:System.EventArgs"/> that contains the event data.</param>
  909. </member>
  910. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.AutoSize">
  911. <summary>
  912. Gets / sets whether columns and rows will be automatically sized to fit their contents before exporting.
  913. </summary>
  914. <remarks>
  915. <para class="note"><b>Note:</b> columns with <see cref="P:Infragistics.Win.UltraWinGrid.UltraGridColumn.CellMultiLine"/> set to True will not be autosized horizontally. This is to prevent columns for memo or other extremely large fields from becoming too wide. If you want to autosize a multiline column, you should do so in the <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.BeginExport"/> event by calling the <see cref="M:Infragistics.Win.UltraWinGrid.UltraGridColumn.PerformAutoResize(Infragistics.Win.UltraWinGrid.PerformAutoSizeType)"/> method on the column.</para>
  916. </remarks>
  917. </member>
  918. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.FileBuffer">
  919. <summary>
  920. A filename where data can be cached during a Publish operation.
  921. </summary>
  922. <remarks>
  923. <para class="body">Specifies a filename for the file buffer. A filebuffer will only be used if <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.UseFileBuffer"/> is True. The filename specified need not exist on the drive, but if it does, any data in the file will be lost.</para>
  924. <para class="note"><b>Note:</b> If FileBuffer is not specified and UseFileBuffer is True, the UltraGridDocumentExporter will attempt to create a file in the system temp folder. So it is not neccessary to specify a FileBuffer unless there is reason to beleive that the application will not have access to the temp folder.</para>
  925. </remarks>
  926. </member>
  927. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ImageCompressorType">
  928. <summary>
  929. Determines which type of compressor to use for images.
  930. </summary>
  931. <remarks>
  932. <para class="body">The default is the <see cref="P:Infragistics.Documents.Graphics.ImageCompressors.Flate"/> compressor. This compressor generally results in less compression (larger files), but it can handle transparent images. The <see cref="P:Infragistics.Documents.Graphics.ImageCompressors.JPEG"/> compressor results in better compression (smaller files), but it will not support transparency. So you should use JPEG only when you know that none of the images in your grid have transparency.</para>
  933. </remarks>
  934. </member>
  935. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ImageTransparentMapColor">
  936. <summary>
  937. Determines the color in the exported documented that will be used as the Transparent color.
  938. </summary>
  939. <remarks>
  940. <para class="body">PDF and XPS format do not support per-pixel transparency. So the alpha channel of an image is stripped out of any images in the document before it is exported. By default, completely transparent pixels will be converted to White, since that the standard background color.</para>
  941. <para class="body">By specifying an ImageTransparentMapColor, you can make the transparent parts of your image display transparently (instead of white). However, the color selected here will apply to all parts of the image. So, for example, if you choose Magenta, all parts of the image that are either transparent or magenta will display transparently in the resulting exported document. Therefore, it is advisable to choose an ImageTransparentMapColor that is not used in any of the images being exported.</para>
  942. <para class="body">Also note that if you are using a JPEG Compressor, the colors in the image may be changed by compression and transparency will not work properly. If you have transparency in you images, you sure make sure <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.ImageCompressorType"/> is set to Flate.</para>
  943. </remarks>
  944. <exception cref="T:System.ArgumentOutOfRangeException">The assigned color value is not opaque (has an Alpha value of less than 255).</exception>
  945. </member>
  946. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Margins">
  947. <summary>
  948. Gets or returns the page margins of the pages within the section of the report in which the grid is exported.
  949. </summary>
  950. <remarks>
  951. <para class="body">The Margins indicate the amount of space around the edges of each page of the document section into which the grid is exporter.</para>
  952. </remarks>
  953. </member>
  954. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperOrientation">
  955. <summary>
  956. Gets/sets the target paper orientation.
  957. </summary>
  958. <remarks>
  959. <para class="body">This is used to maintain the aspect ratio of the pages of the document. When exporting, the DocumentExporter will determine the neccessary page width in order to fit all grid columns on one page. If this is wider than the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperSize"/>, then the page width and height will be increased proportionally, maintaining the aspect ratio of the page based on the TargetPaperSize and <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperOrientation"/>. This means that when the document is printed and scaled down to a page, the maximum amount of page area will be utilized.</para>
  960. </remarks>
  961. </member>
  962. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperSize">
  963. <summary>
  964. The target paper size in points (a point is 1/72th of an inch).
  965. </summary>
  966. <remarks>
  967. <para class="body">This is used to maintain the aspect ratio of the pages of the document. When exporting, the DocumentExporter will determine the neccessary page width in order to fit all grid columns on one page. If this is wider than the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperSize"/>, then the page width and height will be increased proportionally, maintaining the aspect ratio of the page based on the TargetPaperSize and <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperOrientation"/>. This means that when the document is printed and scaled down to a page, the maximum amount of page area will be utilized.</para>
  968. </remarks>
  969. </member>
  970. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.UseFileBuffer">
  971. <summary>
  972. Gets or returns whether a FileBuffer will be used during a Publish operation.
  973. </summary>
  974. <remarks>
  975. <para class="body">The file buffer is used to store data to a temporary file during the publishing of a report. If a filename is specified by the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.FileBuffer"/> property, then that filename is used. If no filename is specified, the UltraGridDocumentExporter will attempt to create a file in the system temp folder.</para>
  976. </remarks>
  977. </member>
  978. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Report">
  979. <summary>
  980. Gets the report that is currently being exported. This property is only valid during an export event.
  981. </summary>
  982. <remarks>
  983. <p class="body">This property is deprecated with no replacement.</p>
  984. </remarks>
  985. </member>
  986. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.BeginExport">
  987. <summary>
  988. Occurs before the export begins.
  989. </summary>
  990. <remarks>
  991. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.Layout"/> is a cloned <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridLayout"/> of the grid being exported. Since the layout is cloned, you can safely modify the layout for exporting without affecting the on-screen grid.</p>
  992. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.Rows"/> is the root <see cref="T:Infragistics.Win.UltraWinGrid.RowsCollection"/> of the grid being exported.</p>
  993. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.BeginExportEventArgs.Section"/> is the the <see cref="T:Infragistics.Documents.Report.Section.ISection"/> in the report into which the grid will be exported. The section PageSize will automatically be set during the export process and should not be modified in this event.</p>
  994. <p class="body">This event is fired before all other events when the <see cref="M:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Export(Infragistics.Win.UltraWinGrid.UltraGrid,System.String,Infragistics.Win.UltraWinGrid.DocumentExport.GridExportFileFormat)"/> method is called. You can use it to do any preprocessing before exporting process starts. For example, you can set properties on the cloned layout.</p>
  995. </remarks>
  996. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.EndExport"/>
  997. </member>
  998. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.InitializeRow">
  999. <summary>
  1000. Occurs when a row is initialized.
  1001. </summary>
  1002. <remarks>
  1003. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.Row"/> argument returns the grid row which is being initialized. Note that this row exists in the cloned export layout, so any changes made to this row will affect the export without affecting the on-screen grid. This row may not have the same state information (such as the Selected or Expanded state) as the actual grid row in the on-screen grid. To get the on-screen row associated with this row, use the <see cref="M:Infragistics.Win.UltraWinGrid.UltraGrid.GetRowFromPrintRow(Infragistics.Win.UltraWinGrid.UltraGridRow)"/> method.</p>
  1004. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.SkipRow"/> argument specifies whether to skip the current row. This argument doesn't affect exporting of descendant rows.</p>
  1005. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.SkipDescendants"/> argument specifies whether to skip the descendats of the current row.</p>
  1006. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.SkipSiblings"/> argument specifies whether to skip sibling rows of the current row.</p>
  1007. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.DocumentExportInitializeRowEventArgs.TerminateExport"/> argument specifies whether to terminate the export process. Current row will not be processed.</p>
  1008. <p class="body">This event is fired for every grid row which is being exported, and before <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExporting"/> and <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExported"/> are fired. Use this event to set grid row specific properties and to control exporting process.</p>
  1009. </remarks>
  1010. </member>
  1011. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.EndExport">
  1012. <summary>
  1013. Occurs after grid export is finished.
  1014. </summary>
  1015. <remarks>
  1016. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.EndExportEventArgs.Canceled"/> argument is True if the exporting process was canceled.</p>
  1017. <p class="body">This event is fired after the exporting process is finished and is fired after all other events.</p>
  1018. </remarks>
  1019. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.BeginExport"/>
  1020. </member>
  1021. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExporting">
  1022. <summary>
  1023. Occurs before a header row is exported to a report.
  1024. </summary>
  1025. <remarks>
  1026. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.Band"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridBand"/> associated with the headers being exported.</p>
  1027. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.IsFixedHeader"/> returns a boolean indicating whether this set of headers is a fixed header or not. A fixed header will repeat at the top of every page of the report. Other headers will appear at the top of a particulr island of data and repeat on a page break.</p>
  1028. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.FixedHeaderContainer"/> returns a the report object which will contain the set of headers if the headers are fixed. If IsFixedHeader is false, this will return null.</p>
  1029. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportingEventArgs.HeaderContainer"/> returns a report object which will contain the headers if they are not fixed. If IsFixedHeader is True, this will return null.</p>
  1030. <p class="body">This event is fired before a set of headers is exported to the report. The header includes the band header (if any), the group headers (if groups and levels are used), and the column headers. Use the Cancel argument to cancel the exporting of the entire set of headers.</p>
  1031. <p class="body">Using these event arguments, it is possible to override the exporting of a header and provide custom exported data. Typically, this would be done by setting Cancel to True, and adding conent to the appropriate header container. If IsFixedHeader is True, content should be added to the FixedHeaderContainer, otherwise, content should be added to the HeaderContainer.</p>
  1032. </remarks>
  1033. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExported"/>
  1034. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExporting"/>
  1035. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExporting"/>
  1036. </member>
  1037. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExporting">
  1038. <summary>
  1039. Occurs before a grid row is exported to a report.
  1040. </summary>
  1041. <remarks>
  1042. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs.GridRow"/> argument returns the grid row which is being exported. Note that this row exists in the cloned export layout, so any changes made to this row will affect the export without affecting the on-screen grid. This row may not have the same state information (such as the Selected or Expanded state) as the actual grid row in the on-screen grid. To get the on-screen row associated with this row, use the <see cref="M:Infragistics.Win.UltraWinGrid.UltraGrid.GetRowFromPrintRow(Infragistics.Win.UltraWinGrid.UltraGridRow)"/> method.</p>
  1043. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportingEventArgs.ContainingTable"/> returns the ITable in the report to which the row will be exported.</p>
  1044. <p class="body">This event is fired before each row is exported. This includes the row, it's cells, it's RowPreviewArea, and may also include column header if using RowLayout mode with column headers that are displayed with the cells. Use the Cancel argument to cancel the default exporting of this row.</p>
  1045. <p class="body">This event fires only for normal data rows or GroupBy rows. It does not fire for header or summary rows. For header rows, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExporting"/>. For summary rows, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExporting"/>.</p>
  1046. <p class="body">Using these event arguments, it is possible to override the exporting of a row and provide a custom export. Typically, this would be done by setting Cancel to True, adding a row to the reportTable, and then populating that row with the desired contents.</p>
  1047. </remarks>
  1048. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExported"/>
  1049. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExporting"/>
  1050. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExporting"/>
  1051. </member>
  1052. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExporting">
  1053. <summary>
  1054. Occurs before summary row is exported to a report.
  1055. </summary>
  1056. <remarks>
  1057. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs.GridSummaryRow"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridSummaryRow"/> being exported.</p>
  1058. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportingEventArgs.ContainingTable"/> returns the ITable in the report to which the row will be exported.</p>
  1059. <p class="body">This event is fired before a summary row is exported to a report. A summary row includes the SummaryFooterCaption and all summary values. Use the Cancel argument to cancel row exporting.</p>
  1060. <p class="body">Using these event arguments, it is possible to override the exporting of a summary row and provide a custom export. Typically, this would be done by setting Cancel to True, adding a row to the reportTable, and then populating that row with the desired contents.</p>
  1061. </remarks>
  1062. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExported"/>
  1063. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExporting"/>
  1064. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExporting"/>
  1065. </member>
  1066. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExported">
  1067. <summary>
  1068. Occurs after a header row is exported to a report.
  1069. </summary>
  1070. <remarks>
  1071. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.Band"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridBand"/> associated with the headers that were exported.</p>
  1072. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.IsFixedHeader"/> returns a boolean indicating whether this set of headers is a fixed header or not. A fixed header will repeat at the top of every page of the report. Other headers will appear at the top of a particulr island of data and repeat on a page break.</p>
  1073. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.FixedHeaderContainer"/> returns a the report object which contains the set of headers if the headers are fixed. If IsFixedHeader is false, this will return null.</p>
  1074. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.HeaderContainer"/> returns a report object which contains the headers if they are not fixed. If IsFixedHeader is True, this will return null.</p>
  1075. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderRowExportedEventArgs.ReportHeaderRow"/> returns the ITable in the report which represents the exported header row.</p>
  1076. <p class="body">This event is fired after a set of headers is exported to the report. The header includes the band header (if any), the group headers (if groups and levels are used), and the column headers.</p>
  1077. </remarks>
  1078. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExporting"/>
  1079. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExported"/>
  1080. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExported"/>
  1081. </member>
  1082. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExported">
  1083. <summary>
  1084. Occurs after a grid row is exported to a report.
  1085. </summary>
  1086. <remarks>
  1087. <p class="body">The <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.GridRow"/> property returns the grid row which was being exported. Note that this row exists in the cloned export layout. This row may not have the same state information (such as the Selected or Expanded state) as the actual grid row in the on-screen grid. To get the on-screen row associated with this row, use the <see cref="M:Infragistics.Win.UltraWinGrid.UltraGrid.GetRowFromPrintRow(Infragistics.Win.UltraWinGrid.UltraGridRow)"/> method.</p>
  1088. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.ContainingTable"/> returns the <see cref="T:Infragistics.Documents.Report.Table.ITable"/> in the report to which the row was exported.</p>
  1089. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.RowExportedEventArgs.ReportRow"/> returns the ITable in the report which represents the exported row.</p>
  1090. <p class="body">This event is fired after each row is exported. This includes the row, it's cells, it's RowPreviewArea, and may also include column header if using RowLayout mode with column headers that are displayed with the cells.</p>
  1091. <p class="body">This event fires only for normal data rows or GroupBy rows. It does not fire for header or summary rows. For header rows, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExported"/>. For summary rows, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExported"/>.</p>
  1092. </remarks>
  1093. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExporting"/>
  1094. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExported"/>
  1095. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExported"/>
  1096. </member>
  1097. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExported">
  1098. <summary>
  1099. Occurs after a summary row is exported to a report.
  1100. </summary>
  1101. <remarks>
  1102. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.GridSummaryRow"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridSummaryRow"/> that was exported.</p>
  1103. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.ContainingTable"/> returns the ITable in the report to which the row was exported.</p>
  1104. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryRowExportedEventArgs.ReportSummaryRow"/> returns the ITable in the report which represents the exported summary row.</p>
  1105. <p class="body">This event is fired after a summary row is exported to a report. A summary row includes the SummaryFooterCaption and all summary values.</p>
  1106. </remarks>
  1107. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryRowExporting"/>
  1108. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderRowExported"/>
  1109. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.RowExported"/>
  1110. </member>
  1111. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExporting">
  1112. <summary>
  1113. Occurs before a grid cell is exported to a report.
  1114. </summary>
  1115. <remarks>
  1116. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.GridRow"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridRow"/> containing the cell.</p>
  1117. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.GridColumn"/> returns the associated <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridColumn"/>.</p>
  1118. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportingEventArgs.ReportCell"/> returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the cell will be exported.</p>
  1119. <p class="body">This event fires for data cells only. It will not fire for header or summary cells. For header cells, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExporting"/>. For summary cells, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExporting"/>. </p>
  1120. <p class="body">Use the Cancel argument to cancel the exporting of a cell.</p>
  1121. <p class="body">Using these event arguments, it is possible to override the exporting of a cell and provide a custom export. Typically, this would be done by setting Cancel to True, and then adding content to the ReportCell.</p>
  1122. </remarks>
  1123. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExported"/>
  1124. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExporting"/>
  1125. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExporting"/>
  1126. </member>
  1127. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExporting">
  1128. <summary>
  1129. Occurs before a header cell is exported to a report.
  1130. </summary>
  1131. <remarks>
  1132. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.GridHeader"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.HeaderBase"/> being exported.</p>
  1133. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.HeaderType"/> indicates what type of header is being exported: a band header, group, or column header.</p>
  1134. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.ColumnHeaderContainer"/>, <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.GroupHeaderContainer"/>, and <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportingEventArgs.BandHeaderContainer"/> return a report object which will contain the header being exported. Only one of these three properties will contain an object, the other two will be null.</p>
  1135. <p class="body">ColumnHeaderContainer returns an <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> which will contain the column header being exported. If HeaderType is not a column header, this will be null.</p>
  1136. <p class="body">GroupHeaderContainer returns an <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which will contain the group header being exported. If HeaderType is not a group header, this will be null.</p>
  1137. <p class="body">BandHeaderContainer returns an ITableCell which will contain the band header being exported. If HeaderType is not a band header, this will be null.</p>
  1138. <p class="body">Use the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> argument to cancel the exporting of the header cell.</p>
  1139. <p class="body">Using these event arguments, it is possible to override the exporting of a header cell and provide a custom export. Typically, this would be done by setting Cancel to True, and then adding content to the ColumnHeaderContainer, GroupHeaderContainer, or BandHeaderContainer (depending on the HeaderType).</p>
  1140. </remarks>
  1141. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExported"/>
  1142. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExporting"/>
  1143. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExporting"/>
  1144. </member>
  1145. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExporting">
  1146. <summary>
  1147. Occurs before a summary cell is exported to a report.
  1148. </summary>
  1149. <remarks>
  1150. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.Summary"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.SummaryValue"/> being exported.</p>
  1151. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.SummaryLevel"/> returns the level of the Summary. Summaries are exporting into multiple rows (levels). The summary level indicates on which level this summary is displayed.</p>
  1152. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportingEventArgs.ReportCell"/> returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the summary value will be exported.</p>
  1153. <p class="body">Use the <see cref="P:System.ComponentModel.CancelEventArgs.Cancel"/> argument to cancel the exporting of a summary cell.</p>
  1154. <p class="body">Using these event arguments, it is possible to override the exporting of a summary cell and provide a custom export. Typically, this would be done by setting Cancel to True, and then adding content to the ReportCell.</p>
  1155. </remarks>
  1156. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExported"/>
  1157. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExporting"/>
  1158. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExporting"/>
  1159. </member>
  1160. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExported">
  1161. <summary>
  1162. Occurs after a grid cell is exported to a report.
  1163. </summary>
  1164. <remarks>
  1165. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.GridRow"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridRow"/> containing the cell.</p>
  1166. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.GridColumn"/> returns the associated <see cref="T:Infragistics.Win.UltraWinGrid.UltraGridColumn"/>.</p>
  1167. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.CellExportedEventArgs.ReportCell"/> returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the cell were exported.</p>
  1168. <p class="body">This event fires for data cells only. It will not fire for header or summary cells. For header cells, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExported"/>. For summary cells, use <see cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExported"/>.</p>
  1169. </remarks>
  1170. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExporting"/>
  1171. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExported"/>
  1172. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExported"/>
  1173. </member>
  1174. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExported">
  1175. <summary>
  1176. Occurs after a header cell is exported to a report.
  1177. </summary>
  1178. <remarks>
  1179. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.GridHeader"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.HeaderBase"/> being exported.</p>
  1180. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.HeaderType"/> indicates what type of header is being exported: a band header, group, or column header.</p>
  1181. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.ColumnHeaderContainer"/>, <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.GroupHeaderContainer"/>, and <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.HeaderCellExportedEventArgs.BandHeaderContainer"/> return a report object which contains the header being exported. Only one of these three properties will contain an object, the other two will be null.</p>
  1182. <p class="body">ColumnHeaderContainer returns an <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> which contains the column header being exported. If HeaderType is not a column header, this will be null.</p>
  1183. <p class="body">GroupHeaderContainer returns an <see cref="T:Infragistics.Documents.Report.Table.ITableCell"/> which contains the group header being exported. If HeaderType is not a group header, this will be null.</p>
  1184. <p class="body">BandHeaderContainer returns an ITableCell which contains the band header being exported. If HeaderType is not a band header, this will be null.</p>
  1185. </remarks>
  1186. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExporting"/>
  1187. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExported"/>
  1188. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExported"/>
  1189. </member>
  1190. <member name="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExported">
  1191. <summary>
  1192. Occurs after a summary cell is exported to a report.
  1193. </summary>
  1194. <remarks>
  1195. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.Summary"/> returns the <see cref="T:Infragistics.Win.UltraWinGrid.SummaryValue"/> being exported.</p>
  1196. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.SummaryLevel"/> returns the level of the Summary. Summaries are exporting into multiple rows (levels). The summary level indicates on which level this summary is displayed.</p>
  1197. <p class="body"><see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.SummaryCellExportedEventArgs.ReportCell"/> returns the <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the contents of the summary value were exported.</p>
  1198. </remarks>
  1199. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.SummaryCellExporting"/>
  1200. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.CellExported"/>
  1201. <seealso cref="E:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.HeaderCellExported"/>
  1202. </member>
  1203. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.About">
  1204. <summary>
  1205. Displays the About dialog for the control.
  1206. </summary>
  1207. </member>
  1208. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.Infragistics#Shared#IUltraLicensedComponent#License">
  1209. <summary>
  1210. Return the license we cached inside the constructor
  1211. </summary>
  1212. </member>
  1213. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner">
  1214. <summary>
  1215. The designer class for the <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter"/> component.
  1216. </summary>
  1217. <remarks>
  1218. <p class="body">For Internal use only.</p>
  1219. <p class="body">This class handles various design-time maintanence tasks such as providing SmartTags.</p>
  1220. </remarks>
  1221. </member>
  1222. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.ActionLists">
  1223. <summary>
  1224. Gets the <see cref="T:System.ComponentModel.Design.DesignerActionListCollection"/> for this designer's control/component.
  1225. </summary>
  1226. </member>
  1227. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList">
  1228. <summary>
  1229. Provides DesignerActionItems for the SmartTag associated with the UltraGridDocumentExporter.
  1230. </summary>
  1231. </member>
  1232. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList.#ctor(Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter)">
  1233. <summary>
  1234. Creates a new <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList"/> instance.
  1235. </summary>
  1236. <param name="product">The <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter"/> component.</param>
  1237. </member>
  1238. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList.CreateActionItems(System.ComponentModel.Design.DesignerActionItemCollection)">
  1239. <summary>
  1240. Provides the DesignerActionItems to be displayed in the SmartTag Panel.
  1241. </summary>
  1242. <param name="actionItems">The collection to fill with DesignerActionItem objects.</param>
  1243. </member>
  1244. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList.AutoSize">
  1245. <summary>
  1246. Proxy that gets/sets the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.AutoSize"/> property of the component.
  1247. </summary>
  1248. </member>
  1249. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList.TargetPaperSize">
  1250. <summary>
  1251. Proxy that gets/sets the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperSize"/> property of the component.
  1252. </summary>
  1253. </member>
  1254. <member name="P:Infragistics.Win.UltraWinGrid.DocumentExport.Design.UltraGridDocumentExporterDesigner.UltraGridDocumentExporterActionList.TargetPaperOrientation">
  1255. <summary>
  1256. Proxy that gets/sets the <see cref="P:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter.TargetPaperOrientation"/> property of the component.
  1257. </summary>
  1258. </member>
  1259. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridExporterHelper">
  1260. <summary>
  1261. UltraGridExporterHelper implements <see cref="T:Infragistics.Win.UltraWinGrid.IUltraGridExporter"/> and serves
  1262. as communication between grid and <see cref="T:Infragistics.Win.UltraWinGrid.DocumentExport.UltraGridDocumentExporter"/>.
  1263. Class is internal so user can't create helper and call
  1264. <see cref="M:Infragistics.Win.UltraWinGrid.UltraGrid.Export(Infragistics.Win.UltraWinGrid.IUltraGridExporter)"/> method on the grid directly.
  1265. </summary>
  1266. </member>
  1267. <member name="T:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities">
  1268. <summary>
  1269. A class containing static helper methods.
  1270. </summary>
  1271. </member>
  1272. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.BuildFormattedText(System.String,System.Drawing.Size,System.Drawing.Font,Infragistics.Win.AppearanceData@)">
  1273. <summary>
  1274. Generates a string that can be parsed by the <see cref="M:Infragistics.Documents.Report.Text.IText.AddRichContent(System.String)"/> method.
  1275. </summary>
  1276. <param name="formattedText">The string representation of the value of a <see cref="T:Infragistics.Win.FormattedLinkLabel.FormattedLinkEditor"/>.</param>
  1277. <param name="sizeInPixels">The size of the object that will contain the string. This is mainly used for images whose size is represented as a percentage.</param>
  1278. <param name="baseFont">The default font to use when no font is specified for an element.</param>
  1279. <param name="defaultAppearance">The default <see cref="T:Infragistics.Win.AppearanceData"/> used to resolve the font information and color.</param>
  1280. <returns>A string containing the supported elements of the AddRichContent method.</returns>
  1281. <remarks>
  1282. <p class="body">
  1283. BuildFormattedText is a method used to parse the string representation of an UltraFormattedTextEditor or
  1284. UltraFormattedLinkLabel such that it can be added to an element of a report. Not all aspects of these controls are
  1285. supported by the AddRichContent method, so any such attributes are
  1286. ignored.
  1287. </p>
  1288. <br/>
  1289. <p class="note">
  1290. <b>Note:</b>The list of unsupported attributes or properties includes the following list:
  1291. <br/>
  1292. <ul type="bullet">
  1293. <li>Floating Images</li>
  1294. <li>Text Background</li>
  1295. </ul>
  1296. </p>
  1297. <p class="body">
  1298. In addition to the above list, the following are not possible without providing an element into which multiple
  1299. <see cref="T:Infragistics.Documents.Report.Text.IText"/> elements can be added, such as through
  1300. <see cref="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.BuildFormattedText(System.String,System.Drawing.Size,System.Drawing.Font,Infragistics.Win.AppearanceData@,Infragistics.Documents.Report.Grid.IGridCell@)"/>.
  1301. <br/>
  1302. <ul type="bullet">
  1303. <li>Horizontal Rule</li>
  1304. <li>Text Alignment</li>
  1305. <li>
  1306. If the resolved font, specified in either in the formatted text or the base font, does not natively support bold as a
  1307. TrueType font, then it cannot be drawn as such into a PDF document; for example, if the font does not have a specific Bold entry in the Fonts
  1308. directory (default: C:\Windows\Fonts), then the text will be rendered as slightly wider than non-bold text.
  1309. </li>
  1310. </ul>
  1311. </p>
  1312. </remarks>
  1313. </member>
  1314. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.BuildFormattedText(System.String,System.Drawing.Size,System.Drawing.Font,Infragistics.Win.AppearanceData@,Infragistics.Documents.Report.Grid.IGridCell@)">
  1315. <summary>
  1316. Generates a string that can be parsed by the <see cref="M:Infragistics.Documents.Report.Text.IText.AddRichContent(System.String)"/> method.
  1317. </summary>
  1318. <param name="formattedText">The string representation of the value of a <see cref="T:Infragistics.Win.FormattedLinkLabel.FormattedLinkEditor"/>.</param>
  1319. <param name="sizeInPixels">The size of the object that will contain the string. This is mainly used for images whose size is represented as a percentage.</param>
  1320. <param name="baseFont">The default font to use when no font is specified for an element.</param>
  1321. <param name="defaultAppearance">The default <see cref="T:Infragistics.Win.AppearanceData"/> used to resolve the font information and color.</param>
  1322. <param name="cell">The <see cref="T:Infragistics.Documents.Report.Grid.IGridCell"/> into which the formatted text should be rendered.</param>
  1323. <returns>A string containing the supported elements of the AddRichContent method.</returns>
  1324. <remarks>
  1325. <p class="body">
  1326. BuildFormattedText is a method used to parse the string representation of a UltraFormattedTextEditor or
  1327. UltraFormattedLinkLabel such that it can be added to an element of a report. Not all aspects of these controls are
  1328. supported by the AddRichContent method, so any such attributes are
  1329. ignored.
  1330. </p>
  1331. <br/>
  1332. <p class="note">
  1333. <b>Note:</b>The list of unsupported attributes or properties includes the following list:
  1334. <br/>
  1335. <ul type="bullet">
  1336. <li>Floating Images</li>
  1337. <li>Text Background</li>
  1338. <li>
  1339. If the resolved font, specified in either in the formatted text or the base font, does not natively support bold as a
  1340. TrueType font, then it cannot be drawn as such into a PDF document; for example, if the font does not have a specific Bold entry in the Fonts
  1341. directory (default: C:\Windows\Fonts), then the text will be rendered as slightly wider than non-bold text.
  1342. </li>
  1343. </ul>
  1344. </p>
  1345. </remarks>
  1346. </member>
  1347. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.DrawCheckbox(Infragistics.Documents.Report.ICanvas,System.Windows.Forms.CheckState)">
  1348. <summary>
  1349. Renders a simple checkbox into a <see cref="T:Infragistics.Documents.Report.ICanvas"/>.
  1350. </summary>
  1351. <param name="canvas">The ICanvas into which the checkbox should be rendered.</param>
  1352. <param name="checkState">The <see cref="T:System.Windows.Forms.CheckState"/> of the checkbox.</param>
  1353. <remarks>
  1354. This method will draw a checkbox into a ICanvas, but it is up to the programmer to
  1355. align that canvas in its container.
  1356. </remarks>
  1357. </member>
  1358. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.PixelsToPoints(System.Int32,System.Boolean)">
  1359. <summary>
  1360. Converts pixels to points using the screen DPI.
  1361. </summary>
  1362. <param name="pixels">An integer indicating a measurement in pixels.</param>
  1363. <param name="horizontal">Indicates whether the measurement is horizontal or vertical. This is neccessary to account for screen DPI.</param>
  1364. <returns>The value converted to Points.</returns>
  1365. </member>
  1366. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.PointsToPixels(System.Single,System.Boolean)">
  1367. <summary>
  1368. Converts points to pixels using the screen DPI.
  1369. </summary>
  1370. <param name="points">A float indicating a measurement in points.</param>
  1371. <param name="horizontal">Indicates whether the measurement is horizontal or vertical. This is neccessary to account for screen DPI.</param>
  1372. <returns>The value converted to pixels.</returns>
  1373. </member>
  1374. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.InchesToPoints(System.Single)">
  1375. <summary>
  1376. Converts a length measured in inches into its corresponding measurement in points (a unit often used when printing).”
  1377. </summary>
  1378. <param name="inches">A float indicating a measurement in inches.</param>
  1379. <returns>A float indicates the value in points.</returns>
  1380. <remarks>
  1381. <p class="body">This is typically used for printer calcuations where there are 72 points per inch.</p>
  1382. </remarks>
  1383. </member>
  1384. <member name="M:Infragistics.Win.UltraWinGrid.DocumentExport.Utilities.PointsToInches(System.Single)">
  1385. <summary>
  1386. Converts a length measured in points (a unit often used when printing) into its corresponding measurement in inches.
  1387. </summary>
  1388. <param name="points">A float indicating a value in points.</param>
  1389. <returns>The value in inches.</returns>
  1390. <remarks>
  1391. <p class="body">This is typically used for printer calcuations where there are 72 points per inch.</p>
  1392. </remarks>
  1393. </member>
  1394. </members>
  1395. </doc>