The following Return Properties are available. Click on a topic to move directly to that section.
A CAML template used for filtering.
• To specify a URL parameter that is used within the CAML template, specify the parameter name with [%...%] characters around it
• To specify a default value, separate the parameter name and the default value with a pipe character
• To use a different CAML filter, specify the value CWBlankFilter and fill in the Default CAML property with the CAML to be used.
Example 1:
<Where><Eq><FieldRef Name="Title"/><Value Type="Text">[%SearchText|Task%]</Value></Eq></Where>
Example 2:
<Where><Eq><FieldRef Name="Title"/><Value Type="Text">[%SearchText|CWBlankFilter%]</Value></Eq></Where>
When this property is enabled, the web part will remove any raw content that is not necessary in the data collected. Content such as "1#;" that occurs before an item in a choice column will be removed, showing only the value.
Default: True
Example:
• Disabled Choice Value = 1#;My Value
• Enabled Choice Value = My Value
This property allows you to define the format of date type fields. By default, SharePoint will store any date/time field in MM/dd/yyyy, hh:mm:spreadsheet format. To have dates or times returned in a different format, use the following parameters.
|
d |
The day of the month. Single-digit days will not have a leading zero. |
|
dd |
The day of the month. Single-digit days will have a leading zero. |
|
ddd |
The abbreviated name of the day of the week, as defined in AbbreviatedDayNames. |
|
dddd |
The full name of the day of the week, as defined in DayNames. |
|
M |
The numeric month. Single-digit months will not have a leading zero. |
|
MM |
The numeric month. Single-digit months will have a leading zero. |
|
MMM |
The abbreviated name of the month, as defined in AbbreviatedMonthNames. |
|
MMMM |
The full name of the month, as defined in MonthNames. |
|
y |
The year without the century. If the year without the century is less than 10, the year is displayed with no leading zero. |
|
yy |
The year without the century. If the year without the century is less than 10, the year is displayed with a leading zero. |
|
yyyy |
The year in four digits, including the century. |
|
gg |
The period or era. This pattern is ignored if the date to be formatted does not have an associated period or era string. |
|
h |
The hour in a 12-hour clock. Single-digit hours will not have a leading zero. |
|
hh |
The hour in a 12-hour clock. Single-digit hours will have a leading zero. |
|
H |
The hour in a 24-hour clock. Single-digit hours will not have a leading zero. |
|
HH |
The hour in a 24-hour clock. Single-digit hours will have a leading zero. |
|
m |
The minute. Single-digit minutes will not have a leading zero. |
|
mm |
The minute. Single-digit minutes will have a leading zero. |
|
s |
The second. Single-digit seconds will not have a leading zero. |
|
ss |
The second. Single-digit seconds will have a leading zero. |
|
f |
The fraction of a second in single-digit precision. The remaining digits are truncated. |
|
ff |
The fraction of a second in double-digit precision. The remaining digits are truncated. |
|
fff |
The fraction of a second in three-digit precision. The remaining digits are truncated. |
|
ffff |
The fraction of a second in four-digit precision. The remaining digits are truncated. |
|
fffff |
The fraction of a second in five-digit precision. The remaining digits are truncated. |
|
ffffff |
The fraction of a second in six-digit precision. The remaining digits are truncated. |
|
fffffff |
The fraction of a second in seven-digit precision. The remaining digits are truncated. |
|
t |
The first character in the AM/PM designator defined in AMDesignator or PMDesignator, if any. |
|
tt |
The AM/PM designator defined in AMDesignator or PMDesignator, if any. |
|
z |
The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will not have a leading zero. For example, Pacific Standard Time is "-8". |
|
zz |
The time zone offset ("+" or "-" followed by the hour only). Single-digit hours will have a leading zero. For example, Pacific Standard Time is "-08". |
|
zzz |
The full time zone offset ("+" or "-" followed by the hour and minutes). Single-digit hours and minutes will have leading zeros. For example, Pacific Standard Time is "-08:00". |
|
: |
The default time separator defined in TimeSeparator. |
|
/ |
The default date separator defined in DateSeparator. |
The CAML that will be used if variables come back null and the variable default is set to CWBlankFilter.
When this property is enabled, the content collected will not be reset to field defined types, such as currency and percentage. If this property is disabled, the content collected will be corrected to match the regional settings of the field.
Default: True
Example:
• Enabled Currency Field = $100.00
• Disabled Currency Field = 100.00
This property controls the extra content collected by the SharePoint Data Provider from a list. The following items are available to be captured:
• CompleteDisplayItemURL
• CompleteDisplayItemURLwAnchor
• CompleteEditItemURL
• CompleteEditItemURLwAnchor
• CompleteNewItemURL
• CompleteNewItemURLwAnchor
• DisplayPageURL
• EditPageURL
• EncodedAbsoluteURL
• ImageURL
• ListID
• ListType
• lItemTitle
• lItemURL
• NewFormURL
• ObjSiteTitle
• ObjSiteURL
• SPListID
• SPSiteID
When enabled, this property will only display the web part contents within a web part page, removing anything else from showing on the page. After this feature is enabled, you will need to add "?OverrideXML=true" or "?version=coras" to the URL in order to modify the web part properties.
Default: False
Enter the OXMLWPName that must be called if you want this web part to run. If ?/&OXMLWPName=THISPROPERTY is not found in the URL or Post to this page, the web part will not run. Use this in combination with the Output XML property.
Default: %Auto%
Example: MyWebPart
Page Call: default.aspx?OXMLWPName=MyWebPart
When this property is enabled, null values captured from the external XML source will be treated as empty strings, instead.
Default: False
This feature prevents the web part from returning any results until the user completes a search. It can save much-needed performance when accessing multiple lists and/or sites. With some configuration, this allows you to have multiple SharePoint Data Providers on a page, each pointing to a different list with a different schema, and utilizing a form web part or another connected web part as a search mechanism for all SharePoint Data Providers on the page.
By default, CorasWorks web parts will attempt to categorize text as a URL. If a column contains text with a format of "http://www.site.com," it will translate the text to a URL and automatically place the correct tags around it to make it clickable. If you do not want this to occur, toggle this switch on to disable this automatic feature.
Used to control the target for anchor tags.
When enabled, this property will collect and use the default name of the field within the output XML. When this property is disabled, any field that has a special character will be reformatted, removing all special characters including spaces.
Default: True
Example:
• Field: My Field Name
o Disabled Output: MyFieldName
o Enabled Output: My_x0020_Field_x0020_Name